API de recherche candidate

L'API de recherche de candidats de CCW est utilisée pour rechercher des données sur les candidats qui ont été soumis à une ou plusieurs demandes CCW. Les critères de recherche tels que les prénoms/noms des candidats, le statut, l'admissibilité à être confirmée (en tant que travailleur temporaire) et plus encore, peuvent être demandés via l'API de recherche des candidats CCW. Toutes les données candidates 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 au Présentation de CCW API pour savoir comment authentifier et soumettre des demandes POST aux 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.

Corps de demande

Méta et Données les deux objets doivent être transmis dans le corps de la demande API :

Méta

La section Métadonnées définit le nombre de résultats renvoyés pour garantir des performances plus rapides. Comprend :

• Limite : Définit le nombre maximum de résultats, entre 1 et 50, à renvoyer dans une seule demande API (c'est-à-dire le nombre de résultats sur une page)
  • Prend par défaut la valeur 50 si la valeur de Limite est vide ou supérieure à 50
  • Renvoie une erreur si la valeur de Limite est inférieure à 1
• Décaler : définit l'enregistrement à partir duquel la demande doit commencer ; par exemple, limit=30, offset=51 renvoie les 30 enregistrements suivants commençant par l'enregistrement 51.
  • Prend par défaut la valeur 0 si la valeur pour Décaler est vide
  • Renvoie une erreur si la valeur pour Décaler est inférieur à 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 Données paramètres qui peuvent être transmis dans le corps de la demande API de recherche de candidat :

Exemple de demande

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

{
    "meta":{
        "limit":"number",
        "offset":"number"
    }
    "data":{
        "id":"number",
        "number":"string",
        "first_name":"string",
        "last_name":"string",
        "email":"string",
        "ccw_id":"number",
        "status":"string",
        "external_reference_number":"string",
        "requisition_number":"string",
        "hiring_manager_first_name":"string",
        "hiring_manager_last_name":"string",
        "onboarding_eligibility_met":"string",
        "confirmation_eligibility_met":"string",
        "supplier_name":"string"
    }
}

Réponse API

Le ou les candidats correspondant à tous les paramètres de recherche envoyés dans le corps de la demande 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 CCW à une demande API réussie :

Exemples de réponses

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

Remarques :

• total_count : nombre total de candidats correspondant aux critères de recherche dans la demande API
• a_plus : 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":"Cedric",
             "last_name":"Daniels",
             "email":"cedric.daniels@coupa.com",
             "ccw_id":"23230203",
             "supplier":{
                "id":526,
                "name":"Test Supplier.Inc",
                "number":"483735",
                "contact": {
                    "first_name":"Lester",
                    "last_name":"Freeman",
                    "email":"lester.freeman@supplierssample.com"
                }
             },
             "requisition":{
                "id":"174011",
                "number":"RS-REQ-27130",
                "type":"Create Requisition",
                "job_code":"",
                "job_title":"Clerical",
                "work_location_code":"04872",
                "work_location_name":"04872-Craftsman CA",
                "type_of_service":"Clerical/Professional",
                "rate_type":"Per Hour"
             },
             "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": "Regular",
             "employment_type": "1099",
             "status": "wo-accepted",
             "submitted_date": "2020-07-28T14:36:22Z",
             "cw_number": "RS-CW-059713",
             "number": "RS-CS-0060176",
             "short_listed": false,
             "work_email": "",
             "date_available": null,
             "submitted_to_other_requirements": false,
             "onboarding_status": "initiated",
             "onboarding_eligibility_met": 1,
             "confirmation_eligibility_met": false,
             "statement_of_works": [],
             "work_orders":[
              {
                "id":224583,
                "number":"RS-WO-059860",
                "active":"true",
                "contract_start_date":"2020-07-01T04:00:00Z",
                "contract_end_date":"2020-12-31T05:00:00Z"
                "external_reference_number": ""
              }
            ]
          }
        ],
        "meta": {
        "total_count": 1,
        "has_more": false
    }
}

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

{   
  "meta": {     
    "total_count": 0,     
    "has_more": false   
  },   
  "data":[] 
}

Statuts de candidat valides

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

Codes d'erreur

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