|
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 statistics for available positions
Returns the number of current positions in the job board by function (only the first 2 function levels are returned).
URL: api/GetJobStatsByFunction
Attributes to pass to actionParameters
FilterFunction
string
Mandatory
List of "function" criteria for which we want to have only the result
Possible values: null (no filter) or following string:
For each criterion, you must provide <cgrcod>,<cchcod>,<level>
Each criterion is separated from the next one by the character ;
No need to add the character ; at the end of the list of criteria
When more than one criterion is indicated, each criterion is treated with a logical OR (combination of results)
E.g.: To return only the positions whose "function" is "Head chef":
FON,001,1
E.g.: To return only the positions where the function is "Head chef" OR the speciality is "Food industry"
FON,001,1;SPE,001,2
For more explanations about criteria, refer to the criteria page in the web services section of the online help.
Language
string
Optional
Indicates the language used to display information
Possible values: FR (French) or EN (English)
Default value: EN
Complete example of a request
{
"actionParameters": {
"FilterFunction": "FON,001,1;SPE,001,2",
"Language": "FR"
}
}
Response returned by Web service
{
"status": "success",
"data": [
{
"rownumber": 1,
"JobFunctionName": "Head chef",
"JobFunctionCount": 1,
"JobFunctionFilterJobboard": "FON,001,1",
"JobFunctionGroup": "FON",
"JobFunctionSelection": "001",
"JobFunctionGroupParent": null,
"JobFunctionSelectionParent": null,
"JobFunctionSelectionOrder": 1,
"JobFunctionSelectionParentOrder": null
},
{
"rownumber": 2,
"JobFunctionName": "Food industry",
"JobFunctionCount": 1,
"JobFunctionFilterJobboard": "FON;INF,1;SPE,001,2",
"JobFunctionGroup": "SPE",
"JobFunctionSelection": "001",
"JobFunctionGroupParent": "FON",
"JobFunctionSelectionParent": "INF",
"JobFunctionSelectionOrder": 32,
"JobFunctionSelectionParentOrder": 28
}
]
}
Here is what each field in each section of the data property corresponds to:
rownumber
integer
Rank of the result in the JSON
Possible values: 1 or higher
JobFunctionName
string
Wording of the subject criterion
JobFunctionCount
integer
Number of existing jobs in the job board
Possible values: 0 or higher
JobFunctionFilterJobboard
string
Path for the criterion
Corresponds to information structured in the same way as for the FilterFunction parameter above
General format for each level of criterion: <cgrcod>,<cchcod>,<level>
Each criterion is separated from the next one by the character ;
The character ; is not required after the last criterion
JobFunctionGroup
string
Code of the subject criterion with the lowest level
Possible values: <cgrcod> 2 or 3 characters that identify the criterion
JobFunctionSelection
string
Code of the choice ticked for the criterion with the lowest level
Possible values: <cchcod> 2 or 3 characters to identify the choice ticked for the criterion
JobFunctionGroupParent
stri
Code of the subject criterion of the parent, if section is about a level 2 child criterion
Possible values: null (if level 1 criterion) or <cgrcod> (2 or 3 characters to identify the criterion)
JobFunctionSelectionParent
string
Code of the choice ticked for the parent criterion, if the section is about a level 2 child criterion
Possible values: null (if level 1 criterion) or <cchcod> (2 or 3 characters to identify the criterion)
JobFunctionSelectionOrder
integer
Display order of the criterion with the lowest level
Possible values: 1 or higher
JobFunctionSelectionParentOrder
integer
Display order of the parent criterion
Possible values: null (if level 1 criterion) or 1 and higher
