Get statistics about available candidates



Returns the number of candidates currently available by function (only the first 2 function levels are returned)

URL: api/GetCandidateStatsByFunction

 

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 ;

The character ; is not required after the last criterion

When more than one criterion is specified, each criterion is processed with a logical OR  (combination of results)

E.g.: To return only the candidates whose "function" is "Head chef":

FON,001,1

E.g.: To return only the candidates whose "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 the 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
        },
        {
            "rownumber": 2,
            "JobFunctionName": "Food industry",
            "JobFunctionCount": 1,
            "JobFunctionFilterJobboard": "FON;INF,1;SPE,001,2",
            "JobFunctionGroup": "SPE",
            "JobFunctionSelection": "001",
            "JobFunctionGroupParent": "FON",
            "JobFunctionSelectionParent": "INF"
        }
    ]
}

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 available candidates for this criterion

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 criteria: <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 to identify the criterion)

---

 

JobFunctionSelection

string

Code of the choice ticked for the criterion with the lowest level choix coché pour le critère ayant le niveau le plus bas

Possible values: <cchcod> 2 or 3 characters to identify the choice ticked for the criterion

---

 

JobFunctionGroupParent

string

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 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)

---