Resumes API

This is the API to deal with resumes. Resumes are an essential part of a job application. Each action shows the HTTP request and response. Errors are generic in format and provide action-specific messages and error codes as described here.

Listing Resumes

Request Response

URL takes additional parameters as needed for pagination etc.

Type: GET
          
URL: /resumes.[json, xml]?access_token=<access-token>
          
XML: All resumes. Root element: resumes
JSON: Array of resume elements.
Examples:
JSON: [{"resume":{"id":9,"name":"another resume","url":"/attachments/Resume/1416c3f3-301f-409c-879d-908ff478fd0b.pdf",
"mime_type":"application/pdf"}},{"resume":{"id":11,"name":"another resume","url":"/attachments/Resume/c77e4d9a-4556-421c-9291-855e52653371.pdf",
"mime_type":"application/pdf"}}]
          

Creating a Resume

This is same as "uploading" a resume before applying for a job. The idea is you upload a resume and then reference it while creating a job application.

Request Response

There are two mandatory parameters (name and file_path) along with access token.

Type: POST
          
URL: /resumes.[json, xml]
          
Body: access_token=<access-token>&name=resume_name&file_path=<path_on_local_file_system>
          
XML/JSON: Representation of the created resume.

Showing a Resume

Request Response
Type: GET
          
URL: /resumes/<ID>.[json, xml]
          
XML/JSON representation of the resume.

Updating a Resume

Request Response

There are two mandatory parameters (name and file_path) along with access token. This API is rarely used.

Type: PUT or POST with X-HTTP-Method-Override: PUT Header
          
URL: /resumes/<ID>.[json, xml]
          
Body: access_token=<access-token>&name=resume_name&file_path=<path_on_local_file_system>
          
Just the headers are returned on success.

Deleting a Resume

Request Response
Type: DELETE or POST with X-HTTP-Method-Override: DELETE Header
          
URL: /resumes/<ID>.[json, xml]
          
Body: access_token=<access-token>
          
Just the headers (if it succeeds). Errors are displayed if you are not entitled to delete a resume.