Skip to main content
Rest API Methods
Updated over a week ago

Important Notice: Outdated Information

This article is outdated and will not be updated. The information provided may be inaccurate or no longer relevant

Carerix now offers a GraphQL API. Please use our GraphQL API
https://docs.carerix.io/graphql/welcome


This Article describes REST API methods.


Related articles:

Rest API Methods

Apply the methods in this section to any object (CRUser, CREmployee, CRPublication, etc.). Consult the complete list of objects using the Carerix API Console.

GET $object

List objects matching search criteria.

Request Parameters

  • qualifier (string, optional): Search criteria (specified in a high-level variant of SQL).

  • start (string, optional, default: 0): Offset; number of objects to skip from the beginning of the result.

  • count (string, optional, default: 10): Maximum number of objects to include in the result.

  • ordering (string, optional): Order criteria.

  • show (string, optional): Show selected attributes only.

  • language (string, optional, default: English, options: English, Dutch, Spanish): Data nodes localized using specified language.

GET $object/describe

Describe an object. Get an object schema (properties, attributes, relationships, etc.).

Request Parameters

  • language (string, optional, default: English, options: English, Dutch, Spanish): Data nodes localized using specified language.

GET $object/$id

Fetch an object by $id.

Request Parameters

  • id (string, default: 1): Object id.

  • show (string, optional): Show selected attributes only.

  • language (string, optional, default: English, options: English, Dutch, Spanish): Data nodes localized using specified language.

POST $object

Create a new object.

Request Headers

  • Content-Type (string, test/xml, options/xml): Format of a request body.

Request Body

  • XML document

PUT $object/$id

Update an existing object by id.

Request Headers

  • Content-Type (string, test/xml, options/xml): Format of a request body.

Request Body

  • XML document

Request Parameters

  • id (string): Object id.

DELETE $object/$id

Delete an object by id.

Request Parameters

  • id (string): Object id.

GET $object/email

Generate and send an e-mail for this object. Usage example: send an e-mail to a candidate who has forgotten his/her password for the web portal.

Request Parameters

  • id (integer, test:1): Object id.

  • emailtemplate (string, test): Email-template object code, e.g. forgotpwd.

  • from (string, optional): Override from email address in the template.

  • to (string, optional): Override to email address in the template.

GET $object/attachment

Fetch an attachment. Retrieve company's logo, a photo, or a resume document.

Request Parameters

  • id (string, test:3): Object id.

  • tag (string, test): Tag to search for.

  • show (string, optional): Show selected attributes only.

  • language (string, optional, default: English, options: English, Dutch, Spanish): Data nodes localized using specified language.


CREmployee API Methods

Methods for manipulating CREmployee object. Inherits all methods of $object.

GET CREmployee/get-by

Get employee object by username and password.

Request Parameters

  • userName (string, test): Name known as 'user name' in Carerix system and registered in the user object.

  • password (string, test:9H7pNdDC): The password as registered in the user object.

  • show (string, optional): Show selected attributes only.

  • language (string, optional, default: English, options: English, Dutch, Spanish): Data nodes localized using specified language.

PUT CREmployee/apply

Create or modify an employee object and perform additional tasks in one go. Call this method when a web portal visitor submits the application form. Supports additional tasks:

  • Inherit default values for some of the employee's properties from a specified Publication object.

  • Create a match connecting an employee to a publication's vacancy.

  • Send a confirmation e-mail to a candidate and a recruiter.

  • Send a notification e-mail when a new candidate may be a duplicate of an existing one.

Request Headers

  • Content-Type (string, test/xml, options/xml): Format of a request body.

  • x-cx-pub (string, optional): Publication object id (published vacancy).

  • x-cx-prod (string, optional): Business line (data-node ID) for an open application.

  • x-cx-dedupe (integer, optional, default: 1): 0 to disable, 1 to enable employee de-duplication.

  • x-cx-nomatch (integer, optional, default: 0): 1 to prevent the creation of a match with the publication's vacancy.

  • x-cx-confirm-mail (string, optional): Web-confirm code of the template for the confirmation e-mail, e.g. web-confirm, web-notify, web-dupwarn.

  • x-cx-orgpub (string, optional): Publication object external id on the affiliate website (for example Monsterboard) through which the applicant browsed to the web portal website.

  • x-cx-dupmatch-mail (string, optional): If an application results in a match that already exists, the stage of the match is set to the default stage for that application/medium. If an e-mail template with code web-dupmatch exists, this will be sent to inform the owner of the match. The code of the e-mail template can be changed with this parameter.

Request Body

  • XML document

PUT CREmployee/subscribe

Subscribe a candidate (CREmployee) in your Carerix system to newsletters, groups, or job alerts.

Request Headers

  • Content-Type (string, test/xml, options/xml): Format of a request body.

  • x-cx-subscribe-mail (string, optional, default): Code of the template used for confirmation e-mail to the subscriber.

Request Body

  • XML document

POST | PUT CREmployee/clear

Anonymize candidate

Request Headers

  • Content-Type (string, test/xml, options/xml): Format of a request body.

Request Body

  • XML document

Examples of valid XML:

xmlCopy code<?xml version="1.0" encoding="utf-8" ?> <CREmployee id="1234"></CREmployee>
xmlCopy code<?xml version="1.0" encoding="utf-8" ?> <CREmployee key="importID" value="aaaa-1234-bbbb"></CREmployee>

All other information sent in payload will be ignored.

Response Content

On success:

xmlCopy code<?xml version="1.0" encoding="utf-8"?><NSDictionary> <success>true</success> </NSDictionary>

On failure:

xmlCopy code<?xml version="1.0" encoding="utf-8"?><NSDictionary> <success>false</success> <message>ERROR_MESSAGE</message> </NSDictionary>

CRUser API Methods

Methods for manipulating CRUser object. Inherits all methods of $object.

GET CRUser/meeting

List meetings associated with this object. $startDate and $endDate parameters support the following formats: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM:SS +0200, unix timestamp, string in a format accepted by strtotime function (see http://php.net/strtotime). Omitting these parameters produces results for the last 30 days.

Request Parameters

  • userID (string, test:5772): User object id.

  • startDate (string, optional): List meetings starting from this date.

  • endDate (string, optional): List meetings ending with this date.

GET CRUser/get-by-auth

Get user object by $auth.

Request Parameters

  • auth (string, test): A code supplied by the Carerix system.

  • show (string, optional): Show selected attributes only in result.

GET CRUser/get-by-username-and-hash

Get user object by username and hash.

Request Parameters

  • userName (string, test): Name known as 'user name' in Carerix system and registered in the user object.

  • hash (string, test): A code supplied by the Carerix system.

  • show (string, optional): Show selected attributes only in result.

GET CRUser/login-with-encrypted-password

Get user object by username and encrypted password.

Request Parameters

  • u (string, test): Name known as 'user name' in Carerix system and registered in the user object.

  • p (string, test(mypwd)): User password as md5 string.

  • show (string, optional): Limit response to specified attributes only.

  • qualifier (string, optional): Search criteria (specified in a high-level variant of SQL).

GET CRUser/get-token-using-encrypted-password

Request Parameters

  • userName (string): Carerix user name.

  • encryptedPassword (string): Carerix user encrypted password.

  • type (string): Token type, e.g. api. Must correspond to Note's subject in Carerix system.

  • systemName (string): Carerix system name, e.g

Did this answer your question?