Please enable JavaScript to view this site.

PRIM Help

 

 

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.

 

Obtain active jobs from the job board



Allows you to obtain the list of active job offers (job board)

URL: /api/Jobs

 

Attributes to pass to actionParameters

 


Language

string

Optional

Language in which data is displayed

Possible values: EN (English) or FR (French)

Default value: EN

 


FilterDivision

string

Optional

Restricts display of data to the specified divisions

For each division, we pass the division number (divcod).

Each number is separated from the next one with character ;. This character is not added after the last division.

Possible values: null (return job offers for all divisions) or a string as in the example below

Default value: null

Ex. To return only job offers for divisons 1 or 6

{
    "FilterDivision": "1,6"
}


IncludePermanent

bit

Optional

Includes permanent jobs (job offers)

Possible values: 0 (no) or 1 (yes)

Default value: 1


IncludeContract

bit

Optional

Includes contractual jobs (job offers)

Possible values: 0 (no) or 1 (yes)

Default value: 1


IncludeInternship

bit

Optional

Includes internship type jobs (job offers)

Possible values: 0 (no) ou 1 (yes)

Default value: 1


IncludeTempJob

bit

Optional

Includes shifts

Possible values: 0 (no) ou 1 (yes)

Default value: 1


JobId

integer

Optional

Returns only the job with ID (poscod/remcod) corresponding to the provided value

Must be used in conjunction with one of the following fields with a value of  1 for job offers:

IncludePermanent

IncludeContract

IncludeInternship

and for shifts:

IncludeTempJob

Possible values: null (returns all job offers) or 1 and above

Default value: null


FilterCriteria

json

Optional

Returns job offers corresponding to the provided criteria

Possible values: See examples in the page about criteria in this section of online help

Default value: null (returns all job offers, no matter what are the criteria for the job)

Note:

1.If more than one criterion is specified, the various criteria will be processed with a logical AND  (intersection of results)

2.The maximum number of criteria that can be used at the same time is 256.

 


FilterPriority

integer

Optional

Filters the job offers returned according to their level of priority. To display only featured items, for example

Possible values: 1 to 5

Default value: 3


FilterWordTitle

string

Optional

Returns the jobs containing the specified words (keywords search) in the title only

Possible values: null or <any word with or without accent>

Default value: null (all jobs without restriction)

 

Notes:

If your filter contains more than one word, the search will return the jobs containing the exact string.

The search make no difference between words with or without accents

Upper case or lower case wil make no difference

Ex.: "Montréal Qc" will return all jobs with title including exactly:

oMontréal Qc

oMontreal Qc

omontréal qc

omontreal qc

obut not Montréal, Qc (note the comma on the right of the word Montréal)


FilterByClientId

integer

Optional

Returns only jobs from clients with ID (clicod) taht does match the given value

Possible values: null or 1 and more

Default value: null (returns job offers from all clients)


CurrentLocationLongitude

float

Optional

Longitude in decimal degrees of the coordinate of a place

Possible values: -180 to 180, negative values being to the West of the Greenwich Meridian

CurrentLocationLatitude

float

Optional

Latitude in decimal degrees of the coordinate of a place

Possible values: -90 to 90, negative values being in the Southern Hemisphere

FilterDistanceKM

integer

Optional

Number of kilometers from the above location

Possible values: 1 or higher

 

The combination of these 3 fields returns jobs where the workplace is located in a circle whose center coordinate is

(CurrentLocationLongitude, CurrentLocationLatitude)

the radius of which is

FilterDistanceKM

 

The longitude/latitude are expressed in decimal degrees and the radius in kilometers. The longitude/latitude are in reference to the NAD83 datum,

 

Important

When specifying a coordinate and a radius, it is important to understand that only jobs with a valid address that have been geolocated by the MapBox/Google Maps system will be returned. An invalid address returns the coordinate (0, 0) and an address not yet geolocated returns the coordinate (null, null)


JobRowStart

integer

Optional

Indicates from which line jobs are returned

Use to paginate results

Possible value: 1 or higher

Default value: 1


JobRowEnd

integer

Optional

Indicates up to which line the jobs are returned

Use to paginate results

Possible value: 1 or higher

Default value: 1000000


Complete example:

{
    "actionParameters":
    {
        {
            "Language": "EN",
            "FilterDivision": 1,
            "IncludePermanent": 1,
            "IncludeContract": 0,
            "IncludeInternship": 0,
            "JobId": 1919,
            "FilterCriteria": [{
                "type": "Full",
                "cgrcod": "REG",
                "cchcod": "MTL",
                "SearchOption": 1
            }],
            "FilterPriority": 4,
            "FilterWordTitle": "snow",
            "FilterByClientId": 22,
            "CurrentLocationLongitude": -73.5,
            "CurrentLocationLatitude": 45.5,
            "FilterDistanceKM": 1000
        }
    }
}

 

 

 

Response returned by Web service


