 |
Field Name |
Format |
Example |
Description |
|
| |
UserId * |
String |
"USER_10" |
The Colleague 7 User ID (* Mandatory) |
|
| |
Forenames |
String |
"John" |
The forenames of the Candidate |
|
| |
Surname |
String |
"Smith" |
The surname of the Candidate |
|
| |
KnownAs |
String |
"John" |
The Known As / Salutation field against the Candidate |
|
| |
Title |
String/Lookup |
"Mr" or lookup code |
The lookup description or code of Title |
|
| |
DirectNumber |
String |
"01603 735930" |
Direct Telephone Number of the Candidate |
|
| |
DirectFax |
String |
"01603 735935" |
Direct Fax Number of the Candidate (if applicable) |
|
| |
MobileNumber |
String |
"07777 777777" |
Mobile Number of the Candidate |
|
| |
OtherNumber |
String |
"01603 735930" |
Option for another Relevant Phone Number for the Candidate |
|
| |
EmailAddress |
String |
"support@colleaguesoftware.com" |
Email Address of the Candidate |
|
| |
EmailAddress2 |
String |
"sales@colleaguesoftware.com" |
Secondary Email Address of the Candidate |
|
| |
Website |
String |
"http://www.colleaguesoftware.com" |
A website address specific to the Candidate |
|
| |
Gender |
String/Lookup |
"Male" or lookup code |
Gender Lookup Description or Code (Male, Female) |
|
| |
Married |
Boolean |
"true" |
Married Flag |
|
| |
CandidateStatus |
String/Lookup |
"Active" or lookup code |
Candidate Status Lookup Description or Code |
|
| |
CandidateType |
String/Lookup |
"Contract" or lookup code |
Candidate Type Lookup Description or Code |
|
| |
CandidateSource |
String/Lookup |
"Referral" or lookup code |
Candidate Source Lookup Description or Code |
|
| |
Nationality |
String/Lookup |
"British" or lookup code |
Nationality Lookup Description or Code |
|
| |
JobType |
String |
"Project Manager" |
Freetext field containing Preferred Job Titles of Candidate |
|
| |
DateOfBirth |
date-time (dd MMM yyyy)
|
"02 Jul 1981" |
Candidate Date of Birth |
|
| |
DateAvailable |
date-time (dd MMM yyyy) |
"28 Jan 2020" |
Next Available Date of Candidate |
|
| |
CurrentSalary |
int32 (Integer) |
"30000" |
The current salary of the Candidate |
|
| |
WantedSalary |
int32 (Integer) |
"35000" |
The desired salary of the Candidate |
|
| |
CurrentPay |
int32 (Integer) |
"100" |
The current pay rate of the Candidate |
|
| |
WantedPay |
int32 (Integer) |
"150" |
The desired pay rate of the Candidate |
|
| |
NoticePeriod |
int32 (Integer) |
"4" |
Noticed Period in weeks required by the Candidate |
|
| |
SalaryBreakdown |
String |
"Company Car and Mobile Phone" |
Freetext field containing details of desired package |
|
| |
AddressLine1 |
String |
"The Control Tower" |
First Line of Candidate Address |
|
| |
AddressLine2 |
String |
"Witchcraft Way" |
Second Line of Candidate Address |
|
| |
AddressLine3 |
String |
"Rackheath" |
Third Line of Candidate Address |
|
| |
City |
String |
"Norwich" |
Town of Candidate Address |
|
| |
County |
String |
"Norfolk" |
County of Candidate Address |
|
| |
Postcode |
String |
"NR13 6GA" |
Postcode of Candidate Address |
|
| |
Country |
String/Lookup |
"United Kingdom" or lookup code |
Country of Candidate Address |
|
| |
TelephoneNumber |
String |
"01603 735930" |
Home Telephone Number of Candidate Address |
|
| |
FaxNumber |
String |
"01603 735935" |
Home Fax Number of Candidate Address |
|
| |
NoteTab |
int32 (Integer) |
"0" |
The note tab that the notes should be added to (0,1,2,3,4) |
|
| |
Notes |
String |
"Only Available via Mobile" |
Generic Notes held against the Candidate |
|
| |
CurrencyCode |
String/Lookup |
"GBP" or lookup code |
Currency Lookup Description or Code |
|
| |
PreviousJobTitles |
String |
"Account Manager, Project Manager" |
Freetext field containing previous Job Titles of Candidate |
|
| |
CustomFields |
Array |
""uniqueItems": false, "type": "array", "items": { "type": "object", "properties": { "customFieldName": { "type": "string" }, "customFieldValue": { "type": "object" } } }" |
List of Custom Fields that should be added to the Candidate record |
|
| |
SkillsToAdd |
Array |
"uniqueItems": false, "type": "array", "items": { "type": "object", "properties": { "lookupCode": { "type": "string/lookup" }, "lookupParent": { "type": "string/lookup" }, "lookupPath": { "type": "string" } } |
List of skills that should be added to the Candidate record
(Lookup code is mandatory, lookupParent and lookupPath are optional)
|
|
| |
Username |
String |
"John.Smith" |
Minimum number of characters: 8, Maximum number of characters: 255 (field is optional provided 'Password' is not included) |
|
| |
Password |
String |
"ABC.Password" |
Minimum number of characters: 8, Maximum number of characters: 255 (field is optional provided 'Username' is not included) |
|
