openapi: 3.0.1
info:
title: Cegid Talentsoft Recruiting FrontOffice API
description: "## Introduction\r\nWelcome to the Cegid Talentsoft Recruiting APIs!\r\n\r\nThese APIs represent, through several endpoints, the several actions that a candidate (_or an employee_) can perform through a **Cegid Talentsoft Recruiting Front Office** portal.\r\n\r\n### APIs specifications by topic:\r\n\r\n#### Availability\r\n* In order to access the APIs, you should target a Front Office site through its URL along with:\r\n
http://[front-office-url]/api/v{number}/{endpoint}
\r\n* In the previous example, {number} corresponds to the version of the API and {endpoint} to the action you are calling.\r\n* The API will respect the targeted Front Office configuration to generate a response (_unless indicated otherwise_).\r\n* If the targeted Front Office site is secured (_it uses HTTPS protocol_), you should use https:// when calling any API endpoint.\r\n\r\n#### Language\r\n* The official language of the APIs is **English**: all the objects returned by the API (_or sent back to it_) contain properties named only in English.\r\n* The content of the response will depend on the authentication method:\r\n * If you are authenticated \"as a user\", it will be the language of the user account. \r\n If you do not want to use the user's language, you can use the **lang** query parameter to specify another one (ex. **?lang=en-US**)\r\n * If you are authenticated \"as an application\", it will be the language provided in the **Accept-Language** request header.\r\n* The APIs will fall back to the targeted Front Office default language if the **lang** query parameter or the **Accept-Language** request header are missing. The same will happen if they make reference to a language that is not available in the targeted Front Office.\r\n\r\n#### Authorization\r\n* In order to interact with the APIs, the application will need to be identified through a client_id and a client_secret.\r\n* You can generate many client_ids and client_secrets for a particular Front Office through the Cegid Talentsoft Recruiting Back Office page.\r\n* If you are developing a website, don't forget to add your URL into the whitelist section in the Cegid Talentsoft Recruiting Back Office page.\r\n* All your calls to the APIs should send a Token (to identify your application).\r\n* To get a Token, visit the [Authentication](#api-Authentication) section.\r\n\r\n#### Response and Request formats\r\n* These APIs work only with JSON as their transport format.\r\n* All JSON properties are named in camel case starting by lower case (e.g. customFields).\r\n* Dates follow the ISO 8601 standard.\r\n\r\n## Implementation recommendations \r\n\r\nThe implementer must comply with Cegid Talentsoft's general terms of use. In order to reduce the number of requests, please abide by the following recommendations: \r\n\r\n#### Global: \r\n\r\n* The number of API calls must be kept to a minimum. \r\n* Errors must be corrected. \r\n\r\n#### Authentication: \r\n\r\n* Request only one token for a given user session. Avoid requesting a new token between each API call and only request a new token when the current one has expired (20-minute duration). \r\n* The token request should be made by the server. If an api/token call is made from a browser, then the client_id & client_secret are shared with the end user, which is not recommended for security reasons. The token should therefore be obtained from a backchannel request. \r\n\r\n#### Library (/api/v2/referential/*): \r\n\r\n* You can retrieve all libraries in a single request. \r\n* Retrieving all libraries in a single request can generate a large response (several megabytes). \r\n* The number of calls must be limited. \r\n* Library retrieval API calls must be cached to limit the number of calls made. \r\n* You must use pagination with reasonable values (do not exceed 500 items per page). \r\n* Library data does not change very often. \r\n* Saving library data using a persistence solution such as local storage helps reduce the number of API calls to the service. \r\n* You may also request several library types in one query (see here). \r\n\r\n#### Retrieving vacancies (/api/v2/offersummaries): \r\n\r\n* Vacancy endpoints are only designed for performing searches, and not for exports.\r\n* It is recommended to avoid making calls with a high count parameter.\r\n* Implementation of this behaviour may lead to an API key rate limit or a ban on a given IP address. \r\n* We recommend displaying a maximum of 50 vacancies per page. \r\n\r\n \r\n\r\n### Error codes\r\n\r\nError messages of type 400 (Bad Request) and 409 (Conflict) return a standardized error code. This code is embedded in the header \"X-TS-ErrorCode\" of the Http response.\r\n\r\n## Cinematics\r\n\r\n#### Cinematic of API calls to search offers and display one:\r\n1. Retrieve a token \"as an application\" (grant_type=credentials): **POST** `/api/token`\r\n2. Search for offers: **GET** `api/v2/offersummaries?count=X`\r\n3. Display one offer: **GET** `api/v2/offers/getoffer?reference=[reference]`\r\n\r\n#### Cinematic of API calls to apply without account:\r\n1. Make sure the option is activated on the environment.\r\n2. Retrieve a token \"as an application\" (grant_type=credentials): **POST** `/api/token`\r\n3. Create the application: **POST** `api/v2/applicants/applicationswithoutaccount` (see attached json file)\r\n\r\n#### Cinematic of API calls to apply with account:\r\n1. Retrieve a token \"as an application\" (grant_type=credentials): **POST** `/api/token`\r\n2. Create an account: **POST** `api/v2/accounts`\r\n3. Retrieve a token \"as a user\" (grant_type=password): **POST** `/api/token` using the username and password used in step 2.\r\n4. Create the applicant: **POST** `api/v2/applicants` (see attached json file)\r\n5. Upload the applicant files: **POST** `api/v2/applicants/files`\r\n6. Create the application: **POST** `api/v2/applicants/applications` (see attached json file)\r\n\r\n\r\n\r\n## Identifier Encoding\r\nOffer references may be generated by the Cegid Talentsoft Recruiting system or entered by a user and so there is few restriction on characters that could be used. Several characters may cause issues when used in url so we need to encode references with this procedure. \r\nUrl encode the reference Search and replace ```%``` by ```!```\r\nExamples: \r\n\r\n```2019-Manager H/F -> 2019-Manager%20H%2FF -> 2019-Manager!20H!2FF```\r\n\r\n## How to\r\n\r\n#### How to retrieve a token\r\n\r\n1. **\"As an application\":**\r\n * **POST** `/api/token HTTP/1.1`\r\n * **Host:** [front-office-url]\r\n * **Cache-Control:** no-cache\r\n * **Content-Type:** application/x-www-form-urlencoded\r\n\r\n client_id=[clientID]&client_secret=[clientSecret]&grant_type=client_credentials\r\n\r\n2. **\"As a user\":**\r\n * **POST** `/api/token HTTP/1.1`\r\n * **Host:** [front-office-url]\r\n * **Cache-Control:** no-cache\r\n * **Content-Type:** application/x-www-form-urlencoded\r\n\r\n * client_id=[clientID]&client_secret=[clientSecret]&grant_type=password&username=[username]&password=[password]\r\n\r\n#### How to search vacancies by geolocation\r\n\r\n1. Make sure the option is activated on the environment and that a Google Maps key was provided to Cegid Talentsoft.\r\n2. Retrieve a token \"as an application\" (grant_type=credentials): **POST** `/api/token`\r\n3. Search for vacancies: **GET** `api/v2/offersummaries?latitude=[latitude]&longitude=[longitude]&radius=[radius]`\r\n\r\n#### How to set up the redirection url from jobboards\r\n\r\nWhen a candidate consults an offer on a jobboard, he is redirected to Cegid Talentsoft to postulate.\r\nThus, an url needs to be set up to catch 3 parameters (offerReference, idOrigine and LCID).\r\n\r\nThis url will make an API call to **GET** `api/v2/offers/getoffer?reference=[offerReference]` and display the offer. The idOrigine must be kept and filled in the \"origin\" property of the object Application.\r\n\r\nThe LCID can be used to set up the Accept-Language property of the request header.\r\n\r\n#### Authorized file extensions\r\n\r\ndoc, docx, pdf, txt, rtf, odt, html, jpg\r\n\r\n#### How to fast apply\r\n\r\nThe idea is to propose a single form that, when filed out and validated by the candidate, will on the fly:\r\n* Create his account\r\n* Create his candidate file\r\n* Upload his attached file (Resume and cover letter)\r\n* Create his application\r\n\r\n1. Make sure the option to generate a password automatically is activated on the environment.\r\n2. Retrieve a token \"as an application\" (grant_type=credentials): **POST** `/api/token`\r\n3. Create an account: **POST** `api/v2/accounts`\r\n4. Retrieve a token \"as a user\" (grant_type=password): **POST** `/api/token` using the username and password used in step 2.\r\n5. Create the candidate: **POST** `api/v2/applicants` (see attached json file)\r\n6. Upload the candidatefiles: **POST** `api/v2/applicants/files`\r\n7. Create the application: **POST** `api/v2/applicants/applications` (see attached json file)\r\n\r\n#### Points of attention\r\n\r\nWhen retrieving organisations, the number of levels returned depend on a back office setting.\r\n\r\n#### List of all supported languages\r\n\r\n| LCID | Language | Abbreviation |\r\n| :--- | :--------------------- | :----------- |\r\n| 1029 | Czech | cs |\r\n| 1030 | Dansk | da |\r\n| 1031 | German | de-DE |\r\n| 1032 | Greek | el-GR |\r\n| 1033 | Engish (United States) | en-US |\r\n| 1035 | Finnish | fi |\r\n| 1036 | French (France) | fr-FR |\r\n| 1038 | Hungarian | hu |\r\n| 1039 | Icelandic | is |\r\n| 1040 | Italian | it-IT |\r\n| 1041 | Japanese | ja |\r\n| 1043 | Dutch (Netherlands) | nl-NL |\r\n| 1044 | Norwegian | no-NO |\r\n| 1045 | Polish | pl-PL |\r\n| 1046 | Portuguese (Brazil) | pt-BR |\r\n| 1048 | Romanian | ro |\r\n| 1049 | Russian | ru |\r\n| 1051 | Slovak | sk |\r\n| 1053 | Swedish | sv-SE |\r\n| 2052 | Chinese | zh-CN |\r\n| 2057 | English(GreatBretagne) | en-GB |\r\n| 2067 | Dutch (Belgium) | nl-BE |\r\n| 2070 | Portuguese (Portugal) | pt-PT |\r\n| 3082 | Spanish | es-ES |\r\n| 3084 | French (Canada) | fr-CA |\r\n\r\n#### Referential Listing\r\n\r\n|Type name | Is standard | Description |\r\n|:---- | ------|-----|\r\n| applicationNotificationLevel| Yes | List of notification levels.|\r\n| applicationQuestion | Yes | List of application questions.|\r\n| applicationQuestionAnswer | Yes | List of application question answers.|\r\n| civility | Yes | List of civilities.|\r\n| consent | Yes | List of consents.|\r\n| contractType | Yes | List of contract types.|\r\n| customCodeTableType | Yes | List of custom referential types.|\r\n| diploma | Yes | List of diplomas.|\r\n| ethnicity | Yes | List of ethnicities.|\r\n| educationLevel | Yes | List of education levels.|\r\n| experienceLevel | Yes | List of experience levels.|\r\n| fileType | No | List of file types.|\r\n| incapacityStatus | Yes | List of incapacity statuses.|\r\n| geographicalLocation | Yes | List of geographical locations (this is a superset of offerGeographicalLocation).|\r\n| country | Yes | List of countries (this is a superset of offerCountry).|\r\n| region | Yes | List of regions (this is a superset of offerRegion).|\r\n| department | Yes | List of departments (this is a superset of offerDepartment).|\r\n| language | Yes | List of languages.|\r\n| languageLevel | Yes | List of language levels.|\r\n| nationality | Yes | List of nationalities.|\r\n| noticeDuration | Yes | List of notice durations.|\r\n| offerFamilyCategory | Yes | List of offer's family categories - the highest level of offer family categories.|\r\n| offerFamily | No | List of offer's families - the second level of offer family categories (linked to the first one).|\r\n| offerProfile | No | List of offer's profiles - the third level of offer family categories (linked to the second one).|\r\n| offerGeographicalLocation | Yes | List of offer's geographical locations (this is a subset of geographicalLocation, only the ones that are eligible for an offer are listed).|\r\n| offerCountry | Yes | List of offer's countries (this is a subset of country, only the ones that are eligible for an offer are listed).|\r\n| offerRegion | Yes | List of offer's regions (this is a subset of region, only the ones that are eligible for an offer are listed).|\r\n| offerDepartment | Yes | List of offer's departments (this is a subset of department, only the ones that are eligible for an offer are listed).|\r\n| offerTime | Yes | List of contract times, e.g. fulltime, partial, etc.|\r\n| organisation | No | List of organisations.|\r\n| origin | No | List of origins of applications.|\r\n| race | Yes | List of races.|\r\n| professionalCategory | Yes | List of professional categories, e.g. employee, manager, etc.|\r\n| recruitingReason | Yes | List of recruiting reasons.|\r\n| salaryRange | Yes | List of salary ranges.|\r\n| sex | Yes | List of sex.|\r\n| specialisation | Yes | List of specialisations.|\r\n| veteranStatus | Yes | List of veteran statuses.|\r\n| validationPeriod | Yes | List of validation period.|\r\n| securityquestion | No | List of security questions used in password recovery.|\r\n| softwareLanguage | Yes | List of manager languages.|\r\n| skill | Yes | List of skills.|\r\n| skillsByJobFamily | Yes | List of skills by job families.|\r\n| radius | Yes | List of radius.|\r\n\r\n"
version: '1.0'
servers:
- url: https://inte-api.cegid.com/ts-recruiting-frontoffice
paths:
/api/v2/accounts/changepasswordwithsecretquestionchallenge:
post:
tags:
- Account
summary: "Change the password of a user using secret question.\r\n"
description: Change the password of a user using secret question.
operationId: AccountController_ChangePasswordWithSecretQuestionChallenge
requestBody:
description: The identification user data to recover the password.
content:
application/json:
schema:
$ref: '#/components/schemas/SecretQuestionPasswordReset-Model'
example:
username: string
securityQuestionId: 0
securityAnswer: string
newPassword: string
text/json:
schema:
$ref: '#/components/schemas/SecretQuestionPasswordReset-Model'
example:
username: string
securityQuestionId: 0
securityAnswer: string
newPassword: string
responses:
'200':
description: The message response after the operation ends successfully.
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: "Bad Request\r\n- No username or email specified\r\n- The model has validation errors. (Check [SecretQuestionPasswordReset](#SecretQuestionPasswordReset-Model) model for contraints).\r\n- Parameter AskNewPassword must be enabled.\r\n- Error during validation of the user and updating the password."
content:
application/json: {}
text/json: {}
/api/v2/accounts/delete:
delete:
tags:
- Account
summary: "Delete an account.\r\n"
description: Delete an account.
operationId: AccountController_DeleteAccount
responses:
'204':
description: Empty response body.
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: "Bad Request\r\n- Error during the deletion of the account."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
/api/v2/accounts/personaldataexportstatus:
get:
tags:
- Account
summary: "Get the status of personal data export request.\r\n"
description: "Get the status of personal data export request :\r\n- \"None\" : No request in progress,\r\n- \"InProgress\" : A request is being processed,\r\n- \"DownloadAvailable\" : The file is available for download."
operationId: AccountController_PersonalDataExportStatus
parameters:
- name: Accept-language
in: header
description: 'The applicant code language (fr-FR, en-GB...).
If the language sent is not supported by Talentsoft or not enabled on the website, the applicant will have the default language of the application.
'
schema:
type: string
responses:
'200':
description: "The request status :\r\n- \"None\" : No request in progress,\r\n- \"InProgress\" : A request is being processed,\r\n- \"DownloadAvailable\" : The zip file is available for download.\r\nThe date of the request.\r\nThe export download link url.\r\nThe expiration date of the link."
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicantDataExportFullStatus-Model'
example:
requestStatus: None
requestDate: string
downloadUrl: string
expirationDate: string
text/json:
schema:
$ref: '#/components/schemas/ApplicantDataExportFullStatus-Model'
example:
requestStatus: None
requestDate: string
downloadUrl: string
expirationDate: string
'400':
description: "Bad Request\r\n- Error during the request for personal data export."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
/api/v2/accounts/personaldatarequest:
get:
tags:
- Account
summary: "Request for personal data export.\r\n"
description: Request for personal data export.
operationId: AccountController_PersonalDataRequest
parameters:
- name: Accept-language
in: header
description: 'The applicant code language (fr-FR, en-GB...).
If the language sent is not supported by Talentsoft or not enabled on the website, the applicant will have the default language of the application.
'
schema:
type: string
responses:
'200':
description: The result value.
The result message.
content:
application/json:
schema:
$ref: '#/components/schemas/ActionResult-Model'
example:
result: AtLeastOneFailure
resultMessage: string
text/json:
schema:
$ref: '#/components/schemas/ActionResult-Model'
example:
result: AtLeastOneFailure
resultMessage: string
'400':
description: "Bad Request\r\n- The user has already asked for a request.\r\n- The user has no email.\r\n- Error during the request for personal data export."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
/api/v2/accounts/resetpassword:
post:
tags:
- Account
summary: "Reset the Front Office user account password.\r\n"
description: "Reset the Front Office user account password with a new password. A [PasswordResetTicket](#PasswordResetTicket-Model) with a valid password reset token is needed. This token is sent to the user by mail using [SendForgottenPasswordByEmail](#accountControllerSendForgottenPasswordByEmail).\r\nThis mail contains a customizable link in order to redirect the user to a reset password page (to implement).\r\nThis link is composed as follows: http://[CUSTOM_URL]?TOKEN={0}&LOGIN={1}&LCID={2} with {0}=the password reset token, {1}=username of the candidate, {2}=language of the candidate.\r\nThe reset password page can perform the password reset through this API by sending all [PasswordResetTicket](#PasswordResetTicket-Model) information."
operationId: AccountController_ResetPassword
requestBody:
description: The ticket that contains password reset token and all password reset information.
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordResetTicket-Model'
example:
username: string
newPassword: string
passwordResetToken: string
text/json:
schema:
$ref: '#/components/schemas/PasswordResetTicket-Model'
example:
username: string
newPassword: string
passwordResetToken: string
responses:
'200':
description: The message response after the operation ends successfully.
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: "Bad Request\r\n- The reset password token or username is invalid.\r\n- The user account is disabled.\r\n- The new password doesn't meet password security criteria."
content:
application/json: {}
text/json: {}
'405':
description: "Method Not Allowed\r\n- The site is using applications without account."
content:
application/json: {}
text/json: {}
/api/v2/accounts/sendforgottenpasswordbyemail:
post:
tags:
- Account
summary: "Send the user password by email.\r\n"
description: Send the user password or a password reset link by email depending on security setting.
operationId: AccountController_SendForgottenPasswordByEmail
requestBody:
description: The username or user's email to recover the password.
content:
application/json:
schema:
type: string
example: string
text/json:
schema:
type: string
example: string
responses:
'200':
description: The message response after the operation ends successfully.
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: "Bad Request\r\n- No username or email specified\r\n- Parameter AskNewPassword must be enabled.\r\n- Error during validation of the user and sending the email."
content:
application/json: {}
text/json: {}
/api/v2/applicants:
get:
tags:
- Applicant
summary: "Get applicant information.\r\n"
description: Retrieve the logged-in user's applicant information.
operationId: ApplicantController_GetApplicant
responses:
'200':
description: The logged-in user's complete applicant information (missing information will be sent as null).
content:
application/json:
schema:
$ref: '#/components/schemas/Applicant-Model'
example:
personalInformation:
civility:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
middleName: string
title: string
address: string
city: string
postalCode: string
birthDate: string
country:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
skypeAccount: string
receiveSMS: true
phoneNumber2: string
professionalEmail: string
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
nationalities:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
frenchDisabledWorkerStatus: true
frenchPriorityNeighbourhood: true
firstName: string
lastName: string
email: string
phoneNumber: string
jobPreferences:
primaryProfile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
salaryPretensions: string
dateOfAvailability: string
mobility:
geographicalAreas:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
countries:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
regions:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
departments:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
noticeDuration:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
mobilityDelay: string
trainingDateStart: string
trainingDateEnd: string
jobTime:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
secondaryProfiles:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
availability:
acceptsExtra: true
values:
- xAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
education:
diplomas:
- diplomaId: 0
educationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diplomaCode:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yearObtained: 0
college: string
collegeCity: string
studiedLanguages:
- studiedLanguageId: 0
language:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languageLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceList:
- experienceId: 0
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
profile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
company: string
function: string
length: string
consents:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
skills:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
eEOInformation:
doesNotComplete: true
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
race:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
ethnicity:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
veteranStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
incapacityStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
customFields:
personalInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
jobPreferences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
backOfficeData:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock1:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock2:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock3:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock4:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experience:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
text/json:
schema:
$ref: '#/components/schemas/Applicant-Model'
example:
personalInformation:
civility:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
middleName: string
title: string
address: string
city: string
postalCode: string
birthDate: string
country:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
skypeAccount: string
receiveSMS: true
phoneNumber2: string
professionalEmail: string
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
nationalities:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
frenchDisabledWorkerStatus: true
frenchPriorityNeighbourhood: true
firstName: string
lastName: string
email: string
phoneNumber: string
jobPreferences:
primaryProfile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
salaryPretensions: string
dateOfAvailability: string
mobility:
geographicalAreas:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
countries:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
regions:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
departments:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
noticeDuration:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
mobilityDelay: string
trainingDateStart: string
trainingDateEnd: string
jobTime:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
secondaryProfiles:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
availability:
acceptsExtra: true
values:
- xAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
education:
diplomas:
- diplomaId: 0
educationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diplomaCode:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yearObtained: 0
college: string
collegeCity: string
studiedLanguages:
- studiedLanguageId: 0
language:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languageLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceList:
- experienceId: 0
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
profile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
company: string
function: string
length: string
consents:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
skills:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
eEOInformation:
doesNotComplete: true
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
race:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
ethnicity:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
veteranStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
incapacityStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
customFields:
personalInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
jobPreferences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
backOfficeData:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock1:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock2:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock3:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock4:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experience:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
'404':
description: "Not Found\r\n- There is no applicant information for the logged-in user. You should first create this information with the endpoint\r\n[Create applicant information](#applicantControllerPostApplicant)."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
put:
tags:
- Applicant
summary: "Update applicant information.\r\n"
description: Update the logged-in user's applicant information. The entire Applicant object is updated at each request.
operationId: ApplicantController_PutApplicant
parameters:
- name: Accept-language
in: header
description: 'The applicant code language (fr-FR, en-GB...).
If the language sent is not supported by Talentsoft or not enabled on the website, the applicant will have the default language of the application.
'
schema:
type: string
requestBody:
description: 'The applicant information to update.
In order to delete an information from the applicant, you should not send the property that has to be deleted.'
content:
application/json:
schema:
$ref: '#/components/schemas/Applicant-Model'
example:
personalInformation:
civility:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
middleName: string
title: string
address: string
city: string
postalCode: string
birthDate: string
country:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
skypeAccount: string
receiveSMS: true
phoneNumber2: string
professionalEmail: string
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
nationalities:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
frenchDisabledWorkerStatus: true
frenchPriorityNeighbourhood: true
firstName: string
lastName: string
email: string
phoneNumber: string
jobPreferences:
primaryProfile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
salaryPretensions: string
dateOfAvailability: string
mobility:
geographicalAreas:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
countries:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
regions:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
departments:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
noticeDuration:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
mobilityDelay: string
trainingDateStart: string
trainingDateEnd: string
jobTime:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
secondaryProfiles:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
availability:
acceptsExtra: true
values:
- xAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
education:
diplomas:
- diplomaId: 0
educationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diplomaCode:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yearObtained: 0
college: string
collegeCity: string
studiedLanguages:
- studiedLanguageId: 0
language:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languageLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceList:
- experienceId: 0
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
profile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
company: string
function: string
length: string
consents:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
skills:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
eEOInformation:
doesNotComplete: true
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
race:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
ethnicity:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
veteranStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
incapacityStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
customFields:
personalInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
jobPreferences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
backOfficeData:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock1:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock2:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock3:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock4:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experience:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
text/json:
schema:
$ref: '#/components/schemas/Applicant-Model'
example:
personalInformation:
civility:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
middleName: string
title: string
address: string
city: string
postalCode: string
birthDate: string
country:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
skypeAccount: string
receiveSMS: true
phoneNumber2: string
professionalEmail: string
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
nationalities:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
frenchDisabledWorkerStatus: true
frenchPriorityNeighbourhood: true
firstName: string
lastName: string
email: string
phoneNumber: string
jobPreferences:
primaryProfile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
salaryPretensions: string
dateOfAvailability: string
mobility:
geographicalAreas:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
countries:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
regions:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
departments:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
noticeDuration:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
mobilityDelay: string
trainingDateStart: string
trainingDateEnd: string
jobTime:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
secondaryProfiles:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
availability:
acceptsExtra: true
values:
- xAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
education:
diplomas:
- diplomaId: 0
educationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diplomaCode:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yearObtained: 0
college: string
collegeCity: string
studiedLanguages:
- studiedLanguageId: 0
language:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languageLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceList:
- experienceId: 0
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
profile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
company: string
function: string
length: string
consents:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
skills:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
eEOInformation:
doesNotComplete: true
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
race:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
ethnicity:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
veteranStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
incapacityStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
customFields:
personalInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
jobPreferences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
backOfficeData:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock1:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock2:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock3:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock4:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experience:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
responses:
'204':
description: Empty response body.
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: "Bad Request\r\n- The model has validation errors. (Check [Applicant](#Applicant-Model) model for contraints).\r\n- The body of the request is null or doesn't match the [Applicant](#Applicant-Model) contract."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
post:
tags:
- Applicant
summary: "Create applicant information.\r\n"
description: "Create applicant information for the logged-in user.\r\n
Click here to download an example."
operationId: ApplicantController_PostApplicant
parameters:
- name: Accept-language
in: header
description: 'The applicant code language (fr-FR, en-GB...).
If the language sent is not supported by Talentsoft or not enabled on the website, the applicant will have the default language of the application.
'
schema:
type: string
requestBody:
description: The applicant information.
content:
application/json:
schema:
$ref: '#/components/schemas/Applicant-Model'
example:
personalInformation:
civility:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
middleName: string
title: string
address: string
city: string
postalCode: string
birthDate: string
country:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
skypeAccount: string
receiveSMS: true
phoneNumber2: string
professionalEmail: string
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
nationalities:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
frenchDisabledWorkerStatus: true
frenchPriorityNeighbourhood: true
firstName: string
lastName: string
email: string
phoneNumber: string
jobPreferences:
primaryProfile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
salaryPretensions: string
dateOfAvailability: string
mobility:
geographicalAreas:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
countries:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
regions:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
departments:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
noticeDuration:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
mobilityDelay: string
trainingDateStart: string
trainingDateEnd: string
jobTime:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
secondaryProfiles:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
availability:
acceptsExtra: true
values:
- xAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
education:
diplomas:
- diplomaId: 0
educationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diplomaCode:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yearObtained: 0
college: string
collegeCity: string
studiedLanguages:
- studiedLanguageId: 0
language:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languageLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceList:
- experienceId: 0
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
profile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
company: string
function: string
length: string
consents:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
skills:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
eEOInformation:
doesNotComplete: true
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
race:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
ethnicity:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
veteranStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
incapacityStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
customFields:
personalInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
jobPreferences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
backOfficeData:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock1:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock2:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock3:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock4:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experience:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
text/json:
schema:
$ref: '#/components/schemas/Applicant-Model'
example:
personalInformation:
civility:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
middleName: string
title: string
address: string
city: string
postalCode: string
birthDate: string
country:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
skypeAccount: string
receiveSMS: true
phoneNumber2: string
professionalEmail: string
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
nationalities:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
frenchDisabledWorkerStatus: true
frenchPriorityNeighbourhood: true
firstName: string
lastName: string
email: string
phoneNumber: string
jobPreferences:
primaryProfile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
salaryPretensions: string
dateOfAvailability: string
mobility:
geographicalAreas:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
countries:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
regions:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
departments:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
noticeDuration:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
mobilityDelay: string
trainingDateStart: string
trainingDateEnd: string
jobTime:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
secondaryProfiles:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
availability:
acceptsExtra: true
values:
- xAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
education:
diplomas:
- diplomaId: 0
educationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diplomaCode:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yearObtained: 0
college: string
collegeCity: string
studiedLanguages:
- studiedLanguageId: 0
language:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languageLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceList:
- experienceId: 0
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
profile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
company: string
function: string
length: string
consents:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
skills:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
eEOInformation:
doesNotComplete: true
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
race:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
ethnicity:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
veteranStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
incapacityStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
customFields:
personalInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
jobPreferences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
backOfficeData:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock1:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock2:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock3:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock4:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experience:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
responses:
'201':
description: Details of the created applicant.
content:
application/json:
schema:
$ref: '#/components/schemas/Applicant-Model'
example:
personalInformation:
civility:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
middleName: string
title: string
address: string
city: string
postalCode: string
birthDate: string
country:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
skypeAccount: string
receiveSMS: true
phoneNumber2: string
professionalEmail: string
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
nationalities:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
frenchDisabledWorkerStatus: true
frenchPriorityNeighbourhood: true
firstName: string
lastName: string
email: string
phoneNumber: string
jobPreferences:
primaryProfile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
salaryPretensions: string
dateOfAvailability: string
mobility:
geographicalAreas:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
countries:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
regions:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
departments:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
noticeDuration:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
mobilityDelay: string
trainingDateStart: string
trainingDateEnd: string
jobTime:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
secondaryProfiles:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
availability:
acceptsExtra: true
values:
- xAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
education:
diplomas:
- diplomaId: 0
educationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diplomaCode:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yearObtained: 0
college: string
collegeCity: string
studiedLanguages:
- studiedLanguageId: 0
language:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languageLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceList:
- experienceId: 0
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
profile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
company: string
function: string
length: string
consents:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
skills:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
eEOInformation:
doesNotComplete: true
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
race:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
ethnicity:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
veteranStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
incapacityStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
customFields:
personalInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
jobPreferences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
backOfficeData:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock1:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock2:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock3:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock4:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experience:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
text/json:
schema:
$ref: '#/components/schemas/Applicant-Model'
example:
personalInformation:
civility:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
middleName: string
title: string
address: string
city: string
postalCode: string
birthDate: string
country:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
skypeAccount: string
receiveSMS: true
phoneNumber2: string
professionalEmail: string
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
nationalities:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
frenchDisabledWorkerStatus: true
frenchPriorityNeighbourhood: true
firstName: string
lastName: string
email: string
phoneNumber: string
jobPreferences:
primaryProfile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
salaryPretensions: string
dateOfAvailability: string
mobility:
geographicalAreas:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
countries:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
regions:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
departments:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
noticeDuration:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
mobilityDelay: string
trainingDateStart: string
trainingDateEnd: string
jobTime:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
secondaryProfiles:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
availability:
acceptsExtra: true
values:
- xAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
education:
diplomas:
- diplomaId: 0
educationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diplomaCode:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yearObtained: 0
college: string
collegeCity: string
studiedLanguages:
- studiedLanguageId: 0
language:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languageLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceList:
- experienceId: 0
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
profile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
company: string
function: string
length: string
consents:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
skills:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
eEOInformation:
doesNotComplete: true
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
race:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
ethnicity:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
veteranStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
incapacityStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
customFields:
personalInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
jobPreferences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
backOfficeData:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock1:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock2:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock3:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock4:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experience:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
'400':
description: "Bad Request\r\n- The model has validation errors. (Check [Applicant](#Applicant-Model) model for constraints).\r\n- The logged-in user already has associated applicant information. (If you want to update please use PUT).\r\n- The body of the request is null or doesn't match the [Applicant](#Applicant-Model) contract."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
/api/v2/applicants/metadata:
get:
tags:
- Applicant
summary: "Get metadata for applicant form.\r\n"
description: Retrieve the metadata for applicant form.
operationId: ApplicantController_GetMetadata
responses:
'200':
description: The metadata for applicant form (missing information will be sent as null).
content:
application/json:
schema:
$ref: '#/components/schemas/Metadata-Model'
example:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
text/json:
schema:
$ref: '#/components/schemas/Metadata-Model'
example:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
'404':
description: "Not Found\r\n- There is no applicant information for the logged-in user. You should first create this information with the endpoint\r\n[Create applicant information](#applicantControllerPostApplicant)."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
/api/v2/applicants/quickapply:
post:
tags:
- Applicant
summary: "Quick apply to an offer.\r\n"
description: Quick apply to offer
operationId: ApplicantController_QuickApplyToOffer
parameters:
- name: reference
in: query
description: The offer reference.
schema:
type: string
- name: organisationId
in: query
description: The organisation client id.
schema:
type: string
requestBody:
description: The list of file ids.
content:
application/json:
schema:
$ref: '#/components/schemas/FileIdList-Model'
example:
fileIds:
- 00000000-0000-0000-0000-000000000000
text/json:
schema:
$ref: '#/components/schemas/FileIdList-Model'
example:
fileIds:
- 00000000-0000-0000-0000-000000000000
responses:
'201':
description: "Success\r\nThe quick apply was done successfuly"
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: "Bad Request\r\n- If both (or neither) reference and organisationId are provided in the query string. Only one should be provided, as they are mutually exclusive\r\n- The logged user does not have a candidate profile\r\n- An empty file id list is provided, or any of the provided file ids are not valid"
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
/api/v2/applicants/applications:
get:
tags:
- Application
summary: "Get all the applicant's applications.\r\n"
description: Retrieve all the applications associated with the logged-in user.
operationId: ApplicationController_GetApplications
responses:
'200':
description: "An array of objects that represent applications.\r\nAn object containing metadata."
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndPagination_Application-Model'
example:
data:
- id: 0
type: Offer
offerReference: string
offerTitle: string
isOfferPublished: true
organisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
motivation: string
referralCode: string
files:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationAnswers:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answer:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
date: string
status:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
personalDataConsentReceived: true
retentionDelay: 0
frenchDisabledWorkerStatus: true
locations:
- clientCode: string
_pagination:
start: 0
count: 0
total: 0
resultsPerPage: 0
hasMore: true
links:
- href: string
rel: string
lastPage: 0
text/json:
schema:
$ref: '#/components/schemas/ModelAndPagination_Application-Model'
example:
data:
- id: 0
type: Offer
offerReference: string
offerTitle: string
isOfferPublished: true
organisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
motivation: string
referralCode: string
files:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationAnswers:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answer:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
date: string
status:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
personalDataConsentReceived: true
retentionDelay: 0
frenchDisabledWorkerStatus: true
locations:
- clientCode: string
_pagination:
start: 0
count: 0
total: 0
resultsPerPage: 0
hasMore: true
links:
- href: string
rel: string
lastPage: 0
'400':
description: "Bad Request\r\n- There is no applicant information for the logged-in user. You should first create this information with the endpoint\r\n[Create applicant information](#applicantControllerPostApplicant) and then apply to offers."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
post:
tags:
- Application
summary: "Create an application.\r\n"
description: "Create an application associated with the logged-in user.\r\n
The parameter JobAdReference allows to create an application on the offer associated to the jobAd.\r\nWhen the JobAdReference parameter is present, the following fields in the model are not mandatory and will be ignored: type, offerReference and organisation."
operationId: ApplicationController_PostApplications
parameters:
- name: jobAdReference
in: query
description: The reference of a jobAd.
schema:
type: string
requestBody:
description: The application information.
content:
application/json:
schema:
$ref: '#/components/schemas/Application-Model'
example:
id: 0
type: Offer
offerReference: string
offerTitle: string
isOfferPublished: true
organisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
motivation: string
referralCode: string
files:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationAnswers:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answer:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
date: string
status:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
personalDataConsentReceived: true
retentionDelay: 0
frenchDisabledWorkerStatus: true
locations:
- clientCode: string
text/json:
schema:
$ref: '#/components/schemas/Application-Model'
example:
id: 0
type: Offer
offerReference: string
offerTitle: string
isOfferPublished: true
organisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
motivation: string
referralCode: string
files:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationAnswers:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answer:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
date: string
status:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
personalDataConsentReceived: true
retentionDelay: 0
frenchDisabledWorkerStatus: true
locations:
- clientCode: string
responses:
'200':
description: The details of the created application.
content:
application/json:
schema:
$ref: '#/components/schemas/Application-Model'
example:
id: 0
type: Offer
offerReference: string
offerTitle: string
isOfferPublished: true
organisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
motivation: string
referralCode: string
files:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationAnswers:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answer:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
date: string
status:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
personalDataConsentReceived: true
retentionDelay: 0
frenchDisabledWorkerStatus: true
locations:
- clientCode: string
text/json:
schema:
$ref: '#/components/schemas/Application-Model'
example:
id: 0
type: Offer
offerReference: string
offerTitle: string
isOfferPublished: true
organisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
motivation: string
referralCode: string
files:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationAnswers:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answer:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
date: string
status:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
personalDataConsentReceived: true
retentionDelay: 0
frenchDisabledWorkerStatus: true
locations:
- clientCode: string
'202':
description: "The details of the created application.\r\n
This case will occur if the application has been created and saved but there has been an error on the e-mail server. If you see this status code, please contact Talentsoft Services."
content:
application/json:
schema:
$ref: '#/components/schemas/Application-Model'
example:
id: 0
type: Offer
offerReference: string
offerTitle: string
isOfferPublished: true
organisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
motivation: string
referralCode: string
files:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationAnswers:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answer:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
date: string
status:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
personalDataConsentReceived: true
retentionDelay: 0
frenchDisabledWorkerStatus: true
locations:
- clientCode: string
text/json:
schema:
$ref: '#/components/schemas/Application-Model'
example:
id: 0
type: Offer
offerReference: string
offerTitle: string
isOfferPublished: true
organisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
motivation: string
referralCode: string
files:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationAnswers:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answer:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
date: string
status:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
personalDataConsentReceived: true
retentionDelay: 0
frenchDisabledWorkerStatus: true
locations:
- clientCode: string
'400':
description: "Bad Request\r\n- There is no applicant information for the logged-in user. You should first create this information with the endpoint\r\n[Create applicant information](#applicantControllerPostApplicant) and then apply to offers.\r\n- The model has validation errors. (Check [Application](#Application-Model) model for constraints).\r\n- The type is \"offer\" and the offerReference information is missing or incorrect.\r\n- The type is \"spontaneous\" and the organization information is missing or incorrect (most importantly the organization code)."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
'/api/v2/applicants/applications/{id}/deactivate':
post:
tags:
- Application
summary: "Deactivate an application.\r\n"
description: "Deactivate an application associated with the logged-in user.\r\n
The logged-in user must have his applicant information created in order to interact with applications."
operationId: ApplicationController_PostDeactivateApplication
parameters:
- name: id
in: path
description: The application ID.
required: true
schema:
type: integer
format: int32
responses:
'200':
description: The message response after updating the application.
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: "Bad Request\r\n- There is no applicant information for the logged-in user. You should first create this information with the endpoint\r\n[Create applicant information](#applicantControllerPostApplicant) and then apply to offers.\r\n- Parameter DisableApplicationEnable must be enabled."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
'/api/v2/applicants/applications/{id}/reactivate':
post:
tags:
- Application
summary: "Reactivate an application.\r\n"
description: "Reactivate an application associated with the logged-in user.\r\n
The logged-in user must have his applicant information created in order to interact with applications."
operationId: ApplicationController_PostReactivateApplication
parameters:
- name: id
in: path
description: The application ID.
required: true
schema:
type: integer
format: int32
responses:
'200':
description: The message response after updating the application.
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: "Bad Request\r\n- There is no applicant information for the logged-in user. You should first create this information with the endpoint\r\n[Create applicant information](#applicantControllerPostApplicant) and then apply to offers.\r\n- Parameter DisableApplicationEnable must be enabled."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
/api/v2/applicants/applicationswithoutaccount:
post:
tags:
- Applications Without Account
summary: "Create an application without front office account.\r\n"
description: "Create an application without front office account. The enctype of the request must be \"multipart/form-data\".\r\nThe request should contain a form field with the applicantApplication key.\r\nThe value should be a json document with the format described in the documentation.\r\n
For each element in the uploadedFiles list, a form field should be added to the request.\r\nThe key of the field is the key property provided in the UploadedFileInfo part of the json document and the value is the file data.\r\n
The name of the key can be anything. It is up to the client application to define it.\r\nThe important thing is to have the same keys in the form and in the applicantApplication.uploadedFiles[i].key properties.\r\n
The size of the request must not be greater than 100 MB.\r\n
The max size of a single file depends on the settings in the applicant view.\r\n
Click here to download an example.
The parameter JobAdReference allows to create an application on the offer associated to the jobAd.\r\nWhen the JobAdReference parameter is present, the following fields in the model are not mandatory and will be ignored: type, offerReference and organisation."
operationId: ApplicationWithoutAccountController_PostApplicantApplication
parameters:
- name: Accept-language
in: header
description: 'The applicant code language (fr-FR, en-GB...).
If the language sent is not supported by Talentsoft or not enabled on the website, the applicant will have the default language of the application.
'
schema:
type: string
- name: jobAdReference
in: header
description: Reference of the job ad.
schema:
type: string
requestBody:
description: The applicant information with an application(attached files including) to an offer or a spontaneous application.
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicantApplication-Model'
example:
applicant:
personalInformation:
civility:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
middleName: string
title: string
address: string
city: string
postalCode: string
birthDate: string
country:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
skypeAccount: string
receiveSMS: true
phoneNumber2: string
professionalEmail: string
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
nationalities:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
frenchDisabledWorkerStatus: true
frenchPriorityNeighbourhood: true
firstName: string
lastName: string
email: string
phoneNumber: string
jobPreferences:
primaryProfile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
salaryPretensions: string
dateOfAvailability: string
mobility:
geographicalAreas:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
countries:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
regions:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
departments:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
noticeDuration:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
mobilityDelay: string
trainingDateStart: string
trainingDateEnd: string
jobTime:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
secondaryProfiles:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
availability:
acceptsExtra: true
values:
- xAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
education:
diplomas:
- diplomaId: 0
educationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diplomaCode:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yearObtained: 0
college: string
collegeCity: string
studiedLanguages:
- studiedLanguageId: 0
language:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languageLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceList:
- experienceId: 0
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
profile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
company: string
function: string
length: string
consents:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
skills:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
eEOInformation:
doesNotComplete: true
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
race:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
ethnicity:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
veteranStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
incapacityStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
customFields:
personalInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
jobPreferences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
backOfficeData:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock1:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock2:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock3:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock4:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experience:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
application:
id: 0
type: Offer
offerReference: string
offerTitle: string
isOfferPublished: true
organisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
motivation: string
referralCode: string
files:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationAnswers:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answer:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
date: string
status:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
personalDataConsentReceived: true
retentionDelay: 0
frenchDisabledWorkerStatus: true
locations:
- clientCode: string
uploadedFiles:
- description: string
fileTypeId: string
key: string
responses:
'201':
description: The details of the created applicant and its application (attached files including) to an offer or a spontaneous application.
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicantApplication-Model'
example:
applicant:
personalInformation:
civility:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
middleName: string
title: string
address: string
city: string
postalCode: string
birthDate: string
country:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
skypeAccount: string
receiveSMS: true
phoneNumber2: string
professionalEmail: string
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
nationalities:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
frenchDisabledWorkerStatus: true
frenchPriorityNeighbourhood: true
firstName: string
lastName: string
email: string
phoneNumber: string
jobPreferences:
primaryProfile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
salaryPretensions: string
dateOfAvailability: string
mobility:
geographicalAreas:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
countries:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
regions:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
departments:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
noticeDuration:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
mobilityDelay: string
trainingDateStart: string
trainingDateEnd: string
jobTime:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
secondaryProfiles:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
availability:
acceptsExtra: true
values:
- xAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
education:
diplomas:
- diplomaId: 0
educationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diplomaCode:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yearObtained: 0
college: string
collegeCity: string
studiedLanguages:
- studiedLanguageId: 0
language:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languageLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceList:
- experienceId: 0
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
profile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
company: string
function: string
length: string
consents:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
skills:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
eEOInformation:
doesNotComplete: true
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
race:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
ethnicity:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
veteranStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
incapacityStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
customFields:
personalInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
jobPreferences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
backOfficeData:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock1:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock2:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock3:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock4:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experience:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
application:
id: 0
type: Offer
offerReference: string
offerTitle: string
isOfferPublished: true
organisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
motivation: string
referralCode: string
files:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationAnswers:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answer:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
date: string
status:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
personalDataConsentReceived: true
retentionDelay: 0
frenchDisabledWorkerStatus: true
locations:
- clientCode: string
uploadedFiles:
- description: string
fileTypeId: string
key: string
text/json:
schema:
$ref: '#/components/schemas/ApplicantApplication-Model'
example:
applicant:
personalInformation:
civility:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
middleName: string
title: string
address: string
city: string
postalCode: string
birthDate: string
country:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
skypeAccount: string
receiveSMS: true
phoneNumber2: string
professionalEmail: string
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
nationalities:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
frenchDisabledWorkerStatus: true
frenchPriorityNeighbourhood: true
firstName: string
lastName: string
email: string
phoneNumber: string
jobPreferences:
primaryProfile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
salaryPretensions: string
dateOfAvailability: string
mobility:
geographicalAreas:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
countries:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
regions:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
departments:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
noticeDuration:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
mobilityDelay: string
trainingDateStart: string
trainingDateEnd: string
jobTime:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
secondaryProfiles:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
availability:
acceptsExtra: true
values:
- xAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
education:
diplomas:
- diplomaId: 0
educationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diplomaCode:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yearObtained: 0
college: string
collegeCity: string
studiedLanguages:
- studiedLanguageId: 0
language:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languageLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceList:
- experienceId: 0
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
profile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
company: string
function: string
length: string
consents:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
skills:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
eEOInformation:
doesNotComplete: true
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
race:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
ethnicity:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
veteranStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
incapacityStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
customFields:
personalInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
jobPreferences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
backOfficeData:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock1:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock2:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock3:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock4:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experience:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
application:
id: 0
type: Offer
offerReference: string
offerTitle: string
isOfferPublished: true
organisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
motivation: string
referralCode: string
files:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationAnswers:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answer:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
date: string
status:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
personalDataConsentReceived: true
retentionDelay: 0
frenchDisabledWorkerStatus: true
locations:
- clientCode: string
uploadedFiles:
- description: string
fileTypeId: string
key: string
'400':
description: Bad Request
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- The \"application without account in web api\" option is not active."
content:
application/json: {}
text/json: {}
/api/v2/favouriteoffers:
get:
tags:
- Bookmarks
summary: "Get Bookmarks.\r\n"
description: Retrieve the logged-in user's bookmarks.
operationId: BookmarksController_GetBookmarks
responses:
'200':
description: An array of objects that represent bookmarks.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Bookmark-Model'
example:
- title: string
reference: string
address: string
isPublished: true
organisation:
entityCode: string
name: string
description: string
url: string
phoneNumber: string
postCode: string
geolocation:
latitude: 0
longitude: 0
parentName: string
logoUrl: string
maxDelayForConsent: 0
retentionPeriod: 0
generalConditions: string
personalDataConsent: string
contractType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Bookmark-Model'
example:
- title: string
reference: string
address: string
isPublished: true
organisation:
entityCode: string
name: string
description: string
url: string
phoneNumber: string
postCode: string
geolocation:
latitude: 0
longitude: 0
parentName: string
logoUrl: string
maxDelayForConsent: 0
retentionPeriod: 0
generalConditions: string
personalDataConsent: string
contractType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
'405':
description: "Method Not Allowed\r\n- The request calls this endpoint with any other verb than GET."
content:
application/json: {}
text/json: {}
'/api/v2/favouriteoffers/{offerReference}':
post:
tags:
- Bookmarks
summary: "Add offer into favorites\r\n"
description: "The vacancy passed in parameter will be added to the logged-in user's bookmarks.\r\n[see identifier encoding](#identifier_encoding)"
operationId: BookmarksController_AddBookmark
parameters:
- name: offerReference
in: path
description: The reference of the offer.
required: true
schema:
type: string
responses:
'200':
description: Empty response body.
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: "Already added\r\n- The vacancy is already in the favorites."
content:
application/json: {}
text/json: {}
'404':
description: "Not Found\r\n- The reference points to an offer that doesn't exist."
content:
application/json: {}
text/json: {}
delete:
tags:
- Bookmarks
summary: "Delete offer from favorites\r\n"
description: "The vacancy passed in parameter will be deleted from the logged-in user's bookmarks.\r\n[see identifier encoding](#identifier_encoding)"
operationId: BookmarksController_DeleteBookmark
parameters:
- name: offerReference
in: path
description: The reference of the offer.
required: true
schema:
type: string
responses:
'200':
description: Empty response body.
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'404':
description: "Not added or doesn't exist.\r\n- The vacancy is not in the favorites.\r\n- The reference points to an offer that doesn't exist."
content:
application/json: {}
text/json: {}
'/api/v2/organisation/{id}':
get:
tags:
- Entity
summary: "Get organisation details.\r\n"
description: Retrieves the organisation details.
operationId: EntityController_GetEntityDetails
parameters:
- name: id
in: path
description: 'Identifier used to retrieve the entity which is ClientCode or EntityId, api retrieves by entity id by default unless entityIdType is specified.'
required: true
schema:
type: string
- name: entityIdType
in: query
description: "The type of identifier used to retrieve the entity. You need to use {entityid} to retrieve by id of entity and {clientcode} to retrieve by client code.\r\nDefault value: entityid"
schema:
type: string
responses:
'200':
description: An object that represents the organisation details.
content:
application/json:
schema:
$ref: '#/components/schemas/Entity-Model'
example:
entityCode: string
name: string
description: string
url: string
phoneNumber: string
postCode: string
geolocation:
latitude: 0
longitude: 0
parentName: string
logoUrl: string
maxDelayForConsent: 0
retentionPeriod: 0
generalConditions: string
personalDataConsent: string
text/json:
schema:
$ref: '#/components/schemas/Entity-Model'
example:
entityCode: string
name: string
description: string
url: string
phoneNumber: string
postCode: string
geolocation:
latitude: 0
longitude: 0
parentName: string
logoUrl: string
maxDelayForConsent: 0
retentionPeriod: 0
generalConditions: string
personalDataConsent: string
'400':
description: "Bad Request\r\n- The given entity code is wrong."
content:
application/json: {}
text/json: {}
/api/v2/applicants/files:
get:
tags:
- File
summary: "Get all the applicant's associated files.\r\n"
description: Retrieve all the applicant's associated files.
operationId: FileController_GetFiles
responses:
'200':
description: "An array of objects that represent the file information.\r\nAn object containing metadata."
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndPagination_FileInfo-Model'
example:
data:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_pagination:
start: 0
count: 0
total: 0
resultsPerPage: 0
hasMore: true
links:
- href: string
rel: string
lastPage: 0
text/json:
schema:
$ref: '#/components/schemas/ModelAndPagination_FileInfo-Model'
example:
data:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_pagination:
start: 0
count: 0
total: 0
resultsPerPage: 0
hasMore: true
links:
- href: string
rel: string
lastPage: 0
'400':
description: "Bad Request\r\n- There is no applicant information for the logged-in user. You shall first create this information with the endpoint\r\n[Create applicant information](#applicantControllerPostApplicant) and then apply to offers."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this method without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
post:
tags:
- File
summary: "Create an applicant file.\r\n"
description: "Upload a document and associate it with the logged-in user's applicant information.\r\n
The enctype of the request must be \"multipart/form-data\".\r\n The max size of a single file depends on the settings in the applicant view."
operationId: FileController_PostFile
requestBody:
content:
multipart/form-data:
schema:
properties:
description:
type: string
description: The file description.
fileTypeId:
type: number
description: The id of the Referential fileType that corresponds to the uploaded file.
file:
type: file
description: The file content.
Be sure to upload only a single file per request.
responses:
'200':
description: An object that represent the file information.
content:
application/json:
schema:
$ref: '#/components/schemas/FileInfo-Model'
example:
guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
text/json:
schema:
$ref: '#/components/schemas/FileInfo-Model'
example:
guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
'400':
description: "Bad Request\r\n- There is no applicant information for the logged-in user. You shall first create this information with the endpoint\r\n[Create applicant information](#applicantControllerPostApplicant) and then apply to offers.\r\n- The request was sent without the enctype \"multipart/form-data\".\r\n- The request was sent with more than one file (only one file per POST is supported).\r\n- The request does not contain any file."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
'/api/v2/applicants/files/{fileGuid}':
get:
tags:
- File
summary: "Get the applicant's associated file with a given GUID.\r\n"
description: "Retrieve the applicant's associated file with a given GUID.\r\nBy this way, the file content can be downloaded, with the length, the type and the name of the file."
operationId: FileController_GetFileByGuid
parameters:
- name: fileGuid
in: path
description: The file guid.
required: true
schema:
type: string
format: uuid
responses:
'404':
description: "Not Found\r\n- The file with this GUID doesn't exist."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this method without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
put:
tags:
- File
summary: "Update an applicant file.\r\n"
description: "Update a file associated with the applicant.\r\n
The enctype of the request must be \"multipart/form-data\".\r\n The max size of a single file depends on the settings in the applicant view."
operationId: FileController_UpdateFileByGuid
parameters:
- name: fileGuid
in: path
description: The file guid.
required: true
schema:
type: string
format: uuid
requestBody:
content:
multipart/form-data:
schema:
properties:
description:
type: string
description: The file description.
file:
type: file
description: The file content.
Be sure to upload only a single file per request.
responses:
'200':
description: An object that represents the file information.
content:
application/json:
schema:
$ref: '#/components/schemas/FileInfo-Model'
example:
guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
text/json:
schema:
$ref: '#/components/schemas/FileInfo-Model'
example:
guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
'400':
description: "Bad Request\r\n- There is no applicant information for the logged-in user. You shall first create this information with the endpoint\r\n[Create applicant information](#applicantControllerPostApplicant) and then apply to offers."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
'404':
description: "Not Found\r\n- The file to update doesn't exist."
content:
application/json: {}
text/json: {}
delete:
tags:
- File
summary: "Delete an applicant file.\r\n"
description: Delete a file associated with the applicant as long as it has not been used for an application.
operationId: FileController_DeleteFileByGuid
parameters:
- name: fileGuid
in: path
description: The file guid.
required: true
schema:
type: string
format: uuid
responses:
'400':
description: "Bad Request\r\n- There is no applicant information for the logged-in user. You shall first create this information with the endpoint\r\n[Create applicant information](#applicantControllerPostApplicant) and then apply to offers."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
'404':
description: "Not Found\r\n- The file to delete doesn't exist."
content:
application/json: {}
text/json: {}
'409':
description: "Conflict\r\n- You requested to delete a file that is associated with an application."
content:
application/json: {}
text/json: {}
/api/v2/applicants/files/extensions:
get:
tags:
- File
summary: Action that retrieves all allowed file extensions.
description: Action that retrieves all allowed file extensions
operationId: FileController_GetAllFileExtensions
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
/api/v2/applicants/jobadapplications:
post:
tags:
- JobAdApplication
summary: Add a location for an existing application with an account.
description: "This endpoint allow to add a location for an existing application. \r\nIt should be used only for customer using the job advertising services.\r\nThe job Advertising services is a new service that allows to decline vacancies into job ads.In this context a job ad corresponds to a place."
operationId: JobAdApplicationController_PostJobAdApplications
parameters:
- name: offerId
in: query
description: Reference of the vacancy.
required: true
schema:
type: string
- name: jobAdReference
in: query
description: Reference of the job ad.
required: true
schema:
type: string
responses:
'200':
description: A confirmation message that the JobAd application was successful.
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: "Bad Request\r\n- There is no applicant information for the logged-in user. You should first create this information with the endpoint\r\n[Create applicant information](#applicantControllerPostApplicant) and then apply to offers.\r\n- The candidate has already replied to this JobAd/vacancy\r\n- The specified jobAd reference doesn't exist."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
/api/v2/applicants/jobadapplicationswithoutaccount:
post:
tags:
- JobAdApplicationWithoutAccount
summary: Add a location on an existing application without an account
description: "This endpoint allow to add a location for an existing application.\r\nIt should be used only for customer using the job advertising services.\r\nThe job Advertising services is a new service that allows to decline vacancies into job ads.In this context a job ad corresponds to a place."
operationId: JobAdApplicationWithoutAccountController_PostJobAdApplicationsWithoutAccount
parameters:
- name: email
in: query
description: The candidate email.
required: true
schema:
type: string
- name: offerId
in: query
description: '"Reference of the vacancy.'
required: true
schema:
type: string
- name: jobAdReference
in: query
description: '"Reference of the job ad.'
required: true
schema:
type: string
responses:
'200':
description: A confirmation message that the JobAd application was successful.
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: "Bad Request\r\n- There is no applicant information for the specified email\r\n- The candidate has already replied to this JobAd/vacancy\r\n- The specified jobAd reference doesn't exist."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
/api/v2/offersubscriptionswithoutaccount:
get:
tags:
- Offer Subscription Without Account
summary: "Retrieve Job Alert without an account.\r\n"
description: 'Retrieve the Job Alert for the user associated with the given token. A GUID token must be given in the query string. This GUID should have been returned in the _metada field of the Job Alert. This method will give a new GUID that must be used for future retrieval, deletion or modification.'
operationId: OfferSubscriptionWithoutAccountController_GetOfferSubscriptionForUser
parameters:
- name: token
in: query
description: The GUID refering to a token.
required: true
schema:
type: string
responses:
'201':
description: Details of the created job alert.
content:
application/json:
schema:
$ref: '#/components/schemas/OffersSubscription-Model'
example:
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
text/json:
schema:
$ref: '#/components/schemas/OffersSubscription-Model'
example:
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
'403':
description: "Forbidden\r\n- The \"apply without account\" option is not active.\r\n- The GUID given in the url does not refer to any existing token or this token is not valid anymore."
content:
application/json: {}
text/json: {}
'404':
description: "Not Found\r\n- The user associated with the token does not have a job alert (if you want to create please use PUSH)."
content:
application/json: {}
text/json: {}
put:
tags:
- Offer Subscription Without Account
summary: "Modify Job Alert without an account.\r\n"
description: 'Modify the Job Alert for the user associated with the given token. A GUID token must be given in the query string. This GUID should have been returned in the _metada field of the Job Alert. This method will give a new GUID that must be used for future retrieval, deletion or modification.'
operationId: OfferSubscriptionWithoutAccountController_PutOfferSubscriptionConnectedUser
parameters:
- name: token
in: query
description: The GUID refering to a token.
required: true
schema:
type: string
- name: Accept-language
in: header
description: 'The applicant code language (fr-FR, en-GB...).
If the language sent is not supported by Talentsoft or not enabled on the website, the applicant will have the default language of the application.
'
schema:
type: string
requestBody:
description: 'The object containing the Job Alert. Must be included inside the body. For more information of the available criterias, please refer to the [OffersSubscription](#OffersSubscription-Model).'
content:
application/json:
schema:
$ref: '#/components/schemas/OffersSubscription-Model'
example:
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
text/json:
schema:
$ref: '#/components/schemas/OffersSubscription-Model'
example:
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
responses:
'201':
description: Details of the created job alert.
content:
application/json:
schema:
$ref: '#/components/schemas/OffersSubscription-Model'
example:
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
text/json:
schema:
$ref: '#/components/schemas/OffersSubscription-Model'
example:
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
'400':
description: "Bad Request\r\n- The model has validation errors. (Check [JobAlert](#api-Models-JobAlert) model for constraints).\r\n- The user associated with the token does not have a job alert. (If you want to create please use PUSH).\r\n- The body of the request is null or doesn't match the [JobAlert](#api-Models-JobAlert) contract."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- The \"apply without account\" option is not active.\r\n- The GUID given in the url does not refer to any existing token or this token is not valid anymore."
content:
application/json: {}
text/json: {}
post:
tags:
- Offer Subscription Without Account
summary: "Create Job Alert without an account.\r\n"
description: 'Inserts a specified Job Alert. A GUID token will be given in the _metadata field of the returned JobAlert object. This GUID must be given back to have the right to modify, delete or get this Job Alert.'
operationId: OfferSubscriptionWithoutAccountController_PostOfferSubscriptionConnectedUser
parameters:
- name: Accept-language
in: header
description: 'The applicant code language (fr-FR, en-GB...).
If the language sent is not supported by Talentsoft or not enabled on the website, the applicant will have the default language of the application.
'
schema:
type: string
requestBody:
description: 'The object containing the Job Alert. Must be included inside the body. For more information of the available criterias, please refer to the [OffersSubscriptionWithConsent](#OffersSubscriptionWithConsent-Model).'
content:
application/json:
schema:
$ref: '#/components/schemas/OffersSubscriptionWithConsent-Model'
example:
personalDataConsentReceived: true
retentionDelay: 0
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
text/json:
schema:
$ref: '#/components/schemas/OffersSubscriptionWithConsent-Model'
example:
personalDataConsentReceived: true
retentionDelay: 0
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
responses:
'201':
description: Details of the created Job Alert.
content:
application/json:
schema:
$ref: '#/components/schemas/OffersSubscriptionWithConsent-Model'
example:
personalDataConsentReceived: true
retentionDelay: 0
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
text/json:
schema:
$ref: '#/components/schemas/OffersSubscriptionWithConsent-Model'
example:
personalDataConsentReceived: true
retentionDelay: 0
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
'400':
description: "Bad Request\r\n- The model has validation errors. (Check [OffersSubscriptionWithConsent](#OffersSubscriptionWithConsent-Model) model for constraints).\r\n- The body of the request is null or doesn't match the [OffersSubscriptionWithConsent](#OffersSubscriptionWithConsent-Model) contract.\r\n- No criteria is present in the request."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- The \"apply without account\" option is not active."
content:
application/json: {}
text/json: {}
delete:
tags:
- Offer Subscription Without Account
summary: "Delete Job Alert without an account.\r\n"
description: Delete the Job Alert for the user associated with the given token. A GUID token must be given in the query string. This GUID should have been returned in the _metada field of the Job Alert.
operationId: OfferSubscriptionWithoutAccountController_DeleteOfferSubscriptionForUser
parameters:
- name: token
in: query
description: The GUID refering to a token.
required: true
schema:
type: string
responses:
'204':
description: Empty response body.
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: "Bad Request\r\n- The logged-in user already does not has a job alert.\r\n- Error during the deletion of the Job alert."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- The \"apply without account\" option is not active.\r\n- The GUID given in the url does not refer to any existing token or this token is not valid anymore."
content:
application/json: {}
text/json: {}
'404':
description: "Not Found\r\n- The user associated with the token does not have a job alert. (If you want to create please use PUSH)."
content:
application/json: {}
text/json: {}
/api/v2/offersubscriptionswithoutaccount/settings:
get:
tags:
- Offer Subscription Without Account
summary: "Retrieve Job Alert active criteria without an account.\r\n"
description: Retrieve the active criteria for the job alert.
operationId: OfferSubscriptionWithoutAccountController_GetOfferSubscriptionSettings
responses:
'201':
description: The object containing the list of active criteria for the job alert.
content:
application/json:
schema:
$ref: '#/components/schemas/EngineSettings-Model'
example:
criteria:
- block: string
name: string
label: string
isDynamicField: true
referentialType: string
isMultiSelection: true
isInEmailAlerting: true
text/json:
schema:
$ref: '#/components/schemas/EngineSettings-Model'
example:
criteria:
- block: string
name: string
label: string
isDynamicField: true
referentialType: string
isMultiSelection: true
isInEmailAlerting: true
'403':
description: "Forbidden\r\n- The \"apply without account\" option is not active."
content:
application/json: {}
text/json: {}
/api/v2/offersubscriptions:
get:
tags:
- Offer Subscription
summary: "Retrieve Job Alert.\r\n"
description: Retrieve the Job Alert for the logged-in user.
operationId: OfferSubscriptionController_GetOfferSubscriptionForUser
responses:
'201':
description: Details of the created job alert.
content:
application/json:
schema:
$ref: '#/components/schemas/OffersSubscription-Model'
example:
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
text/json:
schema:
$ref: '#/components/schemas/OffersSubscription-Model'
example:
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
'403':
description: " Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
'404':
description: "Not Found\r\n- The user has no job alert."
content:
application/json: {}
text/json: {}
put:
tags:
- Offer Subscription
summary: "Modify Job Alert.\r\n"
description: Modify the Job Alert for the logged-in user.
operationId: OfferSubscriptionController_PutOfferSubscriptionConnectedUser
parameters:
- name: Accept-language
in: header
description: 'The applicant code language (fr-FR, en-GB...).
If the language sent is not supported by Talentsoft or not enabled on the website, the applicant will have the default language of the application.
'
schema:
type: string
requestBody:
description: 'The object containing the Job Alert. Must be included inside the body. For more information of the available criterias, please refer to the [OfferSubscription](#OfferSubscription) model.'
content:
application/json:
schema:
$ref: '#/components/schemas/OffersSubscription-Model'
example:
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
text/json:
schema:
$ref: '#/components/schemas/OffersSubscription-Model'
example:
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
responses:
'204':
description: Empty response body.
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: "Bad Request\r\n- The model has validation errors. (Check [OfferSubscription](#OfferSubscription) model for constraints).\r\n- The logged-in user does not has a job alert. (If you want to create please use PUSH).\r\n- The body of the request is null or doesn't match the [OfferSubscription](#OfferSubscription) contract."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
post:
tags:
- Offer Subscription
summary: "Create Job Alert.\r\n"
description: Inserts a specified Job Alert for the logged-in user.
operationId: OfferSubscriptionController_PostOfferSubscriptionConnectedUser
parameters:
- name: Accept-language
in: header
description: 'The applicant code language (fr-FR, en-GB...).
If the language sent is not supported by Talentsoft or not enabled on the website, the applicant will have the default language of the application.
'
schema:
type: string
requestBody:
description: 'The object containing the Job Alert. Must be included inside the body. For more information of the available criteria, please refer to the [OfferSubscription](#OfferSubscription) model.'
content:
application/json:
schema:
$ref: '#/components/schemas/OffersSubscription-Model'
example:
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
text/json:
schema:
$ref: '#/components/schemas/OffersSubscription-Model'
example:
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
responses:
'201':
description: Details of the created job alert.
content:
application/json:
schema:
$ref: '#/components/schemas/OffersSubscription-Model'
example:
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
text/json:
schema:
$ref: '#/components/schemas/OffersSubscription-Model'
example:
offerCriteria:
keywords: string
offerFamilyCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractType:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
location: string
locationCriteria:
radius:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
address: string
latitude: 0
longitude: 0
locations:
- string
professionalCategory:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
salaryRange:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
title: string
offerTime:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
dynamicFields:
- blockIdentifier: string
name: string
value:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
reference: string
isEmailAlert: true
validationPeriod:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
alertMail: string
_metadata: 00000000-0000-0000-0000-000000000000
'400':
description: "Bad Request\r\n- The model has validation errors. (Check [OfferSubscription](#OfferSubscription-Model) model for constraints).\r\n- The logged-in user already has associated job alert. (If you want to update please use PUT).\r\n- The body of the request is null or doesn't match the [OfferSubscription](#OfferSubscription-Model) contract.\r\n- No criteria is present in the request."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
delete:
tags:
- Offer Subscription
summary: "Delete Job Alert.\r\n"
description: Delete the Job Alert for the logged-in user.
operationId: OfferSubscriptionController_DeleteOfferSubscriptionForUser
responses:
'204':
description: Empty response body.
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: "Bad Request\r\n- The logged-in user already does not has a job alert."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
/api/v2/offersubscriptions/settings:
get:
tags:
- Offer Subscription
summary: "Retrieve Job Alert active criteria.\r\n"
description: Retrieve the active criteria for the job alert.
operationId: OfferSubscriptionController_GetOfferSubscriptionSettings
responses:
'201':
description: The object containing the list of active criteria for the job alert.
content:
application/json:
schema:
$ref: '#/components/schemas/EngineSettings-Model'
example:
criteria:
- block: string
name: string
label: string
isDynamicField: true
referentialType: string
isMultiSelection: true
isInEmailAlerting: true
text/json:
schema:
$ref: '#/components/schemas/EngineSettings-Model'
example:
criteria:
- block: string
name: string
label: string
isDynamicField: true
referentialType: string
isMultiSelection: true
isInEmailAlerting: true
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
/api/v2/offersummaries:
get:
tags:
- Offer Summaries
summary: OfferSummariesController_GetOffers
operationId: OfferSummariesController_GetOffers
parameters:
- name: start
in: query
schema:
type: integer
format: int32
- name: count
in: query
schema:
type: integer
format: int32
- name: format
in: query
schema:
type: boolean
- name: metadata
in: query
schema:
type: boolean
- name: sort
in: query
schema:
type: string
- name: apiCriteria.keywords
in: query
description: /// Gets or sets Keywords.
schema:
type: string
- name: apiCriteria.offerFamilyCategory
in: query
description: Gets or sets A job family category code.
schema:
type: array
items:
type: integer
format: int32
- name: apiCriteria.contractType
in: query
description: Gets or sets A contract type code.
schema:
type: array
items:
type: integer
format: int32
- name: apiCriteria.geographicalLocation
in: query
description: Gets or sets A code representing a department / region / country / geographical area to which the offer is linked.
schema:
type: array
items:
type: integer
format: int32
- name: apiCriteria.educationLevel
in: query
description: Gets or sets An education level code.
schema:
type: array
items:
type: integer
format: int32
- name: apiCriteria.experienceLevel
in: query
description: Gets or sets An experience level code.
schema:
type: integer
format: int32
- name: apiCriteria.contractDuration
in: query
description: Gets or sets A contract duration.
schema:
type: string
- name: apiCriteria.professionalCategory
in: query
description: Gets or sets A professional category code.
schema:
type: array
items:
type: integer
format: int32
- name: apiCriteria.diploma
in: query
description: Gets or sets A diploma code.
schema:
type: array
items:
type: integer
format: int32
- name: apiCriteria.organisation
in: query
description: Gets or sets An entity code.
schema:
type: array
items:
type: integer
format: int32
- name: apiCriteria.salaryRange
in: query
description: Gets or sets A salary range code.
schema:
type: array
items:
type: integer
format: int32
- name: apiCriteria.title
in: query
description: Gets or sets An offer title.
schema:
type: string
- name: apiCriteria.offerTime
in: query
description: Gets or sets An offer time code.
schema:
type: array
items:
type: integer
format: int32
- name: apiCriteria.location
in: query
description: Gets or sets A location.
schema:
type: string
- name: apiCriteria.locations
in: query
description: Gets or sets A location.
schema:
type: array
items:
type: string
- name: apiCriteria.latitude
in: query
description: 'Gets or sets A latitude, e.g. 48.869576.'
schema:
maximum: 90.0
minimum: -90.0
type: number
format: double
- name: apiCriteria.longitude
in: query
description: 'Gets or sets A longitude, e.g. 2.30825.'
schema:
maximum: 180.0
minimum: -180.0
type: number
format: double
- name: apiCriteria.radius
in: query
description: Gets or sets A radius code.
schema:
type: integer
format: int32
- name: apiCriteria.specialisation
in: query
description: Gets or sets A specialisation code.
schema:
type: array
items:
type: integer
format: int32
- name: apiCriteria.dynamicFields
in: query
description: 'Gets or sets A string with the format `bbbb.pppp.iiii` where `bbbb` is the block identifier, `pppp` a custom code table property name, and `iiii` the code of the referential to look for. ex: `Offer.customCodeTable1.1576`. The key can be included multiple times to specify multiple dynamic field values.'
schema:
type: array
items:
type: string
- name: apiCriteria.reference
in: query
description: Gets or sets the offer's reference.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndPagination_OfferSummary-Model'
example:
data:
- reference: string
isTopOffer: true
title: string
location: string
modificationDate: string
contractType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
offerFamilyCategory:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisationName: string
organisationDescription: string
organisationLogoUrl: string
contractDuration: string
contractTypeCountry:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
description1: string
description2: string
description1Formatted: string
description2Formatted: string
salaryRange:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
country:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
region:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
department:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
latitude: 0
longitude: 0
professionalCategory:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_links:
- href: string
rel: string
offerUrl: string
_format:
title: string
subtitle: string
tooltip: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
urlRedirectionEmployee: string
urlRedirectionApplicant: string
startPublicationDate: string
beginningDate: string
locations:
- locationReferential:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
clientCode: string
displayedAddress: string
address:
country: string
countryCode: string
countryCodeISO3: string
countrySecondarySubdivision: string
countrySubdivision: string
freeformAddress: string
municipality: string
position:
lat: 0
lon: 0
active: true
_pagination:
start: 0
count: 0
total: 0
resultsPerPage: 0
hasMore: true
links:
- href: string
rel: string
lastPage: 0
text/json:
schema:
$ref: '#/components/schemas/ModelAndPagination_OfferSummary-Model'
example:
data:
- reference: string
isTopOffer: true
title: string
location: string
modificationDate: string
contractType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
offerFamilyCategory:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisationName: string
organisationDescription: string
organisationLogoUrl: string
contractDuration: string
contractTypeCountry:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
description1: string
description2: string
description1Formatted: string
description2Formatted: string
salaryRange:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
country:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
region:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
department:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
latitude: 0
longitude: 0
professionalCategory:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_links:
- href: string
rel: string
offerUrl: string
_format:
title: string
subtitle: string
tooltip: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
urlRedirectionEmployee: string
urlRedirectionApplicant: string
startPublicationDate: string
beginningDate: string
locations:
- locationReferential:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
clientCode: string
displayedAddress: string
address:
country: string
countryCode: string
countryCodeISO3: string
countrySecondarySubdivision: string
countrySubdivision: string
freeformAddress: string
municipality: string
position:
lat: 0
lon: 0
active: true
_pagination:
start: 0
count: 0
total: 0
resultsPerPage: 0
hasMore: true
links:
- href: string
rel: string
lastPage: 0
/api/v2/offers/getoffer:
get:
tags:
- Offers
summary: "Get an offer by reference.\r\n"
description: Retrieve all the details of an offer based on the provided reference. The reference parameter can contain special characters but they must be URL encoded (eg. /=%2F)
operationId: OffersController_GetOfferByReference
parameters:
- name: reference
in: query
description: The reference of the offer.
schema:
type: string
- name: metadata
in: query
description: "Parameter to show the metadata information associated to the view.\r\nDefault value: false"
schema:
type: boolean
- name: applicationFormMetadata
in: query
description: "Parameter to show the metadata information associated to the job application.\r\nDefault value: false"
schema:
type: boolean
responses:
'200':
description: "A detailed offer.\r\n
All fields respect the form view configuration in the Back Office.\r\n
Fields that are not enabled or visible will be hidden from the output. A field with null value means that the form view configuration enables/shows the field but the field has no value."
content:
application/json:
schema:
$ref: '#/components/schemas/OfferDetail-Model'
example:
applicationUrl: string
startPublicationDate: string
endPublicationDate: string
organisation:
entityCode: string
name: string
description: string
url: string
phoneNumber: string
postCode: string
geolocation:
latitude: 0
longitude: 0
parentName: string
logoUrl: string
maxDelayForConsent: 0
retentionPeriod: 0
generalConditions: string
personalDataConsent: string
isAnonymousOrganisation: true
mainSupervisor:
fullName: string
login: string
firstName: string
lastName: string
email: string
phoneNumber: string
offerTime:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languages:
- languageName:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languageLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customFields:
offer:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
description:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
location:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCriteria:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
offerCustomBlock1:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
offerCustomBlock2:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
offerCustomBlock3:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
offerCustomBlock4:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
attachedFilesUrls:
- string
specialisations:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationQuestions:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answers:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
isRequired: true
freeCriteria1: string
freeCriteria2: string
freeCriteria1Formatted: string
freeCriteria2Formatted: string
operationalManager:
language:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
firstName: string
lastName: string
email: string
phoneNumber: string
numberOfVacancies: 0
recruitingReason:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationNotificationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
usersInChargeOf:
- string
notificationCollection:
- string
geolocation:
latitude: 0
longitude: 0
profileCollection:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
skillCollection:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_applicationformmetadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
fields:
- name: string
controlType: Unknown
dataType: Unknown
label: string
isReadOnly: true
isRequired: true
isVisible: true
order: 0
referentialTypeName: string
isMultipleSelectionAllowed: true
textValidationType: None
maxTextLength: 0
textValidationRegularExpression: string
booleanTrueLabel: string
booleanFalseLabel: string
booleanNullLabel: string
attachmentSettings:
- fileTypeId: 0
label: string
maxRequired: 0
minRequired: 0
maxSizeInBytes: 0
orderNumber: 0
attachmentType: string
reference: string
isTopOffer: true
title: string
location: string
modificationDate: string
contractType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
offerFamilyCategory:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisationName: string
organisationDescription: string
organisationLogoUrl: string
contractDuration: string
contractTypeCountry:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
description1: string
description2: string
description1Formatted: string
description2Formatted: string
salaryRange:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
country:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
region:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
department:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
latitude: 0
longitude: 0
professionalCategory:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_links:
- href: string
rel: string
offerUrl: string
_format:
title: string
subtitle: string
tooltip: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
urlRedirectionEmployee: string
urlRedirectionApplicant: string
beginningDate: string
locations:
- locationReferential:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
clientCode: string
displayedAddress: string
address:
country: string
countryCode: string
countryCodeISO3: string
countrySecondarySubdivision: string
countrySubdivision: string
freeformAddress: string
municipality: string
position:
lat: 0
lon: 0
active: true
text/json:
schema:
$ref: '#/components/schemas/OfferDetail-Model'
example:
applicationUrl: string
startPublicationDate: string
endPublicationDate: string
organisation:
entityCode: string
name: string
description: string
url: string
phoneNumber: string
postCode: string
geolocation:
latitude: 0
longitude: 0
parentName: string
logoUrl: string
maxDelayForConsent: 0
retentionPeriod: 0
generalConditions: string
personalDataConsent: string
isAnonymousOrganisation: true
mainSupervisor:
fullName: string
login: string
firstName: string
lastName: string
email: string
phoneNumber: string
offerTime:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
educationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languages:
- languageName:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languageLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customFields:
offer:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
description:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
location:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCriteria:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
offerCustomBlock1:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
offerCustomBlock2:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
offerCustomBlock3:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
offerCustomBlock4:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
attachedFilesUrls:
- string
specialisations:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationQuestions:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answers:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
isRequired: true
freeCriteria1: string
freeCriteria2: string
freeCriteria1Formatted: string
freeCriteria2Formatted: string
operationalManager:
language:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
firstName: string
lastName: string
email: string
phoneNumber: string
numberOfVacancies: 0
recruitingReason:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationNotificationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
usersInChargeOf:
- string
notificationCollection:
- string
geolocation:
latitude: 0
longitude: 0
profileCollection:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
skillCollection:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_applicationformmetadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
fields:
- name: string
controlType: Unknown
dataType: Unknown
label: string
isReadOnly: true
isRequired: true
isVisible: true
order: 0
referentialTypeName: string
isMultipleSelectionAllowed: true
textValidationType: None
maxTextLength: 0
textValidationRegularExpression: string
booleanTrueLabel: string
booleanFalseLabel: string
booleanNullLabel: string
attachmentSettings:
- fileTypeId: 0
label: string
maxRequired: 0
minRequired: 0
maxSizeInBytes: 0
orderNumber: 0
attachmentType: string
reference: string
isTopOffer: true
title: string
location: string
modificationDate: string
contractType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
offerFamilyCategory:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
organisationName: string
organisationDescription: string
organisationLogoUrl: string
contractDuration: string
contractTypeCountry:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
description1: string
description2: string
description1Formatted: string
description2Formatted: string
salaryRange:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
geographicalLocation:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
country:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
region:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
department:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
latitude: 0
longitude: 0
professionalCategory:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_links:
- href: string
rel: string
offerUrl: string
_format:
title: string
subtitle: string
tooltip: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
urlRedirectionEmployee: string
urlRedirectionApplicant: string
beginningDate: string
locations:
- locationReferential:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
clientCode: string
displayedAddress: string
address:
country: string
countryCode: string
countryCodeISO3: string
countrySecondarySubdivision: string
countrySubdivision: string
freeformAddress: string
municipality: string
position:
lat: 0
lon: 0
active: true
'404':
description: "Not Found\r\n- The reference points to an offer that doesn't exist."
content:
application/json: {}
text/json: {}
'405':
description: "Method Not Allowed\r\n- The request calls this endpoint with any other verb than GET."
content:
application/json: {}
text/json: {}
/api/v2/offers/metadata:
get:
tags:
- Offers
summary: "Get metadata for offer form.\r\n"
description: Retrieve the metadata for offer form.
operationId: OffersController_GetMetadata
responses:
'200':
description: The metadata for the offer form.
content:
application/json:
schema:
$ref: '#/components/schemas/Metadata-Model'
example:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
text/json:
schema:
$ref: '#/components/schemas/Metadata-Model'
example:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
/api/v2/referential:
get:
tags:
- Referential
summary: "Get a list of standard referential data.\r\n"
description: "Retrieve a list of standard referentials data along with their children.\r\nSee here for the list of standard types."
operationId: ReferentialController_GetReferentials
parameters:
- name: filter
in: query
description: "Indicates if the result should include only active, inactive or all referential.\r\nDefault value: all\r\nAllowed values: \"active\", \"inactive\" and \"all\""
schema:
type: string
- name: start
in: query
description: "Index of the requested page.\r\nDefault value: 1"
schema:
type: integer
format: int32
- name: count
in: query
description: "Number of results per page.\r\nDefault value: 100"
schema:
type: integer
format: int32
responses:
'200':
description: "data: Array of referential objects.\r\n_metadata: Object containing metadata information."
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndPagination_ReferentialItem-Model'
example:
data:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_pagination:
start: 0
count: 0
total: 0
resultsPerPage: 0
hasMore: true
links:
- href: string
rel: string
lastPage: 0
text/json:
schema:
$ref: '#/components/schemas/ModelAndPagination_ReferentialItem-Model'
example:
data:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_pagination:
start: 0
count: 0
total: 0
resultsPerPage: 0
hasMore: true
links:
- href: string
rel: string
lastPage: 0
'400':
description: "Bad Request\r\n- The start parameter is below 1.\r\n- The count parameter is below 1.\r\n- The start parameter is higher than the number of pages."
content:
application/json: {}
text/json: {}
'405':
description: "Method Not Allowed\r\n- The request calls this endpoint with any other verb than GET."
content:
application/json: {}
text/json: {}
'/api/v2/referential/{typename}':
get:
tags:
- Referential
summary: "Get a Referential by type name.\r\n"
description: "Retrieve a list of referential data items (and their children if any) based on the provided type name.\r\nSee here for the list of standard type names."
operationId: ReferentialController_GetReferentialByTypeName
parameters:
- name: typename
in: path
description: The referential name (For custom referentials see ReferentialTypes in Models for informations on how to prefix the name with 'customcodetable_').
required: true
schema:
type: string
- name: filter
in: query
description: "Indicates if the result should include only active, inactive or all reference data.\r\nDefault value: all\r\nAllowed values: \"active\", \"inactive\", \"all\""
schema:
type: string
- name: start
in: query
description: "Index of the requested page.\r\nDefault value: 1"
schema:
type: integer
format: int32
- name: count
in: query
description: "Number of results per page.\r\nDefault Value: 100"
schema:
type: integer
format: int32
- name: parentCode
in: query
description: 'If provided, the result will only contain the children of this specified parentCode.'
schema:
type: integer
format: int32
- name: level
in: query
description: 'If provided, the result will only contain items of the specified level. It is ignored when parentCode is provided.'
schema:
type: integer
format: int32
- name: mode
in: query
description: "Indicates the mode of selection for hierarchical referentials (like organisation or offerFamily).\r\nAllowed values:\r\n- \"recursive\": the result will contain the item specified with parentCode and all of its descendants\r\n- \"recursiveNoParent\": the result will contain all of the item's descendants specified with parentCode\r\n- \"shallow\": the result will contain the item specified with parentCode and only its children\r\n- \"shallowNoParent\": the result will contain only the item's descendants specified with parentCode\r\n- \"hierarchical\": the result will contain the direct descendants of the item\r\n- \"hierarchicalForSearch\": the result will contain the item's direct descendants based on referential parameters' value\r\n \r\nThe default value is used when the parameter is invalid or not supported by the requested referential type\r\nIt is ignored when parentCode is not provided for all modes except \"hierarchical\" and \"hierarchicalForSearch\".\r\nDefault value: \"recursive\" for \"organisation\" type, \"recursiveNoParent\" otherwise\r\nSupported values:\r\n - all for \"organisation\" type,\r\n - \"recursiveNoParent\", \"shallowNoParent\", \"hierarchical\" and \"hierarchicalForSearch\" for \"offerProfile\", \"diploma\" and \"geographicalLocation\" type,\r\n - \"recursiveNoParent\" and \"shallowNoParent\" for the rest of the types"
schema:
type: string
responses:
'200':
description: "data: Array of objects that represent referential data tables\r\n_metadata: Object containing metadata information."
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndPagination_ReferentialItem-Model'
example:
data:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_pagination:
start: 0
count: 0
total: 0
resultsPerPage: 0
hasMore: true
links:
- href: string
rel: string
lastPage: 0
text/json:
schema:
$ref: '#/components/schemas/ModelAndPagination_ReferentialItem-Model'
example:
data:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_pagination:
start: 0
count: 0
total: 0
resultsPerPage: 0
hasMore: true
links:
- href: string
rel: string
lastPage: 0
'400':
description: "Bad Request\r\n- The filter parameter is invalid\r\n- The start parameter is below 1.\r\n- The count parameter is below 1.\r\n- The level parameter is below 0.\r\n- The start parameter is higher than the number of pages."
content:
application/json: {}
text/json: {}
'404':
description: "Not Found\r\n- The typename points to a referential that doesn't exist."
content:
application/json: {}
text/json: {}
'405':
description: "Method Not Allowed\r\n- The request calls this endpoint with any other verb than GET."
content:
application/json: {}
text/json: {}
/api/v2/sitesettings:
get:
tags:
- SiteSettings
summary: "Get all site settings.\r\n"
description: Retrieve the site settings.
operationId: SiteSettingsController_GetSiteSettings
responses:
'200':
description: An object that represents site settings.
content:
application/json:
schema:
$ref: '#/components/schemas/MatrixSettings-Model'
example:
matrixXAxisReferentiels:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
matrixYAxisReferentiels:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
selectionMultiple: true
questionLabel: string
text/json:
schema:
$ref: '#/components/schemas/MatrixSettings-Model'
example:
matrixXAxisReferentiels:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
matrixYAxisReferentiels:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
selectionMultiple: true
questionLabel: string
/api/v2/sitesettings/searchenginecriteria:
get:
tags:
- SiteSettings
summary: "Get all search engine criteria.\r\n"
description: Retrieve search engines settings.
operationId: SiteSettingsController_GetSearchEngineCriteria
responses:
'200':
description: '[SearchEngineCriteria[]](#SearchEngineCriteria-Model) - An array that represents search engine criteria.'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SearchEngineCriteria-Model'
example:
- criteria: string
order: 0
label: string
type: string
isDynamic: true
refTypeName: string
isMultiSelection: true
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/SearchEngineCriteria-Model'
example:
- criteria: string
order: 0
label: string
type: string
isDynamic: true
refTypeName: string
isMultiSelection: true
/api/v2/accounts:
post:
tags:
- Account
summary: "Create a Front Office user account.\r\n"
description: Create a Front Office user account (candidate or employee) based on the provided parameters.
operationId: AccountController_CreateAccount
requestBody:
description: The account information.
content:
application/json:
schema:
$ref: '#/components/schemas/Account-Model'
example:
username: string
password: string
organisationId: 0
personalDataConsentReceived: true
retentionDelay: 0
text/json:
schema:
$ref: '#/components/schemas/Account-Model'
example:
username: string
password: string
organisationId: 0
personalDataConsentReceived: true
retentionDelay: 0
responses:
'201':
description: Details of the created account.
content:
application/json:
schema:
$ref: '#/components/schemas/Account-Model'
example:
username: string
password: string
organisationId: 0
personalDataConsentReceived: true
retentionDelay: 0
text/json:
schema:
$ref: '#/components/schemas/Account-Model'
example:
username: string
password: string
organisationId: 0
personalDataConsentReceived: true
retentionDelay: 0
'400':
description: "Bad Request\r\n- The username is not provided.\r\n- The provided username is not a valid e-mail address.\r\n- The setting \"Login is e-mail\" is not activated in the Back Office.\r\n- An account already exists with the provided username.\r\n- The password is neither provided nor auto-generated.\r\n- The provided organisationId does not match an existing organisation."
content:
application/json: {}
text/json: {}
'405':
description: "Method Not Allowed\r\n- The site is using applications without account."
content:
application/json: {}
text/json: {}
/api/v2/applicants/createfromname:
post:
tags:
- Applicant
summary: "Create applicant from full name.\r\n"
description: Create applicant information for the logged-in user only with name and firstname.
operationId: ApplicantController_CreateFromName
requestBody:
description: The applicant information.
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicantName-Model'
example:
lastName: string
firstName: string
text/json:
schema:
$ref: '#/components/schemas/ApplicantName-Model'
example:
lastName: string
firstName: string
responses:
'201':
description: Details of the created applicant.
content:
application/json:
schema:
$ref: '#/components/schemas/Applicant-Model'
example:
personalInformation:
civility:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
middleName: string
title: string
address: string
city: string
postalCode: string
birthDate: string
country:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
skypeAccount: string
receiveSMS: true
phoneNumber2: string
professionalEmail: string
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
nationalities:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
frenchDisabledWorkerStatus: true
frenchPriorityNeighbourhood: true
firstName: string
lastName: string
email: string
phoneNumber: string
jobPreferences:
primaryProfile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
salaryPretensions: string
dateOfAvailability: string
mobility:
geographicalAreas:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
countries:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
regions:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
departments:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
noticeDuration:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
mobilityDelay: string
trainingDateStart: string
trainingDateEnd: string
jobTime:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
secondaryProfiles:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
availability:
acceptsExtra: true
values:
- xAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
education:
diplomas:
- diplomaId: 0
educationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diplomaCode:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yearObtained: 0
college: string
collegeCity: string
studiedLanguages:
- studiedLanguageId: 0
language:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languageLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceList:
- experienceId: 0
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
profile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
company: string
function: string
length: string
consents:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
skills:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
eEOInformation:
doesNotComplete: true
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
race:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
ethnicity:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
veteranStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
incapacityStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
customFields:
personalInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
jobPreferences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
backOfficeData:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock1:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock2:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock3:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock4:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experience:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
text/json:
schema:
$ref: '#/components/schemas/Applicant-Model'
example:
personalInformation:
civility:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
middleName: string
title: string
address: string
city: string
postalCode: string
birthDate: string
country:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
skypeAccount: string
receiveSMS: true
phoneNumber2: string
professionalEmail: string
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
nationalities:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
frenchDisabledWorkerStatus: true
frenchPriorityNeighbourhood: true
firstName: string
lastName: string
email: string
phoneNumber: string
jobPreferences:
primaryProfile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contractDuration: string
salaryPretensions: string
dateOfAvailability: string
mobility:
geographicalAreas:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
countries:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
regions:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
departments:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
noticeDuration:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
mobilityDelay: string
trainingDateStart: string
trainingDateEnd: string
jobTime:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
secondaryProfiles:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
availability:
acceptsExtra: true
values:
- xAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yAxis:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
education:
diplomas:
- diplomaId: 0
educationLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diplomaCode:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
specialisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
yearObtained: 0
college: string
collegeCity: string
studiedLanguages:
- studiedLanguageId: 0
language:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
languageLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experienceList:
- experienceId: 0
experienceLevel:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
profile:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
contract:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
company: string
function: string
length: string
consents:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
skills:
- code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
eEOInformation:
doesNotComplete: true
sex:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
race:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
ethnicity:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
veteranStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
incapacityStatus:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
_metadata:
blocks:
- blockIdentifier: string
blockLabel: string
blockOrder: 0
customFields:
- fieldName: string
fieldLabel: string
fieldCustomTableCode: string
fieldOrder: 0
path: string
customFields:
personalInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
jobPreferences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experiences:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
backOfficeData:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
furtherInformation:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock1:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock2:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock3:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicantCustomBlock4:
associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
diploma:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
experience:
- associatedObjectIdentifier: 0
date1: string
date2: string
date3: string
shortText1: string
shortText2: string
shortText3: string
longText1: string
longText2: string
longText3: string
longText1Formatted: string
longText2Formatted: string
longText3Formatted: string
customCodeTable1:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable2:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
customCodeTable3:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
'400':
description: "Bad Request\r\n- The model has validation errors. (Check [ApplicantName](#Applicant-Model) model for constraints).\r\n- The logged-in user already has associated applicant information.\r\n- The body of the request is null or doesn't match the [ApplicantName](#Applicant-Model) contract."
content:
application/json: {}
text/json: {}
'403':
description: "Forbidden\r\n- You called this endpoint without a token of grant_type = \"password\"."
content:
application/json: {}
text/json: {}
/api/v2/applicants/multilocationsapplications:
post:
tags:
- Application
summary: ApplicationController_PostLocationsOfferApplications
operationId: ApplicationController_PostLocationsOfferApplications
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Application-Model'
example:
id: 0
type: Offer
offerReference: string
offerTitle: string
isOfferPublished: true
organisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
motivation: string
referralCode: string
files:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationAnswers:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answer:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
date: string
status:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
personalDataConsentReceived: true
retentionDelay: 0
frenchDisabledWorkerStatus: true
locations:
- clientCode: string
text/json:
schema:
$ref: '#/components/schemas/Application-Model'
example:
id: 0
type: Offer
offerReference: string
offerTitle: string
isOfferPublished: true
organisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
motivation: string
referralCode: string
files:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationAnswers:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answer:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
date: string
status:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
personalDataConsentReceived: true
retentionDelay: 0
frenchDisabledWorkerStatus: true
locations:
- clientCode: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Application-Model'
example:
id: 0
type: Offer
offerReference: string
offerTitle: string
isOfferPublished: true
organisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
motivation: string
referralCode: string
files:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationAnswers:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answer:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
date: string
status:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
personalDataConsentReceived: true
retentionDelay: 0
frenchDisabledWorkerStatus: true
locations:
- clientCode: string
text/json:
schema:
$ref: '#/components/schemas/Application-Model'
example:
id: 0
type: Offer
offerReference: string
offerTitle: string
isOfferPublished: true
organisation:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
origin:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
motivation: string
referralCode: string
files:
- guid: 00000000-0000-0000-0000-000000000000
name: string
description: string
fileType:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
applicationAnswers:
- question:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
answer:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
date: string
status:
code: 0
clientCode: string
label: string
active: true
parentCode: 0
type: string
parentType: string
hasChildren: true
_links:
- href: string
rel: string
personalDataConsentReceived: true
retentionDelay: 0
frenchDisabledWorkerStatus: true
locations:
- clientCode: string
components:
schemas:
Account-Model:
required:
- username
type: object
properties:
username:
maxLength: 255
minLength: 0
type: string
description: "The username.\r\n
To create an account, the username must be an e-mail address and must not have been used to create another account. The setting \"Login is e-mail\" must be activated in the Back Office."
password:
maxLength: 100
minLength: 0
type: string
description: "The password.\r\n
To create an account, a password might be required based on the configuration in the Back Office. Note that the APIs will never send back a user password."
organisationId:
maximum: 2147483647.0
minimum: 0.0
type: integer
description: "The organisation id.\r\n
It is relevant only for employee user accounts."
format: int32
personalDataConsentReceived:
type: boolean
description: A flag indicating if a consent of personal data is received (this value is ignored for employee website).
retentionDelay:
type: integer
description: 'A value indicating the retention period of the consent, in months (0 will be considered as null and this value is ignored for employee website).'
format: int32
description: " Represents a Front Office user account. Only the fields listed below are available through the APIs.\r\n"
ActionResult-Model:
type: object
properties:
result:
enum:
- AtLeastOneFailure
- AllSuccessfull
- AllFailed
type: string
resultMessage:
type: string
ApplicantDataExportFullStatus-Model:
type: object
properties:
requestStatus:
enum:
- None
- InProgress
- DownloadAvailable
type: string
requestDate:
type: string
format: date-time
downloadUrl:
type: string
expirationDate:
type: string
format: date-time
SecretQuestionPasswordReset-Model:
required:
- username
- securityQuestionId
- securityAnswer
- newPassword
type: object
properties:
username:
maxLength: 255
minLength: 0
type: string
description: "The username.\r\n
To retrieve/change the forgotten password, the username can be also the e-mail address of an existing account."
securityQuestionId:
type: integer
description: "The security question id selected on Front Office account creation.\r\n
The security question id can be retrieved using {[ReferentialByTypeName](#api-Referentials-GetReferentialByTypeName)} entry point with securityquestion type."
format: int32
securityAnswer:
type: string
description: "The answer.\r\n
The answer at the secret question."
newPassword:
maxLength: 100
minLength: 0
type: string
description: "The new password.\r\n
The new password that will change the forgotten password. Note that the APIs will never send back a user password."
description: " Represents a Front Office user's account indentification data. Only the fields listed below are available through the APIs.\r\n"
PasswordResetTicket-Model:
required:
- username
- newPassword
- passwordResetToken
type: object
properties:
username:
maxLength: 255
minLength: 0
type: string
description: The account username.
newPassword:
maxLength: 100
minLength: 0
type: string
description: The new password. Must meet the Front Office complexity rules.
passwordResetToken:
type: string
description: 'The password reset token. Provided by the Token URL parameter in reset password mail send by {[SendForgottenPasswordByEmail](#api-Accounts-SendForgottenPasswordByEmail)} endpoint. One time use and have a limited time of validity.'
description: " Represents a password reset ticket for a Front Office account.\r\n"
Applicant-Model:
required:
- personalInformation
- jobPreferences
type: object
properties:
personalInformation:
$ref: '#/components/schemas/PersonalInformation-Model'
jobPreferences:
$ref: '#/components/schemas/JobPreferences-Model'
education:
$ref: '#/components/schemas/Education-Model'
experiences:
$ref: '#/components/schemas/Experiences-Model'
consents:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: The applicant's consent list. The referential type accepted is consent.
furtherInformation:
$ref: '#/components/schemas/FurtherInformation-Model'
eEOInformation:
$ref: '#/components/schemas/EEOInformation-Model'
_metadata:
$ref: '#/components/schemas/Metadata-Model'
customFields:
$ref: '#/components/schemas/ApplicantDynamicFields-Model'
description: " Represents an applicant. These fields cannot be managed (hidden or displayed) based on the form view configuration of an offer or entity in the Back Office site.\r\n"
PersonalInformation-Model:
required:
- firstName
- lastName
type: object
properties:
civility:
$ref: '#/components/schemas/ReferentialItem-Model'
middleName:
maxLength: 50
minLength: 0
type: string
description: The applicant's middle name.
title:
maxLength: 50
minLength: 0
type: string
description: The applicant's title.
address:
maxLength: 200
minLength: 0
type: string
description: The applicant's address information.
city:
maxLength: 100
minLength: 0
type: string
description: The applicant's address city.
postalCode:
maxLength: 20
minLength: 0
type: string
description: The applicant's address postal code.
birthDate:
type: string
description: The applicant's birth date.
format: date-time
country:
$ref: '#/components/schemas/ReferentialItem-Model'
skypeAccount:
maxLength: 50
minLength: 0
type: string
description: The applicant's skype account.
receiveSMS:
type: boolean
description: The applicant's choice to receive SMS or not.
phoneNumber2:
maxLength: 20
minLength: 0
type: string
description: The applicant's second phone number.
professionalEmail:
type: string
description: The applicant's professional e-mail.
sex:
$ref: '#/components/schemas/ReferentialItem-Model'
nationalities:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: The applicant's nationalities. The referential type accepted is nationality.
frenchDisabledWorkerStatus:
type: boolean
description: The applicant's info if he has a French disabled worker status
frenchPriorityNeighbourhood:
type: boolean
description: The applicant's info if he resides in a French priority neighbourhood
firstName:
maxLength: 50
minLength: 0
type: string
description: The user's first name.
lastName:
maxLength: 50
minLength: 0
type: string
description: The user's last name.
email:
maxLength: 255
minLength: 0
type: string
description: 'The user''s e-mail address. Not necessarily the same e-mail as username. If empty, the username e-mail will be used in this field.'
phoneNumber:
maxLength: 20
minLength: 0
type: string
description: The user's phone number.
description: ''
JobPreferences-Model:
type: object
properties:
primaryProfile:
$ref: '#/components/schemas/ReferentialItem-Model'
contract:
$ref: '#/components/schemas/ReferentialItem-Model'
contractDuration:
maxLength: 200
minLength: 0
type: string
description: The applicant's desired contract duration.
salaryPretensions:
maxLength: 200
minLength: 0
type: string
description: The applicant's salary pretensions.
dateOfAvailability:
type: string
description: The applicant's date of availability.
format: date-time
mobility:
$ref: '#/components/schemas/Mobility-Model'
noticeDuration:
$ref: '#/components/schemas/ReferentialItem-Model'
mobilityDelay:
maxLength: 200
minLength: 0
type: string
description: The applicant's mobility delay.
trainingDateStart:
type: string
description: The applicant's date start training.
format: date-time
trainingDateEnd:
type: string
description: The applicant's date end training.
format: date-time
jobTime:
$ref: '#/components/schemas/ReferentialItem-Model'
secondaryProfiles:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: The applicant's list of secondary profiles. The referential type accepted is offerProfile.
availability:
$ref: '#/components/schemas/MatrixReferential-Model'
description: ''
Education-Model:
type: object
properties:
diplomas:
type: array
items:
$ref: '#/components/schemas/Diploma-Model'
description: An array of diplomas that qualify the applicant's education.
studiedLanguages:
type: array
items:
$ref: '#/components/schemas/StudiedLanguage-Model'
description: An array of studied languages that qualify the applicant's education.
description: ''
Experiences-Model:
type: object
properties:
experienceLevel:
$ref: '#/components/schemas/ReferentialItem-Model'
experienceList:
type: array
items:
$ref: '#/components/schemas/Experience-Model'
description: The list of experiences.
description: ''
ReferentialItem-Model:
type: object
properties:
code:
type: integer
description: The referential code.
format: int32
clientCode:
type: string
description: The referential client code.
label:
type: string
description: The referential label.
active:
type: boolean
description: A flag indicating if the referential is active or not.
parentCode:
type: integer
description: The parent referential code.
format: int32
type:
type: string
description: The name or type of the referential.
parentType:
type: string
description: The parent referential name or type.
hasChildren:
type: boolean
description: Gets or sets a value indicating whether the referential has children or not.
_links:
type: array
items:
$ref: '#/components/schemas/Link-Model'
description: An array of objects that represent links to children referential items.
description: "\r\nHere is the list of referential items available through Get a Referential by type name\r\nand Get a list of standard referential data.
\r\nMore details about referentials here."
FurtherInformation-Model:
type: object
properties:
skills:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: The applicant's list of skills. The referential type accepted is skill.
description: ''
EEOInformation-Model:
type: object
properties:
doesNotComplete:
type: boolean
description: The applicant's choice to have his EEO information registered or not.
sex:
$ref: '#/components/schemas/ReferentialItem-Model'
race:
$ref: '#/components/schemas/ReferentialItem-Model'
ethnicity:
$ref: '#/components/schemas/ReferentialItem-Model'
veteranStatus:
$ref: '#/components/schemas/ReferentialItem-Model'
incapacityStatus:
$ref: '#/components/schemas/ReferentialItem-Model'
description: ''
Metadata-Model:
type: object
properties:
blocks:
type: array
items:
$ref: '#/components/schemas/Block-Model'
description: The list of blocks.
description: " Represent the view information related to the object.
\r\nEach property is represented as a \"field\" object. The path represents the location of the property in the json. You may use the path and the fieldName to retrieve the value.\r\nThere are four types of custom fields: short text, long text, date, and custom code table (referential).\r\nIf the field is a custom code table, it should contain referential items of a specific custom type. The list of available values can be retrieved by using the fieldCustomTableCode\r\nproperty as a type name in the referential api.\r\n"
ApplicantDynamicFields-Model:
type: object
properties:
personalInformation:
$ref: '#/components/schemas/DynamicField-Model'
jobPreferences:
$ref: '#/components/schemas/DynamicField-Model'
experiences:
$ref: '#/components/schemas/DynamicField-Model'
backOfficeData:
$ref: '#/components/schemas/DynamicField-Model'
furtherInformation:
$ref: '#/components/schemas/DynamicField-Model'
applicantCustomBlock1:
$ref: '#/components/schemas/DynamicField-Model'
applicantCustomBlock2:
$ref: '#/components/schemas/DynamicField-Model'
applicantCustomBlock3:
$ref: '#/components/schemas/DynamicField-Model'
applicantCustomBlock4:
$ref: '#/components/schemas/DynamicField-Model'
diploma:
type: array
items:
$ref: '#/components/schemas/DynamicField-Model'
description: Custom fields that contains the list of the applicant's diplomas.
experience:
type: array
items:
$ref: '#/components/schemas/DynamicField-Model'
description: Custom fields that contains the list of the applicant's experiences.
description: ''
Mobility-Model:
type: object
properties:
geographicalAreas:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: 'The applicant''s mobility : geographical area. The referential type accepted is offerGeographicalLocation.'
countries:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: 'The applicant''s mobility : country. The referential type accepted is country.'
regions:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: 'The applicant''s mobility : region. The referential type accepted is region.'
departments:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: 'The applicant''s mobility : department. The referential type accepted is department.'
description: ''
MatrixReferential-Model:
type: object
properties:
acceptsExtra:
type: boolean
description: A boolean indicating if the values of the matrix have been used or not.
values:
type: array
items:
$ref: '#/components/schemas/MatrixValue-Model'
description: The list of matrix values.
description: " Represent the view information related to the matrix object.\r\n"
Diploma-Model:
type: object
properties:
diplomaId:
type: integer
description: 'The identifier of the specific diploma information, used to specify the modification of the correct item.'
format: int32
educationLevel:
$ref: '#/components/schemas/ReferentialItem-Model'
diplomaCode:
$ref: '#/components/schemas/ReferentialItem-Model'
specialisation:
$ref: '#/components/schemas/ReferentialItem-Model'
yearObtained:
type: integer
description: The diploma's year obtained.
format: int32
college:
maxLength: 1000
minLength: 0
type: string
description: The diploma's college.
collegeCity:
maxLength: 100
minLength: 0
type: string
description: The diploma's college city.
StudiedLanguage-Model:
type: object
properties:
studiedLanguageId:
type: integer
description: 'The identifier of the specific studied language information, used to specify the modification of the correct item.'
format: int32
language:
$ref: '#/components/schemas/ReferentialItem-Model'
languageLevel:
$ref: '#/components/schemas/ReferentialItem-Model'
description: ''
Experience-Model:
type: object
properties:
experienceId:
type: integer
description: 'The identifier of the specific Experience information, used to specify the modification of the correct item.'
format: int32
experienceLevel:
$ref: '#/components/schemas/ReferentialItem-Model'
profile:
$ref: '#/components/schemas/ReferentialItem-Model'
contract:
$ref: '#/components/schemas/ReferentialItem-Model'
company:
maxLength: 50
minLength: 0
type: string
description: The company under which the experience was acquired.
function:
maxLength: 100
minLength: 0
type: string
description: The function performed during the experience.
length:
maxLength: 200
minLength: 0
type: string
description: The lenght of the experience.
Link-Model:
type: object
properties:
href:
type: string
description: The URL of the link.
rel:
type: string
description: The rel type of the link.
Block-Model:
type: object
properties:
blockIdentifier:
type: string
description: The identifier of the block.
blockLabel:
type: string
description: The title of the block as configured in the back-office.
blockOrder:
type: integer
description: Gets or sets the order of the block as configured in the back-office.
format: int32
customFields:
type: array
items:
$ref: '#/components/schemas/Field-Model'
description: The list of fields associated to the block.
DynamicField-Model:
type: object
properties:
associatedObjectIdentifier:
type: integer
format: int32
date1:
type: string
description: A date.
format: date-time
date2:
type: string
description: A date.
format: date-time
date3:
type: string
description: A date.
format: date-time
shortText1:
maxLength: 100
minLength: 0
type: string
description: A short text.
shortText2:
maxLength: 100
minLength: 0
type: string
description: A short text.
shortText3:
maxLength: 100
minLength: 0
type: string
description: A short text.
longText1:
maxLength: 1500
minLength: 0
type: string
description: A long text.
longText2:
maxLength: 1500
minLength: 0
type: string
description: A long text.
longText3:
maxLength: 1500
minLength: 0
type: string
description: A long text.
longText1Formatted:
type: string
description: A long text with formatting.
longText2Formatted:
type: string
description: A long text with formatting.
longText3Formatted:
type: string
description: A long text with formatting.
customCodeTable1:
$ref: '#/components/schemas/ReferentialItem-Model'
customCodeTable2:
$ref: '#/components/schemas/ReferentialItem-Model'
customCodeTable3:
$ref: '#/components/schemas/ReferentialItem-Model'
description: " Represents all the custom fields of a section. Only activated items will be present in the object.\r\n"
MatrixValue-Model:
type: object
properties:
xAxis:
$ref: '#/components/schemas/ReferentialItem-Model'
yAxis:
$ref: '#/components/schemas/ReferentialItem-Model'
Field-Model:
type: object
properties:
fieldName:
type: string
description: The name of the field in the object output.
fieldLabel:
type: string
description: The title of the field as configured in the back-office.
fieldCustomTableCode:
type: string
description: The code of the custom referential list used by the field (only for customCodeTable fields)
fieldOrder:
type: integer
description: Gets or sets the order of the field in the block as configured in the back-office.
format: int32
path:
type: string
description: The path of the field in the object output.
FileIdList-Model:
type: object
properties:
fileIds:
type: array
items:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
description: " Represents the file ids list object\r\n"
ApplicantName-Model:
required:
- lastName
- firstName
type: object
properties:
lastName:
maxLength: 50
minLength: 0
type: string
description: The user's last name.
firstName:
maxLength: 50
minLength: 0
type: string
description: The user's first name.
description: " Represents an applicant with only a firstname and lastname\r\n"
ModelAndPagination_Application-Model:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Application-Model'
description: An array of objects that represent applications.
_pagination:
$ref: '#/components/schemas/Pagination-Model'
Application-Model:
type: object
properties:
id:
type: integer
description: The application's id. Field not mandatory for creation.
format: int32
type:
enum:
- Offer
- Spontaneous
type: string
description: The application's type.
offerReference:
maxLength: 50
minLength: 0
type: string
description: The application's offer reference. Field required for creation if the type is "offer".
offerTitle:
maxLength: 104
minLength: 0
type: string
description: The application's offer title.
isOfferPublished:
type: boolean
description: Gets or sets a value indicating whether the related vacancy is published. It is read-only.
organisation:
$ref: '#/components/schemas/ReferentialItem-Model'
origin:
$ref: '#/components/schemas/ReferentialItem-Model'
motivation:
maxLength: 1000
minLength: 0
type: string
description: The application's motivation.
referralCode:
type: string
files:
type: array
items:
$ref: '#/components/schemas/FileInfo-Model'
description: An array of FileInfo objects. In the case of application creation the field is optional based on the form view configuration of the applied offer or organisation.
applicationAnswers:
type: array
items:
$ref: '#/components/schemas/ApplicationAnswer-Model'
description: An array of objects that represents the answers given to the offer's question by the applicant.
date:
type: string
description: The application's date.
format: date-time
status:
$ref: '#/components/schemas/ReferentialItem-Model'
personalDataConsentReceived:
type: boolean
description: Gets or sets the status indicating if a consent of personal data is received (this value is ignored for employee website)
retentionDelay:
type: integer
description: 'A value indicating the retention period of the consent, in months (0 will be considered as null and this value is ignored for employee website)'
format: int32
frenchDisabledWorkerStatus:
type: boolean
description: A value indicating if the applicant has the French disabled worker status (RQTH)
locations:
type: array
items:
$ref: '#/components/schemas/Location-Model'
description: " Represents an application to an offer or a spontaneous application.\r\n"
Pagination-Model:
type: object
properties:
start:
type: integer
description: Index of the requested page.
format: int32
count:
type: integer
description: Number of returned results.
format: int32
total:
type: integer
description: Total number of results.
format: int32
resultsPerPage:
type: integer
description: Number of results per page.
format: int32
hasMore:
type: boolean
description: Indicates if more results pages are available.
links:
type: array
items:
$ref: '#/components/schemas/Link-Model'
description: An array of objects that represent links to navigation pages.
lastPage:
type: integer
description: Index of the last page.
format: int32
description: " Represents information for navigating among pages of data.\r\n"
FileInfo-Model:
type: object
properties:
guid:
type: string
description: A string chain that represents the file id.
format: uuid
example: 00000000-0000-0000-0000-000000000000
name:
type: string
description: The name of the file.
description:
type: string
description: The description of the file.
fileType:
$ref: '#/components/schemas/ReferentialItem-Model'
description: " Represents a file. A common use is the applicant's CV or covering letter.\r\n"
ApplicationAnswer-Model:
type: object
properties:
question:
$ref: '#/components/schemas/ReferentialItem-Model'
answer:
$ref: '#/components/schemas/ReferentialItem-Model'
Location-Model:
type: object
properties:
clientCode:
type: string
ApplicantApplication-Model:
required:
- applicant
- application
type: object
properties:
applicant:
$ref: '#/components/schemas/Applicant-Model'
application:
$ref: '#/components/schemas/Application-Model'
uploadedFiles:
type: array
items:
$ref: '#/components/schemas/UploadedFileInfo-Model'
description: An array of UploadedFileInfo objects. In the case of application creation the field is optional based on the form view configuration of the applied offer or organisation.
description: " Represents applicant information and an application (attached files including) to an offer or a spontaneous application, for creating an application without front office account creation.\r\n"
UploadedFileInfo-Model:
type: object
properties:
description:
type: string
description: The file description.
fileTypeId:
type: string
description: The file type identifier. The Referential type accepted is fileType.
key:
type: string
description: A key to recover the file content.
description: " Represents the uploaded file infos. A common use is the applicant's CV or covering letter.\r\n"
Bookmark-Model:
type: object
properties:
title:
type: string
description: The offer title.
reference:
type: string
description: The offer reference number.
address:
type: string
description: The offer location.
isPublished:
type: boolean
description: The offer publication status.
organisation:
$ref: '#/components/schemas/Entity-Model'
contractType:
$ref: '#/components/schemas/ReferentialItem-Model'
description: " Represents a favourite offer.\r\n"
Entity-Model:
type: object
properties:
entityCode:
type: string
description: The organisation's code.
name:
type: string
description: The organisation's name.
description:
type: string
description: The organisation's description.
url:
type: string
description: The organisation's website url.
phoneNumber:
type: string
description: The organisation's phone number.
postCode:
type: string
description: The organisation's postal code.
geolocation:
$ref: '#/components/schemas/GeoCoordinate-Model'
parentName:
type: string
description: The name of the parent organisation. Can be null if the organsiation is the head of the company.
logoUrl:
type: string
description: The URL of the logo of the organisation.
maxDelayForConsent:
type: integer
description: The maximum number of days to wait for applicant consent.
format: int32
retentionPeriod:
type: integer
description: The number of months to keep personal data.
format: int32
generalConditions:
type: string
description: A localized text that represents the general conditions of the organisation.
personalDataConsent:
type: string
description: A localized text that represents the personal data consent.
description: " Represents details of an organisation. Only the fields listed below are available through the APIs.\r\n"
GeoCoordinate-Model:
type: object
properties:
latitude:
type: number
description: The latitude of the organisation geolocation.
format: double
longitude:
type: number
description: The longitude of the organisation geolocation.
format: double
description: ''
ModelAndPagination_FileInfo-Model:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/FileInfo-Model'
description: An array of objects that represent applications.
_pagination:
$ref: '#/components/schemas/Pagination-Model'
OfferDetail-Model:
type: object
properties:
applicationUrl:
type: string
description: The URL of the page where to apply to the offer.
startPublicationDate:
type: string
description: The start date of publication.
format: date-time
endPublicationDate:
type: string
description: The end date of publication.
format: date-time
organisation:
$ref: '#/components/schemas/Entity-Model'
isAnonymousOrganisation:
type: boolean
description: A flag indicating if the organisation information should be hidden or not.
mainSupervisor:
$ref: '#/components/schemas/MainSupervisor-Model'
offerTime:
$ref: '#/components/schemas/ReferentialItem-Model'
educationLevel:
$ref: '#/components/schemas/ReferentialItem-Model'
diploma:
$ref: '#/components/schemas/ReferentialItem-Model'
experienceLevel:
$ref: '#/components/schemas/ReferentialItem-Model'
languages:
type: array
items:
$ref: '#/components/schemas/LanguageSkill-Model'
description: An array of objects that represent the applicant's minimum required languages skills.
customFields:
$ref: '#/components/schemas/OfferDynamicFields-Model'
attachedFilesUrls:
type: array
items:
type: string
description: An array of strings that represent the URLs of the attached files of the offer.
specialisations:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: An array of objects that represent the applicant's specialisations. The referential type accepted is specialisation.
applicationQuestions:
type: array
items:
$ref: '#/components/schemas/ApplicationQuestion-Model'
description: An array of objects that represent the questions the applicant may have to answer in a application.
freeCriteria1:
type: string
description: A free criterion.
freeCriteria2:
type: string
description: Another free criterion.
freeCriteria1Formatted:
type: string
description: A free criterion with formatting.
freeCriteria2Formatted:
type: string
description: Another free criterion with formatting.
operationalManager:
$ref: '#/components/schemas/OriginUser-Model'
numberOfVacancies:
type: integer
description: Number of vacancies of the offer.
format: int32
recruitingReason:
$ref: '#/components/schemas/ReferentialItem-Model'
applicationNotificationLevel:
$ref: '#/components/schemas/ReferentialItem-Model'
usersInChargeOf:
type: array
items:
type: string
description: List of in charge users.
notificationCollection:
type: array
items:
type: string
description: List of notificants employees.
geolocation:
$ref: '#/components/schemas/GeoCoordinate-Model'
profileCollection:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: An array of objects that represent the profile of the application. The referential type accepted is offerProfile.
skillCollection:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: An array of objects that represent the skill of the applicantion. The referential type accepted is skill.
_applicationformmetadata:
$ref: '#/components/schemas/FormMetadata-Model'
reference:
type: string
description: A unique string representing the offer.
isTopOffer:
type: boolean
description: A flag indicating if the offer is highlighted.
title:
type: string
description: The title of the job.
location:
type: string
description: The location of the job.
modificationDate:
type: string
description: The last modification date of the offer.
format: date-time
contractType:
$ref: '#/components/schemas/ReferentialItem-Model'
offerFamilyCategory:
$ref: '#/components/schemas/ReferentialItem-Model'
organisationName:
type: string
description: The name of the organisation making the offer.
organisationDescription:
type: string
description: The description of the organisation making the offer.
organisationLogoUrl:
type: string
description: The URL of the logo of the organisation making the offer.
contractDuration:
maxLength: 200
minLength: 0
type: string
description: The duration of the contract.
contractTypeCountry:
$ref: '#/components/schemas/ReferentialItem-Model'
description1:
type: string
description: A description of the offer.
description2:
type: string
description: A second description of the offer.
description1Formatted:
type: string
description: A description of the offer with formatting.
description2Formatted:
type: string
description: A second description of the offer with formatting.
salaryRange:
$ref: '#/components/schemas/ReferentialItem-Model'
geographicalLocation:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: The geographical location of the offer.
country:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: The country of the offer.
region:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: The region of the offer.
department:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: The department of the offer.
latitude:
maximum: 90.0
minimum: -90.0
type: number
description: 'The latitude, e.g. 48.869576.'
format: double
longitude:
maximum: 180.0
minimum: -180.0
type: number
description: 'The longitude, e.g. 2.30825.'
format: double
professionalCategory:
$ref: '#/components/schemas/ReferentialItem-Model'
_links:
type: array
items:
$ref: '#/components/schemas/Link-Model'
description: An array of objects that represent links to more information related to the offer.
offerUrl:
type: string
description: The customer web site offer url.
_format:
$ref: '#/components/schemas/FormatFields-Model'
_metadata:
$ref: '#/components/schemas/Metadata-Model'
urlRedirectionEmployee:
type: string
description: Specific URL set to allow Employees to apply to the vacancy - will be available only if the API is used in a context of Internal mobility.
urlRedirectionApplicant:
type: string
description: Specific URL set to allow Candidates to apply to the vacancy - will be available only if the API is used in a context of external recruitment.
beginningDate:
type: string
description: The beginning date of the offer.
format: date-time
locations:
type: array
items:
$ref: '#/components/schemas/MultiLocation-Model'
description: " Represents details of an offer. Only the fields listed below are available through the APIs. These fields can be managed (hidden or displayed) based on the form view configuration in the Back Office site.\r\n"
MainSupervisor-Model:
required:
- firstName
- lastName
type: object
properties:
fullName:
type: string
description: The main supervisor's fullname.
login:
type: string
description: The main supervisor's login.
firstName:
maxLength: 50
minLength: 0
type: string
description: The user's first name.
lastName:
maxLength: 50
minLength: 0
type: string
description: The user's last name.
email:
maxLength: 255
minLength: 0
type: string
description: 'The user''s e-mail address. Not necessarily the same e-mail as username. If empty, the username e-mail will be used in this field.'
phoneNumber:
maxLength: 20
minLength: 0
type: string
description: The user's phone number.
description: " Represents a MainSupervisor.\r\n"
LanguageSkill-Model:
type: object
properties:
languageName:
$ref: '#/components/schemas/ReferentialItem-Model'
languageLevel:
$ref: '#/components/schemas/ReferentialItem-Model'
OfferDynamicFields-Model:
type: object
properties:
offer:
$ref: '#/components/schemas/DynamicField-Model'
description:
$ref: '#/components/schemas/DynamicField-Model'
location:
$ref: '#/components/schemas/DynamicField-Model'
applicantCriteria:
$ref: '#/components/schemas/DynamicField-Model'
origin:
$ref: '#/components/schemas/DynamicField-Model'
offerCustomBlock1:
$ref: '#/components/schemas/DynamicField-Model'
offerCustomBlock2:
$ref: '#/components/schemas/DynamicField-Model'
offerCustomBlock3:
$ref: '#/components/schemas/DynamicField-Model'
offerCustomBlock4:
$ref: '#/components/schemas/DynamicField-Model'
description: ''
ApplicationQuestion-Model:
type: object
properties:
question:
$ref: '#/components/schemas/ReferentialItem-Model'
answers:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: The possible answers to the question. The referential type accepted is applicationQuestionAnswer.
isRequired:
type: boolean
description: Is an answer to the question is required or not.
OriginUser-Model:
required:
- firstName
- lastName
type: object
properties:
language:
$ref: '#/components/schemas/ReferentialItem-Model'
firstName:
maxLength: 50
minLength: 0
type: string
description: The user's first name.
lastName:
maxLength: 50
minLength: 0
type: string
description: The user's last name.
email:
maxLength: 255
minLength: 0
type: string
description: 'The user''s e-mail address. Not necessarily the same e-mail as username. If empty, the username e-mail will be used in this field.'
phoneNumber:
maxLength: 20
minLength: 0
type: string
description: The user's phone number.
description: " Represents an OperationalManager.\r\n"
FormMetadata-Model:
type: object
properties:
blocks:
type: array
items:
$ref: '#/components/schemas/FormMetadataBlock-Model'
description: The blocks contained in the form
attachmentSettings:
type: array
items:
$ref: '#/components/schemas/FileSettings-Model'
description: The requirements of the form attachments
description: ' Represents all the information related to a form view.'
FormatFields-Model:
type: object
properties:
title:
type: string
description: The formatted string for the title.
subtitle:
type: string
description: The formatted string for the subtitle.
tooltip:
type: string
description: The formatted string for the tooltip.
description: ''
MultiLocation-Model:
type: object
properties:
locationReferential:
$ref: '#/components/schemas/ReferentialItem-Model'
clientCode:
type: string
displayedAddress:
type: string
address:
$ref: '#/components/schemas/MultiLocationAddress-Model'
position:
$ref: '#/components/schemas/MultiLocationPosition-Model'
active:
type: boolean
FormMetadataBlock-Model:
type: object
properties:
blockIdentifier:
type: string
description: The identifier of the block
blockLabel:
type: string
description: The label of the block
blockOrder:
type: integer
description: The order of the block
format: int32
fields:
type: array
items:
$ref: '#/components/schemas/FormMetadataField-Model'
description: The metadata of the fields contained in the block
FileSettings-Model:
type: object
properties:
fileTypeId:
type: integer
description: The file type.
format: int32
label:
type: string
description: The label of file type.
maxRequired:
type: integer
description: The maximum number of files to attach.
format: int32
minRequired:
type: integer
description: The minimum required number files to attach.
format: int32
maxSizeInBytes:
type: integer
description: The maximum size of a file in bytes.
format: int32
orderNumber:
type: integer
description: Gets or sets gets and sets the order of the attachments.
format: int32
attachmentType:
type: string
description: Gets or sets gets and sets the type of the attachments.
description: " Represents a file setting.\r\n"
MultiLocationAddress-Model:
type: object
properties:
country:
type: string
countryCode:
type: string
countryCodeISO3:
type: string
countrySecondarySubdivision:
type: string
countrySubdivision:
type: string
freeformAddress:
type: string
municipality:
type: string
MultiLocationPosition-Model:
type: object
properties:
lat:
type: number
format: double
lon:
type: number
format: double
FormMetadataField-Model:
type: object
properties:
name:
type: string
description: The name of the property in the response
controlType:
enum:
- Unknown
- CheckBox
- DateTimePicker
- DependentDropDownList
- DropDownList
- ListBox
- Matrix
- TextArea
- TextBox
- Tree
- RadioButton
type: string
description: The control type of the field
dataType:
enum:
- Unknown
- Boolean
- Date
- Referential
- String
type: string
description: The data type of the field
label:
type: string
description: The label of the field
isReadOnly:
type: boolean
description: A value indicating whether the field is read-only
isRequired:
type: boolean
description: A value indicating whether the field is required
isVisible:
type: boolean
description: A value indicating whether the field is visible
order:
type: integer
description: The order of the field in the block
format: int32
referentialTypeName:
type: string
description: "The name of the referential type used to fetch referential items.\r\nShould be ignored when the data type is not a referential."
isMultipleSelectionAllowed:
type: boolean
description: "A value indicating whether the multiple selection of referential items is allowed.\r\nShould be ignored when the data type is not a referential."
textValidationType:
enum:
- None
- Default
- PhoneNumber
- Email
- Numeric
- Decimal
- NoWildcard
- SomeWildcard
- EmailList
- Custom
- Dynamic
- YearInRange
type: string
description: "The text validation type of the field.\r\nShould be ignored when the data type is not a string."
maxTextLength:
type: integer
description: "The maximum number of characters allowed.\r\nShould be ignored when the data type is not a string."
format: int32
textValidationRegularExpression:
type: string
description: "The regular expression linked to the TextValidationType to validate the text value.\r\nShould be ignored when the data type is not a string."
booleanTrueLabel:
type: string
description: "The label of the \"true\" value.\r\nShould be ignored when the data type is not a boolean."
booleanFalseLabel:
type: string
description: "The label of the \"false\" value.\r\nShould be ignored when the data type is not a boolean."
booleanNullLabel:
type: string
description: "The label of the \"null\" value.\r\nShould be ignored when the data type is not a boolean."
EngineSettings-Model:
type: object
properties:
criteria:
type: array
items:
$ref: '#/components/schemas/Criterion-Model'
description: The list of criteria.
description: " Represent the list of active criteria that can be used to create a job alert.
\r\nEach property is represented as a \"criterion\" object, it contains the name of the criterion in the model, the corresponding configured label and,\r\nif applicable, the type of the associated referential type.\r\n"
Criterion-Model:
type: object
properties:
block:
type: string
description: The name of the block associated to the field of the criterion.
name:
type: string
description: The name of the field of the criterion.
label:
type: string
description: The title of the criterion as configured in the back-office.
isDynamicField:
type: boolean
description: A flag to distinguish a dynamic field.
referentialType:
type: string
description: The code of the type of referential used by the criterion.
isMultiSelection:
type: boolean
description: Gets or sets a value indicating whether the criterion allows multiline selection
isInEmailAlerting:
type: boolean
description: Gets or sets a value indicating whether the criterion is in email alerting
OffersSubscription-Model:
type: object
properties:
offerCriteria:
$ref: '#/components/schemas/OfferCriteria-Model'
isEmailAlert:
type: boolean
description: Indicates whether the Job Alert is an email alert.
validationPeriod:
$ref: '#/components/schemas/ReferentialItem-Model'
alertMail:
type: string
description: The email to send subscription emails.
_metadata:
type: string
description: 'When using the without account API, this field contains a GUID that refer to a token that must be given to have the rights to modify this Job Alert.'
format: uuid
example: 00000000-0000-0000-0000-000000000000
description: " Represents the Job Alert model.\r\n"
OfferCriteria-Model:
type: object
properties:
keywords:
type: string
description: Offer's keywords.
offerFamilyCategory:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: An array of offer's family categories. The referential type accepted is offerFamilyCategory.
contractType:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: An array of offer's contract type. The referential type accepted is contractType.
geographicalLocation:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: 'An array of offer''s geographical area. The referential types accepted are offerGeographicalLocation, offerCountry,offerRegion, offerDepartment.'
educationLevel:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: An array of offer's education levels. The referential type accepted is educationLevel.
experienceLevel:
$ref: '#/components/schemas/ReferentialItem-Model'
contractDuration:
maxLength: 200
minLength: 0
type: string
description: Offer's contract duration.
location:
type: string
description: Offer's location string.
locationCriteria:
$ref: '#/components/schemas/Geolocalisation-Model'
locations:
type: array
items:
type: string
professionalCategory:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: An array of offer's professional category. The referential type accepted is professionalCategory.
diploma:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: An array of offer's diplomas. The referential type accepted is diploma.
organisation:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: An array of offer's organisations. The referential type accepted is organisation.
salaryRange:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: An array of offer's salary ranges. The referential type accepted is salaryRange.
title:
type: string
description: The offer title.
offerTime:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: An array of offer's times. The referential type accepted is offerTime.
specialisation:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: An array of offer's specialisations. The referential type accepted is specialisation.
dynamicFields:
type: array
items:
$ref: '#/components/schemas/DynamicFieldCriteria-Model'
description: The list of personalised referential used as search criteria for the offer.
reference:
type: string
description: Gets or sets the offer's reference.
description: " Represents the different criteria available for an offer.\r\n"
Geolocalisation-Model:
type: object
properties:
radius:
$ref: '#/components/schemas/ReferentialItem-Model'
address:
maxLength: 200
minLength: 0
type: string
description: A string representing the address of the location ot its poximity.
latitude:
maximum: 90.0
minimum: -90.0
type: number
description: The geolocation latitude.
format: double
longitude:
maximum: 180.0
minimum: -180.0
type: number
description: The geolocation longitude.
format: double
description: " Represents the location criterias available for an offer.\r\n"
DynamicFieldCriteria-Model:
type: object
properties:
blockIdentifier:
type: string
description: The block to which the personalised referential belongs to.
name:
type: string
description: The name of the referential.
value:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: The value of the referential.
OffersSubscriptionWithConsent-Model:
type: object
properties:
personalDataConsentReceived:
type: boolean
description: A flag indicating if a consent of personal data is received (this value is ignored for employee website)
retentionDelay:
type: integer
description: 'A value indicating the retention period of the consent, in months (0 will be considered as null and this value is ignored for employee website)'
format: int32
offerCriteria:
$ref: '#/components/schemas/OfferCriteria-Model'
isEmailAlert:
type: boolean
description: Indicates whether the Job Alert is an email alert.
validationPeriod:
$ref: '#/components/schemas/ReferentialItem-Model'
alertMail:
type: string
description: The email to send subscription emails.
_metadata:
type: string
description: 'When using the without account API, this field contains a GUID that refer to a token that must be given to have the rights to modify this Job Alert.'
format: uuid
example: 00000000-0000-0000-0000-000000000000
description: " Represents the Job Alert model.\r\n"
SearchOfferCriteria-Model:
type: object
properties:
keywords:
type: string
description: /// Gets or sets Keywords.
offerFamilyCategory:
type: array
items:
type: integer
format: int32
description: Gets or sets A job family category code.
contractType:
type: array
items:
type: integer
format: int32
description: Gets or sets A contract type code.
geographicalLocation:
type: array
items:
type: integer
format: int32
description: Gets or sets A code representing a department / region / country / geographical area to which the offer is linked.
educationLevel:
type: array
items:
type: integer
format: int32
description: Gets or sets An education level code.
experienceLevel:
type: integer
description: Gets or sets An experience level code.
format: int32
contractDuration:
type: string
description: Gets or sets A contract duration.
professionalCategory:
type: array
items:
type: integer
format: int32
description: Gets or sets A professional category code.
diploma:
type: array
items:
type: integer
format: int32
description: Gets or sets A diploma code.
organisation:
type: array
items:
type: integer
format: int32
description: Gets or sets An entity code.
salaryRange:
type: array
items:
type: integer
format: int32
description: Gets or sets A salary range code.
title:
type: string
description: Gets or sets An offer title.
offerTime:
type: array
items:
type: integer
format: int32
description: Gets or sets An offer time code.
location:
type: string
description: Gets or sets A location.
locations:
type: array
items:
type: string
description: Gets or sets A location.
latitude:
maximum: 90.0
minimum: -90.0
type: number
description: 'Gets or sets A latitude, e.g. 48.869576.'
format: double
longitude:
maximum: 180.0
minimum: -180.0
type: number
description: 'Gets or sets A longitude, e.g. 2.30825.'
format: double
radius:
type: integer
description: Gets or sets A radius code.
format: int32
specialisation:
type: array
items:
type: integer
format: int32
description: Gets or sets A specialisation code.
dynamicFields:
type: array
items:
type: string
description: 'Gets or sets A string with the format `bbbb.pppp.iiii` where `bbbb` is the block identifier, `pppp` a custom code table property name, and `iiii` the code of the referential to look for. ex: `Offer.customCodeTable1.1576`. The key can be included multiple times to specify multiple dynamic field values.'
reference:
type: string
description: Gets or sets the offer's reference.
ModelAndPagination_OfferSummary-Model:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/OfferSummary-Model'
description: An array of objects that represent applications.
_pagination:
$ref: '#/components/schemas/Pagination-Model'
OfferSummary-Model:
type: object
properties:
reference:
type: string
description: A unique string representing the offer.
isTopOffer:
type: boolean
description: A flag indicating if the offer is highlighted.
title:
type: string
description: The title of the job.
location:
type: string
description: The location of the job.
modificationDate:
type: string
description: The last modification date of the offer.
format: date-time
contractType:
$ref: '#/components/schemas/ReferentialItem-Model'
offerFamilyCategory:
$ref: '#/components/schemas/ReferentialItem-Model'
organisationName:
type: string
description: The name of the organisation making the offer.
organisationDescription:
type: string
description: The description of the organisation making the offer.
organisationLogoUrl:
type: string
description: The URL of the logo of the organisation making the offer.
contractDuration:
maxLength: 200
minLength: 0
type: string
description: The duration of the contract.
contractTypeCountry:
$ref: '#/components/schemas/ReferentialItem-Model'
description1:
type: string
description: A description of the offer.
description2:
type: string
description: A second description of the offer.
description1Formatted:
type: string
description: A description of the offer with formatting.
description2Formatted:
type: string
description: A second description of the offer with formatting.
salaryRange:
$ref: '#/components/schemas/ReferentialItem-Model'
geographicalLocation:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: The geographical location of the offer.
country:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: The country of the offer.
region:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: The region of the offer.
department:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: The department of the offer.
latitude:
maximum: 90.0
minimum: -90.0
type: number
description: 'The latitude, e.g. 48.869576.'
format: double
longitude:
maximum: 180.0
minimum: -180.0
type: number
description: 'The longitude, e.g. 2.30825.'
format: double
professionalCategory:
$ref: '#/components/schemas/ReferentialItem-Model'
_links:
type: array
items:
$ref: '#/components/schemas/Link-Model'
description: An array of objects that represent links to more information related to the offer.
offerUrl:
type: string
description: The customer web site offer url.
_format:
$ref: '#/components/schemas/FormatFields-Model'
_metadata:
$ref: '#/components/schemas/Metadata-Model'
urlRedirectionEmployee:
type: string
description: Specific URL set to allow Employees to apply to the vacancy - will be available only if the API is used in a context of Internal mobility.
urlRedirectionApplicant:
type: string
description: Specific URL set to allow Candidates to apply to the vacancy - will be available only if the API is used in a context of external recruitment.
startPublicationDate:
type: string
description: The start date of publication.
format: date-time
beginningDate:
type: string
description: The beginning date of the offer.
format: date-time
locations:
type: array
items:
$ref: '#/components/schemas/MultiLocation-Model'
description: ''
ModelAndPagination_ReferentialItem-Model:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: An array of objects that represent applications.
_pagination:
$ref: '#/components/schemas/Pagination-Model'
MatrixSettings-Model:
type: object
properties:
matrixXAxisReferentiels:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: An array of the custom referentials of the X axis.
matrixYAxisReferentiels:
type: array
items:
$ref: '#/components/schemas/ReferentialItem-Model'
description: An array of the custom referentials of the Y axis.
selectionMultiple:
type: boolean
description: A boolean indicating if the selection is multiple.
questionLabel:
type: string
description: The label of the question.
description: " Represents the settings of the matrix.\r\n"
SearchEngineCriteria-Model:
type: object
properties:
criteria:
type: string
description: Name of the setting that will be sent to offersummaries endpoint .
order:
type: integer
description: Order number.
format: int32
label:
type: string
description: Label in the current language.
type:
type: string
description: Expected type.
isDynamic:
type: boolean
description: Boolean that explains if the criteria is a dynamic field.
refTypeName:
type: string
description: The type name of the referential.
isMultiSelection:
type: boolean
description: Gets or sets a value indicating whether the criteria allows multiline selection.
description: " Represents the search engine criteria.\r\n"
securitySchemes:
apiKeyHeader:
type: apiKey
name: Ocp-Apim-Subscription-Key
in: header
apiKeyQuery:
type: apiKey
name: subscription-key
in: query
security:
- apiKeyHeader: []
- apiKeyQuery: []