Get a list of order mail templates

Content

Resource URL

https://apps.ticketmatic.com/api/1/{accountname}/settings/communicationanddesign/ordermails

Example

Request

 1use Ticketmatic\Endpoints\Settings\Communicationanddesign\Ordermails;
 2
 3$result = Ordermails::getlist($client, array(
 4    "filter" => "SELECT id FROM tm.ordermailtemplate WHERE nameen LIKE \"%e\"",
 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 = Ordermails::getlist($client);

Response

 1object(Ticketmatic\Endpoints\Settings\Communicationanddesign\OrdermailsList) (1) {
 2  ["data"]=>
 3  array(1) {
 4    [0]=>
 5    object(\Ticketmatic\Model\OrderMailTemplate) (6) {
 6      ["id"]=>
 7      int(0)
 8      ["typeid"]=>
 9      int(0)
10      ["name"]=>
11      string(18) "Order confirmation"
12      ["isarchived"]=>
13      bool(false)
14      ["createdts"]=>
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      ["lastupdatets"]=>
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    }
33  }
34}

Request

 1import (
 2    "github.com/ticketmatic/tm-go/ticketmatic"
 3    "github.com/ticketmatic/tm-go/ticketmatic/settings/communicationanddesign/ordermails"
 4)
 5
 6result, err := ordermails.Getlist(client, &ticketmatic.OrderMailTemplateQuery{
 7    Filter: "SELECT id FROM tm.ordermailtemplate WHERE nameen LIKE \"%e\"",
 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 := ordermails.Getlist(client, nil)

Response

 1result := ordermails.&List{
 2    Data: []*ticketmatic.OrderMailTemplate{
 3        &ticketmatic.OrderMailTemplate{
 4            Id: 123,
 5            Typeid: 3101,
 6            Name: "Order confirmation",
 7            Isarchived: false,
 8            Createdts: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
 9            Lastupdatets: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
10        },
11    },
12}

Request

1GET /api/1/{accountname}/settings/communicationanddesign/ordermails HTTP/1.1

Response

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

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.ordermailtemplate WHERE nameen LIKE &#34;%e&#34;&#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: OrderMailTemplateQuery

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

The type of this order mail template, defines where this template is used. The available values for this field can be found on the order mail template overview page.

Example value:3101
name
string

Name of the order mail template

Example value:"Order confirmation"
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: OrderMailTemplate[]