API zur Bestätigung von Kandidaten

Die CCW-API für die Kandidatenbestätigung ist für Kunden konzipiert, die einige oder alle Kandidaten-Onboarding-Aktivitäten über Drittanwendungen verwalten und den Prozess der Bestätigung von Kandidaten einzeln als Contingent Worker (CWs) automatisieren möchten. Die API kann eine Anforderung verarbeiten, um einen einzelnen Kandidaten zu bestätigen, ohne dass andere Daten in der Anforderung übergeben werden.

Die CCW-Kandidatensuch-API kann zusammen verwendet werden, um Kandidaten zu finden, die die für die Bestätigung erforderlichen Kriterien erfüllen. Die Kandidatenbestätigungs-API kann dann jeden berechtigten Kandidaten einzeln bestätigen.

Die Basis-URL für den Zugriff auf die CCW-API zur Bestätigung von Kandidaten lautet: https://<instance>/api/candidates/<id>/confirm

Siehe CCW API-Übersicht um zu erfahren, wie Sie sich von CCW-APIs authentifizieren lassen. 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.

Beispielanforderung

Die CCW-API zur Bestätigung von Kandidaten wird von der PUT-Methode unterstützt, um einen Kandidaten als CW zu bestätigen, indem nur die eindeutige ID dieses Kandidaten in der API-Anforderung übergeben wird, ohne dass ein expliziter Anforderungstext erforderlich ist. Im folgenden Beispiel ist "12345" die eindeutige ID, die von einer API-Anforderung für die Kandidatensuche abgerufen wurde:

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

Beispielantworten

Unten sehen Sie ein Beispiel für eine erfolgreiche Antwort. Die angeforderte Kandidaten-ID wird validiert und dann bestätigt. CCW gibt an, dass die Bestätigung erfolgreich war, indem eine Antwort mit dem HTTP 200-Antwortcode und der Kandidaten-ID gesendet wurde:

{
    "id":"12345"
}

Im folgenden Beispiel ist die Bestätigungsanforderung fehlgeschlagen. Der HTTP-Fehlercode wird zusammen mit den entsprechenden Fehlermeldungen zurückgegeben:

{   
 "error_code": "string",
 "error_summary": "string",
 "error_causes": [      
  {   
    "error_sub_code": "string", 
    "error_sub_code_desc": "string",
  }
 ]
}

Fehlercodes

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