Get a list of lock types

Content

Resource URL

https://apps.ticketmatic.com/api/1/{accountname}/settings/ticketsales/locktypes

Example

Request

 1use Ticketmatic\Endpoints\Settings\Ticketsales\Locktypes;
 2
 3$result = Locktypes::getlist($client, array(
 4    "filter" => "SELECT id FROM tm.locktype WHERE ishardlock='t'",
 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 = Locktypes::getlist($client);

Response

 1object(Ticketmatic\Endpoints\Settings\Ticketsales\LocktypesList) (1) {
 2  ["data"]=>
 3  array(1) {
 4    [0]=>
 5    object(\Ticketmatic\Model\LockType) (8) {
 6      ["id"]=>
 7      int(0)
 8      ["name"]=>
 9      string(3) "VIP"
10      ["color"]=>
11      string(7) "#AE77FB"
12      ["hideseats"]=>
13      bool(true)
14      ["ishardlock"]=>
15      bool(true)
16      ["isarchived"]=>
17      bool(false)
18      ["createdts"]=>
19      object(\DateTime) (3) {
20        ["date"]=>
21        string(26) "2014-09-26 15:24:36.000000"
22        ["timezone_type"]=>
23        int(3)
24        ["timezone"]=>
25        string(3) "UTC"
26      }
27      ["lastupdatets"]=>
28      object(\DateTime) (3) {
29        ["date"]=>
30        string(26) "2014-09-26 15:24:36.000000"
31        ["timezone_type"]=>
32        int(3)
33        ["timezone"]=>
34        string(3) "UTC"
35      }
36    }
37  }
38}

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.locktype WHERE ishardlock=&#39;t&#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: LockTypeQuery

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 for the lock type

Example value:"VIP"
color
string

The color of the lock type

Example value:"#AE77FB"
hideseats
bool

Hides seats in online sales if this is true

Example value:true
ishardlock
bool

Indicates whether this lock is a hard lock (meaning that it normally never will be released and does not count for the inventory) or a soft lock

Example value:true
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: LockType[]