Rank One Partner API Version 1.0
You are currently viewing 'Get Chat List ' page
Usage
GET /Chat/List/:DistrictId/:RecipientId
Content-Type
application/json
Description
Returns a list of chat objects that the recipient is participating in.
Note
Put the access token generated from the Get Access Token endpoint (Auth/ValidateUser) in the request header field "Authorization" as "bearer ACCESS_TOKEN_HERE". Sample request URL used when GET request is made/Chat/List/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000
Example
| Type | Name | Required | Note |
| URL | District ID | YES | District ID of user |
| URL | Recipient ID | YES | Recipient ID of user |
Sample response:
[
{
"chatId": "4f8df05c-0d35-4fe1-b772-62e15a03f910",
"linkId": "a0a4767a-8fa3-4b52-abd5-1124af60581a",
"linkTypeId": 1,
"createdDate": "2018-07-02T14:11:49.3157334-05:00",
"createdByRecipientId": "3ee3fde1-4e9b-46f0-b055-c3aeca80da34",
},
{
"chatId": "3f5c0410-bb2f-45b4-9761-d445c89993d8",
"linkId": null,
"linkTypeId": null,
"createdDate": "2018-07-02T14:11:49.3157334-05:00",
"createdByRecipientId": "3b1ed73f-8298-4afc-81c7-01aecf1098fe",
},
...
]