|
WARNING: This section is intended for advanced users and "Super users" of PRIM Logix.
The configuration items presented in this section may indeed have an impact on your operations.
If in doubt, consult your system administrator.
Please note that only users in the appropriate security groups can access the software configuration windows. |
Creating a basic candidate profile
Allows you to programmatically create a new candidate profile by providing basic information (first name, last name, telephone, etc.).
URL: api/CandidateCreateBasicProfile
Attributes to pass to actionParameters
FirstName
string Required. Candidate's first name
LastName
string Required. Candidate's name
string Optional. Candidate's e-mail address
Phone
string Optional. Candidate's telephone number
PhonePaycod
string Optional. The country code(paycod) associated with the candidate's phone number (as configured in your PRIM). Possible values: Code field in Countries and provinces (CFG052) window in PRIM. Default value: Default country code set in PRIM.
Mobile
string Optional. Candidate's cell phone number
MobilePaycod
string Optional. The country code (paycod) associated with the candidate's mobile phone number (as configured in your PRIM). Possible values: Code field in Countries and provinces (CFG052) window in PRIM. Default value: Default country code set in PRIM.
PhonePriority
string Optional. Indicates which phone number should be used first. Possible values: T or C, où
•T = Phone number (voir Phone)
•C = Cell phone number (voir Mobile)
Default value: T
SMSAllowed
boolean Facultatif. Indique si le candidat autorise l'envoi de SMS à son numéro de téléphone. Valeur par défault: false
Language
string Required. The candidate's language code(lascod) Possible values: Code field in PRIM's Languages (CFG003) window.
cchcodProvXRC
string Optional. The cchcod value used for the XRC criterion in the candidate profile. For greater customization within your PRIM system, we recommend creating a cchcod dedicated to your context of use (for example, ZAP for integration with Zapier). Default value: WSC
Complete query example
{
"actionParameters": {
"FirstName": "John",
"LastName": "Doe",
"Email": "j.doe@example.com",
"Phone": null,
"PhonePaycod": null,
"Mobile": "4507762151",
"MobilePaycod": "CA",
"PhonePriority": "C",
"SMSAllowed": true
"Language": "FR",
"cchcodProvXRC": null,
}
}
Response returned by the web service
{
"status": "success",
"data": [
{
"cancod": 1234,
"idrcod": 123456,
"concod": 222
}
]
}
Here's what each of the fields returned by the data property corresponds to:
cancod
integer The unique identifier used to identify the candidate created among all the candidates in PRIM
idrcod
integer A unique identifier used to identify the candidate created across all PRIM entities.
concod
integer A unique identifier for the contact associated with your created candidate, used to identify him or her among all your PRIM contacts.
