GET api/getblacklist/{sessionID}
Returns the user's blacklist
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| sessionID |
Session ID (obtained at login) |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
GetBlacklistResponse| 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. |
| visitors |
User identifiers who are currently ONLINE |
Collection of integer |
None. |
| anonyms |
User identifiers who are currently ONLINE |
Collection of integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"retval": 1,
"desc": "sample string 2",
"visitors": [
1,
2
],
"anonyms": [
1,
2
]
}
application/xml, text/xml
Sample:
<getblacklist.response>
<retval>1</retval>
<desc>sample string 2</desc>
<visitors>
<int>1</int>
<int>2</int>
</visitors>
<anonyms>
<int>1</int>
<int>2</int>
</anonyms>
</getblacklist.response>