GET api/checknewmessages/{sessionID}/{corrID}/{corrType}/{lastID}
Checks for new messages in the correspondence
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| sessionID |
Session ID (obtained at login) |
string |
Required |
| corrID |
Correspondent ID |
integer |
Required |
| corrType |
Correspondent type ("support", "admin", "user", "buyer", "visitor", "anonym") |
string |
Required |
| lastID |
ID of last message (if database has more, then there are new messages) |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
CheckNewMessagesResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| retval |
Return code (0 - ok, otherwise - error) |
integer |
None. |
| desc |
Text description of the return code (error description) |
string |
None. |
| exists |
Check result (0 - none, 1 - messages exist) |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"retval": 1,
"desc": "sample string 2",
"exists": 3
}
application/xml, text/xml
Sample:
<checknew.response> <retval>1</retval> <desc>sample string 2</desc> <exists>3</exists> </checknew.response>