Versions Compared

Key

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

GET /usermatch

Checks Gets the Club OS database unique id for a user with the given systemCode and userId unique to that system.member given the userId from one of Club OS's integrated systems. 

GET https://api.club-os.com/exerciselibrary?memberIdusermatch?systemCode[systemCode]&userId=[memberIduserId]

Parameters

The following fields must be included as parameters in the URL of the request.

memberId
VariableTypeDescription
systemCodeString

The code of the system you wish to access. Get these codes from your Club OS developer contact.

userIdStringThe system userId to match against.
Success Response

If successful, you will be returned a UserResponse object containing the following:

PropertyTypeDescription
idIntegerThe Club OS unique id for the member you wish to access.
Response

The response type is a list of exercises (List<Exercise).  See here for details on the Exercise object.

...

user id.
firstNameStringThe first name of the user.
lastNameStringThe last name of the user.
emailStringThe email of the user.
roleStringThe Club OS role of the user (Client, Trainer, ect..)
Failure Response

If your request fails, you will receive a Response object containing the following:

PropertyTypeDescription
statusBooleanWill always be false.
responsesResponseMessage[]An array of ResponseMessage objects describing the error.