Get a single delivery scenario
Content
Resource URL
https://apps.ticketmatic.com/api/1/{accountname}/settings/ticketsales/deliveryscenarios/{id}
Example
Request
1use Ticketmatic\Endpoints\Settings\Ticketsales\Deliveryscenarios;
2
3$result = Deliveryscenarios::get($client, $id);
Response
1object(\Ticketmatic\Model\DeliveryScenario) (15) {
2 ["id"]=>
3 int(0)
4 ["typeid"]=>
5 int(0)
6 ["name"]=>
7 string(13) "Print at home"
8 ["allowetickets"]=>
9 int(0)
10 ["availability"]=>
11 object(\Ticketmatic\Model\DeliveryscenarioAvailability) (1) {
12 ["saleschannels"]=>
13 array(2) {
14 [0]=>
15 int(0)
16 [1]=>
17 int(0)
18 }
19 }
20 ["deliverystatusaftertrigger"]=>
21 int(0)
22 ["internalremark"]=>
23 string(43) "Don't use this scenario for partner events."
24 ["needsaddress"]=>
25 bool(true)
26 ["ordermailtemplateid_delivery"]=>
27 int(0)
28 ["ordermailtemplateid_deliverystarted"]=>
29 int(0)
30 ["shortdescription"]=>
31 string(70) "Print your own tickets. Do not forget to bring your copy to the event!"
32 ["visibility"]=>
33 string(4) "FULL"
34 ["isarchived"]=>
35 bool(false)
36 ["createdts"]=>
37 object(\DateTime) (3) {
38 ["date"]=>
39 string(26) "2014-09-26 15:24:36.000000"
40 ["timezone_type"]=>
41 int(3)
42 ["timezone"]=>
43 string(3) "UTC"
44 }
45 ["lastupdatets"]=>
46 object(\DateTime) (3) {
47 ["date"]=>
48 string(26) "2014-09-26 15:24:36.000000"
49 ["timezone_type"]=>
50 int(3)
51 ["timezone"]=>
52 string(3) "UTC"
53 }
54}
55
Request
1import (
2 "github.com/ticketmatic/tm-go/ticketmatic"
3 "github.com/ticketmatic/tm-go/ticketmatic/settings/ticketsales/deliveryscenarios"
4)
5
6result, err := deliveryscenarios.Get(client, id)
Response
1result := &ticketmatic.DeliveryScenario{
2 Id: 123,
3 Typeid: 2501,
4 Name: "Print at home",
5 Allowetickets: 1,
6 Availability: &ticketmatic.DeliveryscenarioAvailability{
7 Saleschannels: []int64{
8 1,
9 2,
10 },
11 },
12 Deliverystatusaftertrigger: 2602,
13 Internalremark: "Don't use this scenario for partner events.",
14 Needsaddress: true,
15 OrdermailtemplateidDelivery: 0,
16 OrdermailtemplateidDeliverystarted: 0,
17 Shortdescription: "Print your own tickets. Do not forget to bring your copy to the event!",
18 Visibility: "FULL",
19 Isarchived: false,
20 Createdts: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
21 Lastupdatets: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
22}
Request
1GET /api/1/{accountname}/settings/ticketsales/deliveryscenarios/{id} HTTP/1.1
Response
1HTTP/1.1 200 OK
2Content-Type: application/json
3
4{
5 "id": 123,
6 "typeid": 2501,
7 "name": "Print at home",
8 "allowetickets": 1,
9 "availability": {
10 "saleschannels": [ 1, 2 ]
11 },
12 "deliverystatusaftertrigger": 2602,
13 "internalremark": "Don't use this scenario for partner events.",
14 "needsaddress": true,
15 "ordermailtemplateid_delivery": 0,
16 "ordermailtemplateid_deliverystarted": 0,
17 "shortdescription": "Print your own tickets. Do not forget to bring your copy to the event!",
18 "visibility": "FULL",
19 "isarchived": false,
20 "createdts": "2014-09-26 15:24:36",
21 "lastupdatets": "2014-09-26 15:24:36"
22}
Result fields
Field | Description |
---|---|
id int | Unique ID Example value:123 |
typeid int | The type of this delivery scenario, defines when this delivery scenario is triggered. The available values for this field can be found on the delivery scenario overview page. Example value:2501 |
name | Name of the delivery scenario Example value:"Print at home" |
allowetickets int | Are e-tickets allowed with this delivery scenario? Example value:1 |
availability | The rules that define when this scenario is available. See the delivery scenario overview page for a description of this field Example value:{ "saleschannels": [ 1, 2 ] } |
deliverystatusaftertrigger int | The delivery status the order will transition to when the trigger occurs. Example value:2602 |
internalremark string | An internal description field. Will not be shown to customers. Example value:"Don't use this scenario for partner events." |
needsaddress bool | A physical address is required Example value:true |
ordermailtemplateid_delivery int | The ID of the order mail template that will be used for sending out when changing to delivery state ‘delivered’. Can be 0 to indicate that no mail should be sent |
ordermailtemplateid_deliverystarted int | The ID of the order mail template that will be used for sending out when changing to delivery state ‘delivery started’. Can be 0 to indicate that no mail should be sent |
shortdescription | A short description of the deilvery scenario. Will be shown to customers. Example value:"Print your own tickets. Do not forget to bring your copy to the event!" |
visibility string | Parameter that sets the visibility of this scenario, can be either ‘FULL’ or ‘API’. Example value:"FULL" |
isarchived bool | Whether or not this item is archived |
createdts timestamp | Created timestamp Example value:"2014-09-26 15:24:36" |
lastupdatets timestamp | Last updated timestamp Example value:"2014-09-26 15:24:36" |
Type reference: DeliveryScenario