API zur Kandidatensuche
Die Kandidatensuch-API von CCW ermöglicht es Kunden, Daten über Kandidaten abzurufen, die an die CCW-Anforderung übermittelt wurden.
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:
Attribut | Datentyp | Erforderlich? | Eindeutig? | Werte | Beschreibung |
---|---|---|---|---|---|
Grenzwert | Nummer | Nein | Nein | 1-50 | Anzahl der pro API-Aufruf zurückzugebenden Datensätze |
Offset | Nummer | Nein | Nein | beliebig | Spezifische Bestandsnummer, bei der die Ergebnisse beginnen sollen |
ID | Nummer | Nein | Ja | beliebig | Eindeutige ID des Kandidaten in CCW. Wird generiert, wenn der Kandidat an eine Anforderung übermittelt wird. (Wird für die Bestätigungs-API verwendet). |
Nummer | Zeichenfolge (100) | Nein | Ja | beliebig |
Eindeutige Nummer in CCW für Kandidat zugewiesen. Format:
|
first_name | Zeichenfolge (100) | Nein | Nein | beliebig | Vorname des Kandidaten |
Nachname | Zeichenfolge (100) | Nein | Nein | beliebig | Nachname des Kandidaten |
String(400) | Nein | Ja | beliebig | E-Mail-Adresse des Kandidaten | |
Status | String(50) | Nein | Nein | Einer der gültigen Status von CCW | Siehe Gültige Kandidatenstatus unten stehende Tabelle. |
ccw_id | String(8) | Nein | Ja | beliebig | CCW-ID |
Externe_Referenznummer | String(200) | Nein | Nein | beliebig | Eindeutige ID, die dem Kandidaten zugeordnet ist |
Anforderungsnummer | Zeichenfolge (100) | Nein | Nein | beliebig | Dem Kandidaten zugeordnete Anforderungsnummer |
Personalbeschaffungsmanager_Vorname | Zeichenfolge (100) | Nein | Nein | beliebig | Vorname des Einstellungsverwalters |
hiring_manager_last_name | Zeichenfolge (100) | Nein | Nein | beliebig | Nachname des Einstellungsverwalters |
Onboarding_permission_met | Nummer | Nein | Nein | 0,1 |
0=zulässig, 1=nicht zulässig |
Bestätigung_Berechtigung_erfüllt | boolesch | Nein | Nein | wahr/falsch oder ja/nein oder 1/0 oder J/N oder T/F | Gibt an, ob der Kandidat einen akzeptierten Arbeitsauftrag hat und die Onboarding-Zulassungskriterien erfüllt sind |
supplier_name | String(200) | Nein | Nein | beliebig | Name des Lieferanten |
Startdatum | Datum | Nein | Nein | beliebig | Startdatum des aktiven Arbeitsauftrags, formatiert als JJJJ-MM-TT (ISO 8601-Standardformatierung) |
Enddatum | Datum | Nein | Nein | beliebig | Enddatum des aktiven Arbeitsauftrags, formatiert als JJJJ-MM-TT |
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:
Attribut | Objekt anfordern | Datentyp | Beschreibung |
---|---|---|---|
Summe_Anzahl | Meta | Nummer | Anzahl der Datensätze, die den Suchkriterien entsprachen |
hat_mehr | Meta | boolesch | Wahr oder Falsch - um anzugeben, ob mehr Kandidaten die Suchkriterien erfüllen |
ID | Daten | Nummer | Eindeutige ID des Kandidaten in CCW. Wird generiert, wenn der Kandidat an eine Anforderung übermittelt wird. (Wird für die Bestätigungs-API verwendet). |
Nummer | Daten | Zeichenfolge (100) |
Eindeutige Nummer in CCW für Kandidat zugewiesen. Format:
|
first_name | Daten | Zeichenfolge (100) | Vorname des Kandidaten |
Nachname | Daten | Zeichenfolge (100) | Nachname des Kandidaten |
Daten | String(400) | E-Mail-Adresse des Kandidaten | |
Status | Daten | String(50) | Siehe Gültige Kandidatenstatus unten stehende Tabelle. |
ccw_id | Daten | String(8) | CCW-ID |
cw_number | Daten | Zeichenfolge (100) | Dem Kandidaten zugewiesene CW-Nummer |
Externe_Referenznummer | Daten | String(200) | Eindeutige ID, die dem Kandidaten zugeordnet ist |
Personalbeschaffungsmanager_Vorname | Daten | Zeichenfolge (100) | Vorname des Einstellungsverwalters |
hiring_manager_last_name | Daten | Zeichenfolge (100) | Nachname des Einstellungsverwalters |
hiring_manager_user_name | Daten | String(512) | Benutzername des Leiters der Einstellung |
Einstellungsmanager_E-Mail | Daten | Zeichenfolge (100) | E-Mail-Adresse des Leiters |
Engagement_Typ | Daten | String(400) | Temporär/Anbieter |
Beschäftigungstyp | Daten | String(200) | Beschäftigungsart (W2, 1099 usw.) |
Übermittelt am | Daten | Datum | Datum, an dem der Kandidat an die Anforderung übermittelt wurde, formatiert als JJJJ-MM-DDT24HHMMSSZ. |
in die engere Wahl | Daten | boolesch | Gibt an, ob der Kandidat zu einer Shortlist hinzugefügt wurde |
work_email | Daten | String(400) | Dem Kandidaten zugewiesene Arbeits-E-Mail |
Datum_verfügbar | Daten | Datum | Das Datum, an dem der Kandidat zur Arbeit verfügbar ist, formatiert als JJJJ-MM-DDT24HHMMSSZ. |
an_andere_Anforderungen übermittelt | Daten | boolesch | Gibt an, ob der Kandidat an andere Anforderungen übermittelt wurde |
Onboarding_Status | Daten | string(set values) | "Vorabübermittlung abgeschlossen", "Onboarding-Fortsetzungen", "Onboarding-Angehalten", "Onboarding-Abgeschlossen", "Onboarding-Storniert", "Initiiert", "In Bearbeitung" |
Onboarding_permission_met | Daten | boolesch |
0=zulässig, 1=nicht zulässig |
Bestätigung_Berechtigung_erfüllt | Daten | boolesch | Gibt an, ob der Kandidat einen akzeptierten Arbeitsauftrag hat und die Onboarding-Zulassungskriterien erfüllt sind |
ID | data.supplier | Nummer | Eindeutige ID, die dem Lieferanten in CCW zugewiesen ist |
Name | data.supplier | String(400) | Name des Lieferanten |
Nummer | data.supplier | String(400) | Eindeutige Nummer, die dem Lieferanten in CCW zugewiesen ist |
first_name | data.supplier.contact | Zeichenfolge (100) | Vorname des Lieferantenkontakts |
Nachname | data.supplier.contact | Zeichenfolge (100) | Nachname des Lieferantenkontakts |
data.supplier.contact | String(400) | Kontakt-E-Mail Lieferant | |
ID | data.requisition | Nummer | Eindeutige ID, die der Anforderung in CCW zugewiesen ist |
Nummer | data.requisition | Zeichenfolge (100) | Eindeutige Nummer, die der Anforderung in CCW zugewiesen ist |
Typ | data.requisition | String(200) | Anforderungstyp (z. B. identifizierter Kandidat, erforderlich) |
job_code | data.requisition | String(500) | Anforderungsauftragscode |
job_title | data.requisition | String(400) | Titel des Anforderungsauftrags |
work_location_code | data.requisition | String(1000) | Code des Anforderungsarbeitsplatzes |
Arbeitsstandort_Name | data.requisition | string(40) | Name des Anforderungsarbeitsplatzes |
Servicetyp | data.requisition | String(200) | Art der Arbeit |
Kurstyp | data.requisition | Zeichenfolge (100) | Kurstyp |
ID | data.work_orders | Nummer | Eindeutige ID, die dem Arbeitsauftrag in CCW zugewiesen ist |
Nummer | data.work_orders | String(200) | Eindeutige Nummer, die dem Arbeitsauftrag in CCW zugewiesen ist |
aktiv | data.work_orders | boolesch | Gibt an, ob der Arbeitsauftrag aktiv ist |
Vertrag_Startdatum | data.work_orders | Datum | Startdatum des Arbeitsauftrags, formatiert als JJJJ-MM-TTT24HMMSSZ |
Vertrag_Enddatum | data.work_orders | Datum | Enddatum des Arbeitsauftrags, formatiert als JJJJ-MM-TTT24HMMSSZ |
ID | data.statement_of_works | Nummer | Eindeutige ID, die der SOW in CCW zugewiesen ist |
Nummer | data.statement_of_works | Zeichenfolge (100) | Eindeutige Nummer, die der SOW in CCW zugewiesen ist |
ID | data.sows.task_order | Nummer | Eindeutige ID, die der Aufgabenreihenfolge in CCW zugewiesen ist |
Nummer | data.sows.task_order | Zeichenfolge (100) | Eindeutige ID, die der Aufgabenreihenfolge in CCW zugewiesen ist |
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:
Statusname | Statuscode |
---|---|
Kandidat genehmigt | von Kandidat genehmigt |
Befragung des Kandidaten | Kandidatenbefragung |
Kandidat nicht anzeigen | Kandidat nicht anzeigen |
Kandidat abgelehnt | Kandidat abgelehnt |
Kandidat zur Genehmigung erneut in Warteschlange gestellt | Kandidatenanforderungsgenehmigung |
Kandidat zurückgezogen | Kandidat zurückgezogen |
Nicht übermitteln | Kandidat nicht einreichen |
Onboarding gestartet | Kandidaten-Onboarding gestartet |
OTH akzeptiert | Stand akzeptiert |
OTH erweitert | oth-erweitert |
OTH ausgestellt | von beiden Stellen ausgestellt |
OTH Ablehnen gesperrt | oth-abgelehnt-gesperrt |
OTH abgelehnt | oth-abgelehnt |
OTH zurückgezogen |
von beiden Seiten zurückgezogen |
Erneute Übermittlung angefordert | erneut übermitteln angefordert |
Zur Genehmigung übermittelt | zur Genehmigung eingereicht |
An Manager übermittelt | an Manager übermittelt |
An Programmadministrator übermittelt | Eingereichter Programmadministrator |
WO akzeptiert | zweifach akzeptiert |
WO storniert | zweifach storniert |
WO ausgestellt | zweifach ausgestellt |
WO Abgelehnt | abgelehnt |
Fehlercodes
Wenn eine API-Anforderung fehlschlägt, enthält die Antwort einen der folgenden Fehlercodes:
HTTP-Statuscode | Fehlercode | Fehler Untercode | Fehlermeldung |
---|---|---|---|
400 | E4000000 | E4000001 | Fehlerhafte Anfrage. Mindestens einer der obligatorischen HTTP-Header fehlt |
400 | E400000 | E4000003 | Eingabetext stimmt nicht mit dem erwarteten Schema überein |
400 | E400000 | E4000004 | Ungültiger {field name}-Wert |
400 | E400000 | E4000005 | {field name} darf nicht mehr als {max} Zeichen umfassen |
401 | E4010000 | E4010001 | Authentifizierung fehlgeschlagen. Überprüfen Sie die Anmeldeinformationen, die Ihrer Consumer-App zugeordnet sind |
401 | E401000 | E4010002 | Authentifizierung fehlgeschlagen. Zugriffstoken ist ungültig oder abgelaufen |
403 | E4030000 | E4030001 | Nicht autorisiert. Der Benutzer hat nicht die Rechte, die Aktion auszuführen |
403 | E403000 | E4030002 | Nicht autorisiert. Ungültiger Bereich |
403 | E403000 | E4030003 | Nicht autorisiert. Der API-Benutzer ist ungültig. Stellen Sie sicher, dass der Benutzer aktiv und als API-Benutzer festgelegt ist |
404 | E4040000 | E4040001 | Nicht gefunden |
405 | E4050000 | E4050001 | Methode nicht unterstützt. Service unterstützt die angeforderte HTTP-Methode nicht |
500 | E500000 | E5000001 | Ein System- oder Anwendungsfehler ist aufgetreten. Wenden Sie sich an den Coupa CW-Administrator. |
Parts or all of this page might have been machine-translated. We apologize for any inaccuracies.