Retrieve Jobs
GET https://api.boxbrownie.com/v1/job/
- URL: https://api.boxbrownie.com/v1/job/
- HTTP Method: GET
- Requires Authentication? Yes
- Supported Formats: XML
Request Paramaeters
Parameter | Description |
id | To return a specific job by id. |
since | If included, returns only items modified since the given time. The provided date and time should be in UTC. |
page | The number of page results to be returned. |
perPage | The size of the page of results to be returned (100 Max). |
Returns
<job>
A list of your submitted jobs.
id | String | The id of the job |
jobTitle | String | The job title |
jobDateSubmitted | DateTime | The date the job was submitted |
jobDateComplete | DateTime | The date the job was complete |
jobDownloadURL | String | A download link to the completed .ZIP file of the job |
jobCost | Decimal | The total cost of the job. |
output | Collection of <file> | The completed files within the job |
fileId | String | The id of the file. This id must used if you wish to submit a rework for this file. |
fileURL | String | The URL for the completed file |
Example XML Response
<job>
<id>2sz4trz9pjtwprsx1idmmt7exfzxiho2nuuqs15x</id>
<jobDateSubmitted>2018-03-22 13:55</jobDateSubmitted>
<jobDateComplete>2018-03-22 17:54</jobDateComplete>
<jobTitle>Job Title</jobTitle>
<jobCost>2.00</jobCost>
<jobZipDownloadURL>https://s3-ap-southeast-2.amazonaws.com/boxbrownie/photography/originals/ zips/jmj29tvur7a3x0mtawzsp1pr2fmu8syk11jfcsrh.zip</jobZipDownloadURL>
<output>
<file>
<fileId>axy0gcnxadxbgpw6a5i2qycgo1ickbysbnv4q1bw</fileId>
<fileURL>https://s3-ap-southeast-2.amazonaws.com/boxbrownie/completed/ axy0gcnxadxbgpw6a5i2qycgo1ickbysbnv4q1bw.jpg</fileURL>
</file>
<file>
<fileId>tnsnkgugnwxq2jzmxawzxu0ay1eski3c871v2wfd</fileId>
<fileURL>https://s3-ap-southeast-2.amazonaws.com/boxbrownie/completed/ tnsnkgugnwxq2jzmxawzxu0ay1eski3c871v2wfd.jpg</fileURL>
</file>
</output>
</job>