Versions Compared

Key

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

...

VariableTypeDescription
systemCodeString

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

userIdStringThe userId to match against
Success Response

One of the following messages If successful, you will be returned when the request succeeds.

...

a UserResponse object containing the following fields

PropertyTypeDescription
trueidUser foundIntegerThe Club OS unique user id.The member was successfully found and you have access to them.false

User not found

The invalid systemCode and userIdYour credentials were invalid
firstNameStringThe first name of the user.
lastNameStringThe last name of the user.
clientsList<UserResponse>A list of clients assigned to the user (for staff only). This is used to populate the client selection feature.