DELETE api/v1/admin/fixedmessages

This method deletes a fixed message, given the id.

Request Information

URI Parameters

None.

Body Parameters

holds the id of the fixed message

FixedMessageIDRequest
NameDescriptionTypeAdditional information
ID

ID of fixed message

string

Required

Request Formats

application/json, text/json

Sample:
{
  "ID": "sample string 1"
}

application/xml, text/xml

Sample:
<FixedMessageIDRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>sample string 1</ID>
</FixedMessageIDRequest>

Response Information

Resource Description

ResponseOfObject
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfObject

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {}
  }
}

application/xml, text/xml

Sample:
<ResponseOfObject xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail />
  </ResponseData>
</ResponseOfObject>