|
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. |
Get the details of a job offer/shift
Returns the details of a job offer/shift (for the job offer/shift sheet) when the status of the job offer/shift allows it to be displayed.
URL: api/GetOneJobData
Attributes to pass to actionParameters
JobId
integer
Mandatory
ID of the job offer or the grouped shift returned (poscod or trjcod)
Possible values: 1 or higher
JobType
string
Mandatory
Indicator of the type of the jobs returned
Possible values: P (Permanent), C (Contractual), I (Internship) or T (Temporary)
Language
string
Optional
Indicates the language used to display the information
Possible values: FR (French) or EN (English)
Default value: EN
Complete example of a request
{
"actionParameters":
{
"JobId": 1919,
"JobType": "P",
"Language": "FR"
}
}
Response returned by Web service
{
"status": "success",
"data": [
{
"JobId": 1919,
"idrcod": 1306716,
"ClientId": 22,
"JobType": "P",
"DivisionName": "Intégration Inc.",
"DivisionId": 1,
"ClientName": "",
"clientAddress": "Boucherville Québec Canada",
"adrcodWorkPlace": null,
"JobAddressLongitude": 0,
"JobAddressLatitude": 0,
"imageFshcod": 36290,
"imageName": "logo prim.png",
"clientSocialNetwork": [
{
"wstcod": "FB",
"Name": "FaceBook",
"url": "www.facebook.com"
}, {
"wstcod": "IN",
"Name": "Indeed",
"url": "www.indeed.com"
}, {
"wstcod": "LI",
"Name": "LinkedIn",
"url": "www.linkedin.com"
}, {
"wstcod": "RS",
"Name": "Flux RSS",
"url": "https:\\/\\/www.instagram.com\\/charron_francois\\/"
}, {
"wstcod": "SW",
"Name": "Site Web",
"url": "www.primlogix.com"
}, {
"wstcod": "TW",
"Name": "Twitter",
"url": "www.twitter.com"
}
],
"ClientDescription": "<p><img src=\"FSHCOD:35982\" style=\"width: 474px;\">\n </p>",
"JobTitle": "Snow remover",
"DivisionJobHeader": "<p>Header for the portal </p><p><br></p><p><br></p><p><br></p><p><br></p><p><br></p><p><br></p>",
"DivisionJobFooter": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\">\r\n<HTML><HEAD>\r\n<META content=\"text/html; charset=windows-1252\" http-equiv=Content-Type>\r\n<META name=GENERATOR content=\"MSHTML 11.00.10570.1001\"></HEAD>\r\n<BODY>Pied de page pour la plateforme Web</BODY></HTML>\r\n",
"JobDescription": null,
"JobSummary": null,
"JobUrl": "https://dev-bravo.primlogix.com/jobs/view/snow-remover/1919/P/fr",
"JobFunction": null,
"JobLocation": "Boucherville Québec Canada",
"GoogleForJobCity": "Boucherville",
"GoogleForJobRegion": "Québec",
"GoogleForJobPostalCode": null,
"GoogleForJobCountry": "Canada",
"JobReleaseDate": "2022-10-11",
"JobPriority": 1,
"StatusId": "POVAC",
"StatusDesc": "VACANT",
"StatusColorText": "#333333",
"StatusColorBg": "#dddddd",
"IsClientConfidential": true,
"JobDateStart": "2022-10-11",
"JobDateEnd": null,
"JobDateHire": null,
"bClientAskForDiscretion": false,
"JobSalary": "To be discussed",
"JobIsSelfService": false,
"ShowApplyButton": true,
"JSONSchedule": [
{
"WeekId": 1,
"SunStart": 480,
"SunEnd": 1020,
"MonStart": 480,
"MonEnd": 1020,
"TueStart": 480,
"TueEnd": 1020,
"WedStart": null,
"WedEnd": null,
"ThuStart": null,
"ThuEnd": null,
"FriStart": null,
"FriEnd": null,
"SatStart": null,
"SatEnd": null
}
],
"JobDetailCriteria": [
{
"Level":1,
"cgrcod":"FON",
"cgrcodParent":null,
"Order":5,
"idtcod":1504,
"Subject":"FUNCTION",
"Choices": [
{
"Choice": "Administrative" assistant,
"DataInfo": [
{
"labelData": "Number of years of experience",
"Data": "5"
}
]
}
]
}
,{
"Level":1,
"cgrcod":"FOR",
"cgrcodParent":null,
"Order":10,
"idtcod":1504,
"Subject":"EDUCATION",
"Choices":
[
{
"Choice":"Bachelor's degree"
}
]
}
,{
"Level":1,
"cgrcod":"LAN",
"cgrcodParent":null,
"Order":35,
"idtcod":1504,
"Subject":"LANGUAGE",
"Choices":
[
{
"Choice":"French"
}
,{
"Choice":"English"
}
]
}
,{
"Level":2,
"cgrcod":"LOG",
"cgrcodParent":"FON",
"Order":4,
"idtcod":1504,
"Subject":"SOFTWARE",
"Choices":
[
{
"Choice":"Other"
}
]
}
],
"JobTileCriteria": [
{
"Level":1,
"cgrcod":"FON",
"cgrcodParent":null,
"Order":5,
"idtcod":1504,
"Subject":"FONCTION",
"Choices": [
{
"Choice": "Administrative assistant",
"DataInfo":
[
{
"labelData": "Number of years of experience",
"Data": "5"
}
]
}
]
}
,{
"Level":1,
"cgrcod":"FOR",
"cgrcodParent":null,
"Order":10,
"idtcod":1504,
"Subject":"EDUCATION",
"Choices":
[
{
"Choice":"Bachelor's degree"
}
]
}
,{
"Level":1,
"cgrcod":"LAN",
"cgrcodParent":null,
"Order":35,
"idtcod":1504,
"Subject":"LANGUAGE",
"Choices":
[
{
"Choice":"French"
}
,{
"Choice":"English"
}
]
}
,{
"Level":2,
"cgrcod":"LOG",
"cgrcodParent":"FON",
"Order":4,
"idtcod":1504,
"Subject":"SOFTWARE",
"Choices":
[
{
"Choice":"Other"
}
]
}
]
}
]
}
Here is what each field corresponds to:
JobId
integer
Number of the job offer/shift (poscod or trjcod)
Possible values: 1 or higher
idrcod
integer
Unique ID of the job offer (idrcod)
Possible values: 1 or higher
ClientId
integer
ID of the client (clicod)
Possible values: 1 or higher
JobType
string
Indicates the job type.
Possible values: P (Permanent), C (Contractual), I (Internship) or T (Temporary)
DivisionName
string
Name of the division linked to the job offer
DivisionId
integer
ID of the division linked to the job offer (divcod)
Possible values: 1 or higher
ClientName
string
Client name (information returned only if the property IsClientConfidentiel = false)
clientAddress
string
Client address (information returned only if the property IsClientConfidentiel = false)
adrcodWorkPlace
string
Workplace (information returned only if the property IsClientConfidentiel = false)
JobAddressLongitude
float
Longitude in decimal degrees of the workplace (datum NAD83) (information returned only if the property IsClientConfidentiel = false)
Possible values: null or -180 to 180 (negative value is west of the Greenwich Meridian))
The address of the workplace must be valid for the MapBox/Google Maps services and must have been geolocated already. Otherwise, the value 0 or null will be returned in these 2 situations respectively.
JobAddressLatitude
float
Latitude in decimal degrees of the workplace (datum NAD83) (information returned only if property IsClientConfidentiel = false)
Possible values: null or -90 to 90 (a negative value is in the Southern hemisphere)
The address of the workplace must be valid for the MapBox/Google Maps services and must have been geolocated already. Otherwise, the value 0 or null will be returned in these 2 situations respectively.
imageFshcod
integer
ID of the file of the icon to be displayed (BlobId)
Possible values: 1 or higher
This information is required to retrieve the image with the Web service GetFileBlob
imageName
string
Name of the file of the icon image
clientSocialNetwork
json
Link to the client social networks (information returned only if the property IsClientConfidentiel = false)
Example of returned data:
[
{
"wstcod": "FB",
"Nom": "FaceBook",
"url": "www.facebook.com"
}, {
"wstcod": "IN",
"Nom": "Indeed",
"url": "www.indeed.com"
}, {
"wstcod": "LI",
"Nom": "LinkedIn",
"url": "www.linkedin.com"
}, {
"wstcod": "RS",
"Nom": "Flux RSS",
"url": "https:\\/\\/www.instagram.com\\/charron_francois\\/"
}, {
"wstcod": "SW",
"Nom": "Web site",
"url": "www.primlogix.com"
}, {
"wstcod": "TW",
"Nom": "Twitter",
"url": "www.twitter.com"
}
]
Note: If a social network type has not been defined for the client, the wstcod section will not be returned
Here is what will correspond each of the fields of the returned JSON.
Name |
Type |
Description |
wstcod |
string |
Social network type: FB (Facebook), IN (Indeed), LI (LinkedIn), RS (Flux RSS), SW (Web site) or TW (Twitter) |
Nom |
string |
Exact wording of the social network |
url |
string |
URL du réseau social |
ClientDescription
string
HTML code of the client description
JobTitle
string
Job title in plain text
DivisionJobHeader
string
HTML code to be displayed in the job sheet header (linked to the division of the job/shift)
DivisionJobFooter
string
HTML code to be displayed in the job sheet footer (linked to the division of the job/shift)
JobDescription
string
HTML code for the description of the job offer (body text)
JobSummary
string
HTML code for the job summary
JobUrl
string
URL of the job offer sheet in PRIMWEB
JobFunction
string
Function of the job offer (criterion)
JobLocation
string
Job location (criterion)
JobReleaseDate
date
Date of job posting
Date format: YYYY-MM-DD
JobPriority
integer
Indicator of the priority level of the job posting
Possible values: 1 to 5
StatusId
string
Code for the job status (stacod)
StatusDesc
string
Wording of the job status
StatusColorText
string
Hexadecimal code for status text color
Format of the value (regular expression): #[0-9a-f]{6}
StatusColorBg
string
Hexadecimal code for the background color of the status
Format of the value (regular expression): #[0-9a-f]{6}
IsClientConfidential
boolean
Indicates if the client is confidential
Possible values: true or false
JobDateStart
date
Job start date
Date format: YYYY-MM-DD
JobDateEnd
date
Job end date (e.g. contract)
Date format: YYYY-MM-DD
JobDateHire
date
Date when the candidate starts (when hired)
Date format: YYYY-MM-DD
bClientAskForDiscretion
boolean
Indicates if the job offer is hidden
Possible values: true or false
JobSalary
string
Salary offered for the job
JobIsSelfService
boolean
Indicates if the job offer is managed by the client (self-managed)
Possible values: true or false
ShowApplyButton
boolean
Indicates if the Apply button must be displayed on the job sheet
Possible values: true or false
JSONSchedule
json
Information about the schedule (for permanent job offers only, when defined)
Example of returned data:
[
{
"WeekId": 1,
"SunStart": 480,
"SunEnd": 1020,
"MonStart": 480,
"MonEnd": 1020,
"TueStart": 480,
"TueEnd": 1020,
"WedStart": null,
"WedEnd": null,
"ThuStart": null,
"ThuEnd": null,
"FriStart": null,
"FriEnd": null,
"SatStart": null,
"SatEnd": null
}
]
Voici ce à quoi correspondent chacun des champs de ce JSON:
Name |
Type |
Description |
WeekId |
numeric |
Week number |
SunStart |
numeric |
Start time for Sunday in minutes (e.g. 480 minutes = 6 AM) |
SunEnd |
numeric |
End time for Sunday in minutes (ex. 1020 minutes = 5 PM) |
MonStart |
numeric |
Start time Monday (in minutes) |
MonEnd |
numeric |
End time Monday (in minutes) |
... |
||
SatStart |
numeric |
Start time Saturday (in minutes) |
SatEnd |
numeric |
End time Saturday (in minutes) |
JobDetailCriteria
json
Job Criteria to be displayed for the job offer details (in the job offer sheet)
Possible values: Refer to criteria page in the present section of the online help.
JobTileCriteria
json
Job criteria to be displayed in the job board tile
Possible values: Refer to criteria page in the present section of the online help
