Get a list of order fee definitions

Content

Resource URL

https://apps.ticketmatic.com/api/1/{accountname}/settings/pricing/orderfeedefinitions

Example

Request

 1use Ticketmatic\Endpoints\Settings\Pricing\Orderfeedefinitions;
 2
 3$result = Orderfeedefinitions::getlist($client, array(
 4    "filter" => "SELECT id FROM tm.orderfee WHERE createdts > (now() - INTERVAL '1 year')",
 5    "includearchived" => true,
 6    "lastupdatesince" => "2014-09-26 15:24:36",
 7));
 8
 9// The parameters array is optional, it can be omitted when empty.
10$result = Orderfeedefinitions::getlist($client);

Response

 1object(Ticketmatic\Endpoints\Settings\Pricing\OrderfeedefinitionsList) (1) {
 2  ["data"]=>
 3  array(1) {
 4    [0]=>
 5    object(\Ticketmatic\Model\OrderFeeDefinition) (7) {
 6      ["id"]=>
 7      int(0)
 8      ["typeid"]=>
 9      int(0)
10      ["name"]=>
11      string(12) "Payment cost"
12      ["isarchived"]=>
13      bool(false)
14      ["archivedts"]=>
15      object(\DateTime) (3) {
16        ["date"]=>
17        string(26) "2014-09-26 15:24:36.000000"
18        ["timezone_type"]=>
19        int(3)
20        ["timezone"]=>
21        string(3) "UTC"
22      }
23      ["createdts"]=>
24      object(\DateTime) (3) {
25        ["date"]=>
26        string(26) "2014-09-26 15:24:36.000000"
27        ["timezone_type"]=>
28        int(3)
29        ["timezone"]=>
30        string(3) "UTC"
31      }
32      ["lastupdatets"]=>
33      object(\DateTime) (3) {
34        ["date"]=>
35        string(26) "2014-09-26 15:24:36.000000"
36        ["timezone_type"]=>
37        int(3)
38        ["timezone"]=>
39        string(3) "UTC"
40      }
41    }
42  }
43}

Request

 1import (
 2    "github.com/ticketmatic/tm-go/ticketmatic"
 3    "github.com/ticketmatic/tm-go/ticketmatic/settings/pricing/orderfeedefinitions"
 4)
 5
 6result, err := orderfeedefinitions.Getlist(client, &ticketmatic.OrderFeeDefinitionQuery{
 7    Filter: "SELECT id FROM tm.orderfee WHERE createdts > (now() - INTERVAL '1 year')",
 8    Includearchived: true,
 9    Lastupdatesince: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
10})
11
12// The query object is optional, it can be omitted when empty.
13result, err := orderfeedefinitions.Getlist(client, nil)

Response

 1result := orderfeedefinitions.&List{
 2    Data: []*ticketmatic.OrderFeeDefinition{
 3        &ticketmatic.OrderFeeDefinition{
 4            Id: 123,
 5            Typeid: 2401,
 6            Name: "Payment cost",
 7            Isarchived: false,
 8            Archivedts: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
 9            Createdts: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
10            Lastupdatets: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
11        },
12    },
13}

Request

1GET /api/1/{accountname}/settings/pricing/orderfeedefinitions HTTP/1.1

Response

 1HTTP/1.1 200 OK
 2Content-Type: application/json
 3
 4{
 5    "data": [
 6        {
 7            "id": 123,
 8            "typeid": 2401,
 9            "name": "Payment cost",
10            "isarchived": false,
11            "archivedts": "2014-09-26 15:24:36",
12            "createdts": "2014-09-26 15:24:36",
13            "lastupdatets": "2014-09-26 15:24:36"
14        }
15    ]
16}

Parameters

FieldDescription
filter
        </td>
        <td class="description">
            <p>Filter the returned items by specifying a query on the public datamodel that returns the ids.</p> 
            <strong>Example value:</strong><code>&#34;SELECT id FROM tm.orderfee WHERE createdts &gt; (now() - INTERVAL &#39;1 year&#39;)&#34;</code>
        </td>
    </tr><tr>
        <td class="field">
            <div class="name">includearchived</div>
            
        </td>
        <td class="description">
            <p>If this parameter is true, archived items will be returned as well.</p> 
            <strong>Example value:</strong><code>true</code>
        </td>
    </tr><tr>
        <td class="field">
            <div class="name">lastupdatesince</div>
            
        </td>
        <td class="description">
            <p>All items that were updated since this timestamp will be returned. Timestamp should be passed in <code>YYYY-MM-DD hh:mm:ss</code> format.</p> 
            <strong>Example value:</strong><code>&#34;2014-09-26 15:24:36&#34;</code>
        </td>
    </tr>
</tbody>

Type reference: OrderFeeDefinitionQuery

Result fields

This call returns an object with an array of objects in the data field.

FieldDescription
id
int

Unique ID

Example value:123
typeid
int

Type of the order fee. Can be Automatic (2401), Script (2402) or Manual (2403)

Example value:2401
name
mlstring

Name for the order fee

Example value:"Payment cost"
isarchived
bool

Whether or not this item is archived

archivedts
timestamp

Archived timestamp

Example value:"2014-09-26 15:24:36"
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: OrderFeeDefinition[]