Deprecated - API v1 will be switched off on 01.07.2022. Please upgrade to API v2
Freeze type details
Freeze type details is detaild representation of single freeze type.
Freeze type details properties
Freeze type details holds the same data as Freeze type plus some detailed features of a freeze type. Only freeze type details specyfic properties are described here.
Name | Type | Description |
---|---|---|
freezeFee |
decimal |
Freeze fee. |
availableStartDates |
array |
An array of start dates objects representing dates freeze can start. |
freezeMaxLength |
int |
Maximum freeze length . |
Retrive detailed information about specyfic freeze type
GET Contracts/FreezeType
Returns detailed freeze type informations.
Parameters
Name | Type | Description |
---|---|---|
freezeTypeId |
long |
Required. Freeze type identifier. |
contractId |
long |
Required. Contract to be frozen identifier. |
Example request
In this example we fetch detaild informations about freeze type with id
= 7
. Freeze is to be aplied to contract with id
= 10358
.
curl -i -X GET -H "Authorization: Bearer $ACCESS_TOKEN" http://yoursubdomain.perfectgym.com/Api/Contracts/FreezeType?freezeTypeId=7&contractId=10358
Example response
Status: 200 OK
{
"elements": [
{
"freezeFee": 1,
"freezeMaxLength": 30,
"availableStartDates": [
{
"year": 2016,
"month": 4,
"startMonthDate": "2016-04-01T00:00:00",
"endMonthDate": "2016-04-30T23:59:59"
},
{
"year": 2016,
"month": 5,
"startMonthDate": "2016-05-01T00:00:00",
"endMonthDate": "2016-05-31T23:59:59"
},
{
"year": 2016,
"month": 6,
"startMonthDate": "2016-06-01T00:00:00",
"endMonthDate": "2016-06-30T23:59:59"
}
],
"name": "Daily Freeze",
"isActive": true,
"isSystem": false,
"fixedFee": 1,
"administrationFee": 25,
"freezePeriod": "Day",
"id": 7,
"timestamp": 0
}
]
}