Reference Guide

Base URL Endpoint

The following URL is the base endpoint for the REST API. PCRecruiter v9: https://www2.pcrecruiter.net/rest/api

TIP

Ensure the URL includes "https" to securely access the API.

Content Types

The REST API accepts both JSON and XML content Types. JSON is the default content type.

Accept Types

The REST API can return both JSON and XML data. The default is JSON. The desired type can be set by passing the Accept header.

Compression

The REST API supports gzip. It can be enabled using the Accept-Encoding header. (Accept-Encoding: gzip)

Date Field Format

Dates should be sent (and will be returned) in ISO-8601 format for all non-custom fields.

Custom fields will be returned in the format based on the accept-language submitted in the header. If no accept-language is submitted, then the default en-US will be applied which is MM-DD-YYYY.

Custom Fields

Custom fields will be returned with a field type value to help with determining what data has been placed in them. It is possible for date fields to be returned in a MM-DD-YYYY format or with alpha characters such as December 2, 1992.

Custom currency values will generally return numbers with the possibility of the three-digit currency code appended on the end such as 100 EUR.

Hashed/encrypted fields are sensitive and cannot be returned. Instead, they are represented as masked values, as shown below:

{
     "CandidateId": 1234567890,
     "CustomFields": [ {
          "FieldName": "custom hashed/encrypted",
          "FieldType": "HashedEncrypted",
          "Values": ["***************"]
     }]
}

Adding Names, Companies and Positions

When adding a name or position it is recommended, but not required that a "CompanyId" is submitted in the body of the request. If one is not defined the Name or Position will be attached to the Default Company. This behavior is generally acceptable when adding names through something like a Job Board.

When setting the username fields for records below are general rules which the UI follows.

• If candidates are adding themselves through online forms or applications, the UserName field on those records is typically set to CANDIDATE.
• If a non-PCR User is creating their own companies or positions the UserName field on those records is typically set to EMPLOYER.