"Open Door" Check-In API Documentation

• Overview
• Parameters
• Examples
  • Success
  • Failure (Barcode Not Found)
  • Failure (No Waiver)
  • Failure (No Entry Method)

Overview

This endpoint is used to check customers into a location using their assigned barcodes. It is intended for access control integrations, and the status code indicates whether the facility's door should be opened: 200 indicates that the door should be opened, and 4xx indicates that it should not. The response may also include text in its body. If so, this text should be displayed to the user. This is a write-only endpoint, and it only accepts POST requests.

Parameters

The "open door" check-in endpoint accepts two parameters: barcode and location_id.

barcode
This is the barcode of the customer who will be checked in. This parameter is placed in the URL as follows:
https://api.hellocapitan.com/api/gym-endpoints/barcode-check-in/<barcode>/

location_id
This is placed in the body of the request, as a JSON object with one field. This field is optional, and unnecessary for single-location organizations. For multiple-location organizations, the endpoint will default to the requesting user's location if a location is not provided.

Examples

Success

Request
POST /api/gym-endpoints/open-door-check-in/abc1234567890/

Response
200

Failure (Barcode Not Found)

Request
POST /api/gym-endpoints/barcode-check-in/abc12345678901234/

Response
404
Unknown or deactivated customer account.

Failure (No Waiver)

Request
POST /api/gym-endpoints/barcode-check-in/abc1234567890/

Response
400
The following alert is preventing you from checking in: No waiver.

Failure (No Entry Method)

Request
POST /api/gym-endpoints/barcode-check-in/abc1234567890/

Response
400
You do not have an available entry method. Please ensure you have an active membership, entry pass, or event booking.