POST api/AppMsg/RegnWise

This api sends notification based message to all students of given registration nos.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
msgtype	string	None.
content	string	None.
mdate	string	None.
userid	integer	None.
schoolid	integer	None.
token	string	None.
regnos	Collection of string	None.
sessionid	integer	None.
softwarename	string	None.

Request Formats

application/json, text/json

Sample:

{
  "msgtype": "sample string 1",
  "content": "sample string 2",
  "mdate": "sample string 3",
  "userid": 4,
  "schoolid": 5,
  "token": "sample string 6",
  "regnos": [
    "sample string 1",
    "sample string 2"
  ],
  "sessionid": 7,
  "softwarename": "sample string 8"
}

text/html

Sample:

{"msgtype":"sample string 1","content":"sample string 2","mdate":"sample string 3","userid":4,"schoolid":5,"token":"sample string 6","regnos":["sample string 1","sample string 2"],"sessionid":7,"softwarename":"sample string 8"}

application/xml, text/xml

Sample:

<RegnWiseAppMsg xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/smsapi.Models">
  <content>sample string 2</content>
  <mdate>sample string 3</mdate>
  <msgtype>sample string 1</msgtype>
  <regnos xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </regnos>
  <schoolid>5</schoolid>
  <sessionid>7</sessionid>
  <softwarename>sample string 8</softwarename>
  <token>sample string 6</token>
  <userid>4</userid>
</RegnWiseAppMsg>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns result code 0 for success and token contains msgid when success , result code 3 when Invalid Login Token was supplied, 1 if no reciepent, 4 if content is blank/null, 11 for unknown error

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>