Get a list of contact address types

Content

Resource URL

https://apps.ticketmatic.com/api/1/{accountname}/settings/system/contactaddresstypes

Example

Request

 1use Ticketmatic\Endpoints\Settings\System\Contactaddresstypes;
 2
 3$result = Contactaddresstypes::getlist($client, array(
 4    "filter" => "SELECT id FROM conf.contactaddresstype WHERE name LIKE 'H%'",
 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 = Contactaddresstypes::getlist($client);

Response

 1object(Ticketmatic\Endpoints\Settings\System\ContactaddresstypesList) (1) {
 2  ["data"]=>
 3  array(1) {
 4    [0]=>
 5    object(\Ticketmatic\Model\ContactAddressType) (5) {
 6      ["id"]=>
 7      int(0)
 8      ["name"]=>
 9      string(4) "Home"
10      ["isarchived"]=>
11      bool(false)
12      ["createdts"]=>
13      object(\DateTime) (3) {
14        ["date"]=>
15        string(26) "2014-09-26 15:24:36.000000"
16        ["timezone_type"]=>
17        int(3)
18        ["timezone"]=>
19        string(3) "UTC"
20      }
21      ["lastupdatets"]=>
22      object(\DateTime) (3) {
23        ["date"]=>
24        string(26) "2014-09-26 15:24:36.000000"
25        ["timezone_type"]=>
26        int(3)
27        ["timezone"]=>
28        string(3) "UTC"
29      }
30    }
31  }
32}

Request

 1import (
 2    "github.com/ticketmatic/tm-go/ticketmatic"
 3    "github.com/ticketmatic/tm-go/ticketmatic/settings/system/contactaddresstypes"
 4)
 5
 6result, err := contactaddresstypes.Getlist(client, &ticketmatic.ContactAddressTypeQuery{
 7    Filter: "SELECT id FROM conf.contactaddresstype WHERE name LIKE 'H%'",
 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 := contactaddresstypes.Getlist(client, nil)

Response

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

Request

1GET /api/1/{accountname}/settings/system/contactaddresstypes HTTP/1.1

Response

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

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 conf.contactaddresstype WHERE name LIKE &#39;H%&#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: ContactAddressTypeQuery

Result fields

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

FieldDescription
id
int

Unique ID

Example value:123
name
mlstring

Name of the address type

Example value:"Home"
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: ContactAddressType[]