Versions Compared

Key

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

...

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

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

...

One of the following messages will be returned when the request succeeds.

MessageValueDescription
clubservice createdthe newly created clubServiceIdClub Service successfully created.
clubservice existsthe existing clubServiceIdClub Service already exists, nothing was done.

...

PropertyTypeRequiredDefaultDescription
localServiceIdclubServiceIdStringIntegerY Your systems The Club OS unique id for the club service . Used to lookup the club service to updateyou are updating.
salespersonIdIntegerN The Club OS unique id for the salesperson who was responsible for selling the club service.
startDateDate (M-d-YYYY)N 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)N The date of the sale.
nameStringN The descriptive name of the service, i.e. 'Group Training' or '30 Min Sessions'.
qtyDecimalN The qty of sessions purchased.
unitPriceDecimalN The unit price (cost of 1 item) of the service.
taxesDecimalN The amount of taxes on the payment.
autoRenewBooleanN 

true - the club service auto-renews.

false - the club service does not auto-renew.

statusBooleanN 

true - the club service is active and in good standing.

false - the club service is inactive and not in good standing.

paidOnSaleDecimalN The amount paid on the saleDate, or the date the club service was purchased.
recurTypeStringNmonthlyOne of 'monthly' or 'weekly'.
deletedBooleanN 

true - soft deletes the club service from the system (can be undone).

false - undeletes a club service.

...