SpeedgateSpeedgate

Reference Number Lookup

This endpoint retrieves the details of a reference number, including its type and status. It can be used to check the history of a reference number.

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

Headers

AuthorizationstringRequired

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

x-api-versiondateOptional

Used for API versioning. More details.

Query parameters

referenceNumberstringRequired
The number sent to speedgate to open the gate

Response

Returns a list all usages of the reference number in the speedgate.
referenceNumberstring
The number sent to speedgate to open the gate
referenceNumberTypeenum
The type of reference number that was identified.
scannerIdstring
A human friendly unique code that identifies a specific speedgate.
scannerDescriptionstring
A textual description or name
admitTokenUUID
A unique token that identifies a specific admission request
entryStatusenum
The status of the admission request.
attemptedAtdatetime
The date and time when the reference number was attempted to be admitted.
errorNumberinteger
The error number returned by the API.
entryNumberinteger
The sequence number of the scan entry.
referenceIdUUID or null
The unique identifier for the reference number.
admissionCodestring or null
A unique code that identifies a specific admission.
admittedReferenceNumberstring or null
The number sent to speedgate to open the gate
admittedReferenceIdUUID or null
The unique identifier for the reference number.
admittedAtdatetime or null
The date and time when the ticket was admitted.
errorMessagestring or null
The error message returned by the API.
typeenum or null

When scanning a reference number it can cascade into other types of reference numbers. This is the type used to qualify the reference number id that was identified.

The following types are supported and used in different scenarios
memberGuest

  • when a member card is scanned and a guests can be admitted for free
    • memberCard
  • when a wallet is scanned and a member card can be admitted
    • ticket
  • when a wallet is scanned and a ticket can be admitted
  • when a member card is scanned and multiple admissions will be admitted

    • Allowed values:
    typeIdUUID or null
    The unique identifier of the resource to use.
    typeDescriptionstring or null
    The description of the resource.