Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

This has not be generally released yet. Expected summer 2023

URI: https://api.cloudcard.us/status-queue/{id}

HTTP Method: PUT

Required Headers: 

Request Body: (omitted fields will not be changed)
  • organization: id of organization (see example)

  • messageType: FULL or ID

  • name: name of status queue; max size 32 characters

  • photoStatus: the photo status that will trigger messages to be sent to the queue
    PENDING, APPROVED, DENIED, DISCARDED, READY_FOR_DOWNLOAD, DOWNLOADED, DONE, ENROUTE, ON_HOLD


Example HTTP Request 1 (Omitted fields are unchanged)
    {
        "name": "random name 1234"
    }
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": "random name 1234"
}

Example HTTP Request 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"
}

  • No labels