Boarding Pass Identifiers
A boarding pass issued on the system has at least one identifier, which can either be allocated by the API or by the Issuer.
API Allocated Identifier
When a pass is issued it is allocated a unique id by the system. This is returned in the Boarding Pass Response as the Id attribute and is a positive integer.
Once a boarding pass is issued, its status can be queried; it can be revoked or resent/reissued by specifying its Id.
Issuer Allocated Identifier
The issuing application may wish to store its own identifier when issuing the boarding pass. It should do so using the IssuerId attribute in the Issue Request. This is a string identifier and may contain up to 300 bytes of case insensitive data.
When a boarding pass is issued, its status can be queried; it can be revoked or resent/reissued by specifying its IssuerId which is the same as specifying the Id.
- The API does not impose a unique constraint on the IssuerId. It is up to the calling application to do this if necessary.
- The calling application may use its internal database or primary key identifier for the pass or it may use a combination of fields in the issue request here to specify what should be a unique identifier. An example might be the ticketnumber with the departure airport code appended, which should uniquely identify the pass in the system.
Once allocated, the IssuerId should not be changed.