Reference

BackstageClient.passIdentifiers

BackstageClient.passIdentifiers in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / passIdentifiers

passIdentifiers: {
  bind: (passId: string, request: {
     kind: "nfc_uid" | "wallet_serial";
     value: string;
   }, requestOptions?: RequestOptions) => Promise<{
     activatedAt: string;
     endedAt: string | null;
     endedReason: string | null;
     id: string;
     kind:   | "random_barcode"
        | "signed_barcode"
        | "rotating_code"
        | "nfc_uid"
        | "wallet_serial";
     passId: string;
     status: "revoked" | "active" | "superseded";
     value: string | null;
  }>;
  list: (passId: string, requestOptions?: RequestOptions) => Promise<{
     activatedAt: string;
     endedAt: string | null;
     endedReason: string | null;
     id: string;
     kind:   | "random_barcode"
        | "signed_barcode"
        | "rotating_code"
        | "nfc_uid"
        | "wallet_serial";
     passId: string;
     status: "revoked" | "active" | "superseded";
     value: string | null;
  }[]>;
  reissue: (passId: string, request: {
     reason: string;
     revokeOld?: boolean;
   }, requestOptions?: RequestOptions) => Promise<{
     barcode: string;
     identifiers: {
        activatedAt: string;
        endedAt: string | null;
        endedReason: string | null;
        id: string;
        kind:   | "random_barcode"
           | "signed_barcode"
           | "rotating_code"
           | "nfc_uid"
           | "wallet_serial";
        passId: string;
        status: "revoked" | "active" | "superseded";
        value: string | null;
     }[];
     passId: string;
  }>;
  revoke: (passId: string, identifierId: string, request: {
     reason: string;
   }, requestOptions?: RequestOptions) => Promise<{
     activatedAt: string;
     endedAt: string | null;
     endedReason: string | null;
     id: string;
     kind:   | "random_barcode"
        | "signed_barcode"
        | "rotating_code"
        | "nfc_uid"
        | "wallet_serial";
     passId: string;
     status: "revoked" | "active" | "superseded";
     value: string | null;
  }>;
  sign: (passId: string, requestOptions?: RequestOptions) => Promise<{
     activatedAt: string;
     endedAt: string | null;
     endedReason: string | null;
     id: string;
     kind:   | "random_barcode"
        | "signed_barcode"
        | "rotating_code"
        | "nfc_uid"
        | "wallet_serial";
     passId: string;
     status: "revoked" | "active" | "superseded";
     value: string | null;
  }[]>;
};

Defined in: client.ts:8907

Pass Identifiers methods

bind()#

bind: (passId: string, request: {
  kind: "nfc_uid" | "wallet_serial";
  value: string;
}, requestOptions?: RequestOptions) => Promise<{
  activatedAt: string;
  endedAt: string | null;
  endedReason: string | null;
  id: string;
  kind:   | "random_barcode"
     | "signed_barcode"
     | "rotating_code"
     | "nfc_uid"
     | "wallet_serial";
  passId: string;
  status: "revoked" | "active" | "superseded";
  value: string | null;
}>;

Bind an identifier to a pass Bind a wristband's or card's chip UID, or a wallet serial, to a pass. The pass keeps its barcode. A value already bound to any pass is refused (409 PASS_IDENTIFIER_TAKEN).

Parameters#

Parameter	Type
`passId`	`string`
`request`	{ `kind`: `"nfc_uid"` \| `"wallet_serial"`; `value`: `string`; }
`request.kind`	`"nfc_uid"` \| `"wallet_serial"`
`request.value?`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ activatedAt: string; endedAt: string | null; endedReason: string | null; id: string; kind: | "random_barcode" | "signed_barcode" | "rotating_code" | "nfc_uid" | "wallet_serial"; passId: string; status: "revoked" | "active" | "superseded"; value: string | null; }>

Operation Id#

bindPassIdentifier

list()#

list: (passId: string, requestOptions?: RequestOptions) => Promise<{
  activatedAt: string;
  endedAt: string | null;
  endedReason: string | null;
  id: string;
  kind:   | "random_barcode"
     | "signed_barcode"
     | "rotating_code"
     | "nfc_uid"
     | "wallet_serial";
  passId: string;
  status: "revoked" | "active" | "superseded";
  value: string | null;
}[]>;

List a pass's identifiers Everything a scanner can read for this pass, active and ended: its random barcode (and every barcode it had before a re-issue), chip UIDs and wallet serials. An ended identifier still names the pass, so a door can say why it is refused.

Parameters#

Parameter	Type
`passId`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Operation Id#

listPassIdentifiers

reissue()#

reissue: (passId: string, request: {
  reason: string;
  revokeOld?: boolean;
}, requestOptions?: RequestOptions) => Promise<{
  barcode: string;
  identifiers: {
     activatedAt: string;
     endedAt: string | null;
     endedReason: string | null;
     id: string;
     kind:   | "random_barcode"
        | "signed_barcode"
        | "rotating_code"
        | "nfc_uid"
        | "wallet_serial";
     passId: string;
     status: "revoked" | "active" | "superseded";
     value: string | null;
  }[];
  passId: string;
}>;

Re-issue a pass Give a pass a new barcode, for a lost or leaked ticket. The pass and its entitlements are unchanged; the old barcode is revoked (or only superseded) and refused at the door. Renditions print the new barcode from now on.

Parameters#

Parameter	Type
`passId`	`string`
`request`	{ `reason`: `string`; `revokeOld?`: `boolean`; }
`request.reason`	`string`
`request.revokeOld?`	`boolean`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ barcode: string; identifiers: { activatedAt: string; endedAt: string | null; endedReason: string | null; id: string; kind: | "random_barcode" | "signed_barcode" | "rotating_code" | "nfc_uid" | "wallet_serial"; passId: string; status: "revoked" | "active" | "superseded"; value: string | null; }[]; passId: string; }>

Operation Id#

reissuePass

revoke()#

revoke: (passId: string, identifierId: string, request: {
  reason: string;
}, requestOptions?: RequestOptions) => Promise<{
  activatedAt: string;
  endedAt: string | null;
  endedReason: string | null;
  id: string;
  kind:   | "random_barcode"
     | "signed_barcode"
     | "rotating_code"
     | "nfc_uid"
     | "wallet_serial";
  passId: string;
  status: "revoked" | "active" | "superseded";
  value: string | null;
}>;

Revoke one of a pass's identifiers End one identifier, such as a lost card's chip, keeping the pass and its other identifiers. Scanning it is then refused with identifier_revoked. To replace a barcode, re-issue the pass instead.

Parameters#

Parameter	Type
`passId`	`string`
`identifierId`	`string`
`request`	{ `reason`: `string`; }
`request.reason`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Operation Id#

revokePassIdentifier

sign()#

sign: (passId: string, requestOptions?: RequestOptions) => Promise<{
  activatedAt: string;
  endedAt: string | null;
  endedReason: string | null;
  id: string;
  kind:   | "random_barcode"
     | "signed_barcode"
     | "rotating_code"
     | "nfc_uid"
     | "wallet_serial";
  passId: string;
  status: "revoked" | "active" | "superseded";
  value: string | null;
}[]>;

Give a pass a signed barcode Sign the pass now with the organisation's key: a TL1. barcode a scanner can verify offline, beside its random barcode, ending any signed barcode it had. Renditions print the signed one from then on. An event's or ticket type's pass policy (signedBarcodes) does this at issuance.

Parameters#

Parameter	Type
`passId`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Operation Id#

signPass