Submit a Job

POST https://api.boxbrownie.com/v1/job

• URL: https://api.boxbrownie.com/v1/job
• HTTP Method: POST
• Requires Authentication? Yes
• Supported Formats: XML
• XML Schema: job

POST Data

<Job>

jobTitle	String (required)	The title of the job. Maximum of 120 characters.
input
files	Collection of <fileURL>
fileURL	String (Required)	An public accessible URL of the file. Valid file types: .jpg, .gif, .png, .pdf.
edits	Collection of <edit>
editName	String (Required)	The name of the selected edit. A full list of edits can be retrieved at https://api.boxbrownie.com/v1/edits
editOptions	Collection of <editOption>
editOptionName	String	The name of the selected option
editOptionValue	String	The value of the selected option
comments	String	Any additional information relating to this input.

Example XML Requests

The below example shows the minimal payload require to submit a job, a single Image Enhancement edit.

  	<job>
		<jobTitle>Sample Job</jobTitle>
		<input>
			<files>
				<fileURL>http://example.com/img1.jpg</fileURL>
			</files>
			<edits>
				<edit>
					<editName>Image Enhancement Real Estate</editName>
				</edit>
			</edits>
		</input>
	</job>

The below example represents a job containing 2 Image Enhancement edits with some options. Each input will result in single "edited" output.

  	
	<job>
		<jobTitle>Sample Job</jobTitle>
		<input>
			<files>
				<fileURL>http://example.com/img1.jpg</fileURL>
				<fileURL>http://example.com/img1.jpg</fileURL>
			</files>
			<edits>
				<edit>
					<editName>Image Enhancement</editName>
					<editOptions>
						<editOption>
							<editOptionName>TV Screen Replacement</editOptionName>
							<editOptionValue>Yes</editOptionValue>
						</editOption>	
					</editOptions>
				</edit>
			</edits>
			<comments>Brighten</comments>
		</input>
		<input>
			<files>
				<fileURL>http://example.com/img3.jpg</fileURL>
				<fileURL>http://example.com/img4.jpg</fileURL>
			</files>
			<edits>
				<edit>
					<editName>Image Enhancement</editName>
					<editOptions>
						<editOption>
							<editOptionName>TV Screen Replacement</editOptionName>
							<editOptionValue>Yes</editOptionValue>
						</editOption>	
					</editOptions>
				</edit>
			</edits>
			<comments>Brighten</comments>
		</input>
	</job>

Example XML Response

  	<jobResponse>
		<success>true</success>
		<id>2sz4trz9pjtwprsx1idmmt7exfzxiho2nuuqs15x</id>
		<jobDateSubmitted>2018-04-24T22:16:57+1000</jobDateSubmitted>
		<jobDateDue>2018-04-24T22:16:57+1000</jobDateDue>
		<jobTitle>Sample Job</jobTitle>
		<jobStatus>Pending</jobStatus>
		<jobCost>3.20</jobCost>	
		<jobCurrency>US$</jobCurrency>
		<editCount>2</editCount>
	</jobResponse>