POST api/messages/checkunread/{sessionID}

CheckUnreadMessagesResponse

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sessionID

string

Required

Body Parameters

CheckUnreadMessagesRequest
NameDescriptionTypeAdditional information
ids

List of IDs to check

 Collection of integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "ids": [
    1,
    2
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

application/xml, text/xml

Sample: 
<checkunreadmessages.request>
  <ids>1</ids>
  <ids>2</ids>
</checkunreadmessages.request>

Response Information

Resource Description

CheckUnreadMessagesResponse
NameDescriptionTypeAdditional information
retval

Return code (0 - success, otherwise - error)

 integer

None.
ids

Identifiers of read messages

 Collection of integer

None.
desc

Text description of the return code (error description)

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "retval": 1,
  "ids": [
    1,
    2
  ],
  "desc": "sample string 2"
}

application/xml, text/xml

Sample: 
<checkunreadmessages.response>
  <retval>1</retval>
  <desc>sample string 2</desc>
  <ids>1</ids>
  <ids>2</ids>
</checkunreadmessages.response>