Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GET /clubservices

Verifies that the given club service exists in Club OS and you have access to itReturns a list of club services for the given clubLocationId.  

GET https://api.club-os.com/clubservices?clubLocationId=[clubLocationId]&serviceId=[serviceId]

VariableTypeDescription
clubLocationIdIntegerThe Club OS unique id for the club location you wish to access. Club OS will provide these to you.
serviceIdIntegerThe Club OS unique id for the club service you are requesting.

POST /clubservices

Add a club service to the system.

POST https://api.club-os.com/clubservices?clubLocationId=[clubLocationId]

Request Body

The following fields must be included in the body of the HTTP request.

...

Response

You will receive an array of ClubService objects having the following properties:

PropertyTypeDescription
idIntegerthe unique Club OS id for the club service.
nameStringY The name of the service - as of now, 'Personal Training' is the only option.
qtyDecimalY The qty of sessions purchased.
unitPriceDecimalY The unit price (cost of 1 item) of the service.
taxesDecimalN The amount of taxes on the payment.
autoRenewBooleanY false

true - membership auto-renews.

false - membership does not auto-renew.

startDateDate (M-d-YYYY)Y The effective start date of the club service.
endDateDate (M-d-YYYY)N The end date of the club service if one exists.
saleDateDate (M-d-YYYY)Y The date of the sale.
paidOnSaleDecimalY The amount paid on the saleDate, or the date the club service was purchased.
recurTypeStringNmonthlyOne of 'weekly' or 'monthly'.

 

...

the name of the club service
eventTypeIdInteger2=Personal Training, 3=Group Class