API de recherche de candidat

L'API de recherche de candidats de la CCW est utilisée pour rechercher des données sur les candidats qui ont été soumis à une ou plusieurs demandes de la CCW. Les critères de recherche tels que les prénoms/noms des candidats, le statut, l'éligibilité à confirmer (en tant que travailleur occasionnel) et plus encore, peuvent être demandés via l'API de recherche de candidats CCW. Toutes les données de candidat correspondant aux critères de recherche spécifiques sont renvoyées.

L'URL de base pour accéder à l'API de recherche de candidats CCW est : https :/<instance>//api/candidates/search

Reportez-vous à l'aperçu de l'API CCW pour savoir comment authentifier et soumettre des demandes POST aux 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.

Corps de la demande

Les objets Meta et Data doivent tous deux être transmis dans le corps de la requête API :

Méta

La section des métadonnées définit le nombre de résultats renvoyés, afin d'assurer des performances plus rapides. Inclut :

• Limite : Définit le nombre maximal de résultats, entre 1 et 50, à renvoyer dans une seule requête API (c'est-à-dire le nombre de résultats sur une page)
  • Par défaut, 50 résultats si la valeur de la limite est vide ou supérieure à 50
  • Renvoie une erreur si la valeur de la limite est inférieure à 1
• Compenser : Définit l'enregistrement auquel la demande doit commencer ; par exemple, limit=30, offset=51 renvoie les 30 enregistrements suivants en commençant par l'enregistrement 51.
  • La valeur par défaut est 0 si la valeur de décalage est vide
  • Renvoie une erreur si la valeur de décalage est inférieure à 0.

Données

Un ou plusieurs paramètres de recherche spécifiques à demander (au moins un paramètre non vide doit être envoyé).

Le tableau suivant définit tous les paramètres de données qui peuvent être transmis dans le corps de la demande d'API de recherche de candidat :

Demande d'exemple

PUBLICATION /API/candidats/recherche

HÔTE : <CCW FQDN>

Autorisation : Porteur <token>

Accept : "application/json"

Corrélation-Id : Z098Jth56Nkio343YY1vXt



{

    "meta" :{

        "limit" :"nombre",

        "offset" :"numéro"

    }

    "data" :{

        "id" :"numéro",

        "number" :"chaîne",

        "first_name" :"chaîne",

        "last_name" :"chaîne",

        "email" :"chaîne",

        "ccw_id" :"numéro",

        "status" :"chaîne",

        "external_reference_number" :"chaîne",

        "réquisition_NUMBER" :"chaîne",

        "hiring_manager_first_name" :"chaîne",

        "hiring_manager_last_name" :"chaîne",

        "onboarding_eligibility_met" :"chaîne",

        "confirmation_eligibility_met" :"chaîne",

        "supplier_name" :"chaîne"

    }

}

Réponse API

Le ou les candidats correspondant à tous les paramètres de recherche envoyés dans le corps de la demande d'API sont renvoyés. Le tableau suivant définit tous les paramètres qui peuvent être inclus avec les candidats dans la réponse de la CCW à une demande d'API réussie :

Exemples de réponses

Voici un exemple de réponse réussie, où au moins un candidat correspondait aux critères de recherche.

Notes :

• total_count : nombre total de candidats correspondant aux critères de recherche dans la demande d'API
• has_more : vrai ou faux, indiquant s'il y a plus de candidats qui correspondent aux critères de recherche, en plus de ceux inclus dans la réponse

{

  "meta" : {

    "total_count" : 1,

    "has_more" : false

  },

  "data" : [{

          "candidate" :{

             "id" :622757,

             "number" :"CCW_CS_13897",

             "first_name" :"Cédric",

             "last_name" :"Daniels",

             "email" :"cedric.daniels@coupa.com",

             "ccw_id" :"23230203",

             "fournisseur" :{

                "id" :526,

                "name" :"Tester Supplier.Inc",

                "number" :"483735",

                "contact" : {

                    "first_name" :"Lester",

                    "last_name" :"Freeman",

                    "email" :"lester.freeman@supplierssample.com"

                }

             },

             "demande" :{

                "id" :"174011",

                "numéro" :"RS-REQ-27130",

                "type" :"Créer une demande",

                "job_code" :"",

                "job_title" :"Commis",

                "work_location_code" :"04872",

                "work_location_name" :"04872-Artisan CA",

                "type_of_service" :"Commis/Professionnel",

                "rate_type" :"Par heure"

             },

             "hiring_manager_user_name" : "100DuChloe1.DuCollins1.1@coupadev.com",

             "hiring_manager_first_name" : "DuCollins1.1",

             "hiring_manager_last_name" : "100DuChloe1",

             "hiring_manager_email" : "100DuChloe1.DuCollins1.1@coupadev.com",

             "engagement_type" : "Normale",

             "employment_type" : "1099",

             "status" : "wo-accepté",

             "submitted_date" : "2020-07-28T14:36:22Z",

             "cw_number" : "RS-CW-059713",

             "nombre" : "RS-CS-0060176",

             "short_listed" : false,

             "courriel_travail" : "",

             "date_available" : null,

             "submitted_to_other_requirements" : false,

             "onboarding_status" : "initié",

             "onboarding_eligibility_met" : 1,

             "confirmation_eligibility_met" : faux,

             "statement_of_works" : [],

             "work_orders" :[

              {

                "id" :224583,

                "number" :"RS-WO-059860",

                "active" :"vrai",

                "contract_start_date" :"2020-07-01T04:00:00Z",

                "contract_end_date" :"31/12/2020T05:00:00Z"

                "numéro_de_référence_externe" : ""

              }

            ]

          }

        ],

        "meta" : {

        "total_count" : 1,

        "has_more" : false

    }

}

Voici un exemple de réponse où aucun candidat ne répondait aux critères de recherche :

{   

  "meta" : {     

    "total_count" : 0,     

    "has_more" : false   

  },   

  "data" :[] 

}

Statut valide du candidat

Voici les valeurs de statut de candidat valides qui peuvent être transmises dans une demande à l'API candidate de CCW :

Codes d'erreur

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