Kandidaten-Such-API

Die Kandidaten-Such-API von CCW wird verwendet, um Daten über Kandidaten abzufragen, die für eine oder mehrere CCW-Anforderungen eingereicht wurden. Suchkriterien wie Vor-/Nachnamen der Kandidaten, Status, Berechtigung zur Bestätigung (als Zeitarbeiter) und mehr können über die CCW Candidate Lookup API angefordert werden. Alle Kandidatendaten, die den spezifischen Suchkriterien entsprechen, werden zurückgegeben.

Die Basis-URL für den Zugriff auf die CCW-Kandidatensuch-API lautet: https://<instance>/api/candidates/search

In der CCW-API-Übersicht erfahren Sie, wie Sie POST-Anfragen authentifizieren und an CCW-APIs SENDEN. Anfragen sollten folgende Elemente enthalten:

Anforderungsköpfe

Für Authentifizierungszwecke sind Anforderungsheader erforderlich. Weitere Informationen finden Sie im Abschnitt Anforderungskopfzeilen der Dokumentation zur API-Übersicht von CCW.

Anforderungstext

Meta- und Datenobjekte müssen beide im API-Anfragetext übergeben werden:

Metadaten

Der Abschnitt Metadaten definiert die Anzahl der zurückgegebenen Ergebnisse, um eine schnellere Leistung zu gewährleisten. Mit dabei:

• Limit : Definiert die maximale Anzahl von Ergebnissen, zwischen 1 und 50, die in einer einzigen API-Anforderung zurückgegeben werden sollen (d. h. die Anzahl der Ergebnisse auf einer Seite)
  • Standardmäßig werden 50 Ergebnisse angezeigt, wenn der Wert für Limit leer oder größer als 50 ist
  • Gibt eine Fehlermeldung zurück, wenn der Wert für Limit kleiner als 1 ist
• Verzögerung : Definiert den Datensatz, bei dem die Anforderung beginnen soll; z. B. Limit=30, Offset=51 gibt die nächsten 30 Datensätze zurück, beginnend mit Datensatz 51.
  • Wird auf 0 gesetzt, wenn der Wert für Offset leer ist
  • Gibt eine Fehlermeldung zurück, wenn der Wert für Offset kleiner als 0 ist.

Daten

Ein oder mehrere spezifische Suchparameter, die angefordert werden sollen (mindestens ein nicht leerer Parameter muss gesendet werden).

Die folgende Tabelle definiert alle Datenparameter, die innerhalb des Candidate Lookup API-Anforderungstextes übergeben werden können:

Beispielanforderung

BEITRAG /API/Kandidaten/Suche

HOST: <CCW FQDN>

Autorisierung: Bearer <token>

Accept: "application/json"

Korrelations-ID: Z098Jth56Nkio343YY1vXt



{

    "meta":{

        "limit":"Anzahl",

        "offset":"Nummer"

    }

    "data":{

        "id":"Nummer",

        "number":"Zeichenfolge",

        "first_name":"Zeichenfolge",

        "last_name":"Zeichenfolge",

        "email":"Zeichenfolge",

        "ccw_id":"Nummer",

        "status":"Zeichenfolge",

        "external_reference_number":"Zeichenfolge",

        "requisition_number":"Zeichenfolge",

        "hiring_manager_first_name":"Zeichenfolge",

        "hiring_manager_last_name":"Zeichenfolge",

        "onboarding_eligibility_met":"Zeichenfolge",

        "confirmation_eligibility_met":"Zeichenfolge",

        "supplier_name":"Zeichenfolge"

    }

}

API-Antwort

Kandidaten, die mit allen im API-Anfragetext gesendeten Suchparametern übereinstimmen, werden zurückgegeben. Die folgende Tabelle definiert alle Parameter, die mit Kandidaten in der Antwort von CCW auf eine erfolgreiche API-Anfrage enthalten sein können:

Antworten-Beispiele

Im Folgenden finden Sie ein Beispiel für eine erfolgreiche Antwort, bei der mindestens ein Kandidat den Suchkriterien entsprach.

Notizen:

• total_count: Gesamtzahl der Kandidaten, die den Suchkriterien in der API-Anfrage entsprachen
• has_more: true oder false, was angibt, ob es mehr Kandidaten gibt, die die Suchkriterien erfüllen, zusätzlich zu denen, die in der Antwort enthalten sind

{

  "meta": {

    "total_count": 1.

    "has_more": falsch

  },

  "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":"Anforderung erstellen",

                "Job_Code":"",

                "job_title":"Sachbearbeiter",

                "work_location_code":"04872",

                "work_location_name":"04872-Handwerker CA",

                "type_of_service":"Sachbearbeiter/Fachmann",

                "rate_type":"Pro Stunde"

             },

             "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": "Regelmäßig",

             "employment_type": "1099",

             "status": "wo-akzeptiert",

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

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

             "number": "RS-CS-0060176",

             "short_listed": falsch,

             "work_email": „“,

             "date_available": Null,

             "submitted_to_other_requirements": falsch,

             "onboarding_status": "initiiert",

             "onboarding_eligibility_met": 1.

             "confirmation_eligibility_met": falsch,

             "statement_of_works": [],

             "work_orders":[

              {

                "id":224583,

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

                "active":"wahr",

                "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": falsch

    }

}

Im Folgenden finden Sie ein Beispiel für eine Antwort, bei der keine Kandidaten die Suchkriterien erfüllen:

{   

  "meta": {     

    "total_count": 0,     

    "has_more": falsch   

  },   

  "data":[] 

}

Gültiger Kandidatenstatus

Im Folgenden sind die gültigen Kandidatenstatuswerte aufgeführt, die in einer Anfrage an die Kandidaten-API von CCW übergeben werden können:

Fehlercodes

Wenn eine API-Anforderung fehlschlägt, enthält die Antwort einen der folgenden Fehlercodes: