Deprecated - API v1 will be switched off on 01.07.2022. Please upgrade to API v2
Contracts
Contract is a summary representation of single user contract.
Contract properties
Contract is described by the following properties
Name | Type | Description |
---|---|---|
id |
long |
Unique identifier of contract. |
timestamp |
long |
Timestamp. Indicates when resource was last modified. |
signDate |
string |
Contract's sign date. |
startDate |
string |
Contract's start date. |
cancelDate |
string |
Contract's cancel date. |
endDate |
string |
Contract's end date. |
commitmentDate |
string |
Contract's commitment date. |
isActive |
bool |
Indicates if contract is marked as active. |
isDeleted |
bool |
Indicates if resource is deleted. |
List user contracts
GET Contracts/Contracts
Returns paginated list of user contracts.
Parameters
Name | Type | Description |
---|---|---|
userId |
long |
Required. User identifier. Request returns contracts assigned to user identified by userId . |
Example request
In this example we fetch list of contracts assigned to user identified with id
= 236
curl -i -X GET -H "Authorization: Bearer $ACCESS_TOKEN" http://yoursubdomain.perfectgym.com/Api/Contracts/Contracts?userId=236
Example response
Status: 200 OK
{
"elements": [
{
"id": 10358,
"timestamp": 350287,
"signUpDate": "2016-01-26T00:00:00",
"startDate": "2016-01-26T00:00:00",
"cancelDate": "",
"endDate": "",
"isActive": true,
"isDeleted": false
}
]
}