API zur Kandidatensuche

Die Kandidatensuch-API von CCW wird verwendet, um Daten über Kandidaten abzufragen, die an eine oder mehrere CCW-Anforderungen übermittelt wurden. Suchkriterien wie Vor-/Nachnamen von Kandidaten, Status, Berechtigung zur Bestätigung (als Contingent Worker) und mehr können über die CCW-Kandidatensuch-API angefordert werden. Alle Kandidatendaten, die mit den spezifischen Suchkriterien übereinstimmen, werden zurückgegeben.

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

Siehe CCW API-Übersicht um zu erfahren, wie Sie POST-Anforderungen authentifizieren und an CCW-APIs übermitteln. Die Anfragen sollten die folgenden Elemente enthalten:

Kopfzeilen anfordern

Anforderungskopfzeilen sind für Authentifizierungszwecke erforderlich. Siehe Kopfzeilen anfordern Abschnitt der Dokumentation API-Übersicht von CCW für Details.

Text anfordern

Meta und Daten Objekte, die beide im API-Anforderungstext übergeben werden müssen:

Meta

Der Metadatenabschnitt definiert die Anzahl der zurückgegebenen Ergebnisse, um eine schnellere Leistung zu gewährleisten. Umfasst:

• Begrenzung : Definiert die maximale Anzahl von Ergebnissen zwischen 1 und 50, die in einer einzelnen API-Anforderung zurückgegeben werden sollen (d. h. die Anzahl der Ergebnisse auf einer Seite)
  • Der Standardwert ist 50 Ergebnisse, wenn der Wert für Limit leer oder größer als 50 ist
  • Gibt einen Fehler zurück, wenn der Wert für Limit kleiner als 1 ist
• Aufheben : Definiert den Datensatz, bei dem die Anforderung beginnen soll; z. B. gibt limit=30, offset=51 die nächsten 30 Datensätze zurück, die mit Datensatz 51 beginnen.
  • Der Standardwert ist 0, wenn der Wert für Aufheben ist leer
  • Gibt einen Fehler zurück, wenn der Wert für Aufheben ist kleiner als 0.

Daten

Mindestens ein spezifischer Suchparameter, der angefordert werden soll (mindestens ein nicht leerer Parameter muss gesendet werden).

Die folgende Tabelle definiert alle Daten Parameter, die im Anforderungstext der Kandidatensuch-API übergeben werden können:

Beispielanforderung

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"
    }
}

API-Antwort

Kandidaten, die mit allen im API-Anforderungstext gesendeten Suchparametern übereinstimmen, werden zurückgegeben. Die folgende Tabelle definiert alle Parameter, die Kandidaten in die Antwort von CCW auf eine erfolgreiche API-Anforderung einschließen können:

Beispielantworten

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

Notizen:

• Summe_Anzahl: Gesamtzahl der Kandidaten, die den Suchkriterien in der API-Anforderung entsprachen
• hat_mehr: wahr oder falsch, 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": 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
    }
}

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

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

Gültige Kandidatenstatus

Im Folgenden finden Sie die gültigen Kandidatenstatuswerte, 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: