LogoLogo
SupportProduct Documentation
    • Introduction
    • URL Structure
    • API Key
    • Errors
    • Versioning
    • Pagination
    • Replication
    • Performance
    • Rate Limits
    • Webhooks
  • System Services
    • Companies
    • Hello World
  • Accounts
  • Ticketing
    • Getting started
    • Catalog
    • Capacity
    • Tickets
    • Reservations
    • Schedule
  • Memberships
    • Catalog
    • Membership
    • Member
    • Card
    • Payment Method
    • Lifecycle
    • Miscellaneous
    • Points
  • Speedgate
  • Attraction Wallet
  • POS
    • POS Sale
    • POS Unit
    • POS Store
    • Salesperson
    • External POS Sale
    • Global POS Entry
  • Inventory
    • Barcodes
    • Items
    • Item Ledger Entries
    • Item Categories
    • Item Variants
    • Item Translations
  • Coupon
  • Vouchers
    • Vouchers
  • Ecommerce
    • Sales Documents
  • Finance
    • General Ledger Account
    • General Ledger Entries
    • General Ledger Journal
SupportProduct Documentation
SpeedgateSpeedgate

Try Admit

POST
https://api.npretail.app/:tenant/:environment/:company/speedgate/try
POST
/:tenant/:environment/:company/speedgate/try
1curl -X POST https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%20International%20Ltd./speedgate/try \
2     -H "Authorization: Bearer <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "referenceNumber": "TIC123456",
6  "scannerId": "GATE1",
7  "admissionCode": "CASTLE"
8}'
Try it
200Ticket Reference
1{
2  "token": "aaaaaaaa-aaaa-aaaa-aaaa-426614174000",
3  "referenceNumberType": "ticket",
4  "ticket": {
5    "ticketId": "cccccccc-e89b-12d3-a456-426614174000",
6    "ticketNumber": "TIC123456",
7    "itemNo": "31001",
8    "admissionCode": "CASTLE",
9    "admitCount": 0,
10    "itemCategoryCode": "ADULT",
11    "printedAt": "2024-10-11T12:13:00Z",
12    "printCount": 1
13  }
14}
This endpoint attempts to validate a customer's reference number and identifies it as either a ticket, member card, or wallet. Each type provides different responses. <br><br><b>Ticket Reference</b> Returns a single token that you can use with the admitToken endpoint. <br><br><b>Member Card</b> Reference Returns a primary token for the member and additional tokens for any guests, with details such as guest type and max number of guests. <br><br><b>Wallet Reference</b> Returns a list of tickets, each with relevant admission details, which can be individually used in subsequent calls to tryAdmit. <br><br><b>City Card Reference</b> Returns a token for the city card, which can be used with the admit endpoint. <br><br><b>Ticket Token Reference</b> Returns an admit token and a list of tickets that will be admitted when the admit token is used.

Path parameters

tenantstringRequired
Your Entra Tenant ID. [More details.](/paths#1-tenant)
environmentstringRequired
Your Business Central Environment. [More details.](/paths#2-environment)
companystringRequired
Your Business Central Company. [More details.](/paths#3-company)

Headers

AuthorizationstringRequired
Bearer authentication of the form `Bearer <token>`, where token is your auth token.
x-api-versiondateOptional
Used for API versioning. [More details.](/versioning)

Request

This endpoint expects an object.
referenceNumberstringRequired
The number sent to speedgate to open the gate
scannerIdstringOptional
A human friendly unique code that identifies a specific speedgate.
admissionCodestringOptional
A unique code that identifies a specific admission.

Response

Returns the result of the try to admit a customer.
tokenUUID
A unique token that identifies a specific admission request
referenceNumberTypeenum
The type of reference number that was identified.
memberCardobject or null
Details of a member card and its guests
ticketobject or null
When attempting to admit a ticket, some ticket details should be provided.
walletobject or null
Details of a wallet and its tickets
docLxCityCardobject or null
ticketRequestobject or null
Was this page helpful?
Previous

Admit Token

Next
Built with
Returns the result of the try to admit a customer.

Your Entra Tenant ID. More details.

Your Business Central Company. More details.

Used for API versioning. More details.

Your Business Central Environment. More details.

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

This endpoint attempts to validate a customer’s reference number and identifies it as either a ticket, member card, or wallet. Each type provides different responses.

Ticket Reference Returns a single token that you can use with the admitToken endpoint.

Member Card Reference Returns a primary token for the member and additional tokens for any guests, with details such as guest type and max number of guests.

Wallet Reference Returns a list of tickets, each with relevant admission details, which can be individually used in subsequent calls to tryAdmit.

City Card Reference Returns a token for the city card, which can be used with the admit endpoint.

Ticket Token Reference Returns an admit token and a list of tickets that will be admitted when the admit token is used.