Download Photos (API)

Owned by Tony Erskine
Last updated: Sept 28, 2023
1 min read

URI: https://api.cloudcard.us/photo/download

HTTP Method: GET

Required Headers: X-Auth-Token (see: Authentication)

Example HTTP Request Body
EMPTY

The response will depend on your organization's downloadStrategy

Download Strategy: ZIP_READY_FOR_DOWNLOAD or ZIP_DOWNLOADED

Example Response if APPROVED Photos Exist
303 SEE OTHER { "link": "http://{api url}/api/photos/download/zip?token=sMo7fflhBijq0mOlotsOfRandomLettersAndNumbersmb8iAaKLtj0vrhm05" }

You will have to send a GET request to the URL in the link attribute to download the zip file and move the photos to the DOWNLOADED status.

Example Response if No APPROVED Photos Exist
204 NO CONTENT

Download Strategy: EXTERNAL_READY_FOR_DOWNLOAD or EXTERNAL_DOWNLOADED

This call will only move the APPROVED photos to the DOWNLOADED status. Some other mechanism, such as an APPROVED or DOWNLOADED Status Queue is necessary to retrieve the photos.

Example Response if Photos Were Updated
Example Response if No APPROVED Photos Exist

Â