Deprecated - API v1 will be switched off on 01.07.2022. Please upgrade to API v2
Club details
Club details is detaild representation of single club in your company.
Club details properties
Club details holds the same data as Club plus some detailed features of a club. Only club details specific properties are described here.
Name | Type | Description |
---|---|---|
displayName |
string |
Club display name. |
description |
string |
Club detailed description. |
languageCode |
string |
Language identifier club information are translated to (for example EN , DE etc.) |
equipment |
array |
An array of Equipment objects, each representing equipment type available in club. |
facilities |
array |
An array of Facility objects, each representing facility available in club. |
openingHours |
array |
An array of Opening hours objects, each representing club opening hours in a given week day. |
urls |
array |
An array of Url objects, each representing an url to your club's social service site. |
contacts |
array |
An array of Contact objects, each representing an individual or a departament in your club, user can reach using e-mail or phone. |
zones |
array |
An array of Zone objects, each representing a distinct area in club. |
photos |
array |
An array of Photo objects, each representing photo of your club. |
classes |
array |
An array of [Class type][ClassesType] objects, each representing available class type. |
Retrive detailed information about specific club
GET Clubs/Club
Returns detailed club informations.
Parameters
Name | Type | Description |
---|---|---|
clubId |
long |
Required. Club identifier. |
languageCode |
string |
Language identifier club information should be translated to (for example EN , DE etc.). |
Example request
In this example we fetch club with id
= 16
detailed information. Information will be returned in club's language (languageCode
parameter is ommited).
curl -i -X GET -H "Authorization: Bearer $ACCESS_TOKEN" http://yoursubdomain.perfectgym.com/Api/Clubs/Club?clubId=16
Example response
Status: 200 OK
{
"elements": [
{
"displayName": "Cyberbotics Berlin",
"description": "Our club began in 1979 and has always been a favorite of different types of athletes and fitness enthusiasts. Refined and updated to offer a setting that is open and light where both staff and clientele are friendly and casual and the focus is on well-balanced health.",
"languageCode": "",
"equipment": [
{
"id": 10,
"type": "Treadmill",
"name": "Treadmill",
"quantity": 10,
"isDeleted": false
},
{
"id": 11,
"type": "StationaryBicycle",
"name": "Stationary bicycle",
"quantity": 10,
"isDeleted": false
}
],
"facilities": [
{
"id": 7,
"type": "WiFi",
"name": "WiFi",
"isDeleted": false
},
{
"id": 8,
"type": "Coffee",
"name": "Coffee",
"isDeleted": false
},
{
"id": 9,
"type": "Sunbed",
"name": "Sunbed",
"isDeleted": false
}
],
"openHours": [
{
"id": 11,
"isClosed": false,
"dayOfWeekOrHoliday": "Monday",
"openFrom": "07:00:00",
"openUntil": "23:00:00",
"isDeleted": false
},
{
"id": 12,
"isClosed": false,
"dayOfWeekOrHoliday": "Sunday",
"openFrom": "10:00:00",
"openUntil": "18:00:00",
"isDeleted": false
},
{
"id": 13,
"isClosed": false,
"dayOfWeekOrHoliday": "Tuesday",
"openFrom": "07:00:00",
"openUntil": "23:00:00",
"isDeleted": false
},
{
"id": 14,
"isClosed": false,
"dayOfWeekOrHoliday": "Wednesday",
"openFrom": "07:00:00",
"openUntil": "23:00:00",
"isDeleted": false
},
{
"id": 15,
"isClosed": false,
"dayOfWeekOrHoliday": "Thursday",
"openFrom": "07:00:00",
"openUntil": "23:00:00",
"isDeleted": false
},
{
"id": 16,
"isClosed": false,
"dayOfWeekOrHoliday": "Friday",
"openFrom": "07:00:00",
"openUntil": "23:00:00",
"isDeleted": false
},
{
"id": 17,
"isClosed": false,
"dayOfWeekOrHoliday": "Saturday",
"openFrom": "09:00:00",
"openUntil": "20:00:00",
"isDeleted": false
}
],
"urls": [
{
"id": 3,
"mediaType": "Facebook",
"url": "http://facebook.com/Cyberbotics",
"isDeleted": false
},
{
"id": 4,
"mediaType": "Twitter",
"url": "http://twitter.com/Cyberbotics",
"isDeleted": false
},
{
"id": 5,
"mediaType": "YouTube",
"url": "http://youtube.com/Cyberbotics",
"isDeleted": false
},
{
"id": 6,
"mediaType": "Instagram",
"url": "http://instagram.com/Cyberbotics",
"isDeleted": false
}
],
"contacts": [
{
"id": 4,
"title": "",
"name": "Support",
"email": "support@club@cyberbotics.com",
"phoneNumber": "+49 12 123 456 789",
"isDeleted": false
}
],
"zones": [
{
"id": 38,
"parentId": "",
"name": "Mind & Body",
"description": "Studio Mind & Body",
"isDeleted": false
},
{
"id": 39,
"parentId": "",
"name": "Spinning",
"description": "Spinning",
"isDeleted": false
},
{
"id": 40,
"parentId": "",
"name": "Fit & Dance",
"description": "Fit & Dance",
"isDeleted": false
}
],
"photos": [
{
"photoUrl": "http://yoursubdomain.perfectgym.com/Api/Files/Photo?photoId=142",
"id": 5,
"timestamp": 374980,
"isDeleted": false
},
{
"photoUrl": "http://yoursubdomain.perfectgym.com/Api/Files/Photo?photoId=143",
"id": 6,
"timestamp": 374983,
"isDeleted": false
}
],
"id": 16,
"timestamp": 271990,
"name": "Cyberbotics Berlin",
"shortName": "Cyberbotics",
"symbol": "CBTCS",
"type": "Normal",
"openDate": "2015-01-01",
"latitude": 52.51038,
"longitude": 13.39763,
"email": "club@cyberbotics.com",
"phoneNumber": "+49 12 123 456 789",
"timezone": "Central European Standard Time",
"address": {
"line1": "Leipziger Str. 46/47",
"line2": "",
"city": "Berlin",
"postalCode": "10-117",
"country": "Germany"
},
"isDeleted": false,
"isHidden": false
}
]
}