 |
Field Name |
Format |
Example |
Description |
|
| |
userId * |
String |
"USER_10" |
The Colleague 7 User ID (* Mandatory) |
|
| |
candidateId |
ID |
"123" |
The ID of the Candidate record |
|
| |
jobType |
Numeric |
"1" |
0 = Contract, 1 = Permanent, 2 = Rolling Contract, 3 = Unknown, 4 = Education |
|
| |
jobTitle |
String |
"Developer" |
Job Title during Employment |
|
| |
notes |
String |
"First job after University" |
Notes on the Employment or Education |
|
| |
companyName |
String |
"Colleague Software" |
Company Name (Employer or Colleage / University) |
|
| |
contactName |
String |
"Will Minns" |
Name of Contact (Line Manager or Teacher) |
|
| |
location |
String |
"Chichester, UK" |
Location of Employment or Education |
|
| |
workingCompanyId |
ID |
"321" |
ID of Company record where Employment took place (if there is a Parent Company) |
|
| |
owningCompany |
String |
"Colleague Software" |
Name of Parent Company |
|
| |
startDate |
String |
"21/04/19" |
Start Date of Employment or Education |
|
| |
endDate |
String |
"21/04/20" |
End Date of Employment or Education |
|
| |
chargeRate |
Numeric |
"100.00" |
Charge Rate (2 Decimal Places) |
|
| |
otChargeRate |
Numeric |
"120.00" |
Overtime Charge Rate (2 Decimal Places) |
|
| |
payRate |
Numeric |
"75.00" |
Pay Rate (2 Decimal Places) |
|
| |
otPayRate |
Numeric |
"100.00" |
Overtime Pay Rate (2 Decimal Places) |
|
| |
noticePeriod |
Numeric |
"4" |
Notice Period |
|
| |
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 Experience record
(Lookup code is mandatory, lookupParent and lookupPath are optional)
|
|
