Create Status Queue
Requires ADMIN privileges.
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
orID
; defaultFULL
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
Â