Schedule
Flaviu Porutiu
Table of contents |
---|
Entry point
<instance-url>/api/<endpoint> example: https://trancend.dev/api/schedule
Getting clubs
Returns clubs data in a serialized format
GETÂ /clubs
Request
Request | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Endpoint:Â /clubs | ||||||||||||||||||||||
Method: GET | ||||||||||||||||||||||
Headers: Â Click here to expand...
| ||||||||||||||||||||||
Parameters: Â Click here to expand...
|
Response
Response | ||||||||||||||||||||||||||||||||
Http Code | Response | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
200 | Â Click here to expand... Success response { "rows": [ { "id": 1, "cell": { "actions": 1, "name": "Club 1", "max_book_per_day": 5, "max_waitlist": 10, "book_days_advance": 7, "pos": "Manual (fara casa de marcat)" } } ], "records": 1, "page": 1, "total": 1 } | Success response Object description: Base object:
Row object:
Cell object
| ||||||||||||||||||||||||||||||
422 | Â Click here to expand... Error response { "success": 0 } | Error |
Getting studios
Returns studios for a certain club
GETÂ /studios
Request
Request | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Endpoint:Â /studios | ||||||||||||||||||||||||||
Method: GET | ||||||||||||||||||||||||||
Headers: Â Click here to expand...
| ||||||||||||||||||||||||||
Parameters: Â Click here to expand...
|
Response
Response | ||||||||||||||||||||||||||||||||||
Http Code | Response | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
200 | Â Click here to expand... Success response { "rows": [ { "id": 1, "cell": { "actions": 1, "name": "Cycling", "club_id": 1, "cycling_places": 10, "max_book_per_day": 5, "max_waitlist": 10, "book_days_advance": 2 } } ], "records": 1, "page": 1, "total": 1 } | Success response Object description: Base object:
Row object:
Cell object
| ||||||||||||||||||||||||||||||||
422 | Â Click here to expand... Error response { "success": 0 } | Error |
Getting schedule data
Returns schedule data in a serialized format
GETÂ /schedule
Request
Request | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Endpoint:Â /schedule | ||||||||||||||||||||||
Method: GET | ||||||||||||||||||||||
Headers: Â Click here to expand...
| ||||||||||||||||||||||
Parameters: Â Click here to expand...
|
Response
Response | ||||||||||||||||||||||||||||||||||||||||||||||||
Http Code | Response | Description | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
200 | Â Click here to expand... Success response { "success": 1, "days": { "monday": { "classes": { "21:00": [ { "interval": "21:00 - 21:20", "name": "Test clasa", "date": "2018-02-26 21:00", "date_readable": "26/02/2018", "duration": 20, "studio": "Cycling", "time": "21:00", "club": "Club 1", "trainer": "trainer", "can_confirm": true, "id": 2, "can_edit": false, "can_book": false, "color": "#222222", "color_text": "#ffffff", "max_booking": 30, "no_booked": 0, "x_type": 2 } ], "17:00": [ { "name": "filler", "time": "17:00", "x_type": 1 } ], "12:00": [ { "name": "filler", "time": "12:00", "x_type": 1 } ] } }, "tuesday": { "classes": { "17:00": [ { "interval": "17:00 - 17:23", "name": "Clasa", "date": "2018-02-27 17:00", "date_readable": "27/02/2018", "duration": 23, "studio": "Cycling", "time": "17:00", "club": "Club 1", "trainer": "trainer", "can_confirm": false, "id": 3, "can_edit": false, "can_book": false, "color": "#222222", "color_text": "#ffffff", "max_booking": 12, "no_booked": 0, "x_type": 2 } ], "21:00": [ { "name": "filler", "time": "21:00", "x_type": 1 } ], "12:00": [ { "name": "filler", "time": "12:00", "x_type": 1 } ] } }, "wednesday": { "classes": { "12:00": [ { "interval": "12:00 - 12:20", "name": "Clasa waitlist", "date": "2018-02-28 12:00", "date_readable": "28/02/2018", "duration": 20, "studio": "Cycling", "time": "12:00", "club": "Club 1", "trainer": "trainer", "can_confirm": false, "id": 4, "can_edit": false, "can_book": false, "color": "#222222", "color_text": "#ffffff", "max_booking": 32, "no_booked": 0, "x_type": 2 } ], "21:00": [ { "name": "filler", "time": "21:00", "x_type": 1 } ], "17:00": [ { "name": "filler", "time": "17:00", "x_type": 1 } ] } }, "thursday": { "classes": { "21:00": [ { "name": "filler", "time": "21:00", "x_type": 1 } ], "17:00": [ { "name": "filler", "time": "17:00", "x_type": 1 } ], "12:00": [ { "name": "filler", "time": "12:00", "x_type": 1 } ] } }, "friday": { "classes": { "21:00": [ { "name": "filler", "time": "21:00", "x_type": 1 } ], "17:00": [ { "name": "filler", "time": "17:00", "x_type": 1 } ], "12:00": [ { "name": "filler", "time": "12:00", "x_type": 1 } ] } }, "saturday": { "classes": { "21:00": [ { "name": "filler", "time": "21:00", "x_type": 1 } ], "17:00": [ { "name": "filler", "time": "17:00", "x_type": 1 } ], "12:00": [ { "name": "filler", "time": "12:00", "x_type": 1 } ] } }, "sunday": { "classes": { "21:00": [ { "name": "filler", "time": "21:00", "x_type": 1 } ], "17:00": [ { "name": "filler", "time": "17:00", "x_type": 1 } ], "12:00": [ { "name": "filler", "time": "12:00", "x_type": 1 } ] } } }, "time": [ { "time": "21:00" }, { "time": "17:00" }, { "time": "12:00" } ] } | Success response Object description: Base object:
Classes object: Array which has as keys the time and as values an array of class description objects
| ||||||||||||||||||||||||||||||||||||||||||||||
422 | Â Click here to expand... Error response { "success": 0 } | Error |