SpeedgateSpeedgate

Get Scanner Setup

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.

idUUIDRequired
A unique id that identifies a specific speedgate scanner setup.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-api-versiondateOptional

Used for API versioning. More details.

Response

Returns the setup details for the specified gate.
idUUID
A unique id that identifies a specific speedgate scanner setup.
scannerIdstring
A human friendly unique code that identifies a specific speedgate.
descriptionstring
A textual description or name
enabledboolean
permitTicketsboolean
Indicates if the scanner will permit tickets when scanned.
permitMemberCardsboolean
Indicates if the scanner will permit member cards when scanned.
permitWalletsboolean
Indicates if the scanner will permit wallets when scanned.
permitDocLxCityCardsboolean
Indicates if the scanner will permit DocLX city cards when scanned.
imageProfileCodestring
Code representing the image profile.
ticketProfileCodestring
Code representing the ticket profile.
memberCardProfileCodestring
Code representing the member card profile.
itemslist of objects
categoryobjectOptional
A category containing a multiple scanners. The category offers a way to group the scanners for representation purposes.