API de confirmation du candidat
Les clients qui gèrent certaines ou toutes les activités d'intégration des candidats via des applications tierces peuvent automatiser le processus de confirmation des candidats en tant que travailleurs occasionnels, un à la fois, à l'aide de l'API de confirmation des candidats CCW.
L'API de confirmation des candidats CCW est conçue pour les clients qui gèrent certaines ou toutes les activités d'intégration des candidats via des applications tierces et qui souhaitent automatiser le processus de confirmation des candidats, un à la fois, en tant que travailleurs occasionnels (CW). L'API peut traiter une demande de confirmation d'un seul candidat, 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 du candidat peut ensuite confirmer chaque candidat éligible, un par un.
L'URL de base pour accéder à l'API de confirmation des candidats à la CCW est : https :/<instance>//api/candidates/<id>/confirm
Reportez-vous à la présentation de l'API CCW pour savoir comment être authentifié par les API CCW. Les demandes doivent inclure les éléments suivants :
En-têtes de la demande
Des en-têtes de demande sont nécessaires à des fins d'authentification. Voir la section En-têtes de demande de la documentation de présentation de l'API de la CCW pour plus de détails.
Demande d'exemple
L'API de confirmation des candidats à la 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 corps de demande explicite requis. Dans l'exemple ci-dessous, « 12345 » est l'ID unique récupéré à partir d'une demande d'API de recherche de candidat :
PUT /api/candidates/12345/confirm HÔTE : <CCW FQDN> Autorisation : Porteur <token> Accept : "application/json" Corrélation-Id : Z098Jth56Nkio343YY1vXt
Exemples de réponses
Vous trouverez ci-dessous un exemple de réponse réussie. L'ID du candidat demandé est validé puis confirmé. CCW indique que la confirmation a été un succès 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é, ainsi que les messages d'erreur applicables :
{
"error_code" : "chaîne",
"error_summary" : "chaîne",
"error_causes" : [
{
"error_sub_code" : "chaîne",
"error_sub_code_desc" : "chaîne",
}
]
}
Codes d'erreur
Lorsqu'une demande de confirmation d'API échoue, la réponse comprendra l'un des codes d'erreur suivants :
| Code du statut HTTP | Code d'erreur | Sous-code d'erreur | Message d'erreur |
|---|---|---|---|
| 400 | E4000000 | E4000001 | Demande erronée. Manque un ou plusieurs des en-têtes HTTP obligatoires |
| 400 | E4000000 | E4000006 | La date de début ne peut pas être une date dans le passé |
| 400 | E4000000 | E4000007 | Jour de début non valide |
| 400 | E4000000 | E4000008 | La date de fin doit être postérieure à la date de début |
| 400 | E4000000 | E4000009 | La période de contrat dépasse les exigences de durée de service de <configured number of days/weeks/months/years> <days/weeks/months/years> |
| 400 | E4000000 | E4000010 | Compte erroné <account> |
| 400 | E4000000 | E4000012 | Un candidat ou un travailleur avec cet ID CCW existe déjà |
| 400 | E4000000 | E4000013 | La date de début ne peut pas être une date future |
| 400 | E4000000 | E4000019 | Le bon de tâche n'est pas valide. Soit il est annulé, soit il est inactif, soit il est introuvable |
| 400 | E4000000 | E4000020 | Le lot de travail n'est pas valide. Soit il est annulé, soit il est inactif, soit il est introuvable |
| 400 | E4000000 | E4000023 | Le candidat ne répondait pas aux critères de confirmation |
| 400 | E4000000 | E4000024 | Le candidat est déjà confirmé |
| 400 | E4000000 | E4000025 | Le taux de rémunération OT doit être supérieur ou égal au taux de rémunération |
| 400 | E4000000 | E4000026 | Le taux de rémunération DT doit être supérieur ou égal au taux de rémunération OT |
| 400 | E4000000 | E4000027 | Le taux de facturation OT du fournisseur doit être supérieur ou égal au taux de facturation du fournisseur |
| 400 | E4000000 | E4000028 | Le taux de facturation DT du fournisseur doit être supérieur ou égal au taux de facturation OT du fournisseur |
| 400 | E4000000 | E4000029 | Le taux de facturation final des OT doit être supérieur ou égal au taux de facturation final |
| 400 | E4000000 | E4000030 | Le taux de facturation DT final doit être supérieur ou égal au taux de facturation OT final |
| 400 | E4000000 | E4000031 | Le taux de facturation doit être supérieur ou égal au taux de rémunération |
| 400 | E4000000 | E4000032 | Le taux de facturation final doit être supérieur ou égal au taux de facturation du fournisseur |
| 400 | E4000000 | E4000033 | Le taux de facturation OT du fournisseur doit être supérieur ou égal au taux de rémunération OT |
| 400 | E4000000 | E4000034 | Le taux de facturation OT final doit être supérieur ou égal au taux de facturation OT du fournisseur |
| 400 | E4000000 | E4000035 | Le taux de facturation DT du fournisseur doit être supérieur ou égal au taux de rémunération DT |
| 400 | E4000000 | E4000036 | Le taux de facturation DT final doit être supérieur ou égal au taux de facturation DT du fournisseur |
| 400 | E4000000 | E4000037 | Le taux de la facture fournisseur doit être identique au taux de la facture finale |
| 400 | E4000000 | E4000038 | La demande ne peut pas être complétée car la demande est fermée |
| 400 | E4000000 | E4000039 | La demande ne peut pas être complétée car la demande est annulée |
| 401 | E4010000 | E4010001 | Échec de l'authentification. Vérifiez les informations d'identification associées à votre application grand public |
| 401 | E4010000 | E4010002 | Échec de l'authentification. Le jeton d'accès n'est pas valide ou a expiré |
| 403 | E4030000 | E4030001 | Non autorisé. L'utilisateur n'a pas le droit d'effectuer l'action |
| 403 | E4030000 | E4030002 | Non autorisé. Portée non valide |
| 403 | E4030000 | E4030003 | Non autorisé. L'utilisateur API n'est pas valide. Assurez-vous que l'utilisateur est actif et défini en tant qu'utilisateur API |
| 404 | E4040000 | E4040001 | Introuvable |
| 405 | E4050000 | E4050001 | Méthode non prise en charge. Le service ne prend pas en charge la méthode HTTP demandée |
| 500 | E5000000 | E5000001 | Une erreur système ou d'application s'est produite, veuillez communiquer avec l'administrateur Coupa CW |