Request a status update

Content

Resource URL

https://apps.ticketmatic.com/api/1/{accountname}/ratelimiting/status/{queuetoken}

Description

Request a new rate limiting status update. See rate limiting for more details on rate limiting.

Example

Request

1use Ticketmatic\Endpoints\Ratelimiting;
2
3$result = Ratelimiting::status($client, $queuetoken);

Response

 1object(\Ticketmatic\Model\QueueStatus) (9) {
 2  ["id"]=>
 3  string(36) "a9996b64-20d7-4052-844d-d77c44b59652"
 4  ["orderid"]=>
 5  int(0)
 6  ["ahead"]=>
 7  int(0)
 8  ["backoff"]=>
 9  int(0)
10  ["description"]=>
11  string(122) "Further action required before you can proceed, see https://www.ticketmatic.com/docs/api/ratelimiting for more information"
12  ["message"]=>
13  string(46) "Check our Facebook page while you are waiting!"
14  ["progress"]=>
15  int(0)
16  ["started"]=>
17  bool(false)
18  ["starttime"]=>
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}
28

Request

1import (
2    "github.com/ticketmatic/tm-go/ticketmatic"
3    "github.com/ticketmatic/tm-go/ticketmatic/ratelimiting"
4)
5
6result, err := ratelimiting.Status(client, queuetoken)

Response

 1result := &ticketmatic.QueueStatus{
 2    Id: "a9996b64-20d7-4052-844d-d77c44b59652",
 3    Orderid: 654968,
 4    Ahead: 402,
 5    Backoff: 30000,
 6    Description: "Further action required before you can proceed, see https://www.ticketmatic.com/docs/api/ratelimiting for more information",
 7    Message: "Check our Facebook page while you are waiting!",
 8    Progress: 1,
 9    Started: false,
10    Starttime: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
11}

Request

1POST /api/1/{accountname}/ratelimiting/status/{queuetoken} HTTP/1.1

Response

 1HTTP/1.1 200 OK
 2Content-Type: application/json
 3
 4{
 5    "id": "a9996b64-20d7-4052-844d-d77c44b59652",
 6    "orderid": 654968,
 7    "ahead": 402,
 8    "backoff": 30000,
 9    "description": "Further action required before you can proceed, see https://www.ticketmatic.com/docs/api/ratelimiting for more information",
10    "message": "Check our Facebook page while you are waiting!",
11    "progress": 1,
12    "started": false,
13    "starttime": "2014-09-26 15:24:36"
14}

Result fields

FieldDescription
id
string

Queueing ID, used to request status updates

Example value:"a9996b64-20d7-4052-844d-d77c44b59652"
orderid
int

The ID of the newly created order. Only returned when a throttled “create order” call has finished queueing.

Example value:654968
ahead
int

Number of people waiting ahead. Might not be returned when the queue hasn’t started yet.

Example value:402
backoff
int

Number of milliseconds to wait before requesting a new status update

Example value:30000
description
string

Further instructions on how to handle this error

Example value:"Further action required before you can proceed, see https://www.ticketmatic.com/docs/api/ratelimiting for more information"
message
string

Optional message shown to waiting customers

Example value:"Check our Facebook page while you are waiting!"
progress
int

Status code: 1: wait more, 2: ready to proceed

Example value:1
started
bool

Whether the queue has started

starttime
timestamp

When the queue will start

Example value:"2014-09-26 15:24:36"

Type reference: QueueStatus