POST api/SMSService/GetMessageTemplate

Documentation for 'GetMessageTemplate'.

Request Information

Parameters

NameDescriptionAdditional information
request
Documentation for 'request'.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "ConceptId": 1,
  "SMSMessageCategory": 1
}

application/xml, text/xml

Sample:
<MessageTemplateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.Messages.SMS">
  <ConceptId>1</ConceptId>
  <SMSMessageCategory>DirectEnquiry</SMSMessageCategory>
</MessageTemplateRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedMediaTypeFormatterTracer' to write type 'MessageTemplateRequest'.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "status": "sample string 1",
  "Message": {
    "MessageTemplate": "sample string 1",
    "SMSFrom": "sample string 2",
    "RegardsFrom": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<ResponseBaseOfMessageTemplateResponseNZ4_SIqEP xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.MessageBase">
  <Message xmlns:d2p1="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.Messages.SMS">
    <d2p1:MessageTemplate>sample string 1</d2p1:MessageTemplate>
    <d2p1:RegardsFrom>sample string 3</d2p1:RegardsFrom>
    <d2p1:SMSFrom>sample string 2</d2p1:SMSFrom>
  </Message>
  <status>sample string 1</status>
</ResponseBaseOfMessageTemplateResponseNZ4_SIqEP>