GET api/v1/sms/templates/{templateID}

This method retrieves the notification template specified in the request.

Request Information

URI Parameters

Name	Description	Type	Additional information
templateID	The Id of the template to fetch the details for.	string	Required

Body Parameters

None.

Response Information

Resource Description

Template details 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": "1d2f3e93-94bf-4429-a837-750765b073ba",
      "Name": "sample string 2",
      "Type": 0,
      "TemplateText": "sample string 3",
      "DateCreated": "sample string 4",
      "DateModified": "sample string 5"
    }
  }
}

application/xml, text/xml

Sample:

<ResponseOfTemplate 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>
      <ID>1d2f3e93-94bf-4429-a837-750765b073ba</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>
    </Detail>
  </ResponseData>
</ResponseOfTemplate>