Recruiting Customer API

ApplicationEvent library

api-v1-referentials-applicationevents-get

Get all application events

Get a list of all available application events. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/applicationevents

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ApplicationEventArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-applicationevents-id-get

Get ApplicationEvent details

Get the details of a ApplicationEvent.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/applicationevents/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the ApplicationEvent

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ApplicationEvent	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-applicationevents-id-translations-get

Get ApplicationEvent translations

Get all translations of a ApplicationEvent.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/applicationevents/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the ApplicationEvent

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ApplicationEventArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-applicationevents-id-translations-lcid-get

Get ApplicationEvent translation details

Get the details of a ApplicationEvent translation.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/applicationevents/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the ApplicationEvent
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ApplicationEvent	The object is returned with success
400		Query not correct
404		Language not present in the application

ApplicationNotification library

api-v1-referentials-applicationnotifications-get

Get all application notifications

Get a list of all available application notifications. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/applicationnotifications

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ApplicationNotificationArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-applicationnotifications-id-get

Get application notification details

Get the details of a applicaion notification.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/applicationnotifications/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the application notification

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ApplicationNotification	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-applicationnotifications-id-translations-get

Get application notification translations

Get all translations of a application notification.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/applicationnotifications/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the application notification

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ApplicationNotificationArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-applicationnotifications-id-translations-lcid-get

Get application notification translation details

Get the details of a application notification translation.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/applicationnotifications/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the application notification
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ApplicationNotification	The object is returned with success
400		Query not correct
404		Language not present in the application

ApplicationStatus library

api-v1-referentials-applicationstatuses-get

Get all application statuses

Get a list of all active application statuses. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/applicationstatuses

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ApplicationStatusArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-applicationstatuses-id-get

Get application status details

Get the details of a application status.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/applicationstatuses/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the application status

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ApplicationStatus	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-applicationstatuses-id-translations-get

Get application status translations

Get all translations of a application status.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/applicationstatuses/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the application status

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ApplicationStatusArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-applicationstatuses-id-translations-lcid-get

Get application status translation details

Get the details of a application status translation.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/applicationstatuses/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the application status
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ApplicationStatus	The object is returned with success
400		Query not correct
404		Language not present in the application

ApplicationType library

api-v1-referentials-applicationtypes-get

Get all application types

Get a list of all available application types. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/applicationtypes

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ApplicationTypeArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-applicationtypes-id-get

Get application type details

Get the details of a applicaion type.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/applicationtypes/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the application type

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ApplicationType	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-applicationtypes-id-translations-get

Get application type translations

Get all translations of a application type.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/applicationtypes/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the application type

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ApplicationTypeArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-applicationtypes-id-translations-lcid-get

Get application type translation details

Get the details of a application type translation.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/applicationtypes/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the application type
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ApplicationType	The object is returned with success
400		Query not correct
404		Language not present in the application

Applications

api-v1-applications-id-attachments-fileId-get

Get application attachment

Get specific attachment an application for a given file identifier

Required authorization

Type	Value(s)
Ressource	JobAppAttachedFile, permission: Use

Request

GET /api/v1/applications/{id}/attachments/{fileId}

Parameters

Name	Type	Default	Notes
*id			Client code of the application
*fileId			Identifier of the file

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_AttachedFile	The object is returned with success
400		Query not correct
404		Identifier doesn't exist

api-v1-applications-id-events-post

Apply an action on the application

Apply an action on the application for the given identifier. Possible actions for a application:

• activate
• deactivate

Required authorization

Type	Value(s)
Ressource	EventsApplicationProcessing, permission: Create

Request

POST /api/v1/applications/{id}/events

Parameters

Name	Type	Default	Notes
*id			The application identifier
*ApplicationChildEventType	ApplicationChildEventType		Apply an action on the application for the given identifier. Possible actions for a application: activate deactivate Required authorization Type Value(s) Ressource EventsApplicationProcessing, permission: Create

Responses

Status Code	Type	Description	Samples
200	object	Action succesfully executed
400		Query not correct
404		Identifier doesn't exist

api-v1-applications-id-referralbonus-post

Add a bonus for a specific referral linked to an application

Add a bonus for a specific referral linked to an application, based on the offer referral mobile bonus publication support.

Required authorization

Type	Value(s)
Ressource	CooptionBonus, permission: Create

Request

POST /api/v1/applications/{id}/referralbonus

Parameters

Name	Type	Default	Notes
*id			The application identifier

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ReferralBonus	The object is returned with success
400		Query not correct
404		Identifier doesn't exist

api-v1-candidates-id-applications-applicationId-attachments-get

Get application attachments

Get a list of all attachments for an application.

Required authorization

Type	Value(s)
Ressource	JobAppAttachedFile, permission: Use

Request

GET /api/v1/candidates/{id}/applications/{applicationId}/attachments

Parameters

Name	Type	Default	Notes
*id			Client code of the candidate
*applicationId			Client code of the application

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_AttachedFile	The object is returned with success
400		Query not correct
404		Identifier doesn't exist

api-v1-candidates-id-applications-applicationId-attachments-fileId-get

Get application attachment

Get specific attachment an application for a given file identifier

Required authorization

Type	Value(s)
Ressource	JobAppAttachedFile, permission: Use

Request

GET /api/v1/candidates/{id}/applications/{applicationId}/attachments/{fileId}

Parameters

Name	Type	Default	Notes
*id			Client code of the candidate
*applicationId			Client code of the application
*fileId			Identifier of the file

Responses

Status Code	Type	Description	Samples
200	object	The object is returned with success
400		Query not correct
404		Identifier doesn't exist

api-v1-candidates-id-vacancies-vacancyReference-post

Create an application. A resume can be attached.

Create the application for the given data

Attach a resume

If you need to attach a resume to the application, you can post a multipart request as following:

Multipart structure

Name	Description	Content-Disposition	Content-Type
applicationJson	The application model json	form-data
uploadedFile	The file content	form-data	file mime type

Remarks:

• The enctype of the request must be "multipart/form-data"
• The max size of a single file depends on the settings in the applicant view
• If no attached file is provided, the default candidate resume will be linked to the application. If no default candidate resume is found, the newest candidate resume will be linked.

Required authorization

Type	Value(s)
Ressource	EventsApplication, permission: Create

Request

POST /api/v1/candidates/{id}/vacancies/{vacancyReference}

Parameters

Name	Type	Default	Notes
*id			The candidate id.
*vacancyReference			Reference of the vacancy see identifier encoding
*ApplicationDetailWrite	ApplicationDetailWrite		Create the application for the given data Attach a resume If you need to attach a resume to the application, you can post a multipart request as following: Multipart structure Name Description Content-Disposition Content-Type applicationJson The application model json form-data uploadedFile The file content form-data file mime type Remarks: The enctype of the request must be "multipart/form-data" The max size of a single file depends on the settings in the applicant view If no attached file is provided, the default candidate resume will be linked to the application. If no default candidate resume is found, the newest candidate resume will be linked. Required authorization Type Value(s) Ressource EventsApplication, permission: Create

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_ApplicationDetailWriteResponse	The object is successfully created and saved
400		The object update fails
404		The specified vacancy doesn't exist

api-v1-vacancies-vacancyReference-applications-post

Create an application. A resume can be attached.

Create the application for the given data

Attach a resume

If you need to attach a resume to the application, you can post a multipart request as following:

Multipart structure (legacy, only support single file attachment)

Name	Description	Content-Disposition	Content-Type
applicationJson	The application model json	form-data
uploadedFile	The file content	form-data	file mime type

Multipart structure (current, supports multiple file attachment)

Name	Description	Content-Disposition	Content-Type
applicationJson	The application model json	form-data
uploadedFileKey	The file content	form-data	file mime type
anotherFileKey	The file content	form-data	file mime type

Remarks:

• The enctype of the request must be "multipart/form-data"
• The max size of a single file depends on the settings in the applicant view
• In case of multiple files attachment, you need to fill the attachment section of the payload

Anonymization

Set anonymizedFields into the QueryString to specify which fields must be anonymized (could be de-anonymize by using #deanonymize). Possible values:

• phoneNumber
• email
  For multiple values, use the , character to separate them: [...]\applications?anonymizedFields=phoneNumber,email

Required authorization

Type	Value(s)
Ressource	EventsApplication, permission: Create

Request

POST /api/v1/vacancies/{vacancyReference}/applications[?creationMode&candidateLookup]

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy see identifier encoding
creationMode			The code of the candidate's creation mode. If null the back-office creation mode will be used.
candidateLookup			The flag for checking on creation if provided candidate is duplicate. By default, candidateLookup is set to true
*ApplicantApplicationDetailWrite`1	ApplicantApplicationDetailWrite_CandidateDetailWrite		Create the application for the given data Attach a resume If you need to attach a resume to the application, you can post a multipart request as following: Multipart structure (legacy, only support single file attachment) Name Description Content-Disposition Content-Type applicationJson The application model json form-data uploadedFile The file content form-data file mime type Multipart structure (current, supports multiple file attachment) Name Description Content-Disposition Content-Type applicationJson The application model json form-data uploadedFileKey The file content form-data file mime type anotherFileKey The file content form-data file mime type Remarks: The enctype of the request must be "multipart/form-data" The max size of a single file depends on the settings in the applicant view In case of multiple files attachment, you need to fill the attachment section of the payload Anonymization Set anonymizedFields into the QueryString to specify which fields must be anonymized (could be de-anonymize by using #deanonymize). Possible values: phoneNumber email For multiple values, use the , character to separate them: [...]\applications?anonymizedFields=phoneNumber,email Required authorization Type Value(s) Ressource EventsApplication, permission: Create

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_ApplicationDetailWriteResponse	The object is successfully created and saved
400		The object update fails
404		The specified vacancy doesn't exist

AttachedFileTypeCategories library

api-v1-referentials-attachedfiletypecategories-get

Get all AttachedFileTypeCategories items

Get a list of all available AttachedFileTypeCategories items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/attachedfiletypecategories

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-attachedfiletypecategories-post

Creates a AttachedFileTypeCategories item.

Creates the AttachedFileTypeCategories item.

Request

POST /api/v1/referentials/attachedfiletypecategories

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the AttachedFileTypeCategories item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-attachedfiletypecategories-id-get

Get the AttachedFileTypeCategories item details

Get the details of a AttachedFileTypeCategories item, based on its client code

Request

GET /api/v1/referentials/attachedfiletypecategories/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-attachedfiletypecategories-id-put

Creates or updates a AttachedFileTypeCategories item.

Creates or updates the AttachedFileTypeCategories item.

Request

PUT /api/v1/referentials/attachedfiletypecategories/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the AttachedFileTypeCategories item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-attachedfiletypecategories-id-delete

Deletes the specified AttachedFileTypeCategories item.

Deletes the specified AttachedFileTypeCategories item based on its client code.

Request

DELETE /api/v1/referentials/attachedfiletypecategories/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-attachedfiletypecategories-id-translations-get

Get all AttachedFileTypeCategories item translations

Get a list of translations of a AttachedFileTypeCategories item, based on its client code

Request

GET /api/v1/referentials/attachedfiletypecategories/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-attachedfiletypecategories-id-translations-lcid-get

Get the specified AttachedFileTypeCategories item translation

Get the translation of a AttachedFileTypeCategories item, in a specified language, based on its client code

Request

GET /api/v1/referentials/attachedfiletypecategories/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

Authentication

api-token-post

Request

POST /api/token

Parameters

Name	Type	Default	Notes
*grant_type			The grant type. The two grant types are client_credentials and password
*client_id			The client id
*client_secret			The client secret
username			The username (only required when using password grant type)
password			The password (only required when using password grant type)

Responses

Status Code	Type	Description	Samples
200		Authentication succeed.

CandidateStatuses library

api-v1-referentials-candidatestatuses-get

Get all CandidateStatuses items

Get a list of all available CandidateStatuses items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/candidatestatuses

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-candidatestatuses-post

Creates a CandidateStatuses item.

Creates the CandidateStatuses item.

Request

POST /api/v1/referentials/candidatestatuses

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the CandidateStatuses item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-candidatestatuses-id-get

Get the CandidateStatuses item details

Get the details of a CandidateStatuses item, based on its client code

Request

GET /api/v1/referentials/candidatestatuses/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-candidatestatuses-id-put

Creates or updates a CandidateStatuses item.

Creates or updates the CandidateStatuses item.

Request

PUT /api/v1/referentials/candidatestatuses/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the CandidateStatuses item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-candidatestatuses-id-delete

Deletes the specified CandidateStatuses item.

Deletes the specified CandidateStatuses item based on its client code.

Request

DELETE /api/v1/referentials/candidatestatuses/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-candidatestatuses-id-translations-get

Get all CandidateStatuses item translations

Get a list of translations of a CandidateStatuses item, based on its client code

Request

GET /api/v1/referentials/candidatestatuses/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-candidatestatuses-id-translations-lcid-get

Get the specified CandidateStatuses item translation

Get the translation of a CandidateStatuses item, in a specified language, based on its client code

Request

GET /api/v1/referentials/candidatestatuses/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

Candidates

api-v1-candidates-get

Get all candidates

Get a list of all available candidates. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled
filter	Filters enabled
contactquery	Filter candidates by a keyword based on the Lastname, Firstname, email and phone number

Filter available

Filter name	Description	Operator available	Value type
updateDate	filter candidates by modification date (or creation date, if no modification date exists)	::, :gt:, :ge:, :lt:, :le:	date
email	filter candidates by email	::	string
applicantCreationMode	filter candidates by creation mode	::	string

Required authorization

Type	Value(s)
Role	ApplicantsEngine

Request

GET /api/v1/candidates

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_CandidateSummary	The object is returned with success

api-v1-candidates-id-get

Get the candidate details

Get the details of a candidate, based on its client code

Required authorization

Type	Value(s)
Ressource	ApplicantDetails, permission: Use

Request

GET /api/v1/candidates/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the candidate

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_CandidateDetailRead	The object is returned with success
400		The specified candidate don't exist

api-v1-candidates-id-put

Update the candidate

Update the candidate based on its client code

Required authorization

Type	Value(s)
Ressource	ApplicantDetails, permission: Update

Request

PUT /api/v1/candidates/{id}

Parameters

Name	Type	Default	Notes
*id			The candidate client code
*CandidateDetailUpdate	CandidateDetailUpdate		Update the candidate based on its client code Required authorization Type Value(s) Ressource ApplicantDetails, permission: Update

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_CandidateDetailWriteResponse	OK

api-v1-candidates-id-delete

Delete the candidate

Delete the candidate, based on its client code

Required authorization

Type	Value(s)
Ressource	ApplicantDetails, permission: Delete

Request

DELETE /api/v1/candidates/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the candidate

Responses

Status Code	Type	Description	Samples
200	object	The object is successfully deleted
404		The object deletion fails

api-v1-candidates-id-anonymizeddata-get

Get candidate anonymized data

Get the anonymised data of a candidate, based on its client code

Request

GET /api/v1/candidates/{id}/anonymizeddata

Parameters

Name	Type	Default	Notes
*id			Client code of the candidate

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_CandidateAnonymisedData	The object is returned with success
404		The specified candidate don't exist

api-v1-candidates-id-applications-get

Get candidate applications

Get a list of all applications for a candidate.

Required authorization

Type	Value(s)
Ressource	EventsApplication, permission: Use

Request

GET /api/v1/candidates/{id}/applications

Parameters

Name	Type	Default	Notes
*id			Get a list of all applications for a candidate. Required authorization Type Value(s) Ressource EventsApplication, permission: Use

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_CandidateApplication	The object is returned with success
404		Identifier doesn't exist

api-v1-candidates-id-applications-applicationId-events-get

Get the candidate application events

Get the application events, based on the candidate and application id

Required authorization

Type	Value(s)
Ressource	EventsApplication, permission: Use

Request

GET /api/v1/candidates/{id}/applications/{applicationId}/events

Parameters

Name	Type	Default	Notes
*id			The candidate identifier
*applicationId			The application identifier

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_ApplicationChildEvent	The object is returned with success
400		Query not correct
404		Identifier doesn't exist

api-v1-candidates-id-deanonymize-post

De-anonymize all candidate fields

Fields anonymized from candidates/{candidateId}/vacancies/{vacancyReference} using anonymizedFields queryString parameters.

Request

POST /api/v1/candidates/{id}/deanonymize

Parameters

Name	Type	Default	Notes
*id			Client code of the candidate

Responses

Status Code	Type	Description	Samples
200	object	The action is done with success
400		The specified candidate don't have anonymized data
404		The specified candidate don't exist

Consent library

api-v1-referentials-consents-get

Get all consents

Get a list of all available consents. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/consents

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ConsentArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-consents-id-get

Get consent details

Get the details of a consent.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/consents/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the consent

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_Consent	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-consents-id-translations-get

Get consent translations

Get all translations of a consent.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/consents/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the consent

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ConsentArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-consents-id-translations-lcid-get

Get consent translation details

Get the details of a consent translation.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/consents/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the consent
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_Consent	The object is returned with success
400		Query not correct
404		Language not present in the application

Contacts

api-v1-contacts-get

Get all contacts

Get a list of all active contacts. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	Contact, permission: Use

Request

GET /api/v1/contacts

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ContactArray	The list of objects is returned with success
400		Query not correct

api-v1-contacts-id-get

Get contact details

Get the details of a contact

Required authorization

Type	Value(s)
Ressource	Contact, permission: Use

Request

GET /api/v1/contacts/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the contact

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_Contact	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-contacts-id-put

Create or update a contact

Create or update a contact with the given details

Required authorization

Type	Value(s)
Ressource	Contact, permission: Create, Update

Request

PUT /api/v1/contacts/{id}

Parameters

Name	Type	Default	Notes
*id			The contact id
*Contact	Contact		Create or update a contact with the given details Required authorization Type Value(s) Ressource Contact, permission: Create, Update

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_Contact	The object is successfully updated and saved
201	WrappedResponse_Contact	The object is successfully created and saved
400		The object creation/update fails

ContractTypes library

api-v1-referentials-contracttypes-get

Get all ContractTypes items

Get a list of all available ContractTypes items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/contracttypes

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-contracttypes-post

Creates a ContractTypes item.

Creates the ContractTypes item.

Request

POST /api/v1/referentials/contracttypes

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the ContractTypes item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-contracttypes-id-get

Get the ContractTypes item details

Get the details of a ContractTypes item, based on its client code

Request

GET /api/v1/referentials/contracttypes/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-contracttypes-id-put

Creates or updates a ContractTypes item.

Creates or updates the ContractTypes item.

Request

PUT /api/v1/referentials/contracttypes/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the ContractTypes item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-contracttypes-id-delete

Deletes the specified ContractTypes item.

Deletes the specified ContractTypes item based on its client code.

Request

DELETE /api/v1/referentials/contracttypes/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-contracttypes-id-translations-get

Get all ContractTypes item translations

Get a list of translations of a ContractTypes item, based on its client code

Request

GET /api/v1/referentials/contracttypes/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-contracttypes-id-translations-lcid-get

Get the specified ContractTypes item translation

Get the translation of a ContractTypes item, in a specified language, based on its client code

Request

GET /api/v1/referentials/contracttypes/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

Countries library

api-v1-referentials-countries-get

Get all countries

Get a list of all available countries. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/countries

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_CountryReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-countries-id-get

Get country details

Get the details of a country

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/countries/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the country

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_CountryReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-countries-id-translations-get

Get country translations

Get all translations of a country

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/countries/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the country

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_CountryReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-countries-id-translations-lcid-get

Get country translation details

Get the details of a country translation

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/countries/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the country
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_CountryReferential	The object is returned with success
400		Query not correct
404		Language not present in the application

CustomCodeTable library

api-v1-referentials-customcodetables-type-get

Get all custom code tables

Get a list of all available custom code tables. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/customcodetables/{type}

Parameters

Name	Type	Default	Notes
*type			Client code of the custom code table type

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_CustomCodeTableArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-customcodetables-type-id-get

Get custom code table details

Get the details of a custom code table.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/customcodetables/{type}/{id}

Parameters

Name	Type	Default	Notes
*type			Client code of the custom code table type
*id			Client code of the item

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_CustomCodeTable	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-customcodetables-type-id-translations-get

Get custom code table translations

Get all translations of a custom code table.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/customcodetables/{type}/{id}/translations

Parameters

Name	Type	Default	Notes
*type			Client code of the item
*id			Client code of the custom code table type

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_CustomCodeTableArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-customcodetables-type-id-translations-lcid-get

Get custom code table translation details

Get the details of a custom code table translation.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/customcodetables/{type}/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*type			Client code of the item
*id			Client code of the custom code table
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_CustomCodeTable	The object is returned with success
400		Query not correct
404		Language not present in the application

CustomCodeTableType library

api-v1-referentials-customcodetabletypes-get

Get all custom code table types

Get a list of all available code table types. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/customcodetabletypes

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_CustomCodeTableTypeSummaryArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-customcodetabletypes-id-get

Get code table type details with all translations

Get the details of a code table type with all translations.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/customcodetabletypes/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the code table types

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_CustomCodeTableTypeDetail	The object is returned with success
400		Query not correct
404		Client code doesn't exist

Department library

api-v1-referentials-departments-get

Get all departments

Get a list of all available departments. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/departments

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_DepartmentReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-departments-id-get

Get department details

Get the details of a department.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/departments/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the department

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_DepartmentReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-departments-id-translations-get

Get department translations

Get all translations of a department.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/departments/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the department

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_DepartmentReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-departments-id-translations-lcid-get

Get department translation details

Get the details of a department translation.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/departments/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the department
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_DepartmentReferential	The object is returned with success
400		Query not correct
404		Language not present in the application

Diploma library

api-v1-referentials-diplomas-get

Get all diplomas

Get a list of all available diplomas. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/diplomas

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_DiplomaReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-diplomas-id-get

Get diploma details

Get the details of a diploma.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/diplomas/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the diploma

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_DiplomaReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-diplomas-id-translations-get

Get diploma translations

Get all translations of a diploma.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/diplomas/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the diploma

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_DiplomaReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-diplomas-id-translations-lcid-get

Get diploma translation details

Get the details of a diploma translation.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/diplomas/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the diploma
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_DiplomaReferential	The object is returned with success
400		Query not correct
404		Language not present in the application

EEO library

api-v1-referentials-eeo-get

Get all EEO items

Get a list of all available EEO items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/eeo

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-eeo-id-get

Get the EEO item details

Get the details of a EEO item, based on its client code

Request

GET /api/v1/referentials/eeo/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-eeo-id-translations-get

Get all EEO item translations

Get a list of translations of a EEO item, based on its client code

Request

GET /api/v1/referentials/eeo/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-eeo-id-translations-lcid-get

Get the specified EEO item translation

Get the translation of a EEO item, in a specified language, based on its client code

Request

GET /api/v1/referentials/eeo/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

EducationLevels library

api-v1-referentials-educationlevels-get

Get all EducationLevels items

Get a list of all available EducationLevels items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/educationlevels

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-educationlevels-post

Creates a EducationLevels item.

Creates the EducationLevels item.

Request

POST /api/v1/referentials/educationlevels

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the EducationLevels item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-educationlevels-id-get

Get the EducationLevels item details

Get the details of a EducationLevels item, based on its client code

Request

GET /api/v1/referentials/educationlevels/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-educationlevels-id-put

Creates or updates a EducationLevels item.

Creates or updates the EducationLevels item.

Request

PUT /api/v1/referentials/educationlevels/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the EducationLevels item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-educationlevels-id-delete

Deletes the specified EducationLevels item.

Deletes the specified EducationLevels item based on its client code.

Request

DELETE /api/v1/referentials/educationlevels/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-educationlevels-id-translations-get

Get all EducationLevels item translations

Get a list of translations of a EducationLevels item, based on its client code

Request

GET /api/v1/referentials/educationlevels/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-educationlevels-id-translations-lcid-get

Get the specified EducationLevels item translation

Get the translation of a EducationLevels item, in a specified language, based on its client code

Request

GET /api/v1/referentials/educationlevels/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

Employees

api-v1-employees-get

Get all employees

Get a list of all available active employees. If offset and limit provided, it will return only the ones between the interval. Only employees in the current user organisation scope are returns.

QueryString

Parameters	Description
offset & limit	Pagination enabled
filter	Filters enabled
withAuthorization	Display resource authorization information

Filter available

Filter name	Description	Operator available	Value type
updateDate	filter employees by modification date (or creation date, if no modification date exists)	::, :gt:, :ge:, :lt:, :le:	date

Required authorization

Type	Value(s)
Ressource	EmployeeDetails, permission: Use

Request

GET /api/v1/employees

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_EmployeeSummary	The object is returned with success

api-v1-employees-id-get

Get the employee details

Get the details of a active employee, based on its identifier (client code)

QueryString

Parameters	Description
withAuthorization	Display resource authorization information

Required authorization

Type	Value(s)
Ressource	EmployeeDetails, permission: Use

Request

GET /api/v1/employees/{id}

Parameters

Name	Type	Default	Notes
*id			The employee identifier (client code)

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_EmployeeDetailRead	The object is returned with success
404		The specified employee is not active

api-v1-employees-id-put

Create or update an employee

Create or update an employee with the given details

Required authorization

Type	Value(s)
Ressource	EmployeeDetails, permission: Create, Update

Request

PUT /api/v1/employees/{id}

Parameters

Name	Type	Default	Notes
*id			The employee client code
*EmployeeDetailWrite	EmployeeDetailWrite		Create or update an employee with the given details Required authorization Type Value(s) Ressource EmployeeDetails, permission: Create, Update

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_EmployeeDetailWrite	The object is successfully updated and saved
201	WrappedResponse_EmployeeDetailWrite	The object is successfully created and saved
400		The object creation/update fails

Events

api-system-v1-events-event_type-get

Get all event payloads

Get a list of all payloads for the given type of event. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled
duration	(The ISO 8601 standard must be respected. example: P1Y2M10DT2H30M15S)
filter	Filters enabled
eventType	Event type

Filter available

Filter name	Description	Operator available	Value type
eventDate	Filter the query by event date. (Default value is the actual Date and Time)	:lt:	date

Request

GET /api/system/v1/events/{event_type}

Parameters

Name	Type	Default	Notes
*event_type			Type of the event.

Responses

Status Code	Type	Description	Samples
200	EventPayload	This is the generic event payload. Each type has some more specific data
404		The event type provided doesn't exist.

ExperienceLevels library

api-v1-referentials-experiencelevels-get

Get all ExperienceLevels items

Get a list of all available ExperienceLevels items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/experiencelevels

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-experiencelevels-post

Creates a ExperienceLevels item.

Creates the ExperienceLevels item.

Request

POST /api/v1/referentials/experiencelevels

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the ExperienceLevels item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-experiencelevels-id-get

Get the ExperienceLevels item details

Get the details of a ExperienceLevels item, based on its client code

Request

GET /api/v1/referentials/experiencelevels/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-experiencelevels-id-put

Creates or updates a ExperienceLevels item.

Creates or updates the ExperienceLevels item.

Request

PUT /api/v1/referentials/experiencelevels/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the ExperienceLevels item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-experiencelevels-id-delete

Deletes the specified ExperienceLevels item.

Deletes the specified ExperienceLevels item based on its client code.

Request

DELETE /api/v1/referentials/experiencelevels/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-experiencelevels-id-translations-get

Get all ExperienceLevels item translations

Get a list of translations of a ExperienceLevels item, based on its client code

Request

GET /api/v1/referentials/experiencelevels/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-experiencelevels-id-translations-lcid-get

Get the specified ExperienceLevels item translation

Get the translation of a ExperienceLevels item, in a specified language, based on its client code

Request

GET /api/v1/referentials/experiencelevels/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

Exports

api-exports-v1-candidates-get

Get all candidates

Get a list of all available candidates. If offset and limit provided, it will return only the ones between the interval. Use the principle of streaming to return data. A streaming http response is organize as a series of chunck and each chunck will contain all informations of a candidate.

Streaming Protocol

This endpoint returns data as streaming and could be identified with these elements :

• Response Headers contains Content-Type: application/octet-stream
• Use Chunked Transfert Encoding cf. wikipedia
• Data are provided as binary formated, described below

Each data block is preceded by a header which provide the size of the following data block.The size is encoded on 4 bytes integer

A stream containing 2 data blocks would be organized as follow :

|------------------Chunk 1-------------------|------------------Chunk 2-------------------|

|------4 Bytes-----|---------c Bytes---------|------4 Bytes-----|---------z Bytes---------|

|Size next block|Block containing data|Size next block|block containing data|

| value = c | | value = z | |

_** Note :** The block size in the header is serialized with reversed encoding bytes.

A size value of 1 will be encoded as follow :_

|---Byte---|---Byte---|---Byte---|---Byte---|

| 00000001 | 00000000 | 00000000 | 00000000 |

Block structure

A block is a zip file containing all the information of a candidate including applications and attachments. The zip file contain a file named applicantdetail containing the model in UTF8 json format (see CandidateExportDetail model). In the attachments field there is a list of the attachments contained into the zip file, you may look for them by using the attachment id as zip entry filename.

QueryString

Parameters	Description
offset & limit	Pagination enabled The page size can't exceed 100
filter	Filters enabled
attachmenttype	If provided with the value resume, the endpoint will return only resume attachment

Filter available

Filter name	Description	Operator available	Value type
chronoNumber	filter applicants by chrono number	::, :gt:, :ge:, :lt:, :le:	integer
updateDate	filter applicants by modification date (or creation date, if no modification date exists)	::, :gt:, :ge:, :lt:, :le:	date
id	filter applicants by url encoded identifier see identifier encoding	::	string
email	filter candidates by email	::	string

Examples

To retrieve the 10 previous candidates from the 10/06/2019 you may use this request

GET http://tenant.talentsoft.com/api/exports/v1/candidates?filter=updateDate:lt:2019-06-10&offset=0&limit=10 HTTP/1.1

To help to implement incremental synchronisation we provide a chronoNumber which is incremental. If your last retrieved candidate had the number 108921, to continue to retrieve candidate you may use the following request

GET http://tenant.talentsoft.com/api/exports/v1/candidates?filter=chronoNumber:gt:108921&offset=0&limit=10 HTTP/1.1

You can retrieve a specific list of candidates by providing the ids. If you want to retrieve the candidates with the following ids : _TS-0002 _TS-0003 and _TS-0005

GET http://tenant.talentsoft.com/api/exports/v1/candidates?filter=id::_TS-0002,_TS-0003,_TS-0005 HTTP/1.1

Required authorization

Type	Value(s)
Ressource	ApplicantDetails, permission: Use

Request

GET /api/exports/v1/candidates

Responses

Status Code	Type	Description	Samples
200	CandidateExportDetail	The object is returned with success

api-exports-v1-vacancies-get

Get all vacancies

Get a list of all available vacancies. If offset and limit provided, it will return only the ones between the interval. Use the principle of streaming to return data. A streaming http response is organize as a series of chunck and each chunck will contain all informations of a vacancy.

Streaming Protocol

This endpoint returns data as streaming and could be identified with these elements :

• Response Headers contains Content-Type: application/octet-stream
• Use Chunked Transfert Encoding cf. wikipedia
• Data are provided as binary formated, described below

Each data block is preceded by a header which provide the size of the following data block.The size is encoded on 4 bytes integer

A stream containing 2 data blocks would be organized as follow :

|------------------Chunk 1-------------------|------------------Chunk 2-------------------|

|------4 Bytes-----|---------c Bytes---------|------4 Bytes-----|---------z Bytes---------|

|Size next block|Block containing data|Size next block|block containing data|

| value = c | | value = z | |

_** Note :** The block size in the header is serialized with reversed encoding bytes.

A size value of 1 will be encoded as follow :_

|---Byte---|---Byte---|---Byte---|---Byte---|

| 00000001 | 00000000 | 00000000 | 00000000 |

Block structure

A block is a zip file containing all the information of a vacancy. The zip file contain a file named offerdetail containing the model in UTF8 json format (see VacancyExportDetail model).

QueryString

Parameters	Description
offset & limit	Pagination enabled The page size can't exceed 1000
q	query search
filter	Filters enabled

Filter available

Filter name	Description	Operator available	Value type
chronoNumber	filter vacancies by chrono number	::, :gt:, :ge:, :lt:, :le:	integer
updateDate	filter vacancies by modification date (or creation date, if no modification date exists)	::, :gt:, :ge:, :lt:, :le:	date
reference	filter vacancies by url encoded reference see identifier encoding	::	string
vacancyStatus	filter vacancies by vacancy status enum value	:: ,	string Archived Confirmed Draft Finalized PendingPublication Published Suspended
clientVacancyStatus	filter vacancies by vacancy status identifier	::	string
publicationMedia	filter vacancies by publication media	::	string
publishedOnTheMedia	filter vacancies by currently published on a specific media	::	string

Examples

To retrieve the 10 previous offers from the 10/06/2019 you may use this request

GET http://tenant.talentsoft.com/api/exports/v1/vacancies?filter=updateDate:lt:2019-06-10&offset=0&limit=10 HTTP/1.1

To help to implement incremental synchronisation we provide a chronoNumber which is incremental. If your last retrieved offer had the number 108921, to continue to retrieve offer you may use the following request

GET http://tenant.talentsoft.com/api/exports/v1/vacancies?filter=chronoNumber:gt:108921&offset=0&limit=10 HTTP/1.1

You can retrieve a specific list of offer by providing the references. If you want to retrieve the offers with the following references : 2019-01 2019-02 and 2019-03

GET http://tenant.talentsoft.com/api/exports/v1/vacancies?filter=reference::2019-01,2019-02,2019-03 HTTP/1.1

Required authorization

Type	Value(s)
Ressource	OfferDetails, permission: Use

Request

GET /api/exports/v1/vacancies

Responses

Status Code	Type	Description	Samples
200	VacancyExportDetail	The object is returned with success

api-exports-v1-vacancyrequests-get

Get all vacancy requests

Get a list of all available vacancy requests. If offset and limit provided, it will return only the ones between the interval. Use the principle of streaming to return data. A streaming http response is organize as a series of chunck and each chunck will contain all informations of a vacancy.

Streaming Protocol_streamingService

This endpoint returns data as streaming and could be identified with these elements :

• Response Headers contains Content-Type: application/octet-stream
• Use Chunked Transfert Encoding cf. wikipedia
• Data are provided as binary formated, described below

Each data block is preceded by a header which provide the size of the following data block.The size is encoded on 4 bytes integer

A stream containing 2 data blocks would be organized as follow :

|------------------Chunk 1-------------------|------------------Chunk 2-------------------|

|------4 Bytes-----|---------c Bytes---------|------4 Bytes-----|---------z Bytes---------|

|Size next block|Block containing data|Size next block|block containing data|

| value = c | | value = z | |

_** Note :** The block size in the header is serialized with reversed encoding bytes.

A size value of 1 will be encoded as follow :_

|---Byte---|---Byte---|---Byte---|---Byte---|

| 00000001 | 00000000 | 00000000 | 00000000 |

Block structure

A block is a zip file containing all the information of a vacancy. The zip file contain a file named vacancyRequestDetail containing the model in UTF8 json format (see VacancyExportDetail model).

QueryString

Parameters	Description
offset & limit	Pagination enabled The page size can't exceed 1000
q	query search
filter	Filters enabled

Filter available

Filter name	Description	Operator available	Value type
chronoNumber	filter vacancy requests by chrono number	:: :gt: :ge: :lt: :le:	integer
updateDate	filter vacancy requests by modification date (or creation date, if no modification date exists)	:: :gt: :ge: :lt: :le:	date
id	filter vacancy requests by url encoded reference see identifier encoding	:: ,	string
vacancyRequestStatus	filter vacancy requests by vacancy request status	:: ,	string Approval Archived Expired InProcess Processed Refused ToBeProcessed
clientVacancyRequestStatus	filter vacancy requests by vacancy request status referential identifier	:: ,	string

Examples

To retrieve the 10 previous vacancy request from the 10/06/2019 you may use this request

GET http://tenant.talentsoft.com/api/exports/v1/vacancyrequests?filter=updateDate:lt:2019-06-10&offset=0&limit=10 HTTP/1.1

To help to implement incremental synchronisation we provide a chronoNumber which is incremental. If your last retrieved vacancy request had the number 108921, to continue to retrieve vacancy requests you may use the following request

GET http://tenant.talentsoft.com/api/exports/v1/vacancyrequests?filter=chronoNumber:gt:108921&offset=0&limit=10 HTTP/1.1

You can retrieve a specific list of vacancy request by providing the references. If you want to retrieve the vacancy requests with the following references : 2019-01 2019-02 and 2019-03

GET http://tenant.talentsoft.com/api/exports/v1/vacancyrequests?filter=id::2019-01,2019-02,2019-03 HTTP/1.1

Required authorization

Type	Value(s)
Ressource	PreliminaryJobRequestDetails, permission: Use

Request

GET /api/exports/v1/vacancyrequests

Responses

Status Code	Type	Description	Samples
200	VacancyRequestExportDetail	The object is returned with success

GeographicalAreas library

api-v1-referentials-geographicalareas-get

Get all GeographicalAreas items

Get a list of all available GeographicalAreas items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/geographicalareas

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-geographicalareas-post

Creates a GeographicalAreas item.

Creates the GeographicalAreas item.

Request

POST /api/v1/referentials/geographicalareas

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the GeographicalAreas item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-geographicalareas-id-get

Get the GeographicalAreas item details

Get the details of a GeographicalAreas item, based on its client code

Request

GET /api/v1/referentials/geographicalareas/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-geographicalareas-id-put

Creates or updates a GeographicalAreas item.

Creates or updates the GeographicalAreas item.

Request

PUT /api/v1/referentials/geographicalareas/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the GeographicalAreas item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-geographicalareas-id-delete

Deletes the specified GeographicalAreas item.

Deletes the specified GeographicalAreas item based on its client code.

Request

DELETE /api/v1/referentials/geographicalareas/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-geographicalareas-id-translations-get

Get all GeographicalAreas item translations

Get a list of translations of a GeographicalAreas item, based on its client code

Request

GET /api/v1/referentials/geographicalareas/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-geographicalareas-id-translations-lcid-get

Get the specified GeographicalAreas item translation

Get the translation of a GeographicalAreas item, in a specified language, based on its client code

Request

GET /api/v1/referentials/geographicalareas/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

IndexationReport

api-exports-v1-reports-post

Posts an indexation report

Saves indexation report.

Request

POST /api/exports/v1/reports

Parameters

Name	Type	Default	Notes
*IndexationReportWrite	IndexationReportWrite		The model of the indexation report.

Responses

Status Code	Type	Description	Samples
201	object	The report was succesfully saved.
400		Failed to save the report.

JobFamily library

api-v1-referentials-jobfamilies-get

Get all job families

Get a list of all available job families. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/jobfamilies

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_JobFamilyArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-jobfamilies-id-get

Get job family details

Get the details of a job family

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/jobfamilies/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the job family

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_JobFamily	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-jobfamilies-id-translations-get

Get job family translations

Get all translations of a job family

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/jobfamilies/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the job family

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_JobFamilyArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-jobfamilies-id-translations-lcid-get

Get job family translation details

Get the details of a job family translation

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/jobfamilies/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the job family
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_JobFamily	The object is returned with success
400		Query not correct
404		Language not present in the application

JobFamilyCategories library

api-v1-referentials-jobfamilycategories-get

Get all JobFamilyCategories items

Get a list of all available JobFamilyCategories items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/jobfamilycategories

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-jobfamilycategories-id-get

Get the JobFamilyCategories item details

Get the details of a JobFamilyCategories item, based on its client code

Request

GET /api/v1/referentials/jobfamilycategories/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-jobfamilycategories-id-translations-get

Get all JobFamilyCategories item translations

Get a list of translations of a JobFamilyCategories item, based on its client code

Request

GET /api/v1/referentials/jobfamilycategories/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-jobfamilycategories-id-translations-lcid-get

Get the specified JobFamilyCategories item translation

Get the translation of a JobFamilyCategories item, in a specified language, based on its client code

Request

GET /api/v1/referentials/jobfamilycategories/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

JobTimes library

api-v1-referentials-jobtimes-get

Get all JobTimes items

Get a list of all available JobTimes items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/jobtimes

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-jobtimes-post

Creates a JobTimes item.

Creates the JobTimes item.

Request

POST /api/v1/referentials/jobtimes

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the JobTimes item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-jobtimes-id-get

Get the JobTimes item details

Get the details of a JobTimes item, based on its client code

Request

GET /api/v1/referentials/jobtimes/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-jobtimes-id-put

Creates or updates a JobTimes item.

Creates or updates the JobTimes item.

Request

PUT /api/v1/referentials/jobtimes/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the JobTimes item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-jobtimes-id-delete

Deletes the specified JobTimes item.

Deletes the specified JobTimes item based on its client code.

Request

DELETE /api/v1/referentials/jobtimes/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-jobtimes-id-translations-get

Get all JobTimes item translations

Get a list of translations of a JobTimes item, based on its client code

Request

GET /api/v1/referentials/jobtimes/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-jobtimes-id-translations-lcid-get

Get the specified JobTimes item translation

Get the translation of a JobTimes item, in a specified language, based on its client code

Request

GET /api/v1/referentials/jobtimes/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

LanguageLevels library

api-v1-referentials-languagelevels-get

Get all LanguageLevels items

Get a list of all available LanguageLevels items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/languagelevels

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-languagelevels-post

Creates a LanguageLevels item.

Creates the LanguageLevels item.

Request

POST /api/v1/referentials/languagelevels

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the LanguageLevels item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-languagelevels-id-get

Get the LanguageLevels item details

Get the details of a LanguageLevels item, based on its client code

Request

GET /api/v1/referentials/languagelevels/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-languagelevels-id-put

Creates or updates a LanguageLevels item.

Creates or updates the LanguageLevels item.

Request

PUT /api/v1/referentials/languagelevels/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the LanguageLevels item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-languagelevels-id-delete

Deletes the specified LanguageLevels item.

Deletes the specified LanguageLevels item based on its client code.

Request

DELETE /api/v1/referentials/languagelevels/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-languagelevels-id-translations-get

Get all LanguageLevels item translations

Get a list of translations of a LanguageLevels item, based on its client code

Request

GET /api/v1/referentials/languagelevels/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-languagelevels-id-translations-lcid-get

Get the specified LanguageLevels item translation

Get the translation of a LanguageLevels item, in a specified language, based on its client code

Request

GET /api/v1/referentials/languagelevels/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

Languages library

api-v1-referentials-languages-get

Get all Languages items

Get a list of all available Languages items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/languages

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-languages-id-get

Get the Languages item details

Get the details of a Languages item, based on its client code

Request

GET /api/v1/referentials/languages/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-languages-id-translations-get

Get all Languages item translations

Get a list of translations of a Languages item, based on its client code

Request

GET /api/v1/referentials/languages/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-languages-id-translations-lcid-get

Get the specified Languages item translation

Get the translation of a Languages item, in a specified language, based on its client code

Request

GET /api/v1/referentials/languages/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

Meetings

api-v1-interviewevents-get

Get all interview events

Get a list of all interview events

Required authorization

Type	Value(s)
Role	MeetingList

Request

GET /api/v1/interviewevents

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_MeetingSummary	The object is returned with success
400		Query not correct
404		Identifier doesn't exist

api-v1-interviewevents-id-get

Get meeting details

Get the details of a meeting

Required authorization

Type	Value(s)
Ressource	MeetingManagement, permission: Use

Request

GET /api/v1/interviewevents/{id}

Parameters

Name	Type	Default	Notes
*id			The meeting identifier

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_MeetingDetail	The object is returned with success
400		Query not correct
404		Identifier doesn't exist

api-v1-interviewevents-id-candidates-get

Get all candidates of a meeting

Get all candidates of a meeting.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	MeetingManagement, permission: Use

Request

GET /api/v1/interviewevents/{id}/candidates

Parameters

Name	Type	Default	Notes
*id			The meeting identifier

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ICollection_MeetingInterviewCandidate	The object is returned with success
400		Query not correct
404		Identifier doesn't exist

api-v1-interviewevents-id-interviewers-get

Get all interviewers of a meeting

Get all interviewers of a meeting.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	MeetingManagement, permission: Use

Request

GET /api/v1/interviewevents/{id}/interviewers

Parameters

Name	Type	Default	Notes
*id			The meeting identifier

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ICollection_MeetingInterviewerDetailRead	The object is returned with success
400		Query not correct
404		Identifier doesn't exist

Nationality library

api-v1-referentials-nationalities-get

Get all Nationality items

Get a list of all available Nationality items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/nationalities

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-nationalities-id-get

Get the Nationality item details

Get the details of a Nationality item, based on its client code

Request

GET /api/v1/referentials/nationalities/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-nationalities-id-translations-get

Get all Nationality item translations

Get a list of translations of a Nationality item, based on its client code

Request

GET /api/v1/referentials/nationalities/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-nationalities-id-translations-lcid-get

Get the specified Nationality item translation

Get the translation of a Nationality item, in a specified language, based on its client code

Request

GET /api/v1/referentials/nationalities/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

Organisations

api-v1-organisations-get

Get all organisations

Get a list of all available organisations. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled
withAuthorization	Display resource authorization information

Required authorization

Type	Value(s)
Ressource	EntitiesCorporation, permission: Use

Request

GET /api/v1/organisations

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_OrganisationArray	The list of objects is returned with success
400		Query not correct

api-v1-organisations-id-get

Get organisation details

Get the details of a organisation.

QueryString

Parameters	Description
withAuthorization	Display resource authorization information

Required authorization

Type	Value(s)
Ressource	EntitiesCorporation, permission: Use

Request

GET /api/v1/organisations/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the organisation

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_Organisation	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-organisations-id-translations-get

Get organisation translations

Get all translations of a organisation.

Required authorization

Type	Value(s)
Ressource	EntitiesCorporation, permission: Use

Request

GET /api/v1/organisations/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the organisation

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_OrganisationArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-organisations-id-translations-lcid-get

Get organisation translation details

Get the details of a organisation translation.

Required authorization

Type	Value(s)
Ressource	EntitiesCorporation, permission: Use

Request

GET /api/v1/organisations/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the organisation
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_Organisation	The object is returned with success
400		Query not correct
404		Language not present in the application

ProfessionalCategories library

api-v1-referentials-professionalcategories-get

Get all ProfessionalCategories items

Get a list of all available ProfessionalCategories items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/professionalcategories

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-professionalcategories-post

Creates a ProfessionalCategories item.

Creates the ProfessionalCategories item.

Request

POST /api/v1/referentials/professionalcategories

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the ProfessionalCategories item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-professionalcategories-id-get

Get the ProfessionalCategories item details

Get the details of a ProfessionalCategories item, based on its client code

Request

GET /api/v1/referentials/professionalcategories/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-professionalcategories-id-put

Creates or updates a ProfessionalCategories item.

Creates or updates the ProfessionalCategories item.

Request

PUT /api/v1/referentials/professionalcategories/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the ProfessionalCategories item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-professionalcategories-id-delete

Deletes the specified ProfessionalCategories item.

Deletes the specified ProfessionalCategories item based on its client code.

Request

DELETE /api/v1/referentials/professionalcategories/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-professionalcategories-id-translations-get

Get all ProfessionalCategories item translations

Get a list of translations of a ProfessionalCategories item, based on its client code

Request

GET /api/v1/referentials/professionalcategories/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-professionalcategories-id-translations-lcid-get

Get the specified ProfessionalCategories item translation

Get the translation of a ProfessionalCategories item, in a specified language, based on its client code

Request

GET /api/v1/referentials/professionalcategories/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

Profile library

api-v1-referentials-profiles-get

Get all profiles

Get a list of all available profiles. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/profiles

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ProfileReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-profiles-id-get

Get profile details

Get the details of a profile.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/profiles/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the profile

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ProfileReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-profiles-id-translations-get

Get profile translations

Get all translations of a profile.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/profiles/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the profile

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ProfileReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-profiles-id-translations-lcid-get

Get profile translation details

Get the details of a profile translation.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/profiles/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the profile
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ProfileReferential	The object is returned with success
400		Query not correct
404		Language not present in the application

Publication Media library

api-v1-referentials-publicationmedia-get

Get all publication medias

Get a list of all available publication media. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/publicationmedia

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_PublicationMediaArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-publicationmedia-id-get

Get publication media details

Get the details of a publication media.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/publicationmedia/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the publication media

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_PublicationMedia	The object is returned with success
404		Client code doesn't exist

api-v1-referentials-publicationmedia-id-translations-get

Get publication media translations

Get all translations of a publication media.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/publicationmedia/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the publication media

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_PublicationMediaArray	The list of objects is returned with success
404		Client code doesn't exist

api-v1-referentials-publicationmedia-id-translations-lcid-get

Get publication media translation details

Get the details of a publication media translation.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/publicationmedia/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the publication media
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_PublicationMedia	The object is returned with success
404		Language not present in the application

Radius library

api-v1-referentials-radius-get

Get all Radius items

Get a list of all available Radius items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/radius

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-radius-post

Creates a Radius item.

Creates the Radius item.

Request

POST /api/v1/referentials/radius

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the Radius item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-radius-id-get

Get the Radius item details

Get the details of a Radius item, based on its client code

Request

GET /api/v1/referentials/radius/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-radius-id-put

Creates or updates a Radius item.

Creates or updates the Radius item.

Request

PUT /api/v1/referentials/radius/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the Radius item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-radius-id-delete

Deletes the specified Radius item.

Deletes the specified Radius item based on its client code.

Request

DELETE /api/v1/referentials/radius/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-radius-id-translations-get

Get all Radius item translations

Get a list of translations of a Radius item, based on its client code

Request

GET /api/v1/referentials/radius/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-radius-id-translations-lcid-get

Get the specified Radius item translation

Get the translation of a Radius item, in a specified language, based on its client code

Request

GET /api/v1/referentials/radius/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

RecruitingReasons library

api-v1-referentials-recruitingreasons-get

Get all RecruitingReasons items

Get a list of all available RecruitingReasons items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/recruitingreasons

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-recruitingreasons-post

Creates a RecruitingReasons item.

Creates the RecruitingReasons item.

Request

POST /api/v1/referentials/recruitingreasons

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the RecruitingReasons item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-recruitingreasons-id-get

Get the RecruitingReasons item details

Get the details of a RecruitingReasons item, based on its client code

Request

GET /api/v1/referentials/recruitingreasons/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-recruitingreasons-id-put

Creates or updates a RecruitingReasons item.

Creates or updates the RecruitingReasons item.

Request

PUT /api/v1/referentials/recruitingreasons/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the RecruitingReasons item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-recruitingreasons-id-delete

Deletes the specified RecruitingReasons item.

Deletes the specified RecruitingReasons item based on its client code.

Request

DELETE /api/v1/referentials/recruitingreasons/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-recruitingreasons-id-translations-get

Get all RecruitingReasons item translations

Get a list of translations of a RecruitingReasons item, based on its client code

Request

GET /api/v1/referentials/recruitingreasons/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-recruitingreasons-id-translations-lcid-get

Get the specified RecruitingReasons item translation

Get the translation of a RecruitingReasons item, in a specified language, based on its client code

Request

GET /api/v1/referentials/recruitingreasons/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

ReferralCurrencies library

api-v1-referentials-currencies-get

Get all ReferralCurrencies items

Get a list of all available ReferralCurrencies items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	[Pagination enabledpagination)

Request

GET /api/v1/referentials/currencies

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-currencies-post

Creates a ReferralCurrencies item.

Creates the ReferralCurrencies item.

Request

POST /api/v1/referentials/currencies

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the ReferralCurrencies item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-currencies-id-get

Get the ReferralCurrencies item details

Get the details of a ReferralCurrencies item, based on its client code

Request

GET /api/v1/referentials/currencies/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-currencies-id-put

Creates or updates a ReferralCurrencies item.

Creates or updates the ReferralCurrencies item.

Request

PUT /api/v1/referentials/currencies/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the ReferralCurrencies item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-currencies-id-delete

Deletes the specified ReferralCurrencies item.

Deletes the specified ReferralCurrencies item based on its client code.

Request

DELETE /api/v1/referentials/currencies/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-currencies-id-translations-get

Get all ReferralCurrencies item translations

Get a list of translations of a ReferralCurrencies item, based on its client code

Request

GET /api/v1/referentials/currencies/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-currencies-id-translations-lcid-get

Get the specified ReferralCurrencies item translation

Get the translation of a ReferralCurrencies item, in a specified language, based on its client code

Request

GET /api/v1/referentials/currencies/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

ReferralStatuses library

api-v1-referentials-referralstatuses-get

Get all referral statuses

Get a list of all available referral statuses. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/referralstatuses

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ReferralStatusArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-referralstatuses-id-get

Get referral status details

Get the details of a referral status.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/referralstatuses/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referral status

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ReferralStatus	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-referralstatuses-id-translations-get

Get referral status translations

Get all translations of a referral status.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/referralstatuses/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referral status

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ReferralStatusArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-referralstatuses-id-translations-lcid-get

Get referral status translation details

Get the details of a referral status translation.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/referralstatuses/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referral status
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ReferralStatus	The object is returned with success
400		Query not correct
404		Language not present in the application

Region library

api-v1-referentials-regions-get

Get all regions

Get a list of all available regions. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/regions

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_RegionReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-regions-id-get

Get region details

Get the details of a region.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/regions/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the region

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_RegionReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-regions-id-translations-get

Get region translations

Get all translations of a region.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/regions/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the region

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_RegionReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-regions-id-translations-lcid-get

Get region translation details

Get the details of a region translation.

Required authorization

Type	Value(s)
Ressource	ReferencesAdministration, permission: Use

Request

GET /api/v1/referentials/regions/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the region
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_RegionReferential	The object is returned with success
400		Query not correct
404		Language not present in the application

SalaryRanges library

api-v1-referentials-salaryranges-get

Get all SalaryRanges items

Get a list of all available SalaryRanges items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/salaryranges

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-salaryranges-post

Creates a SalaryRanges item.

Creates the SalaryRanges item.

Request

POST /api/v1/referentials/salaryranges

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the SalaryRanges item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-salaryranges-id-get

Get the SalaryRanges item details

Get the details of a SalaryRanges item, based on its client code

Request

GET /api/v1/referentials/salaryranges/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-salaryranges-id-put

Creates or updates a SalaryRanges item.

Creates or updates the SalaryRanges item.

Request

PUT /api/v1/referentials/salaryranges/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the SalaryRanges item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-salaryranges-id-delete

Deletes the specified SalaryRanges item.

Deletes the specified SalaryRanges item based on its client code.

Request

DELETE /api/v1/referentials/salaryranges/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-salaryranges-id-translations-get

Get all SalaryRanges item translations

Get a list of translations of a SalaryRanges item, based on its client code

Request

GET /api/v1/referentials/salaryranges/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-salaryranges-id-translations-lcid-get

Get the specified SalaryRanges item translation

Get the translation of a SalaryRanges item, in a specified language, based on its client code

Request

GET /api/v1/referentials/salaryranges/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

Sex library

api-v1-referentials-sexes-get

Get all Sex items

Get a list of all available Sex items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/sexes

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-sexes-id-get

Get the Sex item details

Get the details of a Sex item, based on its client code

Request

GET /api/v1/referentials/sexes/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-sexes-id-translations-get

Get all Sex item translations

Get a list of translations of a Sex item, based on its client code

Request

GET /api/v1/referentials/sexes/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-sexes-id-translations-lcid-get

Get the specified Sex item translation

Get the translation of a Sex item, in a specified language, based on its client code

Request

GET /api/v1/referentials/sexes/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

Skills library

api-v1-referentials-skills-get

Get all Skills items

Get a list of all available Skills items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/skills

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-skills-post

Creates a Skills item.

Creates the Skills item.

Request

POST /api/v1/referentials/skills

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the Skills item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-skills-id-get

Get the Skills item details

Get the details of a Skills item, based on its client code

Request

GET /api/v1/referentials/skills/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-skills-id-put

Creates or updates a Skills item.

Creates or updates the Skills item.

Request

PUT /api/v1/referentials/skills/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the Skills item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-skills-id-delete

Deletes the specified Skills item.

Deletes the specified Skills item based on its client code.

Request

DELETE /api/v1/referentials/skills/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-skills-id-translations-get

Get all Skills item translations

Get a list of translations of a Skills item, based on its client code

Request

GET /api/v1/referentials/skills/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-skills-id-translations-lcid-get

Get the specified Skills item translation

Get the translation of a Skills item, in a specified language, based on its client code

Request

GET /api/v1/referentials/skills/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

SoftwareLanguages library

api-v1-softwarelanguages-get

Get all available languages

Get a list of all available languages. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/softwarelanguages

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SoftwareLanguageArray	The list of objects is returned with success
400		Query not correct

Speciality library

api-v1-referentials-specialities-get

Get all Speciality items

Get a list of all available Speciality items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/specialities

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-specialities-post

Creates a Speciality item.

Creates the Speciality item.

Request

POST /api/v1/referentials/specialities

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the Speciality item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-specialities-id-get

Get the Speciality item details

Get the details of a Speciality item, based on its client code

Request

GET /api/v1/referentials/specialities/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-specialities-id-put

Creates or updates a Speciality item.

Creates or updates the Speciality item.

Request

PUT /api/v1/referentials/specialities/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the Speciality item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-specialities-id-delete

Deletes the specified Speciality item.

Deletes the specified Speciality item based on its client code.

Request

DELETE /api/v1/referentials/specialities/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-specialities-id-translations-get

Get all Speciality item translations

Get a list of translations of a Speciality item, based on its client code

Request

GET /api/v1/referentials/specialities/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-specialities-id-translations-lcid-get

Get the specified Speciality item translation

Get the translation of a Speciality item, in a specified language, based on its client code

Request

GET /api/v1/referentials/specialities/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

Title library

api-v1-referentials-titles-get

Get all Title items

Get a list of all available Title items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/titles

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-titles-post

Creates a Title item.

Creates the Title item.

Request

POST /api/v1/referentials/titles

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the Title item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-titles-id-get

Get the Title item details

Get the details of a Title item, based on its client code

Request

GET /api/v1/referentials/titles/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-titles-id-put

Creates or updates a Title item.

Creates or updates the Title item.

Request

PUT /api/v1/referentials/titles/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the Title item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-titles-id-delete

Deletes the specified Title item.

Deletes the specified Title item based on its client code.

Request

DELETE /api/v1/referentials/titles/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-titles-id-translations-get

Get all Title item translations

Get a list of translations of a Title item, based on its client code

Request

GET /api/v1/referentials/titles/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-titles-id-translations-lcid-get

Get the specified Title item translation

Get the translation of a Title item, in a specified language, based on its client code

Request

GET /api/v1/referentials/titles/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

TypeOfBonuses library

api-v1-referentials-typeofbonuses-get

Get all TypeOfBonuses items

Get a list of all available TypeOfBonuses items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/typeofbonuses

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-typeofbonuses-post

Creates a TypeOfBonuses item.

Creates the TypeOfBonuses item.

Request

POST /api/v1/referentials/typeofbonuses

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the TypeOfBonuses item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-typeofbonuses-id-get

Get the TypeOfBonuses item details

Get the details of a TypeOfBonuses item, based on its client code

Request

GET /api/v1/referentials/typeofbonuses/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-typeofbonuses-id-put

Creates or updates a TypeOfBonuses item.

Creates or updates the TypeOfBonuses item.

Request

PUT /api/v1/referentials/typeofbonuses/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the TypeOfBonuses item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-typeofbonuses-id-delete

Deletes the specified TypeOfBonuses item.

Deletes the specified TypeOfBonuses item based on its client code.

Request

DELETE /api/v1/referentials/typeofbonuses/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-typeofbonuses-id-translations-get

Get all TypeOfBonuses item translations

Get a list of translations of a TypeOfBonuses item, based on its client code

Request

GET /api/v1/referentials/typeofbonuses/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-typeofbonuses-id-translations-lcid-get

Get the specified TypeOfBonuses item translation

Get the translation of a TypeOfBonuses item, in a specified language, based on its client code

Request

GET /api/v1/referentials/typeofbonuses/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

Users

api-v1-users-get

Get all users

Get a list of all available users. If offset and limit provided, it will return only the ones between the interval. Only users in the current user organisation scope are returns.

QueryString

Parameters	Description
offset & limit	Pagination enabled
filter	Filters enabled

Filter available

Filter name	Description	Operator available	Value type
updateDate	filter users by modification date (or creation date, if no modification date exists)	::, :gt:, :ge:, :lt:, :le:	date

Required authorization

Type	Value(s)
Ressource	UsersCorporation, permission: Use

Request

GET /api/v1/users

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_BackOfficeUserRead	The object is returned with success

api-v1-users-login-get

Get user details

Get the details of a user

Required authorization

Type	Value(s)
Ressource	UsersCorporation, permission: Use

Request

GET /api/v1/users/{login}

Parameters

Name	Type	Default	Notes
*login			The user identifier

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_BackOfficeUserRead	The object is returned with success
400		Query not correct
404		Identifier doesn't exist

api-v1-users-login-put

Create or update user details

Create or update the details of a user, based on its login

Required authorization

Type	Value(s)
Ressource	UsersCorporation, permission: Update

Request

PUT /api/v1/users/{login}

Parameters

Name	Type	Default	Notes
*login			The user identifier
*BackOfficeUserWrite	BackOfficeUserWrite		Create or update the details of a user, based on its login Required authorization Type Value(s) Ressource UsersCorporation, permission: Update

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_BackOfficeUserWrite	The object is successfully updated and saved
400		The object update fails

api-v1-users-login-delete

Delete user

Deletes the user

Required authorization

Type	Value(s)
Ressource	UsersCorporation, permission: Delete

Request

DELETE /api/v1/users/{login}

Parameters

Name	Type	Default	Notes
*login			The user identifier

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_BackOfficeUserRead	The object is successfully deleted
500		The object deletion failed

Vacancies

api-v1-vacancies-get

Get all vacancies

Get a list of all available vacancies. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled
q	query search
filters	Filters enabled
withAuthorization	Display resource authorization information

Filter available

Filter name	Description	Operator available	Value type
vacancyStatus	filter vacancies by vacancy status enum value	:: ,	string Archived Confirmed Draft Finalized PendingPublication Published Suspended
clientVacancyStatus	filter vacancies by vacancy status identifier	::	string
publicationMedia	filter vacancies by publication media	::	string
publishedOnTheMedia	filter vacancies by currently published on a specific media	::	string
updateDate	filter vacancies by modification date (or creation date, if no modification date exists)	::, :gt:, :ge:, :lt:, :le:	date
publishedOn	filter vacancies by currently published on a specific publication media	::	string mobilitySite

Required authorization

Type	Value(s)
Role	OffersEngine

Request

GET /api/v1/vacancies[?outputformat]

Parameters

Name	Type	Default	Notes
outputformat			Get a list of all available vacancies. If offset and limit provided, it will return only the ones between the interval. QueryString Parameters Description offset & limit Pagination enabled q query search filters Filters enabled withAuthorization Display resource authorization information Filter available Filter name Description Operator available Value type vacancyStatus filter vacancies by vacancy status enum value :: , string Archived Confirmed Draft Finalized PendingPublication Published Suspended clientVacancyStatus filter vacancies by vacancy status identifier :: string publicationMedia filter vacancies by publication media :: string publishedOnTheMedia filter vacancies by currently published on a specific media :: string updateDate filter vacancies by modification date (or creation date, if no modification date exists) ::, :gt:, :ge:, :lt:, :le: date publishedOn filter vacancies by currently published on a specific publication media :: string mobilitySite Required authorization Type Value(s) Role OffersEngine

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_VacancySummary	The object is returned with success

api-v1-vacancies-post

Create a vacancy

Create a vacancy with the given details

Required authorization

Type	Value(s)
Ressource	OfferDetails, permission: Create

Request

POST /api/v1/vacancies

Parameters

Name	Type	Default	Notes
*vacancy	VacancyDetailWrite		The vacancy object

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_VacancyDetailWrite	The object is successfully created and saved
404		The object creation fails

api-v1-vacancies-vacancyReference-get

Get the vacancy details

Get the details of a vacancy, in the language of the initial translation, based on its reference

QueryString

Parameters	Description
withAuthorization	Display resource authorization information

Required authorization

Type	Value(s)
Ressource	OfferDetails, permission: Use

Request

GET /api/v1/vacancies/{vacancyReference}

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy see identifier encoding

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_VacancyDetailRead	The object is returned with success
404		The specified vacancy doesn't exist

api-v1-vacancies-vacancyReference-put

Update vacancy details

Update the details of a vacancy, based on its reference

Required authorization

Type	Value(s)
Ressource	OfferDetails, permission: Update

Request

PUT /api/v1/vacancies/{vacancyReference}

Parameters

Name	Type	Default	Notes
*vacancyReference			The vacancy reference see identifier encoding
*VacancyDetailWrite	VacancyDetailWrite		Update the details of a vacancy, based on its reference Required authorization Type Value(s) Ressource OfferDetails, permission: Update

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_VacancyDetailWrite	The object is successfully updated and saved
404		The object update fails

api-v1-vacancies-vacancyReference-attachments-get

Get vacancy attachments

Get a list of all attachments for a vacancy.

Required authorization

Type	Value(s)
Ressource	AttachedFilesOffer, permission: Use

Request

GET /api/v1/vacancies/{vacancyReference}/attachments

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_AttachedFile	The object is returned with success
400		Query not correct
404		Identifier doesn't exist

api-v1-vacancies-vacancyReference-attachments-post

Add vacancy attachment

Add vacancy attachment for given offer reference This endpoint accept only multipart request as following:

Multipart structure

Name	Description	Content-Disposition	Content-Type
typeId	The clientCode of attached file type provided	form-data
uploadedFile	The file content	form-data	file mime type

Remarks:

• The enctype of the request must be "multipart/form-data".
• The max size of a single file depends on the settings in the backoffice.
• The file extension accepted by this endpoint depends on the settings in the backoffice.

Required authorization

Type	Value(s)
Ressource	AttachedFilesOffer, permission: Create

Request

POST /api/v1/vacancies/{vacancyReference}/attachments

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy

Responses

Status Code	Type	Description	Samples
200	object	The object is returned with success with a header location which contains the URL for the attachment
400		Query not correct

api-v1-vacancies-vacancyReference-attachments-id-get

Get vacancy attachment

Get specific vacancy attachment for given reference

Required authorization

Type	Value(s)
Ressource	AttachedFilesOffer, permission: Use

Request

GET /api/v1/vacancies/{vacancyReference}/attachments/{id}

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy
*id			Identifier of the file

Responses

Status Code	Type	Description	Samples
200	object	The object is returned with success
400		Query not correct
404		Identifier doesn't exist

api-v1-vacancies-vacancyReference-attachments-id-delete

Delete vacancy attachment

Required authorization

Type	Value(s)
Ressource	AttachedFilesOffer, permission: Delete

Request

DELETE /api/v1/vacancies/{vacancyReference}/attachments/{id}

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy
*id			Identifier of the file

Responses

Status Code	Type	Description	Samples
200	object	The file has been deleted
404		The specified file doesn't exist

api-v1-vacancies-vacancyReference-cover-put

Add or update a cover to the Vacancy.

The file content have to be sent as raw binary in the body of the request.

Required authorization

Type	Value(s)
Ressource	AttachedFilesOffer, permission: Create, Update

Request

PUT /api/v1/vacancies/{vacancyReference}/cover

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the Vacancy
*Content-Disposition			The filename is mandatory, follow this link for the format https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition.
*Content-Type			The mime type have to be provided, follow this link for the format https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type.
*coverFile	object		Raw binary file

Responses

Status Code	Type	Description	Samples
200	object	Vacancy cover have been set.
400		Content-Disposition is missing or not well formated. Content-Type is missing. File exceeds the max size of 200kB.
404		Vacancy reference does not exist.

api-v1-vacancies-vacancyReference-metadata-lcid-get

Get the vacancy metadata

Get the metadata of a vacancy, in the language of the initial translation, based on its reference

QueryString

Parameters	Description
withAuthorization	Display resource authorization information

Required authorization

Type	Value(s)
Ressource	OfferDetails, permission: Use

Request

GET /api/v1/vacancies/{vacancyReference}/metadata/{lcid}

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy see identifier encoding
*lcid			The language ID

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_Dictionary_String_Object	The object is returned with success
404		The specified vacancy doesn't exist

api-v1-vacancies-vacancyReference-publicationmedias-delete

Stop the publication of a vacancy on all medias

Required authorization

Type	Value(s)
Ressource	PublishOffer, permission: Delete

Request

DELETE /api/v1/vacancies/{vacancyReference}/publicationmedias

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_String	The vacancy has been unpublished with success
400		The unpublication failed
404		The vacancy doesn't exist

api-v1-vacancies-vacancyReference-publicationmedias-id-get

Get a vacancy publication media information

Get the information about the publication of a given vacancy for a specific media.

Required authorization

Type	Value(s)
Ressource	PublishOffer, permission: Use

Request

GET /api/v1/vacancies/{vacancyReference}/publicationmedias/{id}

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy see identifier encoding
*id			The publication media identifier

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ICollection_PublicationMediaInfo	The object is returned with success
400		The vacancy or publication media doesn't exist

api-v1-vacancies-vacancyReference-publicationmedias-id-put

Publish a vacancy on a specific media

Required authorization

Type	Value(s)
Ressource	PublishOffer, permission: Create

Request

PUT /api/v1/vacancies/{vacancyReference}/publicationmedias/{id}

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy
*id			The publication media identifier
*PublicationMediaPublishInfo	PublicationMediaPublishInfo		Required authorization Type Value(s) Ressource PublishOffer, permission: Create

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_String	The vacancy has been published with success
400		The publication failed
404		The vacancy doesn't exist

api-v1-vacancies-vacancyReference-publicationmedias-id-delete

Stop the publication of a vacancy on a specific media

The publication support type must be internet or intranet. The offer must not be currently published on a job board/multi-posting service.

Required authorization

Type	Value(s)
Ressource	PublishOffer, permission: Delete

Request

DELETE /api/v1/vacancies/{vacancyReference}/publicationmedias/{id}

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy
*id			The publication media identifier

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_String	The vacancy has been unpublished with success
400		The unpublication failed
404		The vacancy doesn't exist

api-v1-vacancies-vacancyReference-supervisors-get

Get the vacancy supervisors

Get a list of supervisors of a vacancy, based on its reference

Required authorization

Type	Value(s)
Ressource	OfferDetails, permission: Use

Request

GET /api/v1/vacancies/{vacancyReference}/supervisors

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy see identifier encoding

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ICollection_Supervisor	The list of offer supervisors is returned with success
404		The vacancy is not found

api-v1-vacancies-vacancyReference-supervisors-login-put

Add vacancy supervisor

Required authorization

Type	Value(s)
Ressource	OfferDetails, permission: Create

Request

PUT /api/v1/vacancies/{vacancyReference}/supervisors/{login}

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy see identifier encoding
*login			The supervisor login
*SupervisorWrite	SupervisorWrite		Required authorization Type Value(s) Ressource OfferDetails, permission: Create

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SupervisorWrite	The vacancy supervisor is added with success
404		The vacancy or the supervisor are not found

api-v1-vacancies-vacancyReference-supervisors-login-delete

Delete vacancy supervisor

Required authorization

Type	Value(s)
Ressource	OfferDetails, permission: Delete

Request

DELETE /api/v1/vacancies/{vacancyReference}/supervisors/{login}

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy see identifier encoding
*login			The supervisor login

Responses

Status Code	Type	Description	Samples
200	object	The object is successfully deleted
400		The object deletion failed. See error message for reason
500		The object deletion failed

api-v1-vacancies-vacancyReference-translations-get

Get all vacancy translations

Get a list of translations of a vacancy, based on its reference

Required authorization

Type	Value(s)
Ressource	TranslationOffer, permission: Use

Request

GET /api/v1/vacancies/{vacancyReference}/translations

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy see identifier encoding

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ICollection_VacancyTranslation	The object is returned with success
404		The specified vacancyReference doesn't exist

api-v1-vacancies-vacancyReference-translations-lcid-get

Get the specified vacancy translation

Return the translation of a vacancy, in a specified language, based on its reference

Required authorization

Type	Value(s)
Ressource	TranslationOffer, permission: Use

Request

GET /api/v1/vacancies/{vacancyReference}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy see identifier encoding
*lcid			The language ID

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_VacancyTranslation	The translation is returned with success
404		The translation doesn't exist

api-v1-vacancies-vacancyReference-translations-lcid-put

Create or update the specified vacancy translation

Create or update only the specified fields of a vacancy translation, based on its reference and language

Required authorization

Type	Value(s)
Ressource	TranslationOffer, permission: Create, Update

Request

PUT /api/v1/vacancies/{vacancyReference}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy see identifier encoding
*lcid			The language ID
*VacancyTranslation	VacancyTranslation		Create or update only the specified fields of a vacancy translation, based on its reference and language Required authorization Type Value(s) Ressource TranslationOffer, permission: Create, Update

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_VacancyTranslation	The translation is updated with success
404		The translation doesn't exist

api-v1-vacancies-vacancyReference-translations-lcid-delete

Delete the specified vacancy translation

Delete a vacancy translation, based on its reference and language id

Required authorization

Type	Value(s)
Ressource	TranslationOffer, permission: Delete

Request

DELETE /api/v1/vacancies/{vacancyReference}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy see identifier encoding
*lcid			The language ID

Responses

Status Code	Type	Description	Samples
200	object	The object is successfully deleted
400		The object deletion failed. See error message for reason
500		The object deletion failed

api-v1-vacancies-vacancyReference-vacancymetadata-lcid-get

Get the vacancy metadata

Get the metadata of a vacancy, in the language of the initial translation, based on its reference

QueryString

Parameters	Description
withAuthorization	Display resource authorization information

Required authorization

Type	Value(s)
Ressource	OfferDetails, permission: Use

Request

GET /api/v1/vacancies/{vacancyReference}/vacancymetadata/{lcid}

Parameters

Name	Type	Default	Notes
*vacancyReference			Reference of the vacancy see identifier encoding
*lcid			The language ID

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_Dictionary_String_Object	The object is returned with success
404		The specified vacancy doesn't exist

VacancyCategories library

api-v1-referentials-vacancycategories-get

Get all VacancyCategories items

Get a list of all available VacancyCategories items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/vacancycategories

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-vacancycategories-post

Creates a VacancyCategories item.

Creates the VacancyCategories item.

Request

POST /api/v1/referentials/vacancycategories

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the VacancyCategories item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-vacancycategories-id-get

Get the VacancyCategories item details

Get the details of a VacancyCategories item, based on its client code

Request

GET /api/v1/referentials/vacancycategories/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-vacancycategories-id-put

Creates or updates a VacancyCategories item.

Creates or updates the VacancyCategories item.

Request

PUT /api/v1/referentials/vacancycategories/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the VacancyCategories item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-vacancycategories-id-delete

Deletes the specified VacancyCategories item.

Deletes the specified VacancyCategories item based on its client code.

Request

DELETE /api/v1/referentials/vacancycategories/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-vacancycategories-id-translations-get

Get all VacancyCategories item translations

Get a list of translations of a VacancyCategories item, based on its client code

Request

GET /api/v1/referentials/vacancycategories/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-vacancycategories-id-translations-lcid-get

Get the specified VacancyCategories item translation

Get the translation of a VacancyCategories item, in a specified language, based on its client code

Request

GET /api/v1/referentials/vacancycategories/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

VacancyRequestApprovalEvents library

api-v1-referentials-vacancyrequestapprovalevents-get

Get all VacancyRequestApprovalEvents items

Get a list of all available VacancyRequestApprovalEvents items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/vacancyrequestapprovalevents

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-vacancyrequestapprovalevents-id-get

Get the VacancyRequestApprovalEvents item details

Get the details of a VacancyRequestApprovalEvents item, based on its client code

Request

GET /api/v1/referentials/vacancyrequestapprovalevents/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-vacancyrequestapprovalevents-id-translations-get

Get all VacancyRequestApprovalEvents item translations

Get a list of translations of a VacancyRequestApprovalEvents item, based on its client code

Request

GET /api/v1/referentials/vacancyrequestapprovalevents/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-vacancyrequestapprovalevents-id-translations-lcid-get

Get the specified VacancyRequestApprovalEvents item translation

Get the translation of a VacancyRequestApprovalEvents item, in a specified language, based on its client code

Request

GET /api/v1/referentials/vacancyrequestapprovalevents/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

VacancyRequestApprovalStatus library

api-v1-referentials-vacancyrequestapprovalstatus-get

Get all VacancyRequestApprovalStatus items

Get a list of all available VacancyRequestApprovalStatus items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/vacancyrequestapprovalstatus

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-vacancyrequestapprovalstatus-id-get

Get the VacancyRequestApprovalStatus item details

Get the details of a VacancyRequestApprovalStatus item, based on its client code

Request

GET /api/v1/referentials/vacancyrequestapprovalstatus/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-vacancyrequestapprovalstatus-id-translations-get

Get all VacancyRequestApprovalStatus item translations

Get a list of translations of a VacancyRequestApprovalStatus item, based on its client code

Request

GET /api/v1/referentials/vacancyrequestapprovalstatus/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-vacancyrequestapprovalstatus-id-translations-lcid-get

Get the specified VacancyRequestApprovalStatus item translation

Get the translation of a VacancyRequestApprovalStatus item, in a specified language, based on its client code

Request

GET /api/v1/referentials/vacancyrequestapprovalstatus/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

VacancyRequestEvents library

api-v1-referentials-vacancyrequestevents-get

Get all VacancyRequestEvents items

Get a list of all available VacancyRequestEvents items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/vacancyrequestevents

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-vacancyrequestevents-id-get

Get the VacancyRequestEvents item details

Get the details of a VacancyRequestEvents item, based on its client code

Request

GET /api/v1/referentials/vacancyrequestevents/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-vacancyrequestevents-id-translations-get

Get all VacancyRequestEvents item translations

Get a list of translations of a VacancyRequestEvents item, based on its client code

Request

GET /api/v1/referentials/vacancyrequestevents/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-vacancyrequestevents-id-translations-lcid-get

Get the specified VacancyRequestEvents item translation

Get the translation of a VacancyRequestEvents item, in a specified language, based on its client code

Request

GET /api/v1/referentials/vacancyrequestevents/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

VacancyRequestStatus library

api-v1-referentials-vacancyrequeststatus-get

Get all VacancyRequestStatus items

Get a list of all available VacancyRequestStatus items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/vacancyrequeststatus

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-vacancyrequeststatus-id-get

Get the VacancyRequestStatus item details

Get the details of a VacancyRequestStatus item, based on its client code

Request

GET /api/v1/referentials/vacancyrequeststatus/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-vacancyrequeststatus-id-translations-get

Get all VacancyRequestStatus item translations

Get a list of translations of a VacancyRequestStatus item, based on its client code

Request

GET /api/v1/referentials/vacancyrequeststatus/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-vacancyrequeststatus-id-translations-lcid-get

Get the specified VacancyRequestStatus item translation

Get the translation of a VacancyRequestStatus item, in a specified language, based on its client code

Request

GET /api/v1/referentials/vacancyrequeststatus/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

VacancyRequests

api-v1-vacancyrequests-get

Get all available vacancy requests

Get all available vacancy requests If offset and limit provided, it will return only the ones between the interval

QueryString

Parameters	Description
offset & limit	Pagination enabled
q	query search
filter	Filters enabled

Filter available

Filter name	Description	Operator available	Value type
id	filter vacancy requests by URL encoded reference see identifier encoding	:: ,	string
validatorEmail	filter vacancy requests in function of the validator who must validate the vacancy request	:: ,	string
creationUser	filter vacancy requests in function of the user who create it	::	string
vacancyRequestStatus	filter vacancy requests by vacancy request status	:: ,	string Approval Archived Expired InProcess Processed Refused ToBeProcessed
clientVacancyRequestStatus	filter vacancy requests by vacancy request status referential identifier	:: ,	string

Required authorization

Type	Value(s)
Role	PreliminaryJobRequestsEngine

Request

GET /api/v1/vacancyrequests

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_VacancyRequest	The object is returned with success
400		The object is returned with error message

api-v1-vacancyrequests-id-get

Get the vacancy request details

Get the details of a vacancy request, in the language of the initial translation, based on its reference

Required authorization

Type	Value(s)
Ressource	PreliminaryJobRequestDetails, permission: Use

Request

GET /api/v1/vacancyrequests/{id}

Parameters

Name	Type	Default	Notes
*id			Reference of the vacancy request see identifier encoding

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_VacancyRequestDetail	The object is returned with success
404		The specified vacancy doesn't exist

api-v1-vacancyrequests-id-events-get

Get the list of events for a vacancy request.

Get a list of all available vacancy request events for a given vacancy request reference If offset and limit provided, it will return only the ones between the interval

QueryString

Parameters	Description
offset & limit	Pagination enabled

Required authorization

Type	Value(s)
Ressource	EventsPreliminaryJobRequest, permission: Use

Request

GET /api/v1/vacancyrequests/{id}/events

Parameters

Name	Type	Default	Notes
*id			Get a list of all available vacancy request events for a given vacancy request reference If offset and limit provided, it will return only the ones between the interval QueryString Parameters Description offset & limit Pagination enabled Required authorization Type Value(s) Ressource EventsPreliminaryJobRequest, permission: Use

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_VacancyRequestEvent	The object is returned with success
400		The object is returned with error message

api-v1-vacancyrequests-id-externalrecruitmentagreement-get

Get the external recruitment agreement details

Get the details of an external recruitment agreement

Required authorization

Type	Value(s)
Ressource	Agreement_External, permission: Use

Request

GET /api/v1/vacancyrequests/{id}/externalrecruitmentagreement

Parameters

Name	Type	Default	Notes
*id			Reference of the job request see identifier encoding

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_VacancyRequestExternalRecruitmentAgreement	The object is returned with success
404		The specified object doesn't exist

api-v1-vacancyrequests-id-externalrecruitmentagreement-metadata-get

Get the external recruitment agreement metadata

Get the metadata of an external recruitment agreement

Required authorization

Type	Value(s)
Ressource	Agreement_External, permission: Use

Request

GET /api/v1/vacancyrequests/{id}/externalrecruitmentagreement/metadata

Parameters

Name	Type	Default	Notes
*id			Reference of the job request see identifier encoding

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_Dictionary_String_Object	The object is returned with success
404		The specified object doesn't exist

api-v1-vacancyrequests-id-externalrecruitmentagreement-supervisors-get

Get the supervisor list for an external recruitment agreement

Required authorization

Type	Value(s)
Ressource	Agreement_External, permission: Use

Request

GET /api/v1/vacancyrequests/{id}/externalrecruitmentagreement/supervisors

Parameters

Name	Type	Default	Notes
*id			Reference of the job request see identifier encoding

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_Supervisor	Action successfully executed
404		Identifier doesn't exist

api-v1-vacancyrequests-id-externalrecruitmentagreement-validations-get

Get a list of all available external recruitment agreements in the perimeter of the user linked to the client id.

Get all available external recruitment agreements in the perimeter of the user linked to the client id.

Required authorization

Type	Value(s)
Ressource	Agreement_External, permission: Use

Request

GET /api/v1/vacancyrequests/{id}/externalrecruitmentagreement/validations

Parameters

Name	Type	Default	Notes
*id			Get all available external recruitment agreements in the perimeter of the user linked to the client id. Required authorization Type Value(s) Ressource Agreement_External, permission: Use

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_AgreementValidator	The object is returned with success
400		The object is returned with error message

api-v1-vacancyrequests-id-externalrecruitmentagreement-validations-validationId-events-get

Get a list of validation events of a vacancy request external recruitment agreement.

Required authorization

Type	Value(s)
Ressource	EventsAgreementValidation, permission: Use

Request

GET /api/v1/vacancyrequests/{id}/externalrecruitmentagreement/validations/{validationId}/events

Parameters

Name	Type	Default	Notes
*id			Reference of the job request see identifier encoding
*validationId			Reference of the external recruitment agreement validation see identifier encoding

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_VacancyRequestAgreementValidationEvent	The list of all active items is returned with success
400		The object is returned with error message
404		The specified validation doesn't exist

api-v1-vacancyrequests-id-internalmobilityagreement-get

Get the internal mobility agreement details

Get the details of an internal agreement agreement

Required authorization

Type	Value(s)
Ressource	Agreement_Internal, permission: Use

Request

GET /api/v1/vacancyrequests/{id}/internalmobilityagreement

Parameters

Name	Type	Default	Notes
*id			Reference of the job request see identifier encoding

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_VacancyRequestInternalMobilityAgreement	The object is returned with success
404		The specified object doesn't exist

api-v1-vacancyrequests-id-internalmobilityagreement-metadata-get

Get the internal mobility agreement metadata

Get the metadata of an internal mobility agreement

Required authorization

Type	Value(s)
Ressource	Agreement_Internal, permission: Use

Request

GET /api/v1/vacancyrequests/{id}/internalmobilityagreement/metadata

Parameters

Name	Type	Default	Notes
*id			Reference of the job request see identifier encoding

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_Dictionary_String_Object	The object is returned with success
404		The specified object doesn't exist

api-v1-vacancyrequests-id-internalmobilityagreement-supervisors-get

Get the supervisor list for an internal mobility agreement

Required authorization

Type	Value(s)
Ressource	Agreement_Internal, permission: Use

Request

GET /api/v1/vacancyrequests/{id}/internalmobilityagreement/supervisors

Parameters

Name	Type	Default	Notes
*id			Reference of the job request see identifier encoding

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_Supervisor	Action successfully executed
404		Identifier doesn't exist

api-v1-vacancyrequests-id-internalmobilityagreement-validations-get

Get the validators list for an internal mobility agreement

Get all available internal mobility agreements validators in the perimeter of the user linked to the client id.

Required authorization

Type	Value(s)
Ressource	PreliminaryJobRequestValidation, permission: Use

Request

GET /api/v1/vacancyrequests/{id}/internalmobilityagreement/validations

Parameters

Name	Type	Default	Notes
*id			Get all available internal mobility agreements validators in the perimeter of the user linked to the client id. Required authorization Type Value(s) Ressource PreliminaryJobRequestValidation, permission: Use

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_AgreementValidator	The object is returned with success
400		The object is returned with error message

api-v1-vacancyrequests-id-internalmobilityagreement-validations-validationId-events-get

Get a list of validation events of a vacancy request internal mobility agreement.

Required authorization

Type	Value(s)
Ressource	EventsAgreementValidation, permission: Use

Request

GET /api/v1/vacancyrequests/{id}/internalmobilityagreement/validations/{validationId}/events

Parameters

Name	Type	Default	Notes
*id			Reference of the job request see identifier encoding
*validationId			Reference of the internal mobility agreement validation see identifier encoding

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_IEnumerable_VacancyRequestAgreementValidationEvent	The list of all active items is returned with success
400		The object is returned with error message
404		The specified validation doesn't exist

api-v1-vacancyrequests-id-validations-validationId-events-post

Apply an action on the agreement validation of a vacancy request

Apply an action on the agreement validation of a vacancy request for the given identifier. Possible actions for an agreement of a vacancy request:

• validate
• reject

Required authorization

Type	Value(s)
Ressource	PreliminaryJobRequestValidation, permission: Use

Request

POST /api/v1/vacancyrequests/{id}/validations/{validationId}/events

Parameters

Name	Type	Default	Notes
*id			Reference of the job request see identifier encoding
*validationId			Reference of the agreement validation see identifier encoding
*AgreementValidationEvent	AgreementValidationEvent		Apply an action on the agreement validation of a vacancy request for the given identifier. Possible actions for an agreement of a vacancy request: validate reject Required authorization Type Value(s) Ressource PreliminaryJobRequestValidation, permission: Use

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_Object	Action successfully executed
400		Query not correct
404		Identifier doesn't exist

api-v1-vacancyrequests-reference-metadata-get

Get the vacancy request metadata

Get the metadata of a vacancy request

QueryString

Parameters	Description
withAuthorization	Display resource authorization information

Required authorization

Type	Value(s)
Ressource	PreliminaryJobRequestDetails, permission: Use

Request

GET /api/v1/vacancyrequests/{reference}/metadata

Parameters

Name	Type	Default	Notes
*reference			Reference of the vacancy request see identifier encoding

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_Dictionary_String_Object	The object is returned with success
404		Identifier doesn't exist

VacancyStatuses library

api-v1-referentials-vacancystatuses-get

Get all VacancyStatuses items

Get a list of all available VacancyStatuses items. If offset and limit provided, it will return only the ones between the interval.

QueryString

Parameters	Description
offset & limit	Pagination enabled

Request

GET /api/v1/referentials/vacancystatuses

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct

api-v1-referentials-vacancystatuses-post

Creates a VacancyStatuses item.

Creates the VacancyStatuses item.

Request

POST /api/v1/referentials/vacancystatuses

Parameters

Name	Type	Default	Notes
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates the VacancyStatuses item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to create the referential.

api-v1-referentials-vacancystatuses-id-get

Get the VacancyStatuses item details

Get the details of a VacancyStatuses item, based on its client code

Request

GET /api/v1/referentials/vacancystatuses/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferential	The object is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-vacancystatuses-id-put

Creates or updates a VacancyStatuses item.

Creates or updates the VacancyStatuses item.

Request

PUT /api/v1/referentials/vacancystatuses/{id}

Parameters

Name	Type	Default	Notes
*id			The ID of the referential to update.
*SimpleReferentialWriteBase	SimpleReferentialWriteBase		Creates or updates the VacancyStatuses item.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialWrite	The referential is successfully updated.
201	WrappedResponse_SimpleReferentialWrite	The referential is successfully created.
400		Unable to update the referential.

api-v1-referentials-vacancystatuses-id-delete

Deletes the specified VacancyStatuses item.

Deletes the specified VacancyStatuses item based on its client code.

Request

DELETE /api/v1/referentials/vacancystatuses/{id}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential.
Accept-language			The referential language (fr-FR, en-GB...). If the language sent is not supported by Talentsoft or not enabled on the website, the referential will have the default language of the application.

Responses

Status Code	Type	Description	Samples
200	IWrappedResponse	The referential specified is deleted.
400		Unable to delete the referential specified.

api-v1-referentials-vacancystatuses-id-translations-get

Get all VacancyStatuses item translations

Get a list of translations of a VacancyStatuses item, based on its client code

Request

GET /api/v1/referentials/vacancystatuses/{id}/translations

Parameters

Name	Type	Default	Notes
*id			Client code of the referential

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The list of objects is returned with success
400		Query not correct
404		Client code doesn't exist

api-v1-referentials-vacancystatuses-id-translations-lcid-get

Get the specified VacancyStatuses item translation

Get the translation of a VacancyStatuses item, in a specified language, based on its client code

Request

GET /api/v1/referentials/vacancystatuses/{id}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*id			Client code of the referential
*lcid			Language id

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SimpleReferentialArray	The object is returned with success
400		Query not correct
404		Language not present in the application

Validations

api-v1-validations-get

Get all validations of a specific category

Get all validations of a specific category If offset and limit provided, it will return only the ones between the interval

QueryString

Parameters	Description
category	vacancyrequestagreement
offset & limit	Pagination enabled
q	query search on vacancy requests
filter	Filters enabled

Filter available

Filter name	Description	Operator available	Value type
validatorEmail	filter validations in function of the validator who must validate the vacancy request	:: ,	string
approvalRequestStatus	filter validations in function of the status	:: ,	string
id	filter vacancy requests by url encoded reference see identifier encoding	:: ,	string

Request

GET /api/v1/validations

Responses

Status Code	Type	Description	Samples
200	Validation	The object is returned with success
400		The object is returned with error message

Views

api-admin-v1-views-get

Get the list of all views

Get the list of all active views (Vacancy / Vacancy request / Candidate / Job offer / Assessment)

Filter available

Filter name	Description	Operator available	Value type
viewType	filter views by view type	::	string

Required authorization

Type	Value(s)
Role	AdminViewForm

Request

GET /api/admin/v1/views

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ViewArray	The object is returned with success

api-admin-v1-views-viewId-get

Get a view

Get the detail of the view

Required authorization

Type	Value(s)
Role	AdminViewForm

Request

GET /api/admin/v1/views/{viewId}

Parameters

Name	Type	Default	Notes
*viewId			Identifier of the view

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_View	The object is returned with success
404		The specified viewId doesn't exist

api-admin-v1-views-viewId-organisations-get

Get organisations of a view

Get the list of organisations for a view

Required authorization

Type	Value(s)
Role	AdminViewForm

Request

GET /api/admin/v1/views/{viewId}/organisations

Parameters

Name	Type	Default	Notes
*viewId			Client code of the view

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_OrganisationSummaryArray	The list of views is returned with success
404		The specified viewId doesn't exist

api-admin-v1-views-viewId-translations-get

Get translations of a view

Get a list of translation of a view

Required authorization

Type	Value(s)
Role	AdminViewForm

Request

GET /api/admin/v1/views/{viewId}/translations

Parameters

Name	Type	Default	Notes
*viewId			Client code of the view

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_ViewArray	The object is returned with success
404		The specified viewId doesn't exist

api-admin-v1-views-viewId-translations-lcid-get

Get the translation detail of a view

Get the translation details for the specified view and language

Required authorization

Type	Value(s)
Role	AdminViewForm

Request

GET /api/admin/v1/views/{viewId}/translations/{lcid}

Parameters

Name	Type	Default	Notes
*viewId			Client code of the view
*lcid			The language identifier

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_View	The translation is returned with success
404		The specified translation doesn't exist

WebHooks

api-system-v1-webhooks-post

Register to the event type.

Provide the event type to register and get notifications

Request

POST /api/system/v1/webhooks

Parameters

Name	Type	Default	Notes
*subscriptionInfo	SubscriptionInformationWrite		The subscription info

Responses

Status Code	Type	Description	Samples
200	WrappedResponse_SubscriptionInformationRead	Successfully subscribed to the event
400		The model or the event_type is invalid

api-system-v1-webhooks-hookId-delete

Unregister a webhook from an event.

Request

DELETE /api/system/v1/webhooks/{hookId}

Parameters

Name	Type	Default	Notes
*hookId			The event's hook id

Responses

Status Code	Type	Description	Samples
200	object	The hookId was deleted or doesn't exist
400		The clientId is invalid

api-system-v1-webhooks-hookId-pings-post

Ping a webhook.

Request

POST /api/system/v1/webhooks/{hookId}/pings

Parameters

Name	Type	Default	Notes
*hookId			The event's hook id

Responses

Status Code	Type	Description	Samples
200	PingCallResponse	The ping was successful. Check the ping response in the response
400		The clientId is invalid
404		The hookId doesn't exist

Definitions

WrappedResponse_ApplicationEventArray

Wrapped response

Name	Type	Notes
data	ApplicationEvent[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

ApplicationEvent

The response data

Name	Type	Notes
languageId	integer (int32)
orderNumber	integer (int32)
applicationStatus	Reference[]	Referencing object
vacancyEvent	Reference[]	Referencing object
id	string
label	string

Reference

Referencing object

Name	Type	Notes
id	string	Gets or sets ReferenceIdentifier of the referenced object
label	string	Gets or sets ReferenceLabel of the referenced object

WrappedResponse_ApplicationEvent

Wrapped response

Name	Type	Notes
data	ApplicationEvent[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_ApplicationNotificationArray

Wrapped response

Name	Type	Notes
data	ApplicationNotification[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

ApplicationNotification

The response data

Name	Type	Notes
languageId	integer (int32)
orderNumber	integer (int32)
frequency	integer (int32)
id	string
label	string

WrappedResponse_ApplicationNotification

Wrapped response

Name	Type	Notes
data	ApplicationNotification[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_ApplicationStatusArray

Wrapped response

Name	Type	Notes
data	ApplicationStatus[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

ApplicationStatus

The response data

Name	Type	Notes
languageId	integer (int32)
orderNumber	integer (int32)
isFinalStatus	boolean
id	string
label	string

WrappedResponse_ApplicationStatus

Wrapped response

Name	Type	Notes
data	ApplicationStatus[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_ApplicationTypeArray

Wrapped response

Name	Type	Notes
data	ApplicationType[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

ApplicationType

The response data

Name	Type	Notes
languageId	integer (int32)
orderNumber	integer (int32)
applicationStatus	Reference[]	Referencing object
vacancyEvent	Reference[]	Referencing object
id	string
label	string

WrappedResponse_ApplicationType

Wrapped response

Name	Type	Notes
data	ApplicationType[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_IEnumerable_AttachedFile

Wrapped response

Name	Type	Notes
data	AttachedFile[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

AttachedFile

The response data

Name	Type	Notes
mimeType	string
type	Reference[]	Referencing object
id	string (uuid)
filename	string

ApplicationChildEventType

Name	Type	Notes
action	string

WrappedResponse_ReferralBonus

Wrapped response

Name	Type	Notes
data	ReferralBonus[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

ReferralBonus

The response data

Name	Type	Notes
date	string (date-time)
bonusType	Reference[]	Referencing object
value	number (double)
paid	boolean
comments	string

ApplicationDetailWrite

Application details

Name	Type	Notes
applicationInformation	ApplicationInformation[]	The application information
gdprInformation	GdprInformation[]	The GDPR information
referral	Referral[]	The referral

ApplicationInformation

The application information

Name	Type	Notes
motivation	string	The application motivation
publicationMediaId	string	The application publication media identifier

GdprInformation

The GDPR information

Name	Type	Notes
personalDataConsentReceived	boolean	The personal data consent
retentionDelay	integer (int32)	The retention delay. Should be null by default

Referral

The referral

Name	Type	Notes
feedback	string	The referral feedback
date	string (date-time)	The referral date
employeeId	string	The referral identifier

WrappedResponse_ApplicationDetailWriteResponse

Wrapped response

Name	Type	Notes
data	ApplicationDetailWriteResponse[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

ApplicationDetailWriteResponse

The response data

Name	Type	Notes
candidateInformation	CandidateDetailWriteResponse[]	The candidate information
applicationInformation	ApplicationInformation[]	The application information
gdprInformation	GdprInformation[]	The GDPR information
referral	Referral[]	The referral
id	string	The Identifier of the Application

CandidateDetailWriteResponse

The candidate information

Name	Type	Notes
id	string	The Identifier of the applicant
lastName	string	The last name
firstName	string	The first name
middleName	string	The middle name
email	string	The email
phoneNumber	string	The candidate phone number
civilityId	string	The candidate civility identifier (The referential type accepted is Civility)
personalInformation	CandidatePersonalInformationWrite[]	The candidate personal information
jobPreferences	CandidateJobPreferencesWrite[]	The candidate job preferences
languages	CandidateLanguageWrite[]	The candidate language
educations	CandidateEducationWrite[]	The candidate education
experiences	CandidateExperienceWrite[]	The candidate experience
attachments	CandidateAttachmentWrite[]	Describe the file attachments

CandidatePersonalInformationWrite

The candidate personal information

Name	Type	Notes
birthDate	string (date-time)	The candidate birth date
nationalities	array	The candidate nationalities identifiers (The referential type accepted is Nationality)
address	string	The candidate address
postalCode	string	The candidate postal code
city	string	The candidate city
residentCountryId	string	The candidate country identifier (The referential type accepted is Country)
specialEmploymentRegulationsInFrance	SpecialEmploymentRegulationsInFrance[]

SpecialEmploymentRegulationsInFrance

Name	Type	Notes
disabledWorkerStatus	boolean	I have the French disabled worker status (RQTH).
priorityNeighbourhood	boolean	I hereby declare that I reside in a French priority neighbourhood (QPV / "Emploi Franc").

CandidateJobPreferencesWrite

The candidate job preferences

Name	Type	Notes
primaryProfileId	string	The candidate primary profile identifier (The referential type accepted is Profile)
dateOfAvailability	string (date-time)	The candidate date of availability
salaryExpectations	string	The candidate salary expectations

CandidateLanguageWrite

The candidate language

Name	Type	Notes
languageId	string	The candidate language identifier (The referential type accepted is Language)
languageLevelId	string	The candidate language level identifier (The referential type accepted is LanguageLevel)

CandidateEducationWrite

The candidate education

Name	Type	Notes
diplomaId	string	The candidate diploma identifier (The referential type accepted is Diploma)
educationLevelId	string	The education level identifier of the diploma (The referential type accepted is Education Level)

CandidateExperienceWrite

The candidate experience

Name	Type	Notes
experienceLevelId	string	The candidate experience level identifier (The referential type accepted is ExperienceLevel)
profileId	string	The profile identifier of the experience (The referential type accepted is Profile)
company	string	The company under which the experience was acquired
function	string	The function performed during the experience
contractTypeId	string	The contract identifier (The referential type accepted is ContractType)

CandidateAttachmentWrite

Describe the file attachments

Name	Type	Notes
description	string
key	string
fileType	string

ApplicantApplicationDetailWrite_CandidateDetailWrite

Application details

Name	Type	Notes
candidateInformation	CandidateDetailWrite[]	The candidate information
applicationInformation	ApplicationInformation[]	The application information
gdprInformation	GdprInformation[]	The GDPR information
referral	Referral[]	The referral

CandidateDetailWrite

The candidate information

Name	Type	Notes
lastName	string	The last name
firstName	string	The first name
middleName	string	The middle name
email	string	The email
phoneNumber	string	The candidate phone number
civilityId	string	The candidate civility identifier (The referential type accepted is Civility)
personalInformation	CandidatePersonalInformationWrite[]	The candidate personal information
jobPreferences	CandidateJobPreferencesWrite[]	The candidate job preferences
languages	CandidateLanguageWrite[]	The candidate language
educations	CandidateEducationWrite[]	The candidate education
experiences	CandidateExperienceWrite[]	The candidate experience
attachments	CandidateAttachmentWrite[]	Describe the file attachments

WrappedResponse_SimpleReferentialArray

Wrapped response

Name	Type	Notes
data	SimpleReferential[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

SimpleReferential

The response data

Name	Type	Notes
orderNumber	integer (int32)	The referential order number
languageId	integer (int32)	The referential language id
id	string	The referential identifier
label	string	The referential label

SimpleReferentialWriteBase

Name	Type	Notes
label	string	The referential label
orderNumber	integer (int32)	The referential order number

WrappedResponse_SimpleReferentialWrite

Wrapped response

Name	Type	Notes
data	SimpleReferentialWrite[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

SimpleReferentialWrite

The response data

Name	Type	Notes
id	string	The referential identifier
languageId	integer (int32)	The referential language id
label	string	The referential label
orderNumber	integer (int32)	The referential order number

WrappedResponse_SimpleReferential

Wrapped response

Name	Type	Notes
data	SimpleReferential[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

IWrappedResponse

Name	Type	Notes
code	string	The http status code
status	string	The response status
message	string	The message

WrappedResponse_IEnumerable_CandidateSummary

Wrapped response

Name	Type	Notes
data	CandidateSummary[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

CandidateSummary

The response data

Name	Type	Notes
id	string
lastName	string
firstName	string
middleName	string
email	string

WrappedResponse_CandidateDetailRead

Wrapped response

Name	Type	Notes
data	CandidateDetailRead[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

CandidateDetailRead

The response data

Name	Type	Notes
creationDate	string (date-time)	The creation date
agencyUser	string	Full name of the agency user who add this candidate
isAnonymized	boolean	The anonymization state
personalInformation	CandidatePersonalInformationRead[]	The personal information
positionSought	CandidateJobPreferencesRead[]	The position sought
languages	CandidateLanguageRead[]	The languages
educations	CandidateDiplomaRead[]	The educations
experiences	CandidateExperiencesRead[]	The experiences
globalExperience	CandidateGlobalExperience[]	The global experience
additionalInformation	CandidateAdditionalInformationRead[]	The additional information
recruiterData	CandidateBackOfficeDataRead[]	The recruiter data
consents	CandidateConsentRead[]	The consents
referral	CandidateReferral[]	The referal
id	string	The Identifier of the applicant
title	string	The title
sex	Reference[]	The sex
civility	Reference[]	The civility
lastName	string	The last name
firstName	string	The first name
middleName	string	The middle name
email	string	The email
phoneNumber	string	The phone number
status	Reference[]	The status
customBlock1CustomFields	DataWithCustomFieldsRead[]	The custom block1 custom fields
customBlock2CustomFields	DataWithCustomFieldsRead[]	The custom block2 custom fields
customBlock3CustomFields	DataWithCustomFieldsRead[]	The custom block3 custom fields
customBlock4CustomFields	DataWithCustomFieldsRead[]	The custom block4 custom fields

CandidatePersonalInformationRead

The personal information

Name	Type	Notes
nationalities	Reference[]	The nationalities
professionalEmail	string	The professional email
birthDate	string (date-time)
address	string	The address
postalCode	string	The postal code
city	string	The city
residentCountry	Reference[]	The resident country
otherPhoneNumber	string	The other phone number
personalInformationCustomFields	DataWithCustomFieldsRead[]	The custom fields

DataWithCustomFieldsRead

The custom fields

Name	Type	Notes
customCodeTable1	Reference[]	Gets or sets The custom code table 1
customCodeTable2	Reference[]	Gets or sets The custom code table 2
customCodeTable3	Reference[]	Gets or sets The custom code table 3
date1	string (date-time)	Gets or sets The date 1
date2	string (date-time)	Gets or sets The date 2
date3	string (date-time)	Gets or sets The date 3
longText1	string
longText2	string
longText3	string
shortText1	string
shortText2	string
shortText3	string

CandidateJobPreferencesRead

The position sought

Name	Type	Notes
primaryProfile	Reference[]	The primary profile
jobTime	Reference[]	The job time
contractType	Reference[]	The contract
contractLenght	string	The contract length
secondaryProfiles	Reference[]	The secondary profile
salaryExpectations	string	The salary expectations
dateOfAvailability	string (date-time)	The date of availability
trainingStartDate	string (date-time)	The training date start
trainingEndDate	string (date-time)	The training date end
totalMobility	boolean	The total mobility
mobilityDelay	string	The mobility delay
mobility	CandidateMobilityRead[]
jobPreferencesCustomFields	DataWithCustomFieldsRead[]	The custom fields

CandidateMobilityRead

Name	Type	Notes
countries	Reference[]	The candidate mobility countries.
departments	Reference[]	The candidate mobility departments.
geographicalAreas	Reference[]	The candidate mobility geographical areas.
regions	Reference[]	The candidate mobility regions.
zipCodes	Reference[]	The candidate mobility zip codes.

CandidateLanguageRead

The languages

Name	Type	Notes
language	Reference[]	The language
languageLevel	Reference[]	The language level

CandidateDiplomaRead

The educations

Name	Type	Notes
educationLevel	Reference[]	The education level
speciality	Reference[]	The speciality
yearOfGraduation	integer (int32)	The year of graduation
school	string	The school
schoolCity	string	The school city
diploma	Reference[]	The diploma
educationCustomFields	DataWithCustomFieldsRead[]	The custom fields

CandidateExperiencesRead

The experiences

Name	Type	Notes
experience	CandidateExperienceRead[]	The experience
experienceCustomFields	DataWithCustomFieldsRead[]	The custom fields

CandidateExperienceRead

The experience

Name	Type	Notes
experienceLevel	Reference[]	The experience level
profile	Reference[]	The profile
company	string	The company
function	string	The position
typeOfContract	Reference[]	The contract type
duration	string	The length

CandidateGlobalExperience

The global experience

Name	Type	Notes
globalExperienceLevel	Reference[]	The global experience level
globalExperienceLevelCustomFields	DataWithCustomFieldsRead[]	The custom fields

CandidateAdditionalInformationRead

The additional information

Name	Type	Notes
skills	Reference[]	The skills
additionalInformationCustomFields	DataWithCustomFieldsRead[]	The custom fields

CandidateBackOfficeDataRead

The recruiter data

Name	Type	Notes
comment	string	The comment
recommenderName	string	The recommender name
recommenderEmail	string	The recommender email
recruiterDataCustomFields	DataWithCustomFieldsRead[]	The custom fields

CandidateConsentRead

The consents

Name	Type	Notes
consent	Reference[]	The consent ID

CandidateReferral

The referal

Name	Type	Notes
referralStatus	Reference[]	The referral status

CandidateDetailUpdate

Name	Type	Notes
employeeNumber	string	The candidate employee number
lastName	string	The last name
firstName	string	The first name
middleName	string	The middle name
email	string	The email
phoneNumber	string	The candidate phone number
civilityId	string	The candidate civility identifier (The referential type accepted is Civility)
personalInformation	CandidatePersonalInformationWrite[]	The candidate personal information
jobPreferences	CandidateJobPreferencesWrite[]	The candidate job preferences
languages	CandidateLanguageWrite[]	The candidate language
educations	CandidateEducationWrite[]	The candidate education
experiences	CandidateExperienceWrite[]	The candidate experience
attachments	CandidateAttachmentWrite[]	Describe the file attachments

WrappedResponse_CandidateDetailWriteResponse

Wrapped response

Name	Type	Notes
data	CandidateDetailWriteResponse[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_CandidateAnonymisedData

Wrapped response

Name	Type	Notes
data	CandidateAnonymisedData[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

CandidateAnonymisedData

The response data

Name	Type	Notes
phoneNumber	string	Candidate phone number
email	string	Candidate email

WrappedResponse_IEnumerable_CandidateApplication

Wrapped response

Name	Type	Notes
data	CandidateApplication[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

CandidateApplication

The response data

Name	Type	Notes
applicationDate	string (date-time)	Application creation date
applicationStatus	Reference[]	Status of the application
publicationMedia	Reference[]	Publication media
attachmentIds	array	Id list of attached documents
id	string	The identifier of the application
applicationType	Reference[]	Application type
vacancyReference	string	Vacancy Reference if linked to a vacancy
jobTitle	string	Vacancy title if linked to a vacancy
organisation	Reference[]	Organisation of the application

WrappedResponse_IEnumerable_ApplicationChildEvent

Wrapped response

Name	Type	Notes
data	ApplicationChildEvent[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

ApplicationChildEvent

The response data

Name	Type	Notes
creationDate	string (date-time)
modificationDate	string (date-time)
supervisor	string
comments	string
id	string
label	string

WrappedResponse_ConsentArray

Wrapped response

Name	Type	Notes
data	Consent[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

Consent

The response data

Name	Type	Notes
id	string
label	string
languageId	integer (int32)
orderNumber	integer (int32)
details	string

WrappedResponse_Consent

Wrapped response

Name	Type	Notes
data	Consent[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_ContactArray

Wrapped response

Name	Type	Notes
data	Contact[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

Contact

The response data

Name	Type	Notes
receiveSms	boolean	The contact receiveSms. Indicates whether the contact can receive an alert by SMS.
languageId	integer (int32)	The contact language
id	string	The contact identifier
lastName	string	The contact last name
firstName	string	The contact first name
phoneNumber	string	The contact phone number
email	string	The contact email

WrappedResponse_Contact

Wrapped response

Name	Type	Notes
data	Contact[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_CountryReferentialArray

Wrapped response

Name	Type	Notes
data	CountryReferential[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

CountryReferential

The response data

Name	Type	Notes
languageId	integer (int32)
orderNumber	integer (int32)
geographicalArea	Reference[]	Referencing object
id	string
label	string

WrappedResponse_CountryReferential

Wrapped response

Name	Type	Notes
data	CountryReferential[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_CustomCodeTableArray

Wrapped response

Name	Type	Notes
data	CustomCodeTable[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

CustomCodeTable

The response data

Name	Type	Notes
languageId	integer (int32)
orderNumber	integer (int32)
id	string
label	string

WrappedResponse_CustomCodeTable

Wrapped response

Name	Type	Notes
data	CustomCodeTable[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_CustomCodeTableTypeSummaryArray

Wrapped response

Name	Type	Notes
data	CustomCodeTableTypeSummary[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

CustomCodeTableTypeSummary

The response data

Name	Type	Notes
languageId	integer (int32)
id	string
label	string

WrappedResponse_CustomCodeTableTypeDetail

Wrapped response

Name	Type	Notes
data	CustomCodeTableTypeDetail[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

CustomCodeTableTypeDetail

The response data

Name	Type	Notes
translations	CustomCodeTableTypeTranslation[]
id	string

CustomCodeTableTypeTranslation

Name	Type	Notes
languageId	integer (int32)
label	string

WrappedResponse_DepartmentReferentialArray

Wrapped response

Name	Type	Notes
data	DepartmentReferential[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

DepartmentReferential

The response data

Name	Type	Notes
languageId	integer (int32)
orderNumber	integer (int32)
region	Reference[]	Referencing object
id	string
label	string

WrappedResponse_DepartmentReferential

Wrapped response

Name	Type	Notes
data	DepartmentReferential[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_DiplomaReferentialArray

Wrapped response

Name	Type	Notes
data	DiplomaReferential[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

DiplomaReferential

The response data

Name	Type	Notes
languageId	integer (int32)
level	integer (int32)
parent	Reference[]	Referencing object
id	string
label	string

WrappedResponse_DiplomaReferential

Wrapped response

Name	Type	Notes
data	DiplomaReferential[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_IEnumerable_EmployeeSummary

Wrapped response

Name	Type	Notes
data	EmployeeSummary[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

EmployeeSummary

The response data

Name	Type	Notes
languageId	string
creationDate	string (date-time)
modificationDate	string (date-time)
authorizations	AuthorizationInfoRead[]	Customer authorization informations
id	string
lastName	string
firstName	string
middleName	string
email	string
employeeNumber	string
organisation	Reference[]	Referencing object

AuthorizationInfoRead

Customer authorization informations

Name	Type	Notes
scopeCode	string	The inherited list of entities

WrappedResponse_EmployeeDetailRead

Wrapped response

Name	Type	Notes
data	EmployeeDetailRead[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

EmployeeDetailRead

The response data

Name	Type	Notes
creationDate	string (date-time)	The creation date
modificationDate	string (date-time)	The modification date
languages	EmployeeLanguageRead[]	The languages
consents	EmployeeConsentRead[]	The consents
additionalInformation	EmployeeAdditionalInformationRead[]	The additional information
employeeInformation	EmployeeEmployeeInformationRead[]	The employee information
personalInformation	EmployeePersonalInformationRead[]	The personal information
positionSought	EmployeeJobPreferencesRead[]	The position sought
educations	EmployeeDiplomaRead[]	The educations
experiences	EmployeeExperiencesRead[]	The employee experiences
globalExperience	EmployeeGlobalExperience[]	The employee global experience
recruiterData	EmployeeBackOfficeDataRead[]	The recruiter data
frontOfficeAccount	EmployeeFrontOfficeAccountRead[]	The front office account
authorizations	AuthorizationInfoRead[]	Customer authorization informations
id	string	The client code
title	string	The title
sex	Reference[]	The sex
civility	Reference[]	The civility
lastName	string	The last name
firstName	string	The first name
middleName	string	The middle name
email	string	The e-mail
phoneNumber	string	The phone number
status	Reference[]	The status
customBlock1CustomFields	DataWithCustomFieldsRead[]	The custom block1 custom fields
customBlock2CustomFields	DataWithCustomFieldsRead[]	The custom block2 custom fields
customBlock3CustomFields	DataWithCustomFieldsRead[]	The custom block3 custom fields
customBlock4CustomFields	DataWithCustomFieldsRead[]	The custom block4 custom fields

EmployeeLanguageRead

The languages

Name	Type	Notes
language	Reference[]	The language
languageLevel	Reference[]	The language level

EmployeeConsentRead

The consents

Name	Type	Notes
consent	Reference[]	The consent ID

EmployeeAdditionalInformationRead

The additional information

Name	Type	Notes
skills	Reference[]	The skills
additionalInformationCustomFields	DataWithCustomFieldsRead[]	The custom fields

EmployeeEmployeeInformationRead

The employee information

Name	Type	Notes
associatedOrganisation	Reference[]	The associated organisation
currentPosition	Reference[]	The current position
employeeNumber	string	The employee number

EmployeePersonalInformationRead

The personal information

Name	Type	Notes
nationalities	Reference[]	The nationalities
professionalEmail	string	The professional email
birthDate	string (date-time)
address	string	The address
postalCode	string	The postal code
city	string	The city
residentCountry	Reference[]	The resident country
otherPhoneNumber	string	The other phone number
personalInformationCustomFields	DataWithCustomFieldsRead[]	The custom fields

EmployeeJobPreferencesRead

The position sought

Name	Type	Notes
primaryProfile	Reference[]	The primary profile
jobTime	Reference[]	The job time
contractType	Reference[]	The Contract
contractLenght	string	The contract length
secondaryProfiles	Reference[]	The secondary profile
salaryExpectations	string	The salary expectations
dateOfAvailability	string (date-time)	The date of availability
trainingStartDate	string (date-time)	The training date start
trainingEndDate	string (date-time)	The training date end
totalMobility	boolean	The total mobility
mobilityDelay	string	The mobility delay
availabilityMatrixChoice	boolean	The availability matrix choice
jobPreferencesCustomFields	DataWithCustomFieldsRead[]	The custom fields

EmployeeDiplomaRead

The educations

Name	Type	Notes
educationLevel	Reference[]	The education level
speciality	Reference[]	The speciality
yearOfGraduation	integer (int32)	The year of graduation
school	string	The school
schoolCity	string	The school city
diploma	Reference[]	The diploma
educationCustomFields	DataWithCustomFieldsRead[]	The custom fields

EmployeeExperiencesRead

The employee experiences

Name	Type	Notes
experience	EmployeeExperienceRead[]	One experience
experienceCustomFields	DataWithCustomFieldsRead[]	The custom fields

EmployeeExperienceRead

One experience

Name	Type	Notes
experienceLevel	Reference[]	The experience level
profile	Reference[]	The profile
company	string	The company
function	string	The position
typeOfContract	Reference[]	The contract type
duration	string	The length

EmployeeGlobalExperience

The employee global experience

Name	Type	Notes
experienceLevel	Reference[]	The global experience level
globalExperienceLevelCustomFields	DataWithCustomFieldsRead[]	The custom fields

EmployeeBackOfficeDataRead

The recruiter data

Name	Type	Notes
comment	string	The comment
recommenderName	string	The recommender name
recommenderEmail	string	The recommender email
recruiterDataCustomFields	DataWithCustomFieldsRead[]	The custom fields

EmployeeFrontOfficeAccountRead

The front office account

Name	Type	Notes
communicationLanguage	integer (int32)	The communication language (LCID)
login	string	The login

EmployeeDetailWrite

Name	Type	Notes
employeeInformation	EmployeeEmployeeInformationWrite[]	The employee informations
personalInformation	EmployeePersonalInformationWrite[]	The personal informations
positionSought	EmployeeJobPreferencesWrite[]	The job preferences
recruiterData	EmployeeBackOfficeDataWrite[]	The back office data
frontOfficeAccount	EmployeeFrontOfficeAccountWrite[]	The front office account
id	string	The client code
lastName	string	The last name
firstName	string	The first name
middleName	string	The middle name
email	string	The e-mail
statusId	string	The status
title	string	The title

EmployeeEmployeeInformationWrite

The employee informations

Name	Type	Notes
associatedOrganisationId	string	The associated organisation
currentPositionId	string	The current position
employeeNumber	string	The employee number

EmployeePersonalInformationWrite

The personal informations

Name	Type	Notes
birthDate	string (date-time)	The birth date
address	string	The address
postalCode	string	The postal code
city	string	The city
residentCountryId	string	The resident country
phoneNumber	string	The phone number
otherPhoneNumber	string	The other phone number
personalInformationCustomFields	DataWithCustomFieldsWrite[]	The personal information custom fields

DataWithCustomFieldsWrite

The personal information custom fields

Name	Type	Notes
customCodeTable1Id	string	Gets or sets The custom code table 1 identifier
customCodeTable2Id	string	Gets or sets The custom code table 2 identifier
customCodeTable3Id	string	Gets or sets The custom code table 3 identifier
date1	string (date-time)	Gets or sets The date 1
date2	string (date-time)	Gets or sets The date 2
date3	string (date-time)	Gets or sets The date 3
longText1	string
longText2	string
longText3	string
shortText1	string
shortText2	string
shortText3	string

EmployeeJobPreferencesWrite

The job preferences

Name	Type	Notes
primaryProfileId	string	The primary profile
jobTimeId	string	The job time
dateOfAvailability	string (date-time)	The date of availability
totalMobility	boolean	The total mobility
contractId	string	The contract
availabilityMatrixChoice	boolean	The availability matrix choice

EmployeeBackOfficeDataWrite

The back office data

Name	Type	Notes
comment	string	The comment
recommenderName	string	The recommender name
recommenderEmail	string	The recommender email

EmployeeFrontOfficeAccountWrite

The front office account

Name	Type	Notes
communicationLanguage	integer (int32)	The communication language (LCID)
login	string	The login

WrappedResponse_EmployeeDetailWrite

Wrapped response

Name	Type	Notes
data	EmployeeDetailWrite[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

EventPayload

Name	Type	Notes
event_type	string
event_date	string

CandidateExportDetail

Name	Type	Notes
offset	integer (int32)
chronoNumber	integer (int64)
date	string
isDirty	boolean
candidateDetail	CandidateDetailRead[]
applications	CandidateApplication[]
attachments	CandidateAttachedFile[]
isEmployee	boolean
isInProgress	boolean	Has an application in progress on a vacancy (spontaneous application excluded)

CandidateAttachedFile

Name	Type	Notes
isResume	boolean
mimeType	string
type	Reference[]	Referencing object
id	string (uuid)
filename	string

VacancyExportDetail

Name	Type	Notes
offset	integer (int32)
chronoNumber	integer (int64)
date	string
isDirty	boolean
offerDetail	VacancyDetailRead[]
translations	VacancyTranslation[]

VacancyDetailRead

Name	Type	Notes
status	Reference[]	The vacancy status
languageId	integer (int32)	The translation language of the object
vacancyCategory	Reference[]	The vacancy category
vacancyView	Reference[]	The vacancy view
candidateView	Reference[]	The candidate view
organisation	Reference[]	The vacancy organization
candidateRedirectionUrl	string	The candidate redirection url
creationDate	string (date-time)	The vacancy creation date
modificationDate	string (date-time)	The vacancy modification date
requestingParty	VacancyOriginRead[]	The vacancy requesting party object
location	VacancyLocationRead[]	The vacancy location object
criteria	VacancyCriteriaRead[]	The candidate criteria object
jobDescription	VacancyJobDescriptionRead[]	The job description object
languages	VacancyLanguageRead[]	The languages
referral	VacancyReferralRead[]	The vacancy referral information
publishedOnIntranet	boolean	Is published on intranet
publishedOnInternet	boolean	Is published on internet
authorizations	AuthorizationInfoRead[]	Customer authorization informations
coverUrl	string	The candidate redirection url
reference	string	The vacancy reference
generalInformationCustomFields	DataWithFormattedCustomFieldsReadSerializableModel[]	The custom fields object
customBlock1CustomFields	DataWithFormattedCustomFieldsReadSerializableModel[]	The custom block1 custom fields object
customBlock2CustomFields	DataWithFormattedCustomFieldsReadSerializableModel[]	The custom block2 custom fields object
customBlock3CustomFields	DataWithFormattedCustomFieldsReadSerializableModel[]	The custom block3 custom fields object
customBlock4CustomFields	DataWithFormattedCustomFieldsReadSerializableModel[]	The custom block4 custom fields object

VacancyOriginRead

The vacancy requesting party object

Name	Type	Notes
recruitingReason	Reference[]	The vacancy recruiting reason
numberOfVacancies	integer (int32)	The number of vacancies
beginningDate	string (date-time)	The vacancy beginning date
EEO	Reference[]	The eeo object
lineManager	ContactReference[]	The line manager object
commentForAgency	string	The agency comment object
requestingPartyCustomFields	DataWithFormattedCustomFieldsReadSerializableModel[]	The requesting party custom fields object

ContactReference

The line manager object

Name	Type	Notes
email	string	Uri of the referenced object
uri	string	Uri of the referenced object
id	string	Gets or sets ReferenceIdentifier of the referenced object
label	string	Gets or sets ReferenceLabel of the referenced object

DataWithFormattedCustomFieldsReadSerializableModel

The requesting party custom fields object

Name	Type	Notes
customCodeTable1	Reference[]	Gets or sets The custom code table 1
customCodeTable2	Reference[]	Gets or sets The custom code table 2
customCodeTable3	Reference[]	Gets or sets The custom code table 3
date1	string (date-time)
date2	string (date-time)
date3	string (date-time)
longText1	string
longText2	string
longText3	string
shortText1	string
shortText2	string
shortText3	string
longText1HTML	string
longText2HTML	string
longText3HTML	string

VacancyLocationRead

The vacancy location object

Name	Type	Notes
geographicalArea	Reference[]	The vacancy geographical area
country	Reference[]	The vacancy country
region	Reference[]	The vacancy region
department	Reference[]	The vacancy department
address	string	The vacancy address
latitude	number (double)	The vacancy latitude
longitude	number (double)	The vacancy longitude
locationCustomFields	DataWithFormattedCustomFieldsReadSerializableModel[]	The location custom fields object

VacancyCriteriaRead

The candidate criteria object

Name	Type	Notes
freeCriteria1	string	The vacancy free criteria 1
freeCriteria2	string	The vacancy free criteria 2
freeCriteria1HTML	string	The vacancy free criteria 1 formatted
freeCriteria2HTML	string	The vacancy free criteria 2 formatted
diploma	Reference[]	The vacancy diploma
educationLevel	Reference[]	The vacancy education level
experienceLevel	Reference[]	The vacancy experience level
specialisations	Reference[]	The specialisations object list
skills	Reference[]	The skills object list
criteriaCustomFields	DataWithFormattedCustomFieldsReadSerializableModel[]	The candidate criteria custom fields object

VacancyJobDescriptionRead

The job description object

Name	Type	Notes
description1	string	The vacancy description 1
description1HTML	string	The vacancy description 1 formatted
description2	string	The vacancy description 2
description2HTML	string	The vacancy description 2 formatted
jobTime	Reference[]	The vacancy job time
salaryRange	Reference[]	The vacancy salary range
contractType	Reference[]	The vacancy contract type
contractLength	string	The vacancy contract length
primaryProfile	Reference[]	The vacancy primary profile
secondaryProfiles	Reference[]	The secondary profiles object list
country	Reference[]	The country
professionalCategory	Reference[]	The profesional category
title	string	The vacancy title
jobDescriptionCustomFields	DataWithFormattedCustomFieldsReadSerializableModel[]	The job description custom fields object

VacancyLanguageRead

The languages

Name	Type	Notes
language	Reference[]	The language
languageLevel	Reference[]	The language level

VacancyReferralRead

The vacancy referral information

Name	Type	Notes
bonusAmount	number (double)	The bonus amount
currency	Reference[]	The currency
bonusType	Reference[]	The bonus type

VacancyTranslation

Name	Type	Notes
languageId	integer (int32)
criteria	VacancyCriteriaTranslation[]	The candidate criteria object
jobDescription	VacancyJobDescriptionTranslation[]	The job description object
requestingParty	VacancyOriginTranslation[]
location	VacancyLocationTranslation[]
generalInformationCustomFields	DataWithFormattedCustomFieldsBaseSerializableModel[]
customBlock1CustomFields	DataWithFormattedCustomFieldsBaseSerializableModel[]
customBlock2CustomFields	DataWithFormattedCustomFieldsBaseSerializableModel[]
customBlock3CustomFields	DataWithFormattedCustomFieldsBaseSerializableModel[]
customBlock4CustomFields	DataWithFormattedCustomFieldsBaseSerializableModel[]

VacancyCriteriaTranslation

The candidate criteria object

Name	Type	Notes
freeCriteria1	string	The vacancy free criteria 1
freeCriteria2	string	The vacancy free criteria 2
freeCriteria1HTML	string	The vacancy free criteria 1 formatted
freeCriteria2HTML	string	The vacancy free criteria 2 formatted
criteriaCustomFields	DataWithFormattedCustomFieldsBaseSerializableModel[]

DataWithFormattedCustomFieldsBaseSerializableModel

Name	Type	Notes
longText1	string
longText2	string
longText3	string
shortText1	string
shortText2	string
shortText3	string
longText1HTML	string
longText2HTML	string
longText3HTML	string

VacancyJobDescriptionTranslation

The job description object

Name	Type	Notes
description1	string	The vacancy description 1
description1HTML	string	The vacancy description 1 formatted
description2	string	The vacancy description 2
description2HTML	string	The vacancy description 2 formatted
title	string	The vacancy title
jobDescriptionCustomFields	DataWithFormattedCustomFieldsBaseSerializableModel[]

VacancyOriginTranslation

Name	Type	Notes
requestingPartyCustomFields	DataWithFormattedCustomFieldsBaseSerializableModel[]

VacancyLocationTranslation

Name	Type	Notes
locationCustomFields	DataWithFormattedCustomFieldsBaseSerializableModel[]

VacancyRequestExportDetail

Name	Type	Notes
offset	integer (int32)
chronoNumber	integer (int64)
date	string
isDirty	boolean
vacancyRequestDetail	VacancyRequestDetail[]
vacancyRequestEvents	VacancyRequestEvent[]
recruitmentAgreement	VacancyRequestExternalRecruitmentAgreement[]
recruitmentAgreementValidations	AgreementValidator[]
recruitmentAgreementValidationsEvents	VacancyRequestAgreementValidationEvent[]
mobilityAgreement	VacancyRequestInternalMobilityAgreement[]
mobilityAgreementValidations	AgreementValidator[]
mobilityAgreementValidationsEvents	VacancyRequestAgreementValidationEvent[]

VacancyRequestDetail

Name	Type	Notes
id	string
language	Reference[]	Referencing object
status	Reference[]	Referencing object
creationDate	string (date-time)
creationUser	Reference[]	Referencing object
modificationDate	string (date-time)
modificationUser	Reference[]	Referencing object
planned	boolean
vacancy	Reference[]	Referencing object
description	VacancyRequestJobDescription[]
criteria	VacancyRequestCriteria[]
companyInformation	VacancyRequestCompanyInformation[]
requestMotive	VacancyRequestMotive[]
positionLocation	VacancyRequestPositionLocation[]
languages	LanguageRead[]

VacancyRequestJobDescription

Name	Type	Notes
jobTitle	string
description1	string
description1HTML	string
description2	string
description2HTML	string
contractLength	string
salaryRange	Reference[]	Referencing object
contract	Reference[]	Referencing object
jobTime	Reference[]	Referencing object
country	Reference[]	Referencing object
professionalCategory	Reference[]	Referencing object
customFields	DataWithFormattedCustomFieldsReadSerializableModel[]

VacancyRequestCriteria

Name	Type	Notes
profile	Reference[]	Referencing object
experienceLevel	Reference[]	Referencing object
educationLevel	Reference[]	Referencing object
customFields	DataWithFormattedCustomFieldsReadSerializableModel[]

VacancyRequestCompanyInformation

Name	Type	Notes
organisation	Reference[]	Referencing object
eeoCode	Reference[]	Referencing object
operationalManagerName	string
operationalManagerFirstName	string
operationalManagerPhoneNumber	string
operationalManagerEmail	string
operationalManagerLanguage	Reference[]	Referencing object
customFields	DataWithFormattedCustomFieldsReadSerializableModel[]
service	string
location	string

VacancyRequestMotive

Name	Type	Notes
recruitingReason	Reference[]	Referencing object
numberOfVacancies	integer (int32)
comment	string
commentHTML	string
customFields	DataWithFormattedCustomFieldsReadSerializableModel[]

VacancyRequestPositionLocation

Name	Type	Notes
geographicalArea	Reference[]	Referencing object
country	Reference[]	Referencing object
region	Reference[]	Referencing object
department	Reference[]	Referencing object
jobLocation	string

LanguageRead

Name	Type	Notes
language	Reference[]	The language
languageLevel	Reference[]	The language level

VacancyRequestEvent

Name	Type	Notes
id	integer (int32)
eventType	Reference[]	Referencing object
comment	string
creationDate	string (date-time)
creationUser	Reference[]	Referencing object
eventDate	string (date-time)

VacancyRequestExternalRecruitmentAgreement

Name	Type	Notes
contract	Reference[]	Referencing object
jobTime	Reference[]	Referencing object
country	Reference[]	Referencing object
contractLength	string
customFields	DataWithFormattedCustomFieldsReadSerializableModel[]
id	string
status	Reference[]	Referencing object
creationDate	string (date-time)
creationUser	Reference[]	Referencing object
modificationDate	string (date-time)
modificationUser	Reference[]	Referencing object

AgreementValidator

Name	Type	Notes
id	string
validatorName	string
validatorFirstName	string
validatorEmail	string
status	Reference[]	Referencing object
creationUser	Reference[]	Referencing object
modificationUser	Reference[]	Referencing object
creationDate	string (date-time)
modificationDate	string (date-time)
position	integer (int32)
language	Reference[]	Referencing object
comment	string
ticketUrl	ApiUrl[]
validationRequestDate	string (date-time)
expirationDate	string (date-time)

ApiUrl

Name	Type	Notes
href	string

VacancyRequestAgreementValidationEvent

Name	Type	Notes
id	string
creationDate	string (date-time)
creationUser	Reference[]	Referencing object
validationEventType	Reference[]	Referencing object
comment	string
eventDate	string (date-time)

VacancyRequestInternalMobilityAgreement

Name	Type	Notes
customFields	DataWithFormattedCustomFieldsReadSerializableModel[]
id	string
status	Reference[]	Referencing object
creationDate	string (date-time)
creationUser	Reference[]	Referencing object
modificationDate	string (date-time)
modificationUser	Reference[]	Referencing object

IndexationReportWrite

Name	Type	Notes
reportType	string	The type of the report. Candidates or Vacancies (not case sensitive)
items	IndexationReportItem[]	The list of reports.

IndexationReportItem

The list of reports.

Name	Type	Notes
id	string	Gets or sets The client code.
date	string (date-time)	Gets or sets The date.
lastUpdateDate	string (date-time)	Gets or sets The date of the last update.
status	string	Gets or sets TThe status of the report. Success, Warning or Error (not case sensitive)
messages	array	Gets or sets The messages of the report (the total length of all messages should be less or equal to 1600).

WrappedResponse_JobFamilyArray

Wrapped response

Name	Type	Notes
data	JobFamily[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

JobFamily

The response data

Name	Type	Notes
languageId	integer (int32)
orderNumber	integer (int32)
jobFamilyCategory	Reference[]	Referencing object
id	string
label	string

WrappedResponse_JobFamily

Wrapped response

Name	Type	Notes
data	JobFamily[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_IEnumerable_MeetingSummary

Wrapped response

Name	Type	Notes
data	MeetingSummary[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

MeetingSummary

The response data

Name	Type	Notes
id	string
title	string
organisation	Reference[]	Referencing object
location	string
status	Reference[]	Referencing object
numberOfPlaces	integer (int32)
numberOfSubscribers	integer (int32)
mainSupervisor	Reference[]	Referencing object
creationDate	string (date-time)
modificationDate	string (date-time)

WrappedResponse_MeetingDetail

Wrapped response

Name	Type	Notes
data	MeetingDetail[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

MeetingDetail

The response data

Name	Type	Notes
status	Reference[]	Referencing object
numberOfSubscribers	integer (int32)
numberOfRemainingPlaces	integer (int32)
creationDate	string (date-time)
modificationDate	string (date-time)
eventDetails	MeetingEventDetail[]

MeetingEventDetail

Name	Type	Notes
id	string
title	string
eventTemplate	Reference[]	Referencing object
category	Reference[]	Referencing object
linkedVacancy	Reference[]	Referencing object
profile	Reference[]	Referencing object
locationDetailsRead	MeetingLocation[]
room	string
startDate	string (date-time)
endDate	string (date-time)
timeZone	Reference[]	Referencing object
numberOfPlaces	integer (int32)
organisation	Reference[]	Referencing object
mainSupervisor	Reference[]	Referencing object
description	string
comments	string

MeetingLocation

Name	Type	Notes
name	string
address	string
postCode	string
city	string
enable	boolean

WrappedResponse_ICollection_MeetingInterviewCandidate

Wrapped response

Name	Type	Notes
data	MeetingInterviewCandidate[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

MeetingInterviewCandidate

The response data

Name	Type	Notes
id	string
lastName	string
firstName	string
middleName	string
email	string
postCode	string
phoneNumber	string
interviewStatus	Reference[]	Referencing object

WrappedResponse_ICollection_MeetingInterviewerDetailRead

Wrapped response

Name	Type	Notes
data	MeetingInterviewerDetailRead[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

MeetingInterviewerDetailRead

The response data

Name	Type	Notes
id	string
name	string
firstName	string
mail	string
interviewStatus	Reference[]	Referencing object

WrappedResponse_OrganisationArray

Wrapped response

Name	Type	Notes
data	Organisation[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

Organisation

The response data

Name	Type	Notes
languageId	integer (int32)
parentOrganisation	Reference[]	Referencing object
details	string
authorizations	AuthorizationInfoRead[]	Customer authorization informations
id	string
label	string

WrappedResponse_Organisation

Wrapped response

Name	Type	Notes
data	Organisation[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_ProfileReferentialArray

Wrapped response

Name	Type	Notes
data	ProfileReferential[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

ProfileReferential

The response data

Name	Type	Notes
languageId	integer (int32)
orderNumber	integer (int32)
jobFamily	Reference[]	Referencing object
id	string
label	string

WrappedResponse_ProfileReferential

Wrapped response

Name	Type	Notes
data	ProfileReferential[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_PublicationMediaArray

Wrapped response

Name	Type	Notes
data	PublicationMedia[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

PublicationMedia

The response data

Name	Type	Notes
languageId	integer (int32)
orderNumber	integer (int32)
publicationMediaType	Reference[]	Referencing object
id	string
label	string

WrappedResponse_PublicationMedia

Wrapped response

Name	Type	Notes
data	PublicationMedia[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_ReferralStatusArray

Wrapped response

Name	Type	Notes
data	ReferralStatus[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

ReferralStatus

The response data

Name	Type	Notes
languageId	integer (int32)
orderNumber	integer (int32)
isFinalStatus	boolean
id	string
label	string

WrappedResponse_ReferralStatus

Wrapped response

Name	Type	Notes
data	ReferralStatus[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_RegionReferentialArray

Wrapped response

Name	Type	Notes
data	RegionReferential[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

RegionReferential

The response data

Name	Type	Notes
languageId	integer (int32)
orderNumber	integer (int32)
country	Reference[]	Referencing object
id	string
label	string

WrappedResponse_RegionReferential

Wrapped response

Name	Type	Notes
data	RegionReferential[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_SoftwareLanguageArray

Wrapped response

Name	Type	Notes
data	SoftwareLanguage[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

SoftwareLanguage

The response data

Name	Type	Notes
abbreviation	string
lcidCode	integer (int32)
isoCode	string
enabled	boolean
label	string

WrappedResponse_IEnumerable_BackOfficeUserRead

Wrapped response

Name	Type	Notes
data	BackOfficeUserRead[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

BackOfficeUserRead

The response data

Name	Type	Notes
userProfile	Reference[]	The profile of the user
organisations	Reference[]	The organisations of the user
phoneNumber	string	The phone number of the user
languageId	integer (int32)	The language of the user
login	string	The login of the user
name	string	The last name of the user
firstName	string	The first name of the user
email	string	The email of the user

WrappedResponse_BackOfficeUserRead

Wrapped response

Name	Type	Notes
data	BackOfficeUserRead[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

BackOfficeUserWrite

BackOfficeUserWrite : BackOfficeUserBase

Name	Type	Notes
userProfile	string	The profile of the user
organisations	array	The organisations of the user
phoneNumber	string	The phone number of the user
languageId	integer (int32)	The language of the user
login	string	The login of the user
name	string	The last name of the user
firstName	string	The first name of the user
email	string	The email of the user

WrappedResponse_BackOfficeUserWrite

Wrapped response

Name	Type	Notes
data	BackOfficeUserWrite[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_IEnumerable_VacancySummary

Wrapped response

Name	Type	Notes
data	VacancySummary[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

VacancySummary

The response data

Name	Type	Notes
languageId	integer (int32)	The tranlation language of the object
status	Reference[]	The vacancy status
jobTime	Reference[]	The vacancy job time
salaryRange	Reference[]	The vacancy salary range
contractType	Reference[]	The vacancy contract type
contractLength	string	The vacancy contract length
primaryProfile	Reference[]	The vacancy primary profile
geographicalArea	Reference[]	The vacancy geographical area
country	Reference[]	The vacancy country
region	Reference[]	The vacancy region
department	Reference[]	The vacancy department
address	string	The vacancy address
diploma	Reference[]	The vacancy diploma
educationLevel	Reference[]	The vacancy education level
experienceLevel	Reference[]	The vacancy experience level
organisation	Reference[]	The vacancy organisation
modificationDate	string (date-time)	The vacancy modification date
creationDate	string (date-time)	The vacancy creation date
vacancyUrl	string	The vacancy direct url
authorizations	AuthorizationInfoRead[]	Customer authorization informations
reference	string	The vacancy reference
title	string	The vacancy job title

VacancyDetailWrite

Name	Type	Notes
vacancyCategoryId	string	Gets or sets The vacancy category identifier
vacancyViewId	string	Gets or sets The vacancy view identifier
candidateViewId	string	Gets or sets The candidate view identifier
organisationId	string	Gets or sets The vacancy organisation identifier
candidateRedirectionUrl	string	Gets or sets The candidate redirection url
requestingParty	VacancyOriginWrite[]	Gets or sets The vacancy requesting party object
location	VacancyLocationWrite[]	Gets or sets The vacancy location object
criteria	VacancyCriteriaWrite[]	Gets or sets The candidate criteria object
jobDescription	VacancyJobDescriptionWrite[]	The job description object
languages	VacancyLanguageWrite[]	Gets or sets The languages
reference	string	Gets or sets The vacancy reference
generalInformationCustomFields	DataWithFormattedCustomFieldsWrite[]	Gets or sets The custom fields object
customBlock1CustomFields	DataWithFormattedCustomFieldsWrite[]	Gets or sets The custom block1 custom fields object
customBlock2CustomFields	DataWithFormattedCustomFieldsWrite[]	Gets or sets The custom block2 custom fields object
customBlock3CustomFields	DataWithFormattedCustomFieldsWrite[]	Gets or sets The custom block3 custom fields object
customBlock4CustomFields	DataWithFormattedCustomFieldsWrite[]	Gets or sets The custom block4 custom fields object

VacancyOriginWrite

Gets or sets The vacancy requesting party object

Name	Type	Notes
recruitingReasonId	string	The vacancy recruiting reason identifier
EEOId	string	The vacancy organisation identifier
numberOfVacancies	integer (int32)	The number of vacancies
beginningDate	string (date-time)	The vacancy beginning date
lineManager	LineManagerWrite[]	Gets or sets The line manager object
requestingPartyCustomFields	DataWithFormattedCustomFieldsWrite[]	The requesting party custom fields object

LineManagerWrite

Gets or sets The line manager object

Name	Type	Notes
lastName	string	Gets or sets The last name of the operational manager
firstName	string	Gets or sets The first name of the operational manager
email	string	Gets or sets The email of the operational manager

DataWithFormattedCustomFieldsWrite

The requesting party custom fields object

Name	Type	Notes
customCodeTable1Id	string	Gets or sets The custom code table 1 identifier
customCodeTable2Id	string	Gets or sets The custom code table 2 identifier
customCodeTable3Id	string	Gets or sets The custom code table 3 identifier
longText1HTML	string
longText2HTML	string
longText3HTML	string
date1	string (date-time)	Gets or sets The date 1
date2	string (date-time)	Gets or sets The date 2
date3	string (date-time)	Gets or sets The date 3
longText1	string
longText2	string
longText3	string
shortText1	string
shortText2	string
shortText3	string

VacancyLocationWrite

Gets or sets The vacancy location object

Name	Type	Notes
geographicalAreaId	string	The vacancy geographical area identifier
countryId	string	The vacancy country identifier
regionId	string	The vacancy region identifier
departmentId	string	The vacancy department identifier
address	string	The vacancy address
locationCustomFields	DataWithFormattedCustomFieldsWrite[]	The location custom fields object

VacancyCriteriaWrite

Gets or sets The candidate criteria object

Name	Type	Notes
freeCriteria1	string	Gets or sets The vacancy free criteria 1
freeCriteria2	string	Gets or sets The vacancy free criteria 2
freeCriteria1HTML	string	Gets or sets The vacancy free criteria 1 formatted
freeCriteria2HTML	string	Gets or sets The vacancy free criteria 2 formatted
diplomaId	string	The vacancy diploma identifier
educationLevelId	string	Gets or sets The vacancy education level identifier
experienceLevelId	string	Gets or sets The vacancy experience level identifier
specialisations	array	Gets or sets The specialisations object list
skills	array	Gets or sets The skills object list
criteriaCustomFields	DataWithFormattedCustomFieldsWrite[]	Gets or sets The criteria custom fields object

VacancyJobDescriptionWrite

The job description object

Name	Type	Notes
description1	string	Gets or sets The vacancy description 1
description1HTML	string	Gets or sets The vacancy description 1 formatted
description2	string	Gets or sets The vacancy description 2
description2HTML	string	Gets or sets The vacancy description 2 formatted
contractLength	string	Gets or sets The vacancy contract length
contractTypeId	string	Gets or sets The contract identifier
countryId	string	Gets or sets The country identifier
jobTimeId	string	Gets or sets The job time identifier
primaryProfileId	string	Gets or sets The primary profile identifier
professionalCategoryId	string	Gets or sets The profesional category identifier
salaryRangeId	string	Gets or sets The salary range identifier
secondaryProfiles	array	Gets or sets The secondary profiles object list
title	string	Gets or sets The vacancy title
jobDescriptionCustomFields	DataWithFormattedCustomFieldsWrite[]	Gets or sets The job description custom fields object

VacancyLanguageWrite

Gets or sets The languages

Name	Type	Notes
languageId	string
languageLevelId	string

WrappedResponse_VacancyDetailWrite

Wrapped response

Name	Type	Notes
data	VacancyDetailWrite[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_VacancyDetailRead

Wrapped response

Name	Type	Notes
data	VacancyDetailRead[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_Dictionary_String_Object

Wrapped response

Name	Type	Notes
data	object	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_String

Wrapped response

Name	Type	Notes
data	string	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_ICollection_PublicationMediaInfo

Wrapped response

Name	Type	Notes
data	PublicationMediaInfo[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

PublicationMediaInfo

The response data

Name	Type	Notes
startDate	string (date-time)
endDate	string (date-time)
status	Reference[]	Referencing object

PublicationMediaPublishInfo

Name	Type	Notes
startDate	string (date-time)
endDate	string (date-time)

WrappedResponse_ICollection_Supervisor

Wrapped response

Name	Type	Notes
data	Supervisor[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

Supervisor

The response data

Name	Type	Notes
phoneNumber	string	The phone number
isMainSupervisor	boolean	A value indicating whether this instance is main supervisor
employeeNumber	string	The employee number
login	string	The login
lastName	string	The last name
firstName	string	The first name
email	string	The email

SupervisorWrite

Name	Type	Notes
isMainSupervisor	boolean	A value indicating whether this instance is main supervisor

WrappedResponse_SupervisorWrite

Wrapped response

Name	Type	Notes
data	SupervisorWrite[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_ICollection_VacancyTranslation

Wrapped response

Name	Type	Notes
data	VacancyTranslation[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_VacancyTranslation

Wrapped response

Name	Type	Notes
data	VacancyTranslation[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_IEnumerable_VacancyRequest

Wrapped response

Name	Type	Notes
data	VacancyRequest[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

VacancyRequest

The response data

Name	Type	Notes
id	string
status	Reference[]	Referencing object
organisation	Reference[]	Referencing object
creationDate	string (date-time)
modificationDate	string (date-time)
description	VacancyRequestDescriptionRead[]
creationUser	Reference[]	Referencing object

VacancyRequestDescriptionRead

Name	Type	Notes
jobTitle	string
description1	string
description2	string

WrappedResponse_VacancyRequestDetail

Wrapped response

Name	Type	Notes
data	VacancyRequestDetail[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_IEnumerable_VacancyRequestEvent

Wrapped response

Name	Type	Notes
data	VacancyRequestEvent[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_VacancyRequestExternalRecruitmentAgreement

Wrapped response

Name	Type	Notes
data	VacancyRequestExternalRecruitmentAgreement[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_Supervisor

Wrapped response

Name	Type	Notes
data	Supervisor[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_IEnumerable_AgreementValidator

Wrapped response

Name	Type	Notes
data	AgreementValidator[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_IEnumerable_VacancyRequestAgreementValidationEvent

Wrapped response

Name	Type	Notes
data	VacancyRequestAgreementValidationEvent[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_VacancyRequestInternalMobilityAgreement

Wrapped response

Name	Type	Notes
data	VacancyRequestInternalMobilityAgreement[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

AgreementValidationEvent

Name	Type	Notes
action	string
payload	AgreementValidationEventPayload[]

AgreementValidationEventPayload

Name	Type	Notes
comment	string

WrappedResponse_Object

Wrapped response

Name	Type	Notes
data	object	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

Validation

Name	Type	Notes
vacancyRequestAgreement	VacancyRequestAgreementValidation[]
vacancyRequestAgreementContentRange	string

VacancyRequestAgreementValidation

Name	Type	Notes
vacancyRequest	ValidationVacancyRequest[]
validation	AgreementValidator[]
agreementType	string
agreement	VacancyRequestExternalRecruitmentAgreement[]
actions	VacancyRequestAgreementActions[]

ValidationVacancyRequest

Name	Type	Notes
jobTitle	string

VacancyRequestAgreementActions

Name	Type	Notes
getVacancyRequest	ApiUrl[]
getVacancyRequestMetadata	ApiUrl[]
getInternalMobilityValidations	ApiUrl[]
getExternalRecruitmentValidations	ApiUrl[]
getInternalMobilityDetails	ApiUrl[]
getInternalMobilityDetailsMetadata	ApiUrl[]
getExternalRecruitmentDetails	ApiUrl[]
getExternalRecruitmentDetailsMetadata	ApiUrl[]
getInternalMobilitySupervisors	ApiUrl[]
getExternalRecruitmentSupervisors	ApiUrl[]
validate	ApiUrl[]
reject	ApiUrl[]

WrappedResponse_ViewArray

Wrapped response

Name	Type	Notes
data	View[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

View

The response data

Name	Type	Notes
languageId	integer (int32)	The language id
viewType	Reference[]	This attribute describe the type of the view and in which context the view is used. The value may be one of these values : FF_Form_Applicant, FF_Form_Offer, FF_Form_PreliminaryJobRequest, FF_Form_HiringProposition, FF_Form_Appreciation
id	string	Identifier of the view.
label	string	Name of the view.

WrappedResponse_View

Wrapped response

Name	Type	Notes
data	View[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

WrappedResponse_OrganisationSummaryArray

Wrapped response

Name	Type	Notes
data	OrganisationSummary[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

OrganisationSummary

The response data

Name	Type	Notes
name	string	The organisation name
id	string	The organisation client code

SubscriptionInformationWrite

Name	Type	Notes
event	string	The list of the events may be found here DevPortal
callbackUrl	string
pingUrl	string

WrappedResponse_SubscriptionInformationRead

Wrapped response

Name	Type	Notes
data	SubscriptionInformationRead[]	The response data
status	string	The response status
message	string	The message
contentRange	string	The content range
code	string	The http status code

SubscriptionInformationRead

The response data

Name	Type	Notes
hookId	string

PingCallResponse

Name	Type	Notes
code	integer (int32)	The http code returned by the service
status	string	The status if we reached the service
message	string	The message returned by the service
traceId	string	The calls's trace id