GET api/v1/admin/templates/{id}

Fetches the message template provided.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the template.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

The message template.

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Admin.SMS.MessageTemplateResponse
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.Admin.SMS.MessageTemplateResponse

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": "74750d0d-7b56-4d21-9a20-ba20bb20e1d1",
      "Enabled": true,
      "Name": "sample string 3",
      "Template": "sample string 4",
      "Type": 1
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfMessageTemplateResponse 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>
      <Name>sample string 3</Name>
      <Template>sample string 4</Template>
      <Type>ALL</Type>
      <ID>74750d0d-7b56-4d21-9a20-ba20bb20e1d1</ID>
      <Enabled>true</Enabled>
    </Detail>
  </ResponseData>
</ResponseOfMessageTemplateResponse>