{
    "status": "success",
    "data": [
        {
            "rownumber": 1,
            "JobInternalNumber": 1306716,
            "JobID": 1919,
            "JobTypeContract": "P",
            "JobTitle": "Snow remover",
            "JobSummary": null,
            "JobSummaryWithHTML": null,
            "JobUrl": "https://dev-bravo.primlogix.com/jobs/view/snow-remover/1919/P/en",
            "JobCreationDate": "2022-10-11",
            "JobPriority": 1,
            "JobStatus": "VACANT",
            "IsConfidential": true,
            "JobClientName": null,
            "JSONCliWebsite": [
                {
                    "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": "Site Web",
                    "url": "www.primlogix.com"
                }, {
                    "wstcod": "TW",
                    "Nom": "Twitter",
                    "url": "www.twitter.com"
                }
            ],
            "JobCity": "Boucherville",
            "JobAddress": "678, rue du Bosquet",
            "JobOfficeNumber": null,
            "JobStateCode": "QC",
            "JobStateName": "Quebec",
            "JobCountryCode": "CA",
            "JobCountryName": "Canada",
            "JobPostalCode": null,
            "JobLongitude": -73.4102181,
            "JobLatitude": 45.5853337,
            "DistanceFromCurrentLocationMeter": -1,
            "JobIdClientLogo": 36290,
            "JobFileNameClientLogo": "LogoPRIM.png",
            "JobFileEntityId": 3757,
            "DivisionId": 1,
            "DivisionName": "Intégration Inc.",
            "ScheduleFirstday": 7,
            "ScheduleDay1": 0,
            "ScheduleDay2": 0,
            "ScheduleDay3": 0,
            "ScheduleDay4": 0,
            "ScheduleDay5": 0,
            "ScheduleDay6": 0,
            "ScheduleDay7": 0,
            "JobTileCriteria": [
                {
                    "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":"DIPLOMA",
                    "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":"LOGICIEL",
                    "Choices":
                    [
                        {
                            "Choice":"Other"
                        }
                    ]
                }
            ],
            "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":"DIPLOMA",
                    "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 in each section of the data property corresponds to:

rownumber

integer

Indicates the rank of the job in the JSON

Possible values: 1 or higher


JobInternalNumber

integer

Unique identifier of the job offer in the database (idrcod)

Possible values: 1 or higher


JobID

integer

Job offer/shift ID in the DB table (poscod/remcod)

Possible values: 1 or higher


JobTypeContract

string

Letter identifying the type of job

Possible values: P (Permanent), C (Contractual), I (Internship) or T (Temporary)


JobTitle

string

Job title


JobSummary

string

Summary of the job offer in plain text


JobSummaryWithHTML

string

Summary of job offer in HTML code


JobUrl

string

URL of the job offer sheet in PRIMWeb


JobCreationDate

string

Date of job creation

Date format: YYYY-MM-DD


JobPriority

integer

Type of job posting priority

Possible values: 1 to 5


JobStatus

string

Exact wording of the status of the job offer (will vary depending on your agency's configuration). Typically, the job posted will be the ones with status VACANT


IsConfidential

boolean

Indicates if the job offer is confidential

Possible values: true or false


JobClientName

string

Client's name (if the configuration allows the client's name to be displayed in the job board)


JSONCliWebsite

json

Contains the list of URLs of the client's social networks (if the configuration allows the client's name to be displayed in the job board)

For example:

[
      {
          "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":"Site Web",
          "url":"www.primlogix.com"
      }
      ,{
          "wstcod":"TW",
          "Nom":"Twitter",
          "url":"www.twitter.com"
      }
]

Note

If a social network is not defined for a client, the section of this social network (wstcod) will not be returned


JobCity

string

Location of the job


JobAddress

string

Address of the job (if the configuration allows it to be displayed)

Generally, the civic number and the street


JobOfficeNumber

string

Apartment, office or room number (if the configuration allows it to be displayed)


JobStateCode

string

ISO 3166-2 code for the province/state


JobStateName

string

Name of the province/state


JobCountryCode

string

ISO 3166-1 Alpha-2 code for the country


JobCountryName

string

Country name


JobPostalCode

string

Postal code/Zip code


JobLongitude

float

Longitude in decimal degrees of the workplace

Possible values: null or -180 to 180 (a negative value is west of the Greenwich Meridian)

This data is displayed if the workplace address is configured to be displayed, valid for MapBox/Google Maps services and if the address has already been geolocated


JobLatitude

float

Latitude in decimal degrees of the place of employment

Possible values: -90 to 90 (a negative value is in the southern hemisphere)

 

This data is displayed if the workplace address is configured to be displayed, valid for MapBox/Google Maps services and if the address has already been geolocated


DistanceFromCurrentLocationMeter

integer

Distance in meters as the crow flies between the location  of this job and the location provided in the distance filter

Possible values: -1 (not available) or 1 and higher

Note

If the workplace address for the job/shift has not yet been geolocated or is invalid, the value -1 is returned


JobIdClientLogo

integer

Identifier of the image in the blob for the client's logo (blobId)

This information is needed to retrieve the image with the GetFileBlob web service

Possible values: 1 or higer


JobFileNameClientLogo

string

Client's logo file name (fsfname)


JobFileEntityId

integer

Client logo file owner identifier (idrcod)

This information is needed to retrieve the image with the GetFileBlob web service


DivisionId

integer

Division ID (divcod)

Possible values: 1 or higher


DivisionName

string

Division name


ScheduleFirstday

numeric

Number for the first day of the week

Possible values: 7 (sunday) or 1 (Monday)


ScheduleDay1

float

Number of decimal hours in the schedule for the 1st day of the week (for job offers with defined schedule only)


ScheduleDay2

float

Number of decimal hours in the schedule for the 2nd day of the week  (for job offers with defined schedule only)


ScheduleDay3

float

Hours for the 3rd day of the week


ScheduleDay4

float

Hours for the 4th day of the week


ScheduleDay5

float

Hours for the 5th day of the week


ScheduleDay6

float

Hours for the 6th day of the week


ScheduleDay7

float

Hours for the 7th day of the week


JobTileCriteria

json

Job/Shift criteria to be displayed in the job board tiles

See the criteria page in this section of the online help for an example of the data returned


JobDetailCriteria

json

Criteria associated with the job/shift that should be displayed in the detail of the job offer/shift sheet

See the criteria page in this section of the online help for an example of the data returned

Created with Help+Manual 8 and styled with Premium Pack Version 4 © by EC Software