GET api/v1/admin/fixedmessages?id={id}

Retrieves a fixed messages by its id. If the id field is left blank a full list of fixed messages will be returned.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	id of the message (Leave blank to get a full list of fixed messages)	string	Required

Body Parameters

None.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Admin.SMS.FixedMessage

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Admin.SMS.FixedMessage	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": [
      {
        "ID": "sample string 1",
        "Message": "sample string 2",
        "Name": "sample string 3"
      },
      {
        "ID": "sample string 1",
        "Message": "sample string 2",
        "Name": "sample string 3"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfListOfFixedMessage 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>
      <FixedMessage>
        <ID>sample string 1</ID>
        <Message>sample string 2</Message>
        <Name>sample string 3</Name>
      </FixedMessage>
      <FixedMessage>
        <ID>sample string 1</ID>
        <Message>sample string 2</Message>
        <Name>sample string 3</Name>
      </FixedMessage>
    </Detail>
  </ResponseData>
</ResponseOfListOfFixedMessage>