POST api/Message/Template/Get

Request Information

URI Parameters

None.

Body Parameters

MessageTemplateInput
NameDescriptionTypeAdditional information
ForeignDistrictID

string

None.

TemplateID

integer

None.

APIToken

string

None.

Request Formats

application/json, text/json

Sample:
{
  "foreignDistrictID": "sample string 1",
  "templateID": 2,
  "apiToken": "sample string 3"
}

application/xml, text/xml

Sample:
<MessageTemplateInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIService.Models.Employer">
  <APIToken>sample string 3</APIToken>
  <ForeignDistrictID>sample string 1</ForeignDistrictID>
  <TemplateID>2</TemplateID>
</MessageTemplateInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MessageTemplateOutput
NameDescriptionTypeAdditional information
MessageTemplateList

Collection of MessageTemplate

None.

Success

boolean

None.

Info

string

None.

Response Formats

application/json, text/json

Sample:
{
  "messageTemplateList": [
    {
      "id": 1,
      "title": "sample string 2",
      "message": "sample string 3",
      "subject": "sample string 4",
      "isDefaultSelection": true
    },
    {
      "id": 1,
      "title": "sample string 2",
      "message": "sample string 3",
      "subject": "sample string 4",
      "isDefaultSelection": true
    }
  ],
  "success": true,
  "info": "sample string 2"
}

application/xml, text/xml

Sample:
<MessageTemplateOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIService.Models.Employer">
  <Info>sample string 2</Info>
  <MessageTemplateList>
    <MessageTemplate>
      <ID>1</ID>
      <IsDefaultSelection>true</IsDefaultSelection>
      <Message>sample string 3</Message>
      <Subject>sample string 4</Subject>
      <Title>sample string 2</Title>
    </MessageTemplate>
    <MessageTemplate>
      <ID>1</ID>
      <IsDefaultSelection>true</IsDefaultSelection>
      <Message>sample string 3</Message>
      <Subject>sample string 4</Subject>
      <Title>sample string 2</Title>
    </MessageTemplate>
  </MessageTemplateList>
  <Success>true</Success>
</MessageTemplateOutput>