POST api/AppMsg/ClassWise

This api sends notification based message to all students of selected (given) classes and section

Request Information

URI Parameters

None.

Body Parameters

ClassWiseAppMsg
NameDescriptionTypeAdditional information
msgtype

string

None.

content

string

None.

mdate

string

None.

userid

integer

None.

schoolid

integer

None.

token

string

None.

classname

string

None.

sectionname

string

None.

sessionid

string

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",
  "classname": "sample string 7",
  "sectionname": "sample string 8",
  "sessionid": "sample string 9",
  "softwarename": "sample string 10"
}

text/html

Sample:
{"msgtype":"sample string 1","content":"sample string 2","mdate":"sample string 3","userid":4,"schoolid":5,"token":"sample string 6","classname":"sample string 7","sectionname":"sample string 8","sessionid":"sample string 9","softwarename":"sample string 10"}

application/xml, text/xml

Sample:
<ClassWiseAppMsg xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/smsapi.Models">
  <classname>sample string 7</classname>
  <content>sample string 2</content>
  <mdate>sample string 3</mdate>
  <msgtype>sample string 1</msgtype>
  <schoolid>5</schoolid>
  <sectionname>sample string 8</sectionname>
  <sessionid>sample string 9</sessionid>
  <softwarename>sample string 10</softwarename>
  <token>sample string 6</token>
  <userid>4</userid>
</ClassWiseAppMsg>

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
NameDescriptionTypeAdditional 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>