Recruiting JobBoard API
Applications
api-jobboard-v1-vacancies-vacancyReference-applications-post
Create an application. A resume can be attached.
Create the application for the given data
Attach a resume
If you need to attach a resume to the application, you can post a multipart request as following:
Multipart structure (legacy, only support single file attachment)
| Name | Description | Content-Disposition | Content-Type |
|---|---|---|---|
| applicationJson | The application model json | form-data | |
| uploadedFile | The file content | form-data | file mime type |
Multipart structure (current, supports multiple file attachment)
| Name | Description | Content-Disposition | Content-Type |
|---|---|---|---|
| applicationJson | The application model json | form-data | |
| uploadedFileKey | The file content | form-data | file mime type |
| anotherFileKey | The file content | form-data | file mime type |
Remarks:
- The enctype of the request must be "multipart/form-data"
- The max size of a single file depends on the settings in the applicant view
- In case of multiple files attachment, you need to fill the attachment section of the payload
Anonymization
Set anonymizedFields into the QueryString to specify which fields must be anonymized (could be de-anonymize by using #deanonymize). Possible values:
- phoneNumber
- email
For multiple values, use the,character to separate them:[...]\applications?anonymizedFields=phoneNumber,email
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | EventsApplication, permission: Create |
Request
POST /api/jobboard/v1/vacancies/{vacancyReference}/applications[?creationMode&candidateLookup]
Parameters
| Name | Type | Default | Notes | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| *vacancyReference | Reference of the vacancy see identifier encoding |
||||||||||||||||||||||||||||||||||
| creationMode | The code of the candidate's creation mode. If null the back-office creation mode will be used. |
||||||||||||||||||||||||||||||||||
| candidateLookup | The flag for checking on creation if provided candidate is duplicate. By default, candidateLookup is set to true |
||||||||||||||||||||||||||||||||||
| *ApplicantApplicationDetailWrite`1 |
|
Create the application for the given data Attach a resumeIf you need to attach a resume to the application, you can post a multipart request as following: Multipart structure (legacy, only support single file attachment)
Multipart structure (current, supports multiple file attachment)
Remarks:
AnonymizationSet anonymizedFields into the QueryString to specify which fields must be anonymized (could be de-anonymize by using #deanonymize). Possible values:
Required authorization
|
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 201 |
|
The object is successfully created and saved |
|
| 400 | The object update fails |
||
| 404 | The specified vacancy doesn't exist |
Authentication
api-token-post
Request
POST /api/token
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *grant_type | The grant type. The two grant types are client_credentials and password |
||
| *client_id | The client id |
||
| *client_secret | The client secret |
||
| username | The username (only required when using password grant type) |
||
| password | The password (only required when using password grant type) |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 | Authentication succeed. |
CandidatesJobBoard
api-jobboard-v1-candidates-id-applications-get
Get candidate applications
Get a list of all applications for a candidate.
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | EventsApplication, permission: Use |
Request
GET /api/jobboard/v1/candidates/{id}/applications
Parameters
| Name | Type | Default | Notes | ||||
|---|---|---|---|---|---|---|---|
| *id | Get a list of all applications for a candidate. Required authorization
|
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 404 | Identifier doesn't exist |
ContractTypes library
api-jobboard-v1-referentials-contracttypes-get
Get all ContractTypes items
Get a list of all available ContractTypes items. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Request
GET /api/jobboard/v1/referentials/contracttypes
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-contracttypes-id-get
Get the ContractTypes item details
Get the details of a ContractTypes item, based on its client code
Request
GET /api/jobboard/v1/referentials/contracttypes/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-contracttypes-id-translations-get
Get all ContractTypes item translations
Get a list of translations of a ContractTypes item, based on its client code
Request
GET /api/jobboard/v1/referentials/contracttypes/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-contracttypes-id-translations-lcid-get
Get the specified ContractTypes item translation
Get the translation of a ContractTypes item, in a specified language, based on its client code
Request
GET /api/jobboard/v1/referentials/contracttypes/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
Countries library
api-jobboard-v1-referentials-countries-get
Get all countries
Get a list of all available countries. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/countries
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-countries-id-get
Get country details
Get the details of a country
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/countries/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the country |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-countries-id-translations-get
Get country translations
Get all translations of a country
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/countries/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the country |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-countries-id-translations-lcid-get
Get country translation details
Get the details of a country translation
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/countries/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the country |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
Department library
api-jobboard-v1-referentials-departments-get
Get all departments
Get a list of all available departments. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/departments
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-departments-id-get
Get department details
Get the details of a department.
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/departments/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the department |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-departments-id-translations-get
Get department translations
Get all translations of a department.
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/departments/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the department |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-departments-id-translations-lcid-get
Get department translation details
Get the details of a department translation.
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/departments/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the department |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
Diploma library
api-jobboard-v1-referentials-diplomas-get
Get all diplomas
Get a list of all available diplomas. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/diplomas
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-diplomas-id-get
Get diploma details
Get the details of a diploma.
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/diplomas/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the diploma |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-diplomas-id-translations-get
Get diploma translations
Get all translations of a diploma.
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/diplomas/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the diploma |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-diplomas-id-translations-lcid-get
Get diploma translation details
Get the details of a diploma translation.
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/diplomas/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the diploma |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
EducationLevels library
api-jobboard-v1-referentials-educationlevels-get
Get all EducationLevels items
Get a list of all available EducationLevels items. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Request
GET /api/jobboard/v1/referentials/educationlevels
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-educationlevels-id-get
Get the EducationLevels item details
Get the details of a EducationLevels item, based on its client code
Request
GET /api/jobboard/v1/referentials/educationlevels/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-educationlevels-id-translations-get
Get all EducationLevels item translations
Get a list of translations of a EducationLevels item, based on its client code
Request
GET /api/jobboard/v1/referentials/educationlevels/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-educationlevels-id-translations-lcid-get
Get the specified EducationLevels item translation
Get the translation of a EducationLevels item, in a specified language, based on its client code
Request
GET /api/jobboard/v1/referentials/educationlevels/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
ExperienceLevels library
api-jobboard-v1-referentials-experiencelevels-get
Get all ExperienceLevels items
Get a list of all available ExperienceLevels items. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Request
GET /api/jobboard/v1/referentials/experiencelevels
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-experiencelevels-id-get
Get the ExperienceLevels item details
Get the details of a ExperienceLevels item, based on its client code
Request
GET /api/jobboard/v1/referentials/experiencelevels/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-experiencelevels-id-translations-get
Get all ExperienceLevels item translations
Get a list of translations of a ExperienceLevels item, based on its client code
Request
GET /api/jobboard/v1/referentials/experiencelevels/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-experiencelevels-id-translations-lcid-get
Get the specified ExperienceLevels item translation
Get the translation of a ExperienceLevels item, in a specified language, based on its client code
Request
GET /api/jobboard/v1/referentials/experiencelevels/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
GeographicalAreas library
api-jobboard-v1-referentials-geographicalareas-get
Get all GeographicalAreas items
Get a list of all available GeographicalAreas items. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Request
GET /api/jobboard/v1/referentials/geographicalareas
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-geographicalareas-id-get
Get the GeographicalAreas item details
Get the details of a GeographicalAreas item, based on its client code
Request
GET /api/jobboard/v1/referentials/geographicalareas/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-geographicalareas-id-translations-get
Get all GeographicalAreas item translations
Get a list of translations of a GeographicalAreas item, based on its client code
Request
GET /api/jobboard/v1/referentials/geographicalareas/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-geographicalareas-id-translations-lcid-get
Get the specified GeographicalAreas item translation
Get the translation of a GeographicalAreas item, in a specified language, based on its client code
Request
GET /api/jobboard/v1/referentials/geographicalareas/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
JobTimes library
api-jobboard-v1-referentials-jobtimes-get
Get all JobTimes items
Get a list of all available JobTimes items. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Request
GET /api/jobboard/v1/referentials/jobtimes
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-jobtimes-id-get
Get the JobTimes item details
Get the details of a JobTimes item, based on its client code
Request
GET /api/jobboard/v1/referentials/jobtimes/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-jobtimes-id-translations-get
Get all JobTimes item translations
Get a list of translations of a JobTimes item, based on its client code
Request
GET /api/jobboard/v1/referentials/jobtimes/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-jobtimes-id-translations-lcid-get
Get the specified JobTimes item translation
Get the translation of a JobTimes item, in a specified language, based on its client code
Request
GET /api/jobboard/v1/referentials/jobtimes/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
LanguageLevels library
api-jobboard-v1-referentials-languagelevels-get
Get all LanguageLevels items
Get a list of all available LanguageLevels items. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Request
GET /api/jobboard/v1/referentials/languagelevels
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-languagelevels-id-get
Get the LanguageLevels item details
Get the details of a LanguageLevels item, based on its client code
Request
GET /api/jobboard/v1/referentials/languagelevels/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-languagelevels-id-translations-get
Get all LanguageLevels item translations
Get a list of translations of a LanguageLevels item, based on its client code
Request
GET /api/jobboard/v1/referentials/languagelevels/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-languagelevels-id-translations-lcid-get
Get the specified LanguageLevels item translation
Get the translation of a LanguageLevels item, in a specified language, based on its client code
Request
GET /api/jobboard/v1/referentials/languagelevels/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
Languages library
api-jobboard-v1-referentials-languages-get
Get all Languages items
Get a list of all available Languages items. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Request
GET /api/jobboard/v1/referentials/languages
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-languages-id-get
Get the Languages item details
Get the details of a Languages item, based on its client code
Request
GET /api/jobboard/v1/referentials/languages/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-languages-id-translations-get
Get all Languages item translations
Get a list of translations of a Languages item, based on its client code
Request
GET /api/jobboard/v1/referentials/languages/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-languages-id-translations-lcid-get
Get the specified Languages item translation
Get the translation of a Languages item, in a specified language, based on its client code
Request
GET /api/jobboard/v1/referentials/languages/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
Nationality library
api-jobboard-v1-referentials-nationalities-get
Get all Nationality items
Get a list of all available Nationality items. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Request
GET /api/jobboard/v1/referentials/nationalities
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-nationalities-id-get
Get the Nationality item details
Get the details of a Nationality item, based on its client code
Request
GET /api/jobboard/v1/referentials/nationalities/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-nationalities-id-translations-get
Get all Nationality item translations
Get a list of translations of a Nationality item, based on its client code
Request
GET /api/jobboard/v1/referentials/nationalities/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-nationalities-id-translations-lcid-get
Get the specified Nationality item translation
Get the translation of a Nationality item, in a specified language, based on its client code
Request
GET /api/jobboard/v1/referentials/nationalities/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
Profile library
api-jobboard-v1-referentials-profiles-get
Get all profiles
Get a list of all available profiles. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/profiles
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-profiles-id-get
Get profile details
Get the details of a profile.
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/profiles/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the profile |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-profiles-id-translations-get
Get profile translations
Get all translations of a profile.
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/profiles/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the profile |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-profiles-id-translations-lcid-get
Get profile translation details
Get the details of a profile translation.
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/profiles/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the profile |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
Region library
api-jobboard-v1-referentials-regions-get
Get all regions
Get a list of all available regions. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/regions
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-regions-id-get
Get region details
Get the details of a region.
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/regions/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the region |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-regions-id-translations-get
Get region translations
Get all translations of a region.
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/regions/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the region |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-regions-id-translations-lcid-get
Get region translation details
Get the details of a region translation.
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | ReferencesAdministration, permission: Use |
Request
GET /api/jobboard/v1/referentials/regions/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the region |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
Sex library
api-jobboard-v1-referentials-sexes-get
Get all Sex items
Get a list of all available Sex items. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Request
GET /api/jobboard/v1/referentials/sexes
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-sexes-id-get
Get the Sex item details
Get the details of a Sex item, based on its client code
Request
GET /api/jobboard/v1/referentials/sexes/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-sexes-id-translations-get
Get all Sex item translations
Get a list of translations of a Sex item, based on its client code
Request
GET /api/jobboard/v1/referentials/sexes/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-sexes-id-translations-lcid-get
Get the specified Sex item translation
Get the translation of a Sex item, in a specified language, based on its client code
Request
GET /api/jobboard/v1/referentials/sexes/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
Skills library
api-jobboard-v1-referentials-skills-get
Get all Skills items
Get a list of all available Skills items. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Request
GET /api/jobboard/v1/referentials/skills
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-skills-id-get
Get the Skills item details
Get the details of a Skills item, based on its client code
Request
GET /api/jobboard/v1/referentials/skills/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-skills-id-translations-get
Get all Skills item translations
Get a list of translations of a Skills item, based on its client code
Request
GET /api/jobboard/v1/referentials/skills/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-skills-id-translations-lcid-get
Get the specified Skills item translation
Get the translation of a Skills item, in a specified language, based on its client code
Request
GET /api/jobboard/v1/referentials/skills/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
Speciality library
api-jobboard-v1-referentials-specialities-get
Get all Speciality items
Get a list of all available Speciality items. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Request
GET /api/jobboard/v1/referentials/specialities
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-specialities-id-get
Get the Speciality item details
Get the details of a Speciality item, based on its client code
Request
GET /api/jobboard/v1/referentials/specialities/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-specialities-id-translations-get
Get all Speciality item translations
Get a list of translations of a Speciality item, based on its client code
Request
GET /api/jobboard/v1/referentials/specialities/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-specialities-id-translations-lcid-get
Get the specified Speciality item translation
Get the translation of a Speciality item, in a specified language, based on its client code
Request
GET /api/jobboard/v1/referentials/specialities/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
Title library
api-jobboard-v1-referentials-titles-get
Get all Title items
Get a list of all available Title items. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
Request
GET /api/jobboard/v1/referentials/titles
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
api-jobboard-v1-referentials-titles-id-get
Get the Title item details
Get the details of a Title item, based on its client code
Request
GET /api/jobboard/v1/referentials/titles/{id}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-titles-id-translations-get
Get all Title item translations
Get a list of translations of a Title item, based on its client code
Request
GET /api/jobboard/v1/referentials/titles/{id}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of objects is returned with success |
|
| 400 | Query not correct |
||
| 404 | Client code doesn't exist |
api-jobboard-v1-referentials-titles-id-translations-lcid-get
Get the specified Title item translation
Get the translation of a Title item, in a specified language, based on its client code
Request
GET /api/jobboard/v1/referentials/titles/{id}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *id | Client code of the referential |
||
| *lcid | Language id |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Language not present in the application |
VacanciesJobBoard
api-jobboard-v1-vacancies-get
Get all vacancies
Get a list of all available vacancies. If offset and limit provided, it will return only the ones between the interval.
QueryString
| Parameters | Description |
|---|---|
| offset & limit | Pagination enabled |
| q | query search |
| filter | Filters enabled |
Filter available
| Filter name | Description | Operator available | Value type |
|---|---|---|---|
| vacancyStatus | filter vacancies by vacancy status enum value | :: , | string Archived Confirmed Draft Finalized PendingPublication Published Suspended |
| clientVacancyStatus | filter vacancies by vacancy status identifier | :: | string |
| publicationMedia | filter vacancies by publication media | :: | string |
| publishedOnTheMedia | filter vacancies by currently published on a specific media | :: | string |
| updateDate | filter vacancies by modification date (or creation date, if no modification date exists) | ::, :gt:, :ge:, :lt:, :le: | date |
Required authorization
| Type | Value(s) |
|---|---|
| Role | OffersEngine |
Request
GET /api/jobboard/v1/vacancies
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
api-jobboard-v1-vacancies-vacancyReference-get
Get the vacancy details
Get the details of a vacancy, in the language of the initial translation, based on its reference
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | OfferDetails, permission: Use |
Request
GET /api/jobboard/v1/vacancies/{vacancyReference}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *vacancyReference | Reference of the vacancy see identifier encoding |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 404 | The specified vacancy doesn't exist |
api-jobboard-v1-vacancies-vacancyReference-attachments-get
Get vacancy attachments
Get a list of all attachments for a vacancy.
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | AttachedFilesOffer, permission: Use |
Request
GET /api/jobboard/v1/vacancies/{vacancyReference}/attachments
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *vacancyReference | Reference of the vacancy |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Identifier doesn't exist |
api-jobboard-v1-vacancies-vacancyReference-attachments-fileId-get
Get vacancy attachment
Get specific vacancy attachment for given reference
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | AttachedFilesOffer, permission: Use |
Request
GET /api/jobboard/v1/vacancies/{vacancyReference}/attachments/{fileId}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *vacancyReference | Reference of the vacancy |
||
| *fileId | Identifier of the file |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 | object | The object is returned with success |
|
| 400 | Query not correct |
||
| 404 | Identifier doesn't exist |
api-jobboard-v1-vacancies-vacancyReference-supervisors-get
Get the vacancy supervisors
Get a list of supervisors of a vacancy, based on its reference
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | OfferDetails, permission: Use |
Request
GET /api/jobboard/v1/vacancies/{vacancyReference}/supervisors
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *vacancyReference | Reference of the vacancy see identifier encoding |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The list of offer supervisors is returned with success |
|
| 404 | The vacancy is not found |
api-jobboard-v1-vacancies-vacancyReference-translations-get
Get all vacancy translations
Get a list of translations of a vacancy, based on its reference
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | TranslationOffer, permission: Use |
Request
GET /api/jobboard/v1/vacancies/{vacancyReference}/translations
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *vacancyReference | Reference of the vacancy see identifier encoding |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The object is returned with success |
|
| 404 | The specified vacancyReference doesn't exist |
api-jobboard-v1-vacancies-vacancyReference-translations-lcid-get
Get the specified vacancy translation
Return the translation of a vacancy, in a specified language, based on its reference
Required authorization
| Type | Value(s) |
|---|---|
| Ressource | TranslationOffer, permission: Use |
Request
GET /api/jobboard/v1/vacancies/{vacancyReference}/translations/{lcid}
Parameters
| Name | Type | Default | Notes |
|---|---|---|---|
| *vacancyReference | Reference of the vacancy see identifier encoding |
||
| *lcid | The language ID |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
The translation is returned with success |
|
| 404 | The translation doesn't exist |
Definitions
ApplicantApplicationDetailWrite_CandidateDetailWrite
Application details
| Name | Type | Notes |
|---|---|---|
| candidateInformation |
|
The candidate information |
| gdprInformation |
|
The GDPR information |
CandidateDetailWrite
The candidate information
| Name | Type | Notes |
|---|---|---|
| lastName | string | The last name |
| firstName | string | The first name |
| middleName | string | The middle name |
| sexId | string | Sex identifier. |
| string | The email |
|
| phoneNumber | string | The candidate phone number |
| civilityId | string | The candidate civility identifier (The referential type accepted is Civility) |
| personalInformation |
|
The candidate personal information |
| jobPreferences |
|
The candidate job preferences |
| languages |
|
The candidate language |
| educations |
|
The candidate education |
| experiences |
|
The candidate experience |
| attachments |
|
Describe the file attachments |
CandidatePersonalInformationWrite
The candidate personal information
| Name | Type | Notes |
|---|---|---|
| birthDate | string (date-time) | The candidate birth date |
| nationalities | array | The candidate nationalities identifiers (The referential type accepted is Nationality) |
| address | string | The candidate address |
| postalCode | string | The candidate postal code |
| city | string | The candidate city |
| residentCountryId | string | The candidate country identifier (The referential type accepted is Country) |
| specialEmploymentRegulationsInFrance |
|
SpecialEmploymentRegulationsInFrance
| Name | Type | Notes |
|---|---|---|
| disabledWorkerStatus | boolean | I have the French disabled worker status (RQTH). |
| priorityNeighbourhood | boolean | I hereby declare that I reside in a French priority neighbourhood (QPV / "Emploi Franc"). |
CandidateJobPreferencesWrite
The candidate job preferences
| Name | Type | Notes |
|---|---|---|
| primaryProfileId | string | The candidate primary profile identifier (The referential type accepted is Profile) |
| dateOfAvailability | string (date-time) | The candidate date of availability |
| salaryExpectations | string | The candidate salary expectations |
| jobTimeId | string | Wished load of job time. |
| contractLength | string | Contract length wished. |
| contractTypeId | string | Contract Type. |
CandidateLanguageWrite
The candidate language
| Name | Type | Notes |
|---|---|---|
| languageId | string | The candidate language identifier (The referential type accepted is Language) |
| languageLevelId | string | The candidate language level identifier (The referential type accepted is LanguageLevel) |
CandidateEducationWrite
The candidate education
| Name | Type | Notes |
|---|---|---|
| diplomaId | string | The candidate diploma identifier (The referential type accepted is Diploma) |
| educationLevelId | string | The education level identifier of the diploma (The referential type accepted is Education Level) |
CandidateExperienceWrite
The candidate experience
| Name | Type | Notes |
|---|---|---|
| experienceLevelId | string | The candidate experience level identifier (The referential type accepted is ExperienceLevel) |
| profileId | string | The profile identifier of the experience (The referential type accepted is Profile) |
| company | string | The company under which the experience was acquired |
| function | string | The function performed during the experience |
| contractTypeId | string | The contract identifier (The referential type accepted is ContractType) |
CandidateAttachmentWrite
Describe the file attachments
| Name | Type | Notes |
|---|---|---|
| description | string | |
| key | string | |
| fileType | string |
GdprInformation
The GDPR information
| Name | Type | Notes |
|---|---|---|
| personalDataConsentReceived | boolean | The personal data consent |
| retentionDelay | integer (int32) | The retention delay. Should be null by default |
WrappedResponse_ApplicationDetailWriteResponse
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
ApplicationDetailWriteResponse
The response data
| Name | Type | Notes |
|---|---|---|
| candidateInformation |
|
The candidate information |
| gdprInformation |
|
The GDPR information |
| id | string | The Identifier of the Application |
CandidateDetailWriteResponse
The candidate information
| Name | Type | Notes |
|---|---|---|
| id | string | The Identifier of the applicant |
| lastName | string | The last name |
| firstName | string | The first name |
| middleName | string | The middle name |
| sexId | string | Sex identifier. |
| string | The email |
|
| phoneNumber | string | The candidate phone number |
| civilityId | string | The candidate civility identifier (The referential type accepted is Civility) |
| personalInformation |
|
The candidate personal information |
| jobPreferences |
|
The candidate job preferences |
| languages |
|
The candidate language |
| educations |
|
The candidate education |
| experiences |
|
The candidate experience |
| attachments |
|
Describe the file attachments |
WrappedResponse_IEnumerable_SimpleCandidateApplication
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
SimpleCandidateApplication
The response data
| Name | Type | Notes |
|---|---|---|
| applicationDate | string (date-time) | Application creation date |
| status | string | Status of the application |
| vacancy |
|
Vacancy |
| applicationId | string | The identifier of the application |
Reference
Vacancy
WrappedResponse_SimpleReferentialArray
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
SimpleReferential
The response data
| Name | Type | Notes |
|---|---|---|
| orderNumber | integer (int32) | The referential order number |
| languageId | integer (int32) | The referential language id |
| id | string | The referential identifier |
| label | string | The referential label |
WrappedResponse_SimpleReferential
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
WrappedResponse_CountryReferentialArray
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
CountryReferential
The response data
| Name | Type | Notes |
|---|---|---|
| languageId | integer (int32) | |
| orderNumber | integer (int32) | |
| geographicalArea |
|
Referencing object |
| id | string | |
| label | string |
WrappedResponse_CountryReferential
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
WrappedResponse_DepartmentReferentialArray
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
DepartmentReferential
The response data
| Name | Type | Notes |
|---|---|---|
| languageId | integer (int32) | |
| orderNumber | integer (int32) | |
| region |
|
Referencing object |
| id | string | |
| label | string |
WrappedResponse_DepartmentReferential
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
WrappedResponse_DiplomaReferentialArray
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
DiplomaReferential
The response data
| Name | Type | Notes |
|---|---|---|
| languageId | integer (int32) | |
| level | integer (int32) | |
| parent |
|
Referencing object |
| id | string | |
| label | string |
WrappedResponse_DiplomaReferential
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
WrappedResponse_ProfileReferentialArray
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
ProfileReferential
The response data
| Name | Type | Notes |
|---|---|---|
| languageId | integer (int32) | |
| orderNumber | integer (int32) | |
| jobFamily |
|
Referencing object |
| id | string | |
| label | string |
WrappedResponse_ProfileReferential
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
WrappedResponse_RegionReferentialArray
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
RegionReferential
The response data
| Name | Type | Notes |
|---|---|---|
| languageId | integer (int32) | |
| orderNumber | integer (int32) | |
| country |
|
Referencing object |
| id | string | |
| label | string |
WrappedResponse_RegionReferential
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
WrappedResponse_IEnumerable_VacancySummary
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
VacancySummary
The response data
| Name | Type | Notes |
|---|---|---|
| languageId | integer (int32) | The tranlation language of the object |
| status |
|
The vacancy status |
| jobTime |
|
The vacancy job time |
| salaryRange |
|
The vacancy salary range |
| contractType |
|
The vacancy contract type |
| contractLength | string | The vacancy contract length |
| primaryProfile |
|
The vacancy primary profile |
| geographicalArea |
|
The vacancy geographical area |
| country |
|
The vacancy country |
| region |
|
The vacancy region |
| department |
|
The vacancy department |
| address | string | The vacancy address |
| diploma |
|
The vacancy diploma |
| educationLevel |
|
The vacancy education level |
| experienceLevel |
|
The vacancy experience level |
| organisation |
|
The vacancy organisation |
| modificationDate | string (date-time) | The vacancy modification date |
| creationDate | string (date-time) | The vacancy creation date |
| vacancyCareerUrl | string | The url of the vacancy on the Candidate FrontOffice |
| reference | string | The vacancy reference |
| title | string | The vacancy job title |
WrappedResponse_VacancyDetailRead
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
VacancyDetailRead
The response data
| Name | Type | Notes |
|---|---|---|
| languageId | integer (int32) | The translation language of the object |
| organisation |
|
The vacancy organization |
| candidateRedirectionUrl | string | The candidate redirection url |
| creationDate | string (date-time) | The vacancy creation date |
| modificationDate | string (date-time) | The vacancy modification date |
| requestingParty |
|
The vacancy requesting party object |
| location |
|
The vacancy location object |
| criteria |
|
The candidate criteria object |
| jobDescription |
|
The job description object |
| languages |
|
The languages |
| reference | string | The vacancy reference |
VacancyOriginRead
The vacancy requesting party object
| Name | Type | Notes |
|---|---|---|
| beginningDate | string (date-time) | The vacancy beginning date |
VacancyLocationRead
The vacancy location object
| Name | Type | Notes |
|---|---|---|
| geographicalArea |
|
The vacancy geographical area |
| country |
|
The vacancy country |
| region |
|
The vacancy region |
| department |
|
The vacancy department |
| address | string | The vacancy address |
| latitude | number (double) | The vacancy latitude |
| longitude | number (double) | The vacancy longitude |
VacancyCriteriaRead
The candidate criteria object
| Name | Type | Notes |
|---|---|---|
| freeCriteria1 | string | The vacancy free criteria 1 |
| freeCriteria2 | string | The vacancy free criteria 2 |
| diploma |
|
The vacancy diploma |
| educationLevel |
|
The vacancy education level |
| experienceLevel |
|
The vacancy experience level |
| specialisations |
|
The specialisations object list |
| skills |
|
The skills object list |
VacancyJobDescriptionRead
The job description object
| Name | Type | Notes |
|---|---|---|
| description1 | string | The vacancy description 1 |
| description1HTML | string | The vacancy description 1 formatted |
| description2 | string | The vacancy description 2 |
| description2HTML | string | The vacancy description 2 formatted |
| jobTime |
|
The vacancy job time |
| salaryRange |
|
The vacancy salary range |
| contractType |
|
The vacancy contract type |
| contractLength | string | The vacancy contract length |
| primaryProfile |
|
The vacancy primary profile |
| secondaryProfiles |
|
The secondary profiles object list |
| professionalCategory |
|
The profesional category |
| title | string | The vacancy title |
VacancyLanguageRead
The languages
| Name | Type | Notes |
|---|---|---|
| language |
|
The language |
| languageLevel |
|
The language level |
WrappedResponse_IEnumerable_AttachedFile
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
AttachedFile
The response data
WrappedResponse_ICollection_Supervisor
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
Supervisor
The response data
| Name | Type | Notes |
|---|---|---|
| phoneNumber | string | The phone number |
| isMainSupervisor | boolean | A value indicating whether this instance is main supervisor |
| login | string | The login |
| lastName | string | The last name |
| firstName | string | The first name |
| string | The email |
WrappedResponse_ICollection_VacancyTranslation
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |
VacancyTranslation
The response data
| Name | Type | Notes |
|---|---|---|
| languageId | integer (int32) | |
| criteria |
|
The candidate criteria object |
| jobDescription |
|
The job description object |
VacancyCriteriaTranslation
The candidate criteria object
| Name | Type | Notes |
|---|---|---|
| freeCriteria1 | string | The vacancy free criteria 1 |
| freeCriteria2 | string | The vacancy free criteria 2 |
VacancyJobDescriptionTranslation
The job description object
| Name | Type | Notes |
|---|---|---|
| description1 | string | The vacancy description 1 |
| description2 | string | The vacancy description 2 |
| title | string | The vacancy title |
WrappedResponse_VacancyTranslation
Wrapped response
| Name | Type | Notes |
|---|---|---|
| data |
|
The response data |
| status | string | The response status |
| message | string | The message |
| contentRange | string | The content range |
| code | string | The http status code |