Versions Compared

Key

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

...

Gets the Club OS unique id for a member given the userId from one of Club OS's integrated systems.  Useful to do single sign-on validation.

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

...

VariableTypeDescription
systemCodeString

The code of the system you wish to access. Codes can be either 'ABC' or 'OS'.

userIdStringThe userId to match against
Response

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

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

StatusMessageValueDescription
trueUser foundClub OS unique id.The member was successfully found and you have access to them.
false

User not found

The invalid systemCode and userIdYour credentials were invalid.