POST api/Message/BirthdayMessage

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

ResultModel

Name	Type	Additional information
resultcode	integer	None.
resultstring	string	None.
token	string	None.
schoolid	integer	None.
sessionid	integer	None.
userid	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "resultcode": 1,
  "resultstring": "sample string 2",
  "token": "sample string 3",
  "schoolid": 4,
  "sessionid": 5,
  "userid": 6
}

text/html

Sample:

{"resultcode":1,"resultstring":"sample string 2","token":"sample string 3","schoolid":4,"sessionid":5,"userid":6}

application/xml, text/xml

Sample:

<ResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/smsapi.Models">
  <resultcode>1</resultcode>
  <resultstring>sample string 2</resultstring>
  <schoolid>4</schoolid>
  <sessionid>5</sessionid>
  <token>sample string 3</token>
  <userid>6</userid>
</ResultModel>