GET /recurringservices
Verifies that the given recurringServiceId exists in Club OS and you have access to it.
GET https://api.club-os.com/recurringservices?clubLocationId=[clubLocationId]&clubServiceId=[clubServiceId]
| Variable | Type | Description |
|---|---|---|
| clubLocationId | Integer | The Club OS unique id for the club location you wish to access. Club OS will provide these to you. |
| clubServiceId | Integer | The Club OS unique id for the club service you are requesting. |
POST /recurringservices
Add a club service to the system.
POST https://api.club-os.com/recurringservices?clubLocationId=[clubLocationId]
Parameters
The following fields must be included as parameters in the URL of the request.
| Variable | Type | Description |
|---|---|---|
| clubLocationId | Integer | The Club OS unique id for the club location you wish to access. Club OS will provide these to you. |
Request Body
The following fields must be included in the body of the HTTP request as a valid JSON string.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
| localServiceId | String | Y | Your systems unique id for the club service. | |
| memberId | Integer | Y | The Club OS unique id for the member who bought the club service. | |
| salespersonId | Integer | N | The Club OS unique id for the salesperson who sold the club service. If blank, the default sales support account will be used. | |
| name | String | Y | The descriptive name of the service, i.e. 'Group Training' or '30 Min Sessions'. | |
| startDate | Date (M-d-YYYY) | Y | The effective start date of the club service. | |
| endDate | Date (M-d-YYYY) | N | The end date of the club service if one exists. | |
| saleDate | Date (M-d-YYYY) | Y | The date of the sale. | |
| qty | Decimal | Y | The qty of sessions purchased. | |
| unitPrice | Decimal | Y | The unit price (cost of 1 item) of the service. | |
| taxes | Decimal | N | The amount of taxes on the payment. | |
| autoRenew | Boolean | Y | false | true - the club service auto-renews. false - the club service does not auto-renew. |
| status | Boolean | Y | true | true - the club service is active and in good standing. false - the club service is inactive and not in good standing. |
| paidOnSale | Decimal | Y | The amount paid on the saleDate, or the date the club service was purchased. | |
| recurType | String | N | monthly | One of 'monthly' or 'weekly'. |
| deleted | Boolean | N | false | true - the club service is deleted false - the club service is non-deleted and active |
Response Messages
One of the following messages will be returned when the request succeeds.
| Message | Value | Description |
| clubservice created | the newly created clubServiceId | Club Service successfully created. |
| clubservice exists | the existing clubServiceId | Club Service already exists, nothing was done. |
PUT /recurringservices
Update a club service in the system.
PUT https://api.club-os.com/recurringservices?clubLocationId=[clubLocationId]
Parameters
The following fields must be included as parameters in the URL of the request.
| Variable | Type | Description |
|---|---|---|
| clubLocationId | Integer | The Club OS unique id for the club location you wish to access. Club OS will provide these to you. |
Request Body
Any of the fields below may be included in the body of the HTTP request as a valid JSON string. Only fields included in the request will be updated. For example, if you only want to update the name and qty, the JSON should be { clubServiceId: "clubOsClubServiceId", name: "newName", qty: "10"}
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
| clubServiceId | Integer | Y | The Club OS unique id for the club service you are updating. | |
| salespersonId | Integer | N | The Club OS unique id for the salesperson who was responsible for selling the club service. | |
| startDate | Date (M-d-YYYY) | N | The effective start date of the club service. | |
| endDate | Date (M-d-YYYY) | N | The end date of the club service if one exists. Use "" to remove the endDate. | |
| saleDate | Date (M-d-YYYY) | N | The date of the sale. | |
| name | String | N | The descriptive name of the service, i.e. 'Group Training' or '30 Min Sessions'. | |
| qty | Decimal | N | The qty of sessions purchased. | |
| unitPrice | Decimal | N | The unit price (cost of 1 item) of the service. | |
| taxes | Decimal | N | The amount of taxes on the payment. | |
| autoRenew | Boolean | N | true - the club service auto-renews. false - the club service does not auto-renew. | |
| status | Boolean | N | true - the club service is active and in good standing. false - the club service is inactive and not in good standing. | |
| paidOnSale | Decimal | N | The amount paid on the saleDate, or the date the club service was purchased. | |
| recurType | String | N | monthly | One of 'monthly' or 'weekly'. |
| deleted | Boolean | N | true - soft deletes the club service from the system (can be undone). false - undeletes a club service. |
Response Messages
One of the following messages will be returned when the request succeeds.
| Message | Description |
| clubservice updated successfully | Club Service was updated successfully. |
| error | Club Service was not updated due to a data error. |