GET api/v1/sms/templates

This method retrieves all the notification templates that the system can send out for the account.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of templates that the authenticated user is allowed to view.

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Admin.SMS.Template[]

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.Admin.SMS.Template[]	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": [
      {
        "TemplateID": "864d4099-78aa-49e7-9766-73957291a6cc",
        "Name": "sample string 2",
        "Type": 0,
        "TemplateText": "sample string 3",
        "DateCreated": "sample string 4",
        "DateModified": "sample string 5"
      },
      {
        "TemplateID": "864d4099-78aa-49e7-9766-73957291a6cc",
        "Name": "sample string 2",
        "Type": 0,
        "TemplateText": "sample string 3",
        "DateCreated": "sample string 4",
        "DateModified": "sample string 5"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfArrayOfTemplate 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>
      <Template>
        <ID>864d4099-78aa-49e7-9766-73957291a6cc</ID>
        <Name>sample string 2</Name>
        <Type>RECIPIENT_CODE</Type>
        <TemplateText>sample string 3</TemplateText>
        <DateCreated>sample string 4</DateCreated>
        <DateModified>sample string 5</DateModified>
      </Template>
      <Template>
        <ID>864d4099-78aa-49e7-9766-73957291a6cc</ID>
        <Name>sample string 2</Name>
        <Type>RECIPIENT_CODE</Type>
        <TemplateText>sample string 3</TemplateText>
        <DateCreated>sample string 4</DateCreated>
        <DateModified>sample string 5</DateModified>
      </Template>
    </Detail>
  </ResponseData>
</ResponseOfArrayOfTemplate>