Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties
labelapi_docs_CONTROLLERTAG
NameTickets / Add EticketSet Properties
DescriptionAdd a PDF eticket and/or barcode to an individual ticket/seat
TypePUT
URL/v9/tickets/:ticket_id
Credential TypeAPI|User

Long Description

Add a PDF eticket and/or barcode to an individual ticket/seat.

To remove an existing eticket file simply send an empty value {"eticket":""} as the body. Removing an eticket file will also remove the barcode as well. PUTting a new eticket file will overwrite an existing one as well as remove/overwrite the existing barcode.

You cannot add multiple etickets or barcodes in a single API call, you must make a separate PUT for every seat.

Parameters

Name
Description
Type
Presence
LocationLimitationsOther
ticket_idThe id of the individual ticket. It is the id for each item in the ticket_list available via Ticket Groups / ShowIntegerRequiredURI 
eticketBase-64 encoded single page PDFStringRequiredOptionalBodyOnly one page per file allowed
barcodeThe ticket’s barcodeStringOptionalBody 30 Characters max

 

Examples

RequestResponse
PUT /v9/tickets/123456 
Code Block
themeConfluence
languagejs
{
  "eticket": "<base-64 encoded single-page PDF>",
  "barcode": "4567-8731-5497-4859"
}
Paste in Response Code
Code Block
themeConfluence
languageruby
js
{
  "barcode": "4567-8731-5497-4859",
  "eticket": {
    "eticket_pack_id": 457325456,
    "thumbnail": "https://s3.amazonaws.com/etickets.sandbox.ticketevolution.com/65478.png",
    "id": 65478
  },
  "id": 123456,
  "seat": 3
}

Remove an existing PDF

Code Block
themeConfluence
languagejs
{"eticket":""}
 
Code Block
themeConfluence
languagejs
{
  "barcode": "",
  "eticket": null,
  "id": 123456,
  "seat": 3
}