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.
Variable | Type | Description | memberId|
---|---|---|---|
systemCode | String | The code of the system you wish to access. Get these codes from your Club OS developer contact. | |
userId | String | The system userId to match against. |
Success Response
If successful, you will be returned a UserResponse object containing the following:
Property | Type | Description |
id | Integer | The 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. | ||
firstName | String | The first name of the user. |
lastName | String | The last name of the user. |
String | The email of the user. | |
role | String | The Club OS role of the user (Client, Trainer, ect..) |
Failure Response
If your request fails, you will receive a Response object containing the following:
Property | Type | Description |
---|---|---|
status | Boolean | Will always be false. |
responses | ResponseMessage[] | An array of ResponseMessage objects describing the error. |