Get Setup

GET

This endpoint retrieves the setup details for a specific gate, such as the gate’s name, location, and the admission codes it supports.

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

scannerIdstringRequired

A unique code that identifies a specific speedgate.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Response

This endpoint returns an object.
scannerIdstring

A unique code that identifies a specific speedgate.

namestring

A textual description or name

admissionslist of objects
locationstringOptional

A textual description or name

readyImageBase64 stringOptional

Base64 encoded image of the member.

successImageBase64 stringOptional

Base64 encoded image of the member.

failureImageBase64 stringOptional

Base64 encoded image of the member.

acceptsTicketsbooleanOptional
acceptsMemberCardsbooleanOptional
acceptsWalletsbooleanOptional
Built with