Get All Equipment Reservations
GET reservations/getAllReservations
Retrieves all reservations (past and current) in the organization.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[{"reservation_id":1,"whitelabel_id":127,"start_time":1598261400,"end_time":1598265900,"time_human":"Mon Aug 24 3:30am - 4:45am","type":"private","created_at":1598219218,"custid":564,"fname":"Michael","lname":"Testerino","phone_number":"4074031671","email":"Michael@Hello.net","boats":[{"reservation_start":1598261400,"reservation_end":1598265900,"custid":564,"fname":"Michael","lname":"Testerino","reservation_id":1,"whitelabel_id":127,"boat_id":9,"boat_name":"Time Flies","manufacturer":"Empacher","model":"CVV1","year_built":2002,"year_acquired":2017,"purchase_price":"10000","insured":"Yes","insured_value":"5600","hull_type":"2","min_weight":165,"max_weight":200,"color":"Empacher Yellow","serial_number":"KVJSR3","coxed":"No","status":"Available","created_at":0}],"oars":[],"ergs":[],"notes":""}]
[]
Success Response Key
Get Reservation
GET reservations/getReservationById
Retrieves a specific reservation based on its ID number. You can get a list of all equipment reservations from the /reservations/getAllReservations endpoint.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| reservation_id | Id of the reservation to retrieve. |
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[{"reservation_id":1,"whitelabel_id":127,"start_time":1598261400,"end_time":1598265900,"time_human":"Mon Aug 24 3:30am - 4:45am","type":"private","created_at":1598219218,"custid":564,"fname":"Michael","lname":"Testerino","phone_number":"4074031671","email":"Michael@Hello.net","boats":[{"reservation_start":1598261400,"reservation_end":1598265900,"custid":564,"fname":"Michael","lname":"Testerino","reservation_id":1,"whitelabel_id":127,"boat_id":9,"boat_name":"Time Flies","manufacturer":"Empacher","model":"CVV1","year_built":2002,"year_acquired":2017,"purchase_price":"10000","insured":"Yes","insured_value":"5600","hull_type":"2","min_weight":165,"max_weight":200,"color":"Empacher Yellow","serial_number":"KVJSR3","coxed":"No","status":"Available","created_at":0}],"oars":[],"ergs":[],"notes":""}]
[]
Success Response Key
Get All Boat Reservations
GET reservations/getAllBoatReservations
Retrieves all instances of a reservation for all boats. Reservations may be returned multiple times, but only once per boat.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[{"reservation_start":1698508080,"reservation_end":1698530040,"human_readable":"Sat Oct 28, 2023 9:48am - 3:54pm","custid":564,"fname":"Michael","lname":"Testerino","reservation_id":133,"whitelabel_id":127,"boat_id":19,"boat_name":"Lady Vista","manufacturer":"Sykes","model":"sykes151","year_built":2001,"year_acquired":2015,"purchase_price":"12000","insured":"Yes","insured_value":"10000","hull_type":"4","min_weight":152,"max_weight":211,"color":"Blue","serial_number":"4389cj48fnh4","coxed":"No","status":"Available","created_at":0},{"reservation_start":1687701600,"reservation_end":1687708800,"human_readable":"Sun Jun 25, 2023 8:00am - 10:00am","custid":564,"fname":"Michael","lname":"Testerino","reservation_id":141,"whitelabel_id":127,"boat_id":21,"boat_name":"Bayou Navy","manufacturer":"Vespoli","model":"M6","year_built":1970,"year_acquired":2015,"purchase_price":"0","insured":"Yes","insured_value":"5000","hull_type":"8","min_weight":170,"max_weight":230,"color":"Yellow","serial_number":"43f934hf83nbh","coxed":"Stern","status":"Available","created_at":0},{"reservation_start":1687701600,"reservation_end":1687708800,"human_readable":"Sun Jun 25, 2023 8:00am - 10:00am","custid":564,"fname":"Michael","lname":"Testerino","reservation_id":141,"whitelabel_id":127,"boat_id":9,"boat_name":"Time Flies","manufacturer":"Empacher","model":"CVV1","year_built":2002,"year_acquired":2017,"purchase_price":"10000","insured":"No","insured_value":"","hull_type":"2","min_weight":165,"max_weight":200,"color":"Empacher Yellow","serial_number":"KVJSR3","coxed":"No","status":"Available","created_at":0}]
[]
Success Response Key
Get Reservation Restrictions
GET reservations/getReservationRestrictions
Retrieves each of the reservation restrictions placed on all private reservations.time_limit - Maximum length of a private equipment reservation (in seconds). This does not apply to practices, only private equipment reservations. Set as "0" to set a unlimited
min_lead_time - Minimum lead time required before a reservation starts (in seconds). This is used if you want to better control when athletes can checkout equipment. Having a longer minimum lead time allows club admins to have advance warning as to when a athlete plans to checkout equipment. Set as "0" to allow athletes to create right-now reservations.
max_lead_time - Maximum lead time required before a reservation starts (in seconds). This is used to ensure that athletes do not reserve equipment too far in advance. We recommend having no more than a one week (seven days) lead time to prevent possible conflicts with equipment being out of service, needed for practices, etc. . Set as "0" to have unlimited lead time.
seven_day_limit - Maximum number of reservations a user can have in any 7-day rolling window. This setting is generally used to prevent a single athlete from hoarding equipment. Set as "0" to allow unlimited reservations.
fourteen_day_limit - Maximum number of reservations a user can have in any 14-day rolling window. This setting is generally used to prevent a single athlete from hoarding equipment. Set as "0" to allow unlimited reservations.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
{"whitelabel_id":127,"time_limit":5400,"min_lead_time":7200,"max_lead_time":8640000,"seven_day_limit":4,"fourteen_day_limit":10}
[]
Success Response Key
Create Reservation
POST reservations/createReservation
Creates a new equipment reservation. If the type is `private`, either `start_time` and `end_time` OR `raw_start_time` and `raw_end_time` are required to indicate when the reservation starts and ends.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| type | Type of reservation (`private`,`regatta`, `practice`). |
| start_time | (optional) UNIX timestamp of the start of the reservation. |
| end_time | (optional) UNIX timestamp of the end of the reservation. |
| raw_start_time | (optional) String representation of the start time of the reservation. |
| raw_end_time | (optional) String representation of the end time of the reservation. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 5 | Create Practices | Allowed to add / remove / edit practices on the calendar. |
| 11 | Check out equipment | Allowed to check out/in equipment for private uses or for practices. |
Sample Responses
{"Status":"Success","reservation_id":187}
[]
Success Response Key
Delete Reservation
POST reservations/deleteReservation
Deletes an existing equipment reservation based on its reservation_id number.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| reservation_id | Id of the equipment reservation. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 11 | Check out equipment | Allowed to check out/in equipment for private uses or for practices. |
Sample Responses
{"Status":"Success","Message":"Reservation has been deleted"}
[]
Success Response Key
Search Available Equipment
GET reservations/searchAvailableEquipment
Finds all available equipment that the authenticated user is allowed to use for reservations between two UNIX timestamps.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| start_time | UNIX timestamp of the start of the search window. |
| end_time | UNIX timestamp of the end of the search window. |
Required Permissions
No special permissions required to access this endpoint.Sample Responses
{"boats":[{"boat_id":9,"whitelabel_id":127,"boat_name":"Time Flies","manufacturer":"Empacher","model":"CVV1","year_built":2002,"year_acquired":2017,"purchase_price":"10000","insured":"No","insured_value":"","hull_type":"2","min_weight":165,"max_weight":200,"color":"Empacher Yellow","serial_number":"KVJSR3","coxed":"No","status":"Available","created_at":0,"blacked_out":false,"rigging":[{"boat_id":9,"seat":1,"seat_side":"Sculling","total_spread":"0","port_lateral_pitch_min":"0","port_lateral_pitch_max":"0","starboard_lateral_pitch_min":"0","starboard_lateral_pitch_max":"0","port_front_pitch_min":"0","port_front_pitch_max":"0","starboard_front_pitch_min":"0","starboard_front_pitch_max":"0","port_swivel_height_min":"0","port_swivel_height_max":"0","starboard_swivel_height_min":"0","starboard_swivel_height_max":"0","track_length":"0","foot_stretcher_angle_min":"0","foot_stretcher_angle_max":"0","foot_stretcher_placement":"0"},{"boat_id":9,"seat":2,"seat_side":"Sculling","total_spread":"0","port_lateral_pitch_min":"0","port_lateral_pitch_max":"0","starboard_lateral_pitch_min":"0","starboard_lateral_pitch_max":"0","port_front_pitch_min":"0","port_front_pitch_max":"0","starboard_front_pitch_min":"0","starboard_front_pitch_max":"0","port_swivel_height_min":"0","port_swivel_height_max":"0","starboard_swivel_height_min":"0","starboard_swivel_height_max":"0","track_length":"0","foot_stretcher_angle_min":"0","foot_stretcher_angle_max":"0","foot_stretcher_placement":"0"}]},{"boat_id":19,"whitelabel_id":127,"boat_name":"Lady Vista","manufacturer":"Sykes","model":"sykes151","year_built":2001,"year_acquired":2015,"purchase_price":"12000","insured":"Yes","insured_value":"10000","hull_type":"4","min_weight":152,"max_weight":211,"color":"Blue","serial_number":"4389cj48fnh4","coxed":"No","status":"Available","created_at":0,"blacked_out":false,"rigging":[{"boat_id":19,"seat":1,"seat_side":"Port","total_spread":"0","port_lateral_pitch_min":"0","port_lateral_pitch_max":"0","starboard_lateral_pitch_min":"0","starboard_lateral_pitch_max":"0","port_front_pitch_min":"0","port_front_pitch_max":"0","starboard_front_pitch_min":"0","starboard_front_pitch_max":"0","port_swivel_height_min":"0","port_swivel_height_max":"0","starboard_swivel_height_min":"0","starboard_swivel_height_max":"0","track_length":"0","foot_stretcher_angle_min":"0","foot_stretcher_angle_max":"0","foot_stretcher_placement":"0"},{"boat_id":19,"seat":2,"seat_side":"Starboard","total_spread":"0","port_lateral_pitch_min":"0","port_lateral_pitch_max":"0","starboard_lateral_pitch_min":"0","starboard_lateral_pitch_max":"0","port_front_pitch_min":"0","port_front_pitch_max":"0","starboard_front_pitch_min":"0","starboard_front_pitch_max":"0","port_swivel_height_min":"0","port_swivel_height_max":"0","starboard_swivel_height_min":"0","starboard_swivel_height_max":"0","track_length":"0","foot_stretcher_angle_min":"0","foot_stretcher_angle_max":"0","foot_stretcher_placement":"0"},{"boat_id":19,"seat":3,"seat_side":"Starboard","total_spread":"0","port_lateral_pitch_min":"0","port_lateral_pitch_max":"0","starboard_lateral_pitch_min":"0","starboard_lateral_pitch_max":"0","port_front_pitch_min":"0","port_front_pitch_max":"0","starboard_front_pitch_min":"0","starboard_front_pitch_max":"0","port_swivel_height_min":"0","port_swivel_height_max":"0","starboard_swivel_height_min":"0","starboard_swivel_height_max":"0","track_length":"0","foot_stretcher_angle_min":"0","foot_stretcher_angle_max":"0","foot_stretcher_placement":"0"},{"boat_id":19,"seat":4,"seat_side":"Port","total_spread":"0","port_lateral_pitch_min":"0","port_lateral_pitch_max":"0","starboard_lateral_pitch_min":"0","starboard_lateral_pitch_max":"0","port_front_pitch_min":"0","port_front_pitch_max":"0","starboard_front_pitch_min":"0","starboard_front_pitch_max":"0","port_swivel_height_min":"0","port_swivel_height_max":"0","starboard_swivel_height_min":"0","starboard_swivel_height_max":"0","track_length":"0","foot_stretcher_angle_min":"0","foot_stretcher_angle_max":"0","foot_stretcher_placement":"0"}]}],"oars":[],"ergs":[{"erg_id":1,"whitelabel_id":127,"identifier":"BCR-01","make":"Concept 2","model":"D","year_purchased":2017,"location":"Mountains Edge","insured":"Yes","insured_value":"750","status":"Available","created_at":1597791728}]}
[]
Success Response Key
Add Boat to Reservation
POST reservations/addBoatToReservation
Adds a boat to a given equipment reservation.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| reservation_id | Id of the equipment reservation. |
| boat_id | Id of the boat being added to the reservation. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 5 | Create Practices | Allowed to add / remove / edit practices on the calendar. |
| 11 | Check out equipment | Allowed to check out/in equipment for private uses or for practices. |
Sample Responses
{"Status":"Success","Message":"Boat added to reservation","reservation_id":143}
[]
Success Response Key
Add Erg to Reservation
POST reservations/addErgToReservation
Adds an ergometer to a given equipment reservation.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| reservation_id | Id of the equipment reservation. |
| erg_id | Id of the ergometer being added to the reservation. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 11 | Check out equipment | Allowed to check out/in equipment for private uses or for practices. |
Sample Responses
{"Status":"Success","Message":"Erg added to reservation","reservation_id":143}
[]
Success Response Key
Add Oar to Reservation
POST reservations/addOarToReservation
Adds an oar to a given equipment reservation.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| reservation_id | Id of the equipment reservation. |
| oar_id | Id of the oar being added to the reservation. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 11 | Check out equipment | Allowed to check out/in equipment for private uses or for practices. |
Sample Responses
{"Status":"Success","Message":"Oar added to reservation","reservation_id":143}
[]
Success Response Key
Remove Boat From Reservation
POST reservations/removeBoatFromReservation
Removes a given boat from the equipment reservation.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| reservation_id | Id of the equipment reservation. |
| boat_id | Id of the boat being removed from the reservation. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 11 | Check out equipment | Allowed to check out/in equipment for private uses or for practices. |
Sample Responses
{"Status":"Success","Message":"Boat has been removed from reservation"}
[]
Success Response Key
Update Reservation Notes
POST reservations/updateNotes
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| reservation_id | Id of the equipment reservation being updated |
| notes | Notes about the reservation to save. Any existing note will be overwritten. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 5 | Create Practices | Allowed to add / remove / edit practices on the calendar. |
| 11 | Check out equipment | Allowed to check out/in equipment for private uses or for practices. |
Sample Responses
[{"reservation_id":143,"whitelabel_id":127,"start_time":1714888800,"end_time":1714892400,"time_human":"Sun May 5 12:00am - 1:00am","type":"private","created_at":1714845394,"custid":564,"fname":"Michael","lname":"Testerson","phone_number":"4074031671","email":"Michael@Test.net","boats":[],"oars":[],"ergs":[],"notes":"Planning on rowing with Steve. Steve is using his private 1x"}]
[]
Success Response Key
Update Reservation Restrictions
POST reservations/updateRestriction
Updates the reservation restrictions. You can fetch the current restrictions from the /reservations/getReservationRestrictions endpointtime_limit - Maximum length of a private equipment reservation (in seconds). This does not apply to practices, only private equipment reservations. Set as "0" to set a unlimited
min_lead_time - Minimum lead time required before a reservation starts (in seconds). This is used if you want to better control when athletes can checkout equipment. Having a longer minimum lead time allows club admins to have advance warning as to when a athlete plans to checkout equipment. Set as "0" to allow athletes to create right-now reservations.
max_lead_time - Maximum lead time required before a reservation starts (in seconds). This is used to ensure that athletes do not reserve equipment too far in advance. We recommend having no more than a one week (seven days) lead time to prevent possible conflicts with equipment being out of service, needed for practices, etc. . Set as "0" to have unlimited lead time.
seven_day_limit - Maximum number of reservations a user can have in any 7-day rolling window. This setting is generally used to prevent a single athlete from hoarding equipment. Set as "0" to allow unlimited reservations.
fourteen_day_limit - Maximum number of reservations a user can have in any 14-day rolling window. This setting is generally used to prevent a single athlete from hoarding equipment. Set as "0" to allow unlimited reservations.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| time_limit | Maximum number of seconds in length the reservation can be. |
| min_lead_time | Minimum number of seconds away the start of the reservation can be from the moment it is created. |
| max_lead_time | Maximum number of seconds away the start of the reservation can be from the moment it is created. |
| seven_day_limit | Maximum number of reservations a user can have in any 7-day window. |
| fourteen_day_limit | Maximum number of reservations a user can have in any 14-day window. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 10 | Equipment Usage Hours & Group Permissions | Allowed to set hours equipment can be used and which groups are allowed to use them. |
Sample Responses
{"whitelabel_id":127,"time_limit":5400,"min_lead_time":7200,"max_lead_time":8640000,"seven_day_limit":4,"fourteen_day_limit":10}
[]