Kandidaten-Bestätigungs-API

Die CCW-Kandidatenbestätigungs-API wurde für Kunden entwickelt, die einige oder alle Onboarding-Aktivitäten von Kandidaten über Anwendungen von Drittanbietern verwalten und den Prozess der Bestätigung von Kandidaten als Zeitarbeitskräfte (CWs) nacheinander automatisieren möchten. Die API kann eine Anfrage verarbeiten, um einen einzelnen Kandidaten zu bestätigen, ohne dass andere Daten in der Anfrage übergeben werden.

Die CCW Candidate Lookup API kann in Verbindung verwendet werden, um Kandidaten zu finden, die die für die Bestätigung erforderlichen Kriterien erfüllen. Die Bewerberbestätigungs-API kann dann jeden berechtigten Bewerber einzeln bestätigen.

Die Basis-URL für den Zugriff auf die CCW-Kandidatenbestätigungs-API lautet: https://<instance>/api/candidates/<id>/confirm

Weitere Informationen zur Authentifizierung durch CCW-APIs finden Sie in der CCW-API-Übersicht. 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.

Beispielanforderung

Die CCW-Kandidatenbestätigungs-API 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 aus einer Kandidaten-Lookup-API-Anfrage abgerufen wird:

PUT /api/candidates/12345/confirm

HOST: <CCW FQDN>

Autorisierung: Bearer <token>

Accept: "application/json"

Korrelations-ID: Z098Jth56Nkio343YY1vXt

Antworten-Beispiele

Nachfolgend finden Sie ein Beispiel für eine erfolgreiche Antwort. Die angeforderte Kandidaten-ID wird validiert und anschließend 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": "Zeichenfolge",

 "error_summary": "Zeichenfolge",

 "error_causes": [      

  {   

    "error_sub_code": "Zeichenfolge", 

    "error_sub_code_desc": "Zeichenfolge",

  }

 ]

}

Fehlercodes

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