Equipment
Rowing programs need equipment to operate, so Boathouse Connect gives you the most powerful toolset to manage your equipment. Using the equipment endpoints, you can add/remove equipment, check the status of different items, set checkout permissions, etc.
Get All Equipment
GET equipment/getAllEquipment
Returns all equipment in the organization.
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
{"boats":[{"boat_id":9,"whitelabel_id":128,"created_at":1601736575,"boat_name":"Time Flies","boat_type":"2","coxed":"No","manufacturer":"Empacher","model":"CVV1","serial":"KV58DJ48F647","year_built":2002,"year_purchased":2017,"weight_min":165,"weight_max":200,"color":"Empacher Yellow","insured":"No","insured_value":"7500","purchase_price":"10000","status":"Available","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_stern_pitch_min":"0","port_stern_pitch_max":"0","starboard_stern_pitch_min":"0","starboard_stern_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":"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_stern_pitch_min":"0","port_stern_pitch_max":"0","starboard_stern_pitch_min":"0","starboard_stern_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"}],"checkout_groups":[{"whitelabel_id":128,"boat_id":9,"boat_name":"Time Flies","manufacturer":"Empacher","model":"CVV1","serial_number":"KV58DJ48F647","hull_type":"2","status":"Available","created_at":1601736575,"min_weight":165,"max_weight":200,"group_id":44,"group_title":"Super Admin","group_descr":"Access to everything. Able to grant\/revoke permissions for all groups. Able to do everything. Warning: Only add users to this group that should have permission to manage the entire organization. Strongly recommend limiting to organization president and vice-president.","group_self_join":"No"},{"whitelabel_id":128,"boat_id":9,"boat_name":"Time Flies","manufacturer":"Empacher","model":"CVV1","serial_number":"KV58DJ48F647","hull_type":"2","status":"Available","created_at":1601736575,"min_weight":165,"max_weight":200,"group_id":54,"group_title":"Equipment Modifier","group_descr":"allowed to assign equipment rights to groups","group_self_join":"No"}]}],"oars":[{"oar_set_id":3,"whitelabel_id":128,"name":"CJC yellow","type":"Sweep","descr":"reserved for CJC","manufacturer":"Concept2","model":"Fats","created_at":1155996,"oars":[{"oar_id":3,"side":"Port","descr":"oar 1 - port","status":"Available","created_at":1166884585},{"oar_id":4,"side":"Starboard","descr":"oar 1 - starboard","status":"Available","created_at":1166884632}]}],"launches":[],"trailers":[],"coxing":[],"boathouse_misc":[],"ergs":[{"erg_id":6,"whitelabel_id":128,"identifier":"Erg#112","make":"Concept 2","model":"D","year_purchased":2020,"location":"Crossfit Gym","insured":"Yes","insured_value":"800","status":"Available","created_at":1601734252}],"spare_parts":[],"misc":[]}
[]
Success Response Key
Equipment Manufacturers
GET equipment/getManufacturers
Returns a list of equipment manufacturers.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[{"manufacturer_id":1,"type":"Boat","name":"Hudson","store_url":"https:\/\/us.hudsonboatworks.com\/"},{"manufacturer_id":2,"type":"Boat","name":"Kaschper","store_url":"https:\/\/www.kaschper.com\/parts\/"},{"manufacturer_id":3,"type":"Boat","name":"Wintech","store_url":"https:\/\/store.wintechracing.com\/"},{"manufacturer_id":4,"type":"Boat","name":"Vespoli","store_url":"https:\/\/store.vespoli.com\/"}]
[]
Success Response Key
Boat Manufacturers
GET equipment/getBoatManufacturers
Returns a active list of boat manufacturers. This endpoint is similar to the equipment/getManufacturers endpoint, but only returns boat manufacturers.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[{"manufacturer_id":9,"type":"Boat","name":"Alden","store_url":"https:\/\/www.adirondackrowing.com\/parts\/"},{"manufacturer_id":10,"type":"Boat","name":"Empacher","store_url":"https:\/\/www.empachernorthamerica.com\/links-and-information.html"},{"manufacturer_id":8,"type":"Boat","name":"Filippi","store_url":"https:\/\/www.filippiboats.com\/eng"}]
[]
Success Response Key
Boat Analytics
GET equipment/boatAnalytics
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
boat_id | (optional) Id of the boat to fetch analytics for. Fetches all boats when omitted. |
start_time | (optional) UNIX timestamp of the start of the analytics period. |
end_time | (optional) UNIX timestamp of the end of the analytics period. |
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[]
[]
Success Response Key
Get Equipment Issue
GET equipment/getIssues
Retrieves all logged equipment issues. Issues are separated by ones submitted from Post-Practice Surveys and standards
equipment issue submissions.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
{"practices_surveys":[{"whitelabel_id":129,"practice_id":1,"custid":579,"fname":"Olivia","lname":"Testington","practice_name":"Saturday Morning Fun","practice_start":1609600500,"practice_end":1609601100,"reported_at":1609603095,"issue":"My seat broken ","lineup_boat_id":3,"lineup_boat_name":"Time Flies","lineup_boat_seat":"1"}],"reported":[{"id":2,"whitelabel_id":129,"custid":564,"fname":"Michael","lname":"Merwin","timestamp":1617027527,"descr":"Boat needs to be re-rigged"},{"id":1,"whitelabel_id":129,"custid":564,"fname":"Michael","lname":"Merwin","timestamp":1612116093,"descr":"3-seat of the Bayou Navy is missing a wing-nut on the foot-stretcher"}]}
[]
Success Response Key
Add Equipment Issue
POST equipment/addEquipmentIssue
Creates a new equipment issue that needs to be addressed.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
description | Description of the equipment issue being recorded. |
asset_type | Type of asset being reported. `boat`, `erg`, or `oar`. |
asset_id | Id of the asset |
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[]
[]
Success Response Key
Get All Boats
GET equipment/getAllBoats
Returns all boats in the organization.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[{"boat_id":9,"whitelabel_id":128,"created_at":0,"boat_name":"Time Flies","boat_type":"2","coxed":"No","manufacturer":"Empacher","model":"CVV1","serial":"KVJSR345647","year_built":2002,"year_purchased":2017,"weight_min":165,"weight_max":200,"color":"Empacher Yellow","insured":"No","insured_value":"7500","purchase_price":"10000","status":"Available","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_stern_pitch_min":"0","port_stern_pitch_max":"0","starboard_stern_pitch_min":"0","starboard_stern_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":"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_stern_pitch_min":"0","port_stern_pitch_max":"0","starboard_stern_pitch_min":"0","starboard_stern_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"}],"checkout_groups":[{"whitelabel_id":128,"boat_id":9,"boat_name":"Time Flies","manufacturer":"Empacher","model":"CVV1","serial_number":"KV58DJ48F647","hull_type":"2","status":"Available","created_at":1601736575,"min_weight":165,"max_weight":200,"group_id":44,"group_title":"Super Admin","group_descr":"Access to everything. Able to grant\/revoke permissions for all groups. Able to do everything. Warning: Only add users to this group that should have permission to manage the entire organization. Strongly recommend limiting to organization president and vice-president.","group_self_join":"No"},{"whitelabel_id":128,"boat_id":9,"boat_name":"Time Flies","manufacturer":"Empacher","model":"CVV1","serial_number":"KV58DJ48F647","hull_type":"2","status":"Available","created_at":1601736575,"min_weight":165,"max_weight":200,"group_id":54,"group_title":"Equipment Modifier","group_descr":"allowed to assign equipment rights to groups","group_self_join":"No"}]}]
[]
Success Response Key
Add Boat
POST equipment/addBoat
Adds a boat to the equipment inventory.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
boat_type | Number of rowers the boat has. Options are `1`, `2`, `4` or `8`. |
boat_name | Name of the boat. |
manufacturer_id | Id number of the manufacturer. This can be found using the equipment/getManufacturers endpoint. If the manufacturer is not in the list, use the manufacturer_other endpoint instead. |
model | Model of the boat. |
serial | Serial number of the boat. |
year_built | Four-digit year the boat was built. |
year_purchased | Four-digit year the boat was acquired by the organization. |
weight_min | Minimum average weight of the rowers, as recommended by the manufacturer (in lbs). |
weight_max | Maximum average weight of the rowers, as recommended by the manufacturer (in lbs). |
color | Primary color of the hull. |
insured | `Yes` or `No` - If the boat is insured by the organization. |
manufacturer_other | (optional) Name of the manufacturer. |
coxed | (optional) `Yes` or `No` - If the boat has a coxswain seat. |
purchase_price | (optional) Price the organization paid to acquire the boat. |
insured_value | (optional) Value the organization has insured the boat for. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
{"Status":"Success"}
[]
Success Response Key
Update Boat Details
POST equipment/updateBoatDetails
Updates meta-data for a boat. Only set the optional parameters for the attributes that you want to update. This endpoint
returns the same data as the equipment/getAllBoats endpoint.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
boat_id | Id number of the boat. This can be found from the equipment/getAllEquipment endpoint. |
boat_name | (optional) New name of the boat. |
boat_model | (optional) New manufacturer model of the boat. |
year_built | (optional) 4-digit year the boat was constructed. |
year_acquired | (optional) 4-digit year the boat was acquired by the organization. |
min_crew_weight | (optional) Minimum average crew weight (in lbs) |
max_crew_weight | (optional) Maximum average crew weight (in lbs) |
serial | (optional) Serial number of the boat. This should only be updated to correct an error. |
color | (optional) Primary color of the boat. |
insured | (optional) `Yes` or `No` - If the boat is insured by the organization. |
insured_value | (optional) Value the organization has insured the boat for. |
status | (optional) `Available` or `Out of Service` - Describes the state of the boat. If the boat is `Out of Service` it cannot be used for practices or reservations. |
coxswain_location | (optional) `Bow`, `Stern`, or `No` Location of the coxswain seat in the hull. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
[{"boat_id":9,"whitelabel_id":128,"created_at":0,"boat_name":"Time Flies","boat_type":"2","coxed":"No","manufacturer":"Empacher","model":"CVV1","serial":"KVJSR345647","year_built":2002,"year_purchased":2017,"weight_min":165,"weight_max":200,"color":"Empacher Yellow","insured":"No","insured_value":"7500","purchase_price":"10000","status":"Available","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_stern_pitch_min":"0","port_stern_pitch_max":"0","starboard_stern_pitch_min":"0","starboard_stern_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":"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_stern_pitch_min":"0","port_stern_pitch_max":"0","starboard_stern_pitch_min":"0","starboard_stern_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"}],"checkout_groups":[{"whitelabel_id":128,"boat_id":9,"boat_name":"Time Flies","manufacturer":"Empacher","model":"CVV1","serial_number":"KV58DJ48F647","hull_type":"2","status":"Available","created_at":1601736575,"min_weight":165,"max_weight":200,"group_id":44,"group_title":"Super Admin","group_descr":"Access to everything. Able to grant\/revoke permissions for all groups. Able to do everything. Warning: Only add users to this group that should have permission to manage the entire organization. Strongly recommend limiting to organization president and vice-president.","group_self_join":"No"},{"whitelabel_id":128,"boat_id":9,"boat_name":"Time Flies","manufacturer":"Empacher","model":"CVV1","serial_number":"KV58DJ48F647","hull_type":"2","status":"Available","created_at":1601736575,"min_weight":165,"max_weight":200,"group_id":54,"group_title":"Equipment Modifier","group_descr":"allowed to assign equipment rights to groups","group_self_join":"No"}]}]
[]
Success Response Key
Add Boat Checkout Permission to Group
POST equipment/addBoatCheckoutPermissionToGroup
Adds permission for a specific group to be able to checkout a boat for private use or for practices.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
boat_id | Id number of the boat. This can be found from the equipment/getAllEquipment endpoint. |
group_id | Id number of the group that will be allowed to checkout this boat. group_id`s can be found using the wlgroups/getAllGroups endpoint. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
10 | Equipment Usage Hours & Group Permissions | Allowed to set hours equipment can be used and which groups are allowed to use them. |
Sample Responses
[{"boat_id":9,"whitelabel_id":128,"created_at":0,"boat_name":"Time Flies","boat_type":"2","coxed":"No","manufacturer":"Empacher","model":"CVV1","serial":"KVJSR345647","year_built":2002,"year_purchased":2017,"weight_min":165,"weight_max":200,"color":"Empacher Yellow","insured":"No","insured_value":"7500","purchase_price":"10000","status":"Available","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_stern_pitch_min":"0","port_stern_pitch_max":"0","starboard_stern_pitch_min":"0","starboard_stern_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":"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_stern_pitch_min":"0","port_stern_pitch_max":"0","starboard_stern_pitch_min":"0","starboard_stern_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"}],"checkout_groups":[{"whitelabel_id":128,"boat_id":9,"boat_name":"Time Flies","manufacturer":"Empacher","model":"CVV1","serial_number":"KV58DJ48F647","hull_type":"2","status":"Available","created_at":1601736575,"min_weight":165,"max_weight":200,"group_id":44,"group_title":"Super Admin","group_descr":"Access to everything. Able to grant\/revoke permissions for all groups. Able to do everything. Warning: Only add users to this group that should have permission to manage the entire organization. Strongly recommend limiting to organization president and vice-president.","group_self_join":"No"},{"whitelabel_id":128,"boat_id":9,"boat_name":"Time Flies","manufacturer":"Empacher","model":"CVV1","serial_number":"KV58DJ48F647","hull_type":"2","status":"Available","created_at":1601736575,"min_weight":165,"max_weight":200,"group_id":54,"group_title":"Equipment Modifier","group_descr":"allowed to assign equipment rights to groups","group_self_join":"No"}]}]
[]
Success Response Key
Remove Boat Checkout Permission
GET equipment/removeBoatCheckoutPermissionToGroup
Removes permission for a specific group from being able to checkout a boat for private use or for practices.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
boat_id | Id number of the boat. This can be found from the equipment/getAllEquipment endpoint. |
group_id | Id number of the group to remove the checkout permission from. group_id`s can be found using the wlgroups/getAllGroups endpoint. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
10 | Equipment Usage Hours & Group Permissions | Allowed to set hours equipment can be used and which groups are allowed to use them. |
Sample Responses
[{"boat_id":9,"whitelabel_id":128,"created_at":0,"boat_name":"Time Flies","boat_type":"2","coxed":"No","manufacturer":"Empacher","model":"CVV1","serial":"KVJSR345647","year_built":2002,"year_purchased":2017,"weight_min":165,"weight_max":200,"color":"Empacher Yellow","insured":"No","insured_value":"7500","purchase_price":"10000","status":"Available","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_stern_pitch_min":"0","port_stern_pitch_max":"0","starboard_stern_pitch_min":"0","starboard_stern_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":"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_stern_pitch_min":"0","port_stern_pitch_max":"0","starboard_stern_pitch_min":"0","starboard_stern_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"}],"checkout_groups":[{"whitelabel_id":128,"boat_id":9,"boat_name":"Time Flies","manufacturer":"Empacher","model":"CVV1","serial_number":"KV58DJ48F647","hull_type":"2","status":"Available","created_at":1601736575,"min_weight":165,"max_weight":200,"group_id":44,"group_title":"Super Admin","group_descr":"Access to everything. Able to grant\/revoke permissions for all groups. Able to do everything. Warning: Only add users to this group that should have permission to manage the entire organization. Strongly recommend limiting to organization president and vice-president.","group_self_join":"No"},{"whitelabel_id":128,"boat_id":9,"boat_name":"Time Flies","manufacturer":"Empacher","model":"CVV1","serial_number":"KV58DJ48F647","hull_type":"2","status":"Available","created_at":1601736575,"min_weight":165,"max_weight":200,"group_id":54,"group_title":"Equipment Modifier","group_descr":"allowed to assign equipment rights to groups","group_self_join":"No"}]}]
[]
Success Response Key
Update Foot Stretcher Angle
POST equipment/updateFootAngle
Updates the min/max foot stretcher angle at a particular seat.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
boat_id | Id number of the boat. This can be found from the equipment/getAllEquipment endpoint. |
seat | Seat number that needs to be updated. Integer between 1-8. |
field | Defines which attribute is being updated. Acceptable values are: `foot_stretcher_angle_min`, `foot_stretcher_angle_max`. |
degrees | Degrees of pitch for the field. Acceptable range is between 0 and 90 degrees. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
{"Success":"Angle updated!"}
[]
Success Response Key
Update Foot Stretcher Placement
POST equipment/updateFootstretcherPlacement
Updates the foot stretcher distance from the pin (in inches).
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
boat_id | Id number of the boat. This can be found from the equipment/getAllEquipment endpoint. |
seat | Seat number that needs to be updated. Integer between 1-8. |
placement | The horizontal distance, in inches, from the location where the tips of your toes are located to the location of an imaginary line drawn between rowing pins. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
{"Success":"Foot Stretcher Placement Updated"}
[]
Success Response Key
Update Lateral / Stern Pitches
POST equipment/updatePitch
Updates the post/starboard min/max Lateral or stern pitches (in degrees).
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
boat_id | Id number of the boat. This can be found from the equipment/getAllEquipment endpoint. |
seat | Seat number that needs to be updated. Integer between 1-8. |
field | Defines which attribute is being updated. Acceptable values are: `port_lateral_pitch_min`, `port_lateral_pitch_max`, `starboard_lateral_pitch_min`, `starboard_lateral_pitch_max`, `port_stern_pitch_min`, `port_stern_pitch_max`, `starboard_stern_pitch_min`, or `starboard_stern_pitch_max`. |
degrees | Degrees of pitch for the field. Acceptable range is between -15 and 15 degrees. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
{"Success":"Pitch updated!"}
[]
Success Response Key
Update Seat Configuration
POST equipment/updateSeatConfiguration
Updates whether a particular seat is sculling, port, or starboard.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
boat_id | Id number of the boat. This can be found from the equipment/getAllEquipment endpoint. |
seat | Seat number that needs to be updated. Integer between 1-8. |
seat_side | `Port`, `Starboard`, `Sculling`, or `unknown` |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
{"Success":"Seat Updated"}
[]
Success Response Key
Update Boat Spread
POST equipment/updateSpread
Updates the spread for a particular seat.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
boat_id | Id number of the boat. This can be found from the equipment/getAllEquipment endpoint. |
seat | Seat number that needs to be updated. Integer between 1-8. |
spread | New spread in inches. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
{"Success":"Seat Updated"}
[]
Success Response Key
Update Swivel Height
POST equipment/updateSwivel
Updates the post/starboard min/max swivel height of the oarlocks (in inches).
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
boat_id | Id number of the boat. This can be found from the equipment/getAllEquipment endpoint. |
seat | Seat number that needs to be updated. Integer between 1-8. |
field | Defines which attribute is being updated. Acceptable values are: `port_swivel_height_min`, `port_swivel_height_max`, `starboard_swivel_height_min`, `starboard_swivel_height_max`. |
inches | Distance from the lowest part of the seat (where your hip bones rest) to the inside of the oarlock where the oar rests in inches. Recommended range is 1-15 in 1/2-inch increments. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
{"Success":"Swivel height updated!"}
[]
Success Response Key
Update Track Distance
POST equipment/updateTrackLength
Updates distance from the back of the track to the center of the pin at a particular seat.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
boat_id | Id number of the boat. This can be found from the equipment/getAllEquipment endpoint. |
seat | Seat number that needs to be updated. Integer between 1-8. |
distance | Defines the distance (in inches) from the back of the track to the center of the oar lock pin. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
{"Success":"Angle updated!"}
[]
Success Response Key
Get All Oars
GET equipment/getAllOars
Returns all oar sets and oars in the organization.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[{"oar_set_id":7,"whitelabel_id":127,"name":"Red Set","type":"Sculling","descr":"","manufacturer":"Concept 2","model":"Bantam","created_at":1602346325,"oars":[{"oar_id":53,"side":"Starboard","descr":"starboard-1","status":"Available","created_at":1602349157},{"oar_id":54,"side":"Port","descr":"port-1","status":"Available","created_at":1602349926},{"oar_id":95,"side":"Starboard","descr":"starboard-2","status":"Available","created_at":1602435555},{"oar_id":99,"side":"Port","descr":"port-2","status":"Available","created_at":1602436215}]},{"oar_set_id":8,"whitelabel_id":127,"name":"Blue Set","type":"Sweep","descr":"Restricted to rowers training for Masters Nationals","manufacturer":"Dreher","model":"Apex Sweep Oar","created_at":1597596984,"oars":[{"oar_id":41,"side":"Starboard","descr":"starboard-1","status":"Out Of Service","created_at":1597684215},{"oar_id":42,"side":"Port","descr":"port-1","status":"Out Of Service","created_at":1597684515000}]}]
[]
Success Response Key
Add Oar Set
POST equipment/addOarSet
Adds a new oar set. Oar sets are used to group oars that are the same make/model and are generally used interchangeably.
This endpoint returns a list of all oars and sets after the new set is created.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
name | Name of the oar set. This is limited to 100 characters. |
type | Type of oars in the set. Options are `Sweep` or `Sculling`. |
descr | Description of the oars in the set. |
manufacturer | Manufacturer of the oars in the set. |
model | Model of the oars in the set. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
[{"oar_set_id":7,"whitelabel_id":127,"name":"Red Set","type":"Sculling","descr":"","manufacturer":"Concept 2","model":"Bantam","created_at":1602346325,"oars":[{"oar_id":53,"side":"Starboard","descr":"starboard-1","status":"Available","created_at":1602349157},{"oar_id":54,"side":"Port","descr":"port-1","status":"Available","created_at":1602349926},{"oar_id":95,"side":"Starboard","descr":"starboard-2","status":"Available","created_at":1602435555},{"oar_id":99,"side":"Port","descr":"port-2","status":"Available","created_at":1602436215}]},{"oar_set_id":8,"whitelabel_id":127,"name":"Blue Set","type":"Sweep","descr":"Restricted to rowers training for Masters Nationals","manufacturer":"Dreher","model":"Apex Sweep Oar","created_at":1597596984,"oars":[{"oar_id":41,"side":"Starboard","descr":"starboard-1","status":"Out Of Service","created_at":1597684215},{"oar_id":42,"side":"Port","descr":"port-1","status":"Out Of Service","created_at":1597684515000}]}]
[]
Success Response Key
Delete Oar Set
POST equipment/deleteOarSet
Deletes an oar set, as well as all of the oars in the set. This cannot be undone. Returns all remaining oar sets and oars.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
oar_set_id | oar_set_id of the oar set that you want to delete. The oar_set_id can be found from the equipment/allOars endpoint. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
[{"oar_set_id":7,"whitelabel_id":127,"name":"Red Set","type":"Sculling","descr":"","manufacturer":"Concept 2","model":"Bantam","created_at":1602346325,"oars":[{"oar_id":53,"side":"Starboard","descr":"starboard-1","status":"Available","created_at":1602349157},{"oar_id":54,"side":"Port","descr":"port-1","status":"Available","created_at":1602349926},{"oar_id":95,"side":"Starboard","descr":"starboard-2","status":"Available","created_at":1602435555},{"oar_id":99,"side":"Port","descr":"port-2","status":"Available","created_at":1602436215}]},{"oar_set_id":8,"whitelabel_id":127,"name":"Blue Set","type":"Sweep","descr":"Restricted to rowers training for Masters Nationals","manufacturer":"Dreher","model":"Apex Sweep Oar","created_at":1597596984,"oars":[{"oar_id":41,"side":"Starboard","descr":"starboard-1","status":"Out Of Service","created_at":1597684215},{"oar_id":42,"side":"Port","descr":"port-1","status":"Out Of Service","created_at":1597684515000}]}]
[]
Success Response Key
Add Oar
POST equipment/addOar
Adds a new oar to an oar set. Remember to add both port and starboard oars. This endpoint returns a list of all oars
and sets after the new oar is created.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
oar_set_id | oar_set_id of the oar set the oar will be added to. This can be found from the equipment/getAllOars endpoint. |
side | Side of the boat the oar is designed for. Options are `Port` or `Starboard`. |
descriptor | Description of the oar. This field is limited to 100 characters. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
[{"oar_set_id":7,"whitelabel_id":127,"name":"Red Set","type":"Sculling","descr":"","manufacturer":"Concept 2","model":"Bantam","created_at":1602346325,"oars":[{"oar_id":53,"side":"Starboard","descr":"starboard-1","status":"Available","created_at":1602349157},{"oar_id":54,"side":"Port","descr":"port-1","status":"Available","created_at":1602349926},{"oar_id":95,"side":"Starboard","descr":"starboard-2","status":"Available","created_at":1602435555},{"oar_id":99,"side":"Port","descr":"port-2","status":"Available","created_at":1602436215}]},{"oar_set_id":8,"whitelabel_id":127,"name":"Blue Set","type":"Sweep","descr":"Restricted to rowers training for Masters Nationals","manufacturer":"Dreher","model":"Apex Sweep Oar","created_at":1597596984,"oars":[{"oar_id":41,"side":"Starboard","descr":"starboard-1","status":"Out Of Service","created_at":1597684215},{"oar_id":42,"side":"Port","descr":"port-1","status":"Out Of Service","created_at":1597684515000}]}]
[]
Success Response Key
Delete Oar
POST equipment/deleteOar
Deletes an oar AND removes it from the set. This endpoint returns a list of all oars and sets after the oar is deleted.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
oar_set_id | oar_set_id of the oar set the oar is contained in. |
oar_id | oar_id number of the oar. This can be found from the equipment/getAllOars endpoint. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
[{"oar_set_id":7,"whitelabel_id":127,"name":"Red Set","type":"Sculling","descr":"","manufacturer":"Concept 2","model":"Bantam","created_at":1602346325,"oars":[{"oar_id":53,"side":"Starboard","descr":"starboard-1","status":"Available","created_at":1602349157},{"oar_id":54,"side":"Port","descr":"port-1","status":"Available","created_at":1602349926},{"oar_id":95,"side":"Starboard","descr":"starboard-2","status":"Available","created_at":1602435555},{"oar_id":99,"side":"Port","descr":"port-2","status":"Available","created_at":1602436215}]},{"oar_set_id":8,"whitelabel_id":127,"name":"Blue Set","type":"Sweep","descr":"Restricted to rowers training for Masters Nationals","manufacturer":"Dreher","model":"Apex Sweep Oar","created_at":1597596984,"oars":[{"oar_id":41,"side":"Starboard","descr":"starboard-1","status":"Out Of Service","created_at":1597684215},{"oar_id":42,"side":"Port","descr":"port-1","status":"Out Of Service","created_at":1597684515000}]}]
[]
Success Response Key
Update Oar Description
POST equipment/updateOarDesc
Updates the descr (description) tag of a particular oar. This endpoint returns a list of all oars and sets after the oar
is updated.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
oar_id | oar_id of the oar being updated. This can be found from the equipment/getAllOars endpoint. |
descr | New description of the oar. This is limited to 100 characters. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
[{"oar_set_id":7,"whitelabel_id":127,"name":"Red Set","type":"Sculling","descr":"","manufacturer":"Concept 2","model":"Bantam","created_at":1602346325,"oars":[{"oar_id":53,"side":"Starboard","descr":"starboard-1","status":"Available","created_at":1602349157},{"oar_id":54,"side":"Port","descr":"port-1","status":"Available","created_at":1602349926},{"oar_id":95,"side":"Starboard","descr":"starboard-2","status":"Available","created_at":1602435555},{"oar_id":99,"side":"Port","descr":"port-2","status":"Available","created_at":1602436215}]},{"oar_set_id":8,"whitelabel_id":127,"name":"Blue Set","type":"Sweep","descr":"Restricted to rowers training for Masters Nationals","manufacturer":"Dreher","model":"Apex Sweep Oar","created_at":1597596984,"oars":[{"oar_id":41,"side":"Starboard","descr":"starboard-1","status":"Out Of Service","created_at":1597684215},{"oar_id":42,"side":"Port","descr":"port-1","status":"Out Of Service","created_at":1597684515000}]}]
[]
Success Response Key
Update Oar Set Description
POST equipment/updateOarSetDescr
Updates the description of the set of oars. This endpoint returns a list of all oars and sets after the oar set description is updated.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
oar_set_id | oar_set_id of the set being updated. This can be found from the equipment/getAllOars endpoint. |
descr | New description of the oar set. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
[{"oar_set_id":7,"whitelabel_id":127,"name":"Red Set","type":"Sculling","descr":"","manufacturer":"Concept 2","model":"Bantam","created_at":1602346325,"oars":[{"oar_id":53,"side":"Starboard","descr":"starboard-1","status":"Available","created_at":1602349157},{"oar_id":54,"side":"Port","descr":"port-1","status":"Available","created_at":1602349926},{"oar_id":95,"side":"Starboard","descr":"starboard-2","status":"Available","created_at":1602435555},{"oar_id":99,"side":"Port","descr":"port-2","status":"Available","created_at":1602436215}]},{"oar_set_id":8,"whitelabel_id":127,"name":"Blue Set","type":"Sweep","descr":"Restricted to rowers training for Masters Nationals","manufacturer":"Dreher","model":"Apex Sweep Oar","created_at":1597596984,"oars":[{"oar_id":41,"side":"Starboard","descr":"starboard-1","status":"Out Of Service","created_at":1597684215},{"oar_id":42,"side":"Port","descr":"port-1","status":"Out Of Service","created_at":1597684515000}]}]
[]
Success Response Key
Update Oar Set Name
POST equipment/updateOarSetName
Updates the name of the set of oars. This endpoint returns a list of all oars and sets after set name is updated.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
oar_set_id | oar_set_id of the set being updated. This can be found from the equipment/getAllOars endpoint. |
name | New name of the oar set. This is limited to 100 characters. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
[{"oar_set_id":7,"whitelabel_id":127,"name":"Red Set","type":"Sculling","descr":"","manufacturer":"Concept 2","model":"Bantam","created_at":1602346325,"oars":[{"oar_id":53,"side":"Starboard","descr":"starboard-1","status":"Available","created_at":1602349157},{"oar_id":54,"side":"Port","descr":"port-1","status":"Available","created_at":1602349926},{"oar_id":95,"side":"Starboard","descr":"starboard-2","status":"Available","created_at":1602435555},{"oar_id":99,"side":"Port","descr":"port-2","status":"Available","created_at":1602436215}]},{"oar_set_id":8,"whitelabel_id":127,"name":"Blue Set","type":"Sweep","descr":"Restricted to rowers training for Masters Nationals","manufacturer":"Dreher","model":"Apex Sweep Oar","created_at":1597596984,"oars":[{"oar_id":41,"side":"Starboard","descr":"starboard-1","status":"Out Of Service","created_at":1597684215},{"oar_id":42,"side":"Port","descr":"port-1","status":"Out Of Service","created_at":1597684515000}]}]
[]
Success Response Key
Update Oar Status
POST equipment/updateOarStatus
Changes the status of an oar to be either 'Available' or 'Out Of Service'. This endpoint returns a list of all oars and
sets after the oar status is updated.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
oar_id | oar_id of the oar being updated. This can be found from the equipment/getAllOars endpoint. |
status | New status of the oar. Options are `Available` and `Out of Service`. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
[{"oar_set_id":7,"whitelabel_id":127,"name":"Red Set","type":"Sculling","descr":"","manufacturer":"Concept 2","model":"Bantam","created_at":1602346325,"oars":[{"oar_id":53,"side":"Starboard","descr":"starboard-1","status":"Available","created_at":1602349157},{"oar_id":54,"side":"Port","descr":"port-1","status":"Available","created_at":1602349926},{"oar_id":95,"side":"Starboard","descr":"starboard-2","status":"Available","created_at":1602435555},{"oar_id":99,"side":"Port","descr":"port-2","status":"Available","created_at":1602436215}]},{"oar_set_id":8,"whitelabel_id":127,"name":"Blue Set","type":"Sweep","descr":"Restricted to rowers training for Masters Nationals","manufacturer":"Dreher","model":"Apex Sweep Oar","created_at":1597596984,"oars":[{"oar_id":41,"side":"Starboard","descr":"starboard-1","status":"Out Of Service","created_at":1597684215},{"oar_id":42,"side":"Port","descr":"port-1","status":"Out Of Service","created_at":1597684515000}]}]
[]
Success Response Key
Get All Ergs
GET equipment/getAllErgs
Returns all ergometers in the organization.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[{"erg_id":1,"whitelabel_id":127,"identifier":"BCR-01","make":"Concept2","model":"D","year_purchased":2017,"location":"Mountains Edge","insured":"Yes","insured_value":"700","status":"Available","created_at":113284},{"erg_id":5,"whitelabel_id":127,"identifier":"BCR-02","make":"Concept 2","model":"D","year_purchased":2020,"location":"Mountains Edge","insured":"Yes","insured_value":"750","status":"Available","created_at":1597791193}]
[]
Success Response Key
Add Erg
POST equipment/addErg
Adds a new erg to the organization. This endpoint returns all ergs in the organization.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
identifier | Easy-to-remember way to identify the erg. |
make | Manufacturer of the erg. |
model | Manufacturer-defined model of the erg. |
year_purchased | Year the erg was purchased by the organization. |
location | Physical location that the erg is currently stored. |
insured | `Yes` or `No` - if the ergometer is currently insured by the organization. |
insured_value | Dollar value that the erg is currently insured for. Use 0 if the erg is not insured by the organization. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
[{"erg_id":1,"whitelabel_id":127,"identifier":"BCR-01","make":"Concept2","model":"D","year_purchased":2017,"location":"Mountains Edge","insured":"Yes","insured_value":"700","status":"Available","created_at":113284},{"erg_id":5,"whitelabel_id":127,"identifier":"BCR-02","make":"Concept 2","model":"D","year_purchased":2020,"location":"Mountains Edge","insured":"Yes","insured_value":"750","status":"Available","created_at":1597791193}]
[]
Success Response Key
Delete Erg
POST equipment/deleteErg
Deletes the specified erg from the organization. This action cannot be undone. This endpoint returns all ergs in the
organization.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
erg_id | erg_id of the ergometer being deleted. This can be found using the equipment/getAllErgs endpoint. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
[{"erg_id":1,"whitelabel_id":127,"identifier":"BCR-01","make":"Concept2","model":"D","year_purchased":2017,"location":"Mountains Edge","insured":"Yes","insured_value":"700","status":"Available","created_at":113284},{"erg_id":5,"whitelabel_id":127,"identifier":"BCR-02","make":"Concept 2","model":"D","year_purchased":2020,"location":"Mountains Edge","insured":"Yes","insured_value":"750","status":"Available","created_at":1597791193}]
[]
Success Response Key
Update Erg Identifier
POST equipment/updateErgIdentifier
Updates the identifier tag for the erg. This endpoint returns all ergs in the organization.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
erg_id | erg_id of the ergometer. This can be found using the equipment/getAllErgs endpoint. |
identifier | New identifier for the erg. This is an easy-to-remember way to identify the erg. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
[{"erg_id":1,"whitelabel_id":127,"identifier":"BCR-01","make":"Concept2","model":"D","year_purchased":2017,"location":"Mountains Edge","insured":"Yes","insured_value":"700","status":"Available","created_at":113284},{"erg_id":5,"whitelabel_id":127,"identifier":"BCR-02","make":"Concept 2","model":"D","year_purchased":2020,"location":"Mountains Edge","insured":"Yes","insured_value":"750","status":"Available","created_at":1597791193}]
[]
Success Response Key
Update Erg Status
POST equipment/updateErgStatus
Changes the status of an erg to be either 'Available' or 'Out Of Service'. This endpoint returns a list of all ergs after
the erg is updated.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
erg_id | erg_id of the ergometer being updated. This can be found using the equipment/getAllErgs endpoint. |
status | New status of the erg. Options are `Available` and `Out of Service` |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
[{"erg_id":1,"whitelabel_id":127,"identifier":"BCR-01","make":"Concept2","model":"D","year_purchased":2017,"location":"Mountains Edge","insured":"Yes","insured_value":"700","status":"Available","created_at":113284},{"erg_id":5,"whitelabel_id":127,"identifier":"BCR-02","make":"Concept 2","model":"D","year_purchased":2020,"location":"Mountains Edge","insured":"Yes","insured_value":"750","status":"Available","created_at":1597791193}]
[]
Success Response Key
Update Erg Location
POST equipment/updateErgLocation
Updates where the erg is physically stored. This is usually set to a boathouse (or particular spot in a boathouse), a gym,
or a member's house. This endpoint returns all ergs in the organization.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
erg_id | erg_id of the ergometer. This can be found using the equipment/getAllErgs endpoint. |
identifier | New location that the erg is being stored at. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
[{"erg_id":1,"whitelabel_id":127,"identifier":"BCR-01","make":"Concept2","model":"D","year_purchased":2017,"location":"Mountains Edge","insured":"Yes","insured_value":"700","status":"Available","created_at":113284},{"erg_id":5,"whitelabel_id":127,"identifier":"BCR-02","make":"Concept 2","model":"D","year_purchased":2020,"location":"Mountains Edge","insured":"Yes","insured_value":"750","status":"Available","created_at":1597791193}]
[]
Success Response Key
Update Erg Insurance
POST equipment/updateErgInsuredStatus
Updates the insurance information for a given ergometer. This endpoint returns all ergs in the organization.
Parameters
token | API Token. |
---|---|
whitelabel_id | Whitelabel Id of the organization. |
erg_id | erg_id of the ergometer. This can be found using the equipment/getAllErgs endpoint. |
insured | `Yes` or `No` - if the ergometer is currently insured by the organization. |
insured_value | Dollar value that the erg is currently insured for. Use 0 if the erg is not insured by the organization. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:Id | Name | Description |
---|---|---|
8 | Manage Equipment | Allowed to update information related to equipment. |
9 | Add Equipment to Inventory | Allowed to add / remove equipment from organization inventory. |
Sample Responses
[{"erg_id":1,"whitelabel_id":127,"identifier":"BCR-01","make":"Concept2","model":"D","year_purchased":2017,"location":"Mountains Edge","insured":"Yes","insured_value":"700","status":"Available","created_at":113284},{"erg_id":5,"whitelabel_id":127,"identifier":"BCR-02","make":"Concept 2","model":"D","year_purchased":2020,"location":"Mountains Edge","insured":"Yes","insured_value":"750","status":"Available","created_at":1597791193}]
[]