/checkins
POST /checkins
Add a checkin (when the member scans / checks in to the club) to Club OS. Checkins are displayed on the members profile page and used in reporting.
POST https://api.club-os.com/checkins?clubLocationId=[clubLocationId]
Parameters
The following fields must be included as parameters in the URL of the request.
Variable | Type | Description |
|---|---|---|
clubLocationId | Integer | The Club OS unique id for the club location you wish to access. Club OS will provide these to you. |
Request Body
The following fields must be included in the body of the HTTP request as a valid JSON string.
Property | Type | Required | Default | Description |
|---|---|---|---|---|
memberId | Integer | Y |
| The Club OS unique id for the member who checked in. |
localCheckinId | String | Y |
| Your systems unique id for the checkin. |
checkinTime | Date (M-d-YYYY HH:mm:ss) | Y |
| The date and time of the checkin. HH should be in military time i.e. 00-23. |
Response Messages
One of the following messages will be returned when the request succeeds.
Message | Description |
Check-in Created | Checkin successfully created. |
Check-in Found | Checkin already exists in the system with the given localCheckinId. |