Deprecated - API v1 will be switched off on 01.07.2022. Please upgrade to API v2
Message
Message is a summary representation of single message directed to a user.
Message properties
Message is described by the following properties
Name | Type | Description |
---|---|---|
id |
long |
Unique resource identifier. |
timestamp |
long |
Timestamp. Indicates when resource was last modified. |
title |
string |
Message title. |
isDeleted |
bool |
Indicates if resource is deleted. |
status |
string |
Message status. Possible values:
|
isReaded |
bool |
true if message has been read, false otherwise. |
createdDate |
dateTime |
Message created date. |
List user messages
GET Messages/Messages
Returns paginated list of messages directed to a user.
Parameters
Name | Type | Description |
---|---|---|
userId |
long |
Required. User identifier. Request returns messages assigned to user identified by userId . |
timestamp |
long |
Timestamp. Request returns messages with timestamp grater then timestamp . Defaults to 0. |
Example request
In this example we fetch list of messages assigned to user identified with id
= 236
curl -i -X GET -H "Authorization: Bearer $ACCESS_TOKEN" http://yoursubdomain.perfectgym.com/Api/Messages/Messages?userId=236
Example response
Status: 200 OK
{
"elements": [
{
"title": "Shoes",
"id": 10252,
"timestamp": 692590,
"isDeleted": false,
"status": "Planned",
"isReaded": false,
"createdDate": "2016-01-26T00:00:00"
}
]
}