Home › Zipster API › API Reference

API Reference

Get categories

Retrieve all the job categories for the authenticated user.

Endpoint

http://www.zipster.com.au/services/rest/categories

Sample request

GET http://www.zipster.com.au/services/rest/categories

About the response

If the request is successful, Zipster responds with an HTTP 200 message containing a list of job categories.

The following example shows a response to a successful request:

<?xml version="1.0" encoding="UTF-8"?>
<ResponseCategories>
  <Category>
    <Id><![CDATA[1]]></Id>
    <Name><![CDATA[Analyst: Business]]></Name>
  </Category>
  <Category>
    <Id><![CDATA[2]]></Id>
    <Name><![CDATA[Analyst: Programmer]]></Name>
  </Category>
  <Category>
    <Id><![CDATA[3]]></Id>
    <Name><![CDATA[Analyst: Systems]]></Name>
  </Category>
  <Category>
    <Id><![CDATA[4]]></Id>
    <Name><![CDATA[Architect]]></Name>
  </Category>
</ResponseCategories>

If the request is unsuccessful, Zipster responses with an HTTP 500 message (Server Error).

The following example shows a response to an unsuccessful request:

<?xml version="1.0" encoding="UTF-8"?>
<ResponseCategories>
  <Error>
    <Code><![CDATA[500]]></Code>
    <Message><![CDATA[Something is broken. Please contact us so we can investigate.]]></Message>
  </Error>
</ResponseCategories>

Get category

Retrieve a job category for the authenticated user.

Endpoint

http://www.zipster.com.au/services/rest/categories/{id}

Sample request

GET http://www.zipster.com.au/services/rest/categories/1

About the response

If the request is successful, Zipster responds with an HTTP 200 message containing a job category.

The following example shows a response to a successful request:

<?xml version="1.0" encoding="UTF-8"?>
<ResponseCategories>
  <Category>
    <Id><![CDATA[1]]></Id>
    <Name><![CDATA[Analyst: Business]]></Name>
  </Category>
</ResponseCategories>

If the request is unsuccessful, Zipster responses with an HTTP 500 message (Server Error) or an HTTP 404 message (Not Found Error).

The following example shows a response to an unsuccessful (not found) request:

<?xml version="1.0" encoding="UTF-8"?>
<ResponseCategories>
  <Error>
    <Code><![CDATA[404]]></Code>
    <Message><![CDATA[Category not found.]]></Message>
  </Error>
</ResponseCategories>

Get jobs

Retrieve all the posted jobs for the authenticated user.

Endpoint

http://www.zipster.com.au/services/rest/jobs

Parameters

Parameter	Default	Description
start_index	0	(optional) The zero-based offset into the results. When used with the max_results parameter, you can request successive pages of results.
max_results	25	(optional) The maximum number of results to return. This number cannot be greater than 100.
order_by	!posted-date	(optional) The sort order of the results. Set the parameter value to one of the following values: title - Sort job title in ascending order. !title - Sort job title in descending order. reference - Sort reference number in ascending order. !reference - Sort reference number in descending order. status - Sort job status in ascending order. !status - Sort job status in descending order. posted-date - Sort posted date in ascending order. !posted-date - Sort posted date in descending order. expiry-date - Sort expiry date in ascending order. !expiry-date - Sort expiry date in descending order.

Sample request

GET http://www.zipster.com.au/services/rest/jobs?max_results=1

About the response

If the request is successful, Zipster responds with an HTTP 200 message containing a list of posted jobs.

The following example shows a response to a successful request:

<?xml version="1.0" encoding="UTF-8"?>
<ResponseJobs>
  <NumberOfResults><![CDATA[1]]></NumberOfResults>
  <StartIndex><![CDATA[0]]></StartIndex>
  <ResultsPerPage><![CDATA[1]]></ResultsPerPage>
  <Job>
    <Id><![CDATA[1]]></Id>
    <Title><![CDATA[Job Title]]></Title>
    <ApplicationEmail><![CDATA[someone@example.com]]></ApplicationEmail>
    <ReferenceNumber><![CDATA[ZP/01]]></ReferenceNumber>
    <Description><![CDATA[<p>Job details job details.</p>]]></Description>
    <WorkType><![CDATA[Full Time]]></WorkType>
    <City><![CDATA[Sydney]]></City>
    <State><![CDATA[NSW]]></State>
    <Postcode><![CDATA[2000]]></Postcode>
    <Status><![CDATA[Active]]></Status>
    <Category>
      <Id><![CDATA[15]]></Id>
      <Name><![CDATA[Networks & Systems]]></Name>
    </Category>
    <PostedDate><![CDATA[2010-01-01T12:00:00.000Z]]></PostedDate>
    <Link><![CDATA[http://www.zipster.com.au/job/1]]></Link>
  </Job>
</ResponseJobs>

If the request is unsuccessful, Zipster responses with an HTTP 500 message (Server Error).

<?xml version="1.0" encoding="UTF-8"?>
<ResponseCategories>
  <Error>
    <Code><![CDATA[500]]></Code>
    <Message><![CDATA[Something is broken. Please contact us so we can investigate.]]></Message>
  </Error>
</ResponseCategories>

Get job

Retrieve a posted job for the authenticated user.

Endpoint

http://www.zipster.com.au/services/rest/jobs/{id}

Sample request

GET http://www.zipster.com.au/services/rest/jobs/1

About the response

If the request is successful, Zipster responds with an HTTP 200 message containing a posted job.

The following example shows a response to a successful request:

<?xml version="1.0" encoding="UTF-8"?>
<ResponseJobs>
  <Job>
    <Id><![CDATA[1]]></Id>
    <Title><![CDATA[Job Title]]></Title>
    <ApplicationEmail><![CDATA[someone@example.com]]></ApplicationEmail>
    <ReferenceNumber><![CDATA[ZP/01]]></ReferenceNumber>
    <Description><![CDATA[<p>Job details job details.</p>]]></Description>
    <WorkType><![CDATA[Full Time]]></WorkType>
    <City><![CDATA[Sydney]]></City>
    <State><![CDATA[NSW]]></State>
    <Postcode><![CDATA[2000]]></Postcode>
    <Status><![CDATA[Active]]></Status>
    <Category>
      <Id><![CDATA[15]]></Id>
      <Name><![CDATA[Networks & Systems]]></Name>
    </Category>
    <PostedDate><![CDATA[2010-01-01T12:00:00.000Z]]></PostedDate>
    <Link><![CDATA[http://www.zipster.com.au/job/1]]></Link>
  </Job>
</ResponseJobs>

If the request is unsuccessful, Zipster responses with an HTTP 500 message (Server Error) or an HTTP 404 message (Not Found Error).

The following example shows a response to an unsuccessful (not found) request:

<?xml version="1.0" encoding="UTF-8"?>
<ResponseCategories>
  <Error>
    <Code><![CDATA[404]]></Code>
    <Message><![CDATA[Job not found.]]></Message>
  </Error>
</ResponseCategories>

Post job

Post a new job for the authenticated user.

Endpoint

http://www.zipster.com.au/services/rest/jobs

POST XML data block

Zipster expects the following XML in the POST data block, content must be inside CDATA sections.

You must include Job/ApplicationEmail or Job/ApplicationUrl. Do not include both.

<Job>
  <Title />
  <ApplicationEmail /> <!-- To receive the applications via email. -->
  <ApplicationUrl /> <!-- To redirect job seekers to ATS application URL. -->
  <ReferenceNumber /> <!-- Optional -->
  <Description />
  <WorkType />
  <Location />
  <Category>
    <Id />
  </Category>
</Job>

Sample request

POST /services/rest/jobs HTTP/1.1
Host: www.zipster.com.au
Content-Type: text/xml; charset=UTF-8
  <Job>
    <Title><![CDATA[Job Title]]></Title>
    <ApplicationEmail><![CDATA[someone@example.com]]></ApplicationEmail>
    <Description><![CDATA[<p>Job details job details.</p>]]></Description>
    <WorkType><![CDATA[Full Time]]></WorkType>
    <Location><![CDATA[Sydney]]></Location>
    <Category>
      <Id><![CDATA[15]]></Id>
    </Category>
  </Job>

About the response

If the request is successful, Zipster responds with an HTTP 200 message containing a posted job.

The following example shows a response to a successful request:

<?xml version="1.0" encoding="UTF-8"?>
<ResponseJobs>
  <Job>
    <Id><![CDATA[1]]></Id>
    <Title><![CDATA[Job Title]]></Title>
    <ApplicationEmail><![CDATA[someone@example.com]]></ApplicationEmail>
    <ReferenceNumber><![CDATA[ZP/01]]></ReferenceNumber>
    <Description><![CDATA[<p>Job details job details.</p>]]></Description>
    <WorkType><![CDATA[Full Time]]></WorkType>
    <City><![CDATA[Sydney]]></City>
    <State><![CDATA[NSW]]></State>
    <Postcode><![CDATA[2000]]></Postcode>
    <Status><![CDATA[Incomplete]]></Status>
    <Category>
      <Id><![CDATA[15]]></Id>
      <Name><![CDATA[Networks & Systems]]></Name>
    </Category>
    <Link><![CDATA[http://www.zipster.com.au/job/1]]></Link>
  </Job>
</ResponseJobs>

If the request is unsuccessful, Zipster responses with an HTTP 500 message (Server Error) or an HTTP 400 message (Bad Request).

The following example shows a response to an unsuccessful (bad) request with missing data:

<?xml version="1.0" encoding="UTF-8"?>
<ResponseJobs>
  <Error>
    <Code><![CDATA[400]]></Code>
    <Message><![CDATA[There was a problem with your request.]]></Message>
    <Global>
      <Message><![CDATA[ApplicationEmail or ApplicationUrl element cannot be left blank.]]></Message>
    </Global>
    <Elements>
      <Element>
        <Name><![CDATA[Title]]></Name>
        <Message><![CDATA[Required field cannot be left blank.]]></Message>
      </Element>
    </Elements>
  </Error>
</ResponseJobs>

Update job

Update a given job for the authenticated user.

Endpoint

http://www.zipster.com.au/services/rest/jobs/{id}

PUT XML data block

The PUT XML data block is similar to the POST XML data block.

Sample request

PUT /services/rest/jobs/1 HTTP/1.1
Host: www.zipster.com.au
Content-Type: text/xml; charset=UTF-8
  <Job>
    <Title><![CDATA[Job Title]]></Title>
    <ApplicationEmail><![CDATA[someone@example.com]]></ApplicationEmail>
    <Description><![CDATA[<p>Job details job details.</p>]]></Description>
    <WorkType><![CDATA[Full Time]]></WorkType>
    <Location><![CDATA[Sydney]]></Location>
    <Category>
      <Id><![CDATA[15]]></Id>
    </Category>
  </Job>

About the response

The update response is similar to the Post job response.

Close job

Close an active job for the authenticated user.

Endpoint

http://www.zipster.com.au/services/rest/jobs/{id}

Parameters

Parameter	Description
action	(required) The parameter's value must be close.

Sample request

PUT /services/rest/jobs/1?action=close HTTP/1.1
Host: www.zipster.com.au

About the response

If the request is successful, Zipster responds with an HTTP 200 message containing a posted job.

The following example shows a response to a successful request:

<?xml version="1.0" encoding="UTF-8"?>
<ResponseJobs>
  <Job>
    <Id><![CDATA[1]]></Id>
    <Title><![CDATA[Job Title]]></Title>
    <ApplicationEmail><![CDATA[someone@example.com]]></ApplicationEmail>
    <ReferenceNumber><![CDATA[ZP/01]]></ReferenceNumber>
    <Description><![CDATA[<p>Job details job details.</p>]]></Description>
    <WorkType><![CDATA[Full Time]]></WorkType>
    <City><![CDATA[Sydney]]></City>
    <State><![CDATA[NSW]]></State>
    <Postcode><![CDATA[2000]]></Postcode>
    <Status><![CDATA[Closed]]></Status>
    <Category>
      <Id><![CDATA[15]]></Id>
      <Name><![CDATA[Networks & Systems]]></Name>
    </Category>
    <PostedDate><![CDATA[2010-01-01T12:00:00.000Z]]></PostedDate>
    <Link><![CDATA[http://www.zipster.com.au/job/1]]></Link>
  </Job>
</ResponseJobs>

If the request is unsuccessful, Zipster responses with an HTTP 500 message (Server Error).

Open job

Open a closed job for the authenticated user.

Endpoint

http://www.zipster.com.au/services/rest/jobs/{id}

Parameters

Parameter	Description
action	(required) The parameter's value must be open.

Sample request

PUT /services/rest/jobs/1?action=open HTTP/1.1
Host: www.zipster.com.au

About the response

If the request is successful, Zipster responds with an HTTP 200 message containing a posted job.

The following example shows a response to a successful request:

<?xml version="1.0" encoding="UTF-8"?>
<ResponseJobs>
  <Job>
    <Id><![CDATA[1]]></Id>
    <Title><![CDATA[Job Title]]></Title>
    <ApplicationEmail><![CDATA[someone@example.com]]></ApplicationEmail>
    <ReferenceNumber><![CDATA[ZP/01]]></ReferenceNumber>
    <Description><![CDATA[<p>Job details job details.</p>]]></Description>
    <WorkType><![CDATA[Full Time]]></WorkType>
    <City><![CDATA[Sydney]]></City>
    <State><![CDATA[NSW]]></State>
    <Postcode><![CDATA[2000]]></Postcode>
    <Status><![CDATA[Active]]></Status>
    <Category>
      <Id><![CDATA[15]]></Id>
      <Name><![CDATA[Networks & Systems]]></Name>
    </Category>
    <PostedDate><![CDATA[2010-01-01T12:00:00.000Z]]></PostedDate>
    <Link><![CDATA[http://www.zipster.com.au/job/1]]></Link>
  </Job>
</ResponseJobs>

If the request is unsuccessful, Zipster responses with an HTTP 500 message (Server Error).

Job work type

The Job/WorkType element can have one of the following values:

• Full Time
• Part Time
• Contract
• Internship
• Temporary

Job status

The Job/Status element can have one of the following values:

• Active - Job has been activated after payment.
• Closed - Job has been closed, no longer available to apply.
• Incomplete - Job is pending payment or still being edited.