POST api/Message/GetSMSTemplates

Api for getting the sms templates

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
schoolid	integer	None.
software	string	None.
message	string	None.
msgtype	string	None.
mnumbers	Collection of string	None.
token	string	None.

Request Formats

application/json, text/json

Sample:

{
  "schoolid": 1,
  "software": "sample string 2",
  "message": "sample string 3",
  "msgtype": "sample string 4",
  "mnumbers": [
    "sample string 1",
    "sample string 2"
  ],
  "token": "sample string 5"
}

text/html

Sample:

{"schoolid":1,"software":"sample string 2","message":"sample string 3","msgtype":"sample string 4","mnumbers":["sample string 1","sample string 2"],"token":"sample string 5"}

application/xml, text/xml

Sample:

<MessageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/smsapi.Models">
  <message>sample string 3</message>
  <mnumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </mnumbers>
  <msgtype>sample string 4</msgtype>
  <schoolid>1</schoolid>
  <software>sample string 2</software>
  <token>sample string 5</token>
</MessageModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of sms_template

Name	Type	Additional information
msgid	integer	None.
SchoolId	integer	None.
mtype	string	None.
msgtext	string	None.
mdefault	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "msgid": 1,
    "SchoolId": 2,
    "mtype": "sample string 3",
    "msgtext": "sample string 4",
    "mdefault": true
  },
  {
    "msgid": 1,
    "SchoolId": 2,
    "mtype": "sample string 3",
    "msgtext": "sample string 4",
    "mdefault": true
  }
]

text/html

Sample:

[{"msgid":1,"SchoolId":2,"mtype":"sample string 3","msgtext":"sample string 4","mdefault":true},{"msgid":1,"SchoolId":2,"mtype":"sample string 3","msgtext":"sample string 4","mdefault":true}]

application/xml, text/xml

Sample:

<ArrayOfsms_template xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/smsapi">
  <sms_template>
    <SchoolId>2</SchoolId>
    <mdefault>true</mdefault>
    <msgid>1</msgid>
    <msgtext>sample string 4</msgtext>
    <mtype>sample string 3</mtype>
  </sms_template>
  <sms_template>
    <SchoolId>2</SchoolId>
    <mdefault>true</mdefault>
    <msgid>1</msgid>
    <msgtext>sample string 4</msgtext>
    <mtype>sample string 3</mtype>
  </sms_template>
</ArrayOfsms_template>