Create Status Queue

This feature is in Beta.

URI: https://api.cloudcard.us/status-queue

HTTP Method: POST

Required Headers:

X-Auth-Token (see: Authentication)
Accept: application/json

Request Body:

organization: id of organization (see example)
messageType: FULL or ID; default FULL
name: name of status queue; max size 32 characters
photoStatus: the photo status that will trigger messages to be sent to the queue; default DOWNLOADED
PENDING, APPROVED, DENIED, DISCARDED, READY_FOR_DOWNLOAD, DOWNLOADED, DONE, ENROUTE, ON_HOLD

Example HTTP Request 1 (Create the Global Download Queue)

    {
        "organization": { "id": 2 }
    }

Example Response 2

201 CREATED
{
    "id": 10,
    "dateCreated": "2023-06-06T15:14:48Z",
    "lastUpdated": "2023-06-06T15:14:48Z",
    "organization": {
        "id": 2
    },
    "messageType": "FULL",
    "photoStatus": "DOWNLOADED",
    "name": "GLOBAL_DOWNLOAD"
}

Example HTTP Request 2

    {
        "organization": { "id": 2 },
        "messageType": "FULL",
        "name": "random name 123",
        "photoStatus": "DOWNLOADED"
    }

Example Response 2

200 CREATED
{
    "id": 9,
    "dateCreated": "2023-06-06T15:12:11Z",
    "lastUpdated": "2023-06-06T15:12:11Z",
    "organization": {
        "id": 2
    },
    "messageType": "FULL",
    "photoStatus": "DOWNLOADED",
    "name": "random name 123"
}