| Page Properties |
|---|
| label | api_docs_CONTROLLERTAG |
|---|
|
| Name | Tickets / Add EticketSet Properties |
|---|
| Description | Add a PDF eticket and/or barcode to an individual ticket/seat |
|---|
| Type | PUT |
|---|
| URL | /v9/tickets/:ticket_id |
|---|
| Credential Type | API|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.
To remove an existing barcode simply send an empty value {"barcode":""}.
You cannot add multiple etickets or barcodes in a single API call, you must make a separate PUT for every seat.
Parameters
| | | | Location | LimitationsOther |
|---|
ticket_id | The id of the individual ticket. It is the id for each item in the ticket_list available via Ticket Groups / Show - Removed with ticket_list=true set. | Integer | Required | URI | |
eticket | Base-64 encoded single page PDF | StringRequired | Optional | Body | Only one page per file allowed |
barcode | The ticket’s barcode | String | Optional | Body | 30 Characters max |
Examples
| Request | Response |
|---|
| PUT /v9/tickets/123456 | |
| Code Block |
|---|
| theme | Confluence |
|---|
| language | js |
|---|
| {
"eticket": "<base-64 encoded single-page PDF>",
"barcode": "4567-8731-5497-4859"
} |
| | Code Block |
|---|
| theme | Confluence |
|---|
| language | ruby |
|---|
| Paste in Response Code | {
"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 (and barcode) | Code Block |
|---|
| theme | Confluence |
|---|
| language | js |
|---|
| {"eticket":""} |
| | Code Block |
|---|
| theme | Confluence |
|---|
| language | js |
|---|
| {
"barcode": "",
"eticket": null,
"id": 123456,
"seat"} |
|
Remove an existing barcode | Code Block |
|---|
| theme | Confluence |
|---|
| language | js |
|---|
| {"barcode":""} |
| | Code Block |
|---|
| theme | Confluence |
|---|
| language | js |
|---|
| {
"barcode": null,
"eticket": {
"eticket_pack_id": 457325456,
"thumbnail": "https://s3.amazonaws.com/etickets.sandbox.ticketevolution.com/65478.png",
"id": 65478
},
"id": 123456,
"seat": 3
} |
|