API de confirmation du candidat

L'API CCW Candidate Confirmation est conçue pour les clients qui gèrent certaines ou toutes les activités d'onboarding des candidats via des applications tierces et qui souhaitent automatiser le processus de confirmation des candidats, un par un, en tant que travailleurs temporaires (CW). L'API peut traiter une demande pour confirmer un candidat unique, sans qu'aucune autre donnée ne soit transmise dans la demande.

L'API de recherche de candidats CCW peut être utilisée conjointement pour trouver des candidats qui répondent aux critères nécessaires à la confirmation. L'API de confirmation de candidat peut alors confirmer chaque candidat admissible, un par un.

L'URL de base pour accéder à l'API CCW Candidate Confirmation est : https://<instance>/api/candidates/<id>/confirm

Reportez-vous au Présentation de CCW API pour savoir comment être authentifié par les API CCW. Les demandes doivent inclure les éléments suivants :

Demander des en-têtes

Les en-têtes de demande sont requis pour l'authentification. Voir Demander des en-têtes pour plus de détails.

Exemple de demande

L'API de confirmation de candidat CCW est prise en charge par la méthode PUT pour confirmer un candidat en tant que CW, en transmettant uniquement l'ID unique de ce candidat dans la demande d'API, sans qu'aucun corps de demande explicite ne soit requis. In the example below, "12345" is the unique ID retrieved from a Candidate Lookup API request :

PUT /api/candidates/12345/confirm
HOST: <CCW FQDN>
Authorization: Bearer <token>
Accept: "application/json"
Correlation-Id: Z098Jth56Nkio343YY1vXt

Exemples de réponses

Voici un exemple de réponse réussie. L'ID de candidat demandé est validé puis confirmé. CCW indique que la confirmation a réussi en envoyant une réponse avec le code de réponse HTTP 200 et l'ID du candidat :

{
    "id":"12345"
}

Dans l'exemple suivant, la demande de confirmation a échoué. Le code d'erreur HTTP est renvoyé, avec les messages d'erreur applicables :

{   
 "error_code": "string",
 "error_summary": "string",
 "error_causes": [      
  {   
    "error_sub_code": "string", 
    "error_sub_code_desc": "string",
  }
 ]
}

Codes d'erreur

Lorsqu'une demande de confirmation d'API échoue, la réponse inclut l'un des codes d'erreur suivants :