• Zuletzt bearbeitet am: 31 May 2021

Kandidaten-Such-API

Die Kandidaten-Such-API von CCW ermöglicht es Kunden, Daten über Kandidaten abzurufen, die bei einer CCW-Anforderung eingereicht wurden.

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:

Attribut Datentyp Erforderlich? Eindeutig? Werte Beschreibung
begrenzung zahl Nein Nein 1-50 Anzahl der Datensätze, die pro API-Aufruf zurückgegeben werden sollen
versatz zahl Nein Nein alle Spezifische Datensatznummer, bei der die Ergebnisse beginnen sollen
iD nummer Nein Ja alle Eindeutige ID des Kandidaten in CCW. Wird generiert, wenn der Kandidat für eine Anforderung eingereicht wird. (Für Bestätigungs-API verwendet).
zahl string(100) Nein Ja beliebig Eindeutige Nummer, die dem Kandidaten in CCW zugewiesen wurde. Format: <Client prefix>-CS-<sequence-number>
first_name string(100) Nein Nein alle Vorname des Kandidaten
last_name zeichenfolge(100) Nein Nein alle Nachname des Kandidaten
e-Mail zeichenfolge(400) Nein Ja alle Bewerber-E-Mail-Adresse
status string(50) Nein Nein Einer der gültigen Status von CCW Siehe Tabelle "Gültiger Kandidatenstatus" unten.
ccw_id string(8) Nein Ja alle CCW-ID
external_reference_number string(200) Nein Nein alle Eindeutige ID, die dem Kandidaten zugeordnet ist
requisition_number string(100) Nein Nein alle Mit dem Kandidaten verknüpfte Anforderungsnummer
hiring_manager_first_name string(100) Nein Nein alle Vorname des Personalverantwortlichen
hiring_manager_last_name string(100) Nein Nein beliebig Nachname des Personalchefs
onboarding_eligibility_met zahl Nein Nein 0.1

0=teilnahmeberechtigt, 1=nicht teilnahmeberechtigt

confirmation_eligible_met boolean Nein Nein richtig/falsch oder ja/nein oder 1/0 oder J/N oder T/F Gibt an, ob der Kandidat einen akzeptierten Arbeitsauftrag hat und die Zulassungskriterien für das Onboarding erfüllt sind
supplier_name string(200) Nein Nein alle Name des Lieferanten
start_date datum Nein Nein alle Aktives Arbeitsauftragsstartdatum, formatiert als JJJJ-MM-TT (ISO 8601 Standardformatierung)
end_date datum Nein Nein beliebig Aktives Enddatum des Arbeitsauftrags, formatiert als JJJJ-MM-TT

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:

Attribut Körperobjekt anfordern Datentyp Beschreibung
total_count meta nummer Anzahl der Datensätze, die den Suchkriterien entsprachen
has_more meta boolean True oder False - um anzugeben, ob es mehr Kandidaten gibt, die die Suchkriterien erfüllen
iD daten nummer Eindeutige ID des Kandidaten in CCW. Wird generiert, wenn der Kandidat für eine Anforderung eingereicht wird. (Für Bestätigungs-API verwendet).
zahl daten string(100) Eindeutige Nummer, die dem Kandidaten in CCW zugewiesen wurde. Format: <Client prefix>-CS-<sequence-number>
first_name daten string(100) Vorname des Kandidaten
last_name daten string(100) Nachname des Kandidaten
e-Mail daten string(400) E-Mail-Adresse des Bewerbers
status daten string(50) Siehe Tabelle "Gültiger Kandidatenstatus" unten.
ccw_id daten string(8) CCW-ID
cw_number daten string(100) Dem Kandidaten zugewiesene CW-Nummer
external_reference_number daten string(200) Eindeutige ID, die dem Kandidaten zugeordnet ist
hiring_manager_first_name daten zeichenfolge(100) Vorname des Personalverantwortlichen
hiring_manager_last_name daten string(100) Nachname des einstellenden Managers
hiring_manager_user_name daten string(512) Benutzername des Personalverantwortlichen
hiring_manager_email daten string(100) E-Mail-Adresse des Personalverantwortlichen
engagement_type daten string(400) Temp / Anbieter
employment_type daten string(200) Art der Beschäftigung (W2, 1099 usw.)
submitted_date daten datum Datum, an dem der Kandidat an die Anforderung übermittelt wurde, formatiert als JJJJ-MM-TT24HHMMSSZ.
in die engere Wahl daten boolean Gibt an, ob der Kandidat zu einer Auswahlliste hinzugefügt wurde
work_email daten string(400) Dem Kandidaten zugewiesene geschäftliche E-Mail-Adresse
date_available daten datum Das Datum, an dem der Kandidat zur Arbeit zur Verfügung steht, formatiert als YYYY-MM-DDT24HHMMSSZ.
andere_Anforderungen_eingereicht daten boolean Zeigt an, ob der Kandidat anderen Anforderungen unterzogen wurde
onboarding_status daten zeichenfolge(eingestellte Werte) „pre-submission-completed“, „onboarding-Resumed“, „onboarding-paused“, „onboarding-completed“, „onboarding-cancelled“, „initiated“, „in progress“
onboarding_eligibility_met daten boolean

0=teilnahmeberechtigt, 1=nicht teilnahmeberechtigt

confirmation_eligible_met daten boolean Gibt an, ob der Kandidat einen akzeptierten Arbeitsauftrag hat und die Zulassungskriterien für das Onboarding erfüllt sind
iD data.supplier zahl Eindeutige ID, die dem Lieferanten in CCW zugewiesen wurde
name data.supplier string(400) Name des Lieferanten
zahl data.supplier string(400) In CCW dem Lieferanten zugewiesene eindeutige Nummer
first_name data.supplier.contact string(100) Vorname des Lieferantenkontakts
last_name data.supplier.contact string(100) Lieferantenkontakt Nachname
e-Mail data.supplier.contact string(400) E-Mail-Adresse des Lieferanten
iD data.requisition zahl Eindeutige ID, die der Anforderung in CCW zugewiesen ist
nummer data.requisition string(100) Der Anforderung in CCW zugewiesene eindeutige Nummer
typ data.requisition string(200) Anforderungsart (zum Beispiel: identifizierter Kandidat, Anforderung)
job_Code data.requisition string(500) Anforderungsauftragscode
job_title data.requisition string(400) Anforderungsjobbezeichnung
work_location_code data.requisition string(1000) Anforderungsarbeitsplatzcode
work_location_name data.requisition string(40) Name des Anforderungsarbeitsplatzes
type_of_service data.requisition string(200) Arbeitstyp
rate_type data.requisition string(100) Satzart
iD data.work_orders nummer Eindeutige ID, die dem Arbeitsauftrag in CCW zugewiesen ist
zahl data.work_orders string(200) Dem Arbeitsauftrag in CCW zugewiesene eindeutige Nummer
aktiv data.work_orders boolean Zeigt an, ob der Arbeitsauftrag aktiv ist
contract_start_date data.work_orders datum Startdatum des Arbeitsauftrags, formatiert als JJJJ-MM-TT24HHMMSSZ
contract_end_date data.work_orders datum Enddatum des Arbeitsauftrags, formatiert als JJJJ-MM-TT24HHMMSSZ
iD data.statement_of_works nummer Eindeutige ID, die der Leistungsbeschreibung IN CCW zugewiesen ist
nummer data.statement_of_works string(100) Eindeutige Nummer, die der Leistungsbeschreibung IN CCW zugewiesen ist
iD data.sows.task_order nummer Eindeutige ID, die dem Aufgabenauftrag in CCW zugewiesen ist
zahl data.sows.task_order string(100) Eindeutige ID, die dem Aufgabenauftrag in CCW zugewiesen ist

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:

Statusname Statuscode
Kandidat genehmigt kandidaten-genehmigt
Kandidateninterview kandidatenbefragung
Kandidaten-Nichterscheinen candidate-no-show
Kandidat abgelehnt kandidat abgelehnt
Kandidat erneut in Warteschlange gestellt bewerber-Warteschlange-Genehmigung
Kandidat wurde zurückgezogen kandidat zurückgezogen
Nicht absenden candidate-do-not-submit
Onboarding gestartet kandidaten-Onboarding gestartet
ANDERE AKZEPTIERT oth-accepted
SONSTIGES ERWEITERT oth-extended
SONSTIGES AUSGESTELLT oth-issued
Anderer Ausschuss gesperrt oth-rejected-locked
SONSTIGES ABGESTOSSEN oth-rejected
SONSTIGES wurde zurückgezogen

oth-drawn

Erneut einreichen angefragt erneut einreichen - angefordert
Zur Genehmigung eingereicht zur Genehmigung eingereicht
An Manager gesendet submitted-to-Manager
An Programmadministrator gesendet submitted-to-Program-Admin
WO Akzeptiert wo-akzeptiert
Auftrag storniert wo-cancelled
Ausgestelltes WO wo-issued
Arbeitsauftrag abgelehnt wo-rejected

Fehlercodes

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

HTTP-Statuscode Fehlercode Fehler-Subcode Fehlermeldung
400 E4000000 E4000001 Fehlerhafte Anfrage. Mindestens einer der obligatorischen HTTP-Header fehlt
400 E4000000 E4000003 Eingabetext entspricht nicht dem erwarteten Schema
400 E4000000 E4000004 Ungültiger {field name} -Wert
400 E4000000 E4000005 {field name} darf nicht mehr als {max} Zeichen haben
401 E4010000 E4010001 Authentifizierung fehlgeschlagen. Überprüfen Sie die mit Ihrer Verbraucher-App verknüpften Anmeldeinformationen
401 E4010000 E4010002 Authentifizierung fehlgeschlagen. Das Zugriffstoken ist ungültig oder abgelaufen
403 E4030000 E4030001 Nicht berechtigt. Der Benutzer ist nicht berechtigt, die Aktion auszuführen
403 E4030000 E4030002 Nicht berechtigt. Ungültiger Bereich
403 E4030000 E4030003 Nicht berechtigt. Der API-Benutzer ist ungültig. Stellen Sie sicher, dass der Benutzer aktiv ist und als API-Benutzer festgelegt ist
404 E4040000 E4040001 Nicht gefunden
405 E4050000 E4050001 Methode wird nicht unterstützt. Der Dienst unterstützt nicht die angeforderte HTTP-Methode
500 E5000000 E5000001 Ein System- oder Anwendungsfehler ist aufgetreten. Bitte wenden Sie sich an den Coupa CW-Administrator

 

Vergleichbare Artikel


Kandidaten-Bestätigungs-API

31 May 2021

Kunden, die einige oder alle Onboarding-Aktivitäten von Kandidaten über Anwendungen von Drittanbietern verwalten, können den Prozess der Bestätigung von Kandidaten als Kontingentmitarbeiter mithilfe der CCW-Kandidatenbestätigungs-API nacheinander automatisieren.

Überblick über die CCW-API

31 May 2021

Die REST-API von CCW ermöglicht es Kunden und Partnern, neue Anwendungen zu erstellen und auf neue Weise in CCW zu integrieren, um ihre Fähigkeiten bei der Verwaltung einer befristeten Belegschaft zu verbessern.

API-Explorer

31 May 2021

Der Rest API Explorer von CCW ist ein interaktives Tool, mit dem Benutzer CCW-APIs testen und erkunden können.

Coupa Core API

Unsere RESTful-API bietet robusten Zugriff auf das Lesen, Bearbeiten oder Integrieren Ihrer Daten mit der Coupa-Plattform.

Hinweis: Einige Inhalte wurden maschinell übersetzt.