Informationen zur Integration des Exposé-Generators.
Mit dem verlingo TalentScout erstellen Sie schnell & einfach hochwertige Kandidatenprofile und teilen diese als interaktive Webprofile mit Ihren Kunden.
Die verlingo TalentScout API ist nach den Prinzipien von REST aufgebaut. Es stehen mehrere Endpunkte zur Verfügung:
Alle Zugriffe erfolgen über HTTPS.
Jeder Nutzer unserer API erhält individuelle Zugangsdaten. Sollten Sie Interesse an einer Integration unseres Services haben, dann schicken Sie uns eine kurze Email an info@verlingo.de
Diese Zugangsdaten geben Sie einfach per HTTP-Authorization Header als API-Schlüssel an.
Im Folgenden finden Sie eine Liste der wichtigsten HTTP-Status-Codes, die die verlingo API ausgibt, und wie Sie diese interpretieren können. Im Allgemeinen stehen 200er-Codes für einen erfolgreichen Request, 400er für einen Fehler in den Request-Daten (zum Beispiel fehlt ein zwingend anzugebender Parameter) und 500er für einen Fehler auf unseren Servern.
| Code | Bedeutung |
|---|---|
| 200 OK | Eine erfolgreiche Anfrage |
| 400 Bad Request | Liegt meist an einem Syntax-Fehler im Request-Body |
| 401 Unauthorized | Falsche oder fehlende Authentifizierung |
| 404 Not Found | Die Ressource konnte nicht gefunden werden |
| 406 Not Acceptable | Das Format der Anfrage wird nicht unterstützt |
| 417 Expectation Failed | Bei der übermittelten Datei handelt es sich um kein Zeugnis oder das Zeugnis konnte nicht analysiert werden |
| 500, 502, 503 Server Error | Serverfehler. Wiederholen Sie die Anfrage nach kurzer Zeit und melden Sie sich bei uns, falls der Fehler dauerhaft auftritt |
Neue Kandidaten können auf zwei Arten importiert werden:
http-Header:
"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel
http-Body:
{
"Dokuments": [
{
"format": "pdf",
"doc": "base64"
},
{
"format": "jpeg",
"doc": "base64"
},
...
],
"Config": {
"VisibleToAllUsers": boolean (optional)
},
"ExternalInfos": {
"CandidateId": "candidateId (optional)",
"UserId": "userId (optional)",
"CustomerId": "customerId (optional)",
"Additional": {
Optionale benutzerdefinierte Informationen als JSON
}
}
}
Die Größe der Dateien pro Anfrage darf 20 MB nicht überschreiten. Zudem müssen die Dateien in einem Base64 enkodierten String vorliegen und UTF-8 kodiert sein.
Wir akzeptieren die Formate PDF, JPG, JPEG, PNG
Das Attribut ‘ExternalInfos‘ ist optional und dient zum Speichern externer Informationen zum Kandidaten.
Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.
{
"message": "Success",
"CandidateId": "candidateId",
"OverviewLink": "overviewLink",
"EditLink": "editLink",
"VariantId": "variantId",
"VariantName": "variantName"
}
http-Header:
"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel
http-Body:
{
"CandidateData": {
"person": {
"name": {
"given": "Marilena",
"family": "Mustermann",
"formattedName": "Marilena Mustermann",
"preferredSalutationCode": "Frau" or "Herr" or ""
},
"nationality": "Deutsch",
"maritalStatus": "ledig",
"birthDate": "birthDate (any format)",
"age": "32",
"placeOfBirth": "Berlin",
"picture": {
"imageB64": "base64",
"format": "jpeg"
},
"email": "marilena@email.de",
"phone": "+49 162 9876543",
"address": {
"line": "Bödekerstraße 77",
"postalCode": "22506",
"city": "Hamburg",
"countryCode": "DE",
"country": "Deutschland",
"formattedAddress": "Bödekerstraße 77 22506 Hamburg Deutschland"
},
"summary": "Persönliches",
"personalNumber": "Personalnummer"
},
"job": {
"jobTitle": "Jobtitel",
"jobReferenceNumber": "Referenznummer"
},
"employment": [
{
"organization": {
"name": "name"
},
"title": "title",
"start": "start",
"end": "end",
"location": {
"city": "city"
},
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"sidejobs": [
{
"organization": {
"name": "name"
},
"title": "title",
"start": "start",
"end": "end",
"location": {
"city": "city"
},
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"internships": [
{
"organization": {
"name": "name"
},
"title": "title",
"start": "start",
"end": "end",
"location": {
"city": "city"
},
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"education": [
{
"institution": {
"name": "name"
},
"location": {
"city": "city"
},
"area": "area",
"studyType": "studyType",
"start": "start",
"end": "end",
"graduation": "graduation",
"graduationGrade": "graduationGrade",
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"study": [
{
"institution": {
"name": "name"
},
"location": {
"city": "city"
},
"area": "area",
"studyType": "studyType",
"start": "start",
"end": "end",
"graduation": "graduation",
"graduationGrade": "graduationGrade",
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"apprenticeship": [
{
"institution": {
"name": "name"
},
"location": {
"city": "city"
},
"area": "area",
"studyType": "studyType",
"start": "start",
"end": "end",
"graduation": "graduation",
"graduationGrade": "graduationGrade",
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"schooling": [
{
"institution": {
"name": "name"
},
"location": {
"city": "city"
},
"area": "area",
"studyType": "studyType",
"start": "start",
"end": "end",
"graduation": "graduation",
"graduationGrade": "graduationGrade",
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"betterment": [
{
"institution": {
"name": "name"
},
"location": {
"city": "city"
},
"area": "area",
"studyType": "studyType",
"start": "start",
"end": "end",
"graduation": "graduation",
"graduationGrade": "graduationGrade",
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"skills": [
{
"name": "name",
"level": 0 or 1 or 2 or 3 or 4 or 5
},
{
"description": "Unterkategorie1",
"content": [
{
"name": "name",
"level": 0 or 1 or 2 or 3 or 4 or 5
},
...
]
},
...
],
"languages": [
{
"language": "language",
"level": 0 or 1 or 2 or 3 or 4 or 5
},
...
],
"interests": [
{
"name": "name"
},
...
],
"certificates": [
{
"organization": {
"name": "name"
},
"title": "title",
"rating": 1 - 6
},
...
],
"employmentInfo": {
"earliestStart": "Verfügbar ab",
"desiredSalary": "Einkommensvorstellung",
"grouping": "Eingruppierung Tarif",
"costRate": "Verrechnungssatz",
"provision": "Vermittlungsprovision",
"additionalInfo": "Weitere Informationen",
"fixum": "Fixum",
"variableSalary": "Variables Gehalt",
"companyVehicle": "Firmenwagen erwünscht",
"noticePeriod": "Kündigungsfrist",
"move": "Umzugsbereitschaft",
"travel": "Reisebereitschaft",
"competion": "Konkurrenzklausel",
"motivationToChange": "Wechselmotivation"
},
"contactPersons": {
"name": "name",
"email": "email",
"phone": "phone",
"avatar": {
"format": "JPEG",
"imageB64": "base64"
}
},
"additionalInfos": "Ergänzende Informationen"
},
"Config": {
"VisibleToAllUsers": boolean (optional)
},
"ExternalInfos": {
"CandidateId": "candidateId (optional)",
"UserId": "userId (optional)",
"CustomerId": "customerId (optional)",
"Additional": {
Optionale benutzerdefinierte Informationen als JSON
}
}
}
Das Attribut ‘ExternalInfos‘ ist optional und dient zum Speichern externer Informationen zum Kandidaten.
Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.
{
"message": "Success",
"CandidateId": "candidateId",
"OverviewLink": "overviewLink",
"EditLink": "editLink",
"VariantId": "variantId",
"VariantName": "variantName"
}
Kandidaten können auf zwei Arten aktualisiert werden:
http-Header:
"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel
http-Body:
{
"CandidateId": "candidateId",
"Documents": [ (optional)
{
"format": "pdf",
"doc": "base64"
},
{
"format": "jpeg",
"doc": "base64"
},
...
],
"Config": {
"VisibleToAllUsers": boolean (optional)
},
"ExternalInfos": {
"CandidateId": "candidateId (optional)",
"UserId": "userId (optional)",
"CustomerId": "customerId (optional)",
"Additional": {
Optionale benutzerdefinierte Informationen als JSON
}
}
}
Die Größe der Dateien pro Anfrage darf 20 MB nicht überschreiten. Zudem müssen die Dateien in einem Base64 enkodierten String vorliegen und UTF-8 kodiert sein.
Wir akzeptieren die Formate PDF, JPG, JPEG, PNG
Das Attribut ‘ExternalInfos‘ ist optional und dient zum Aktualisieren externer Informationen zum Kandidaten.
Im Kandidaten wird eine neue Variante erzeugt mit den Informationen aus den Dokumenten.
Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.
{
"CandidateId": "candidateId",
"OverviewLink": "overviewLink",
"Variants": [
{
"VariantId": "variantId",
"VariantName": "variantName",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"EditLink": "editLink",
"Sharelinks": [
{
"SharelinkId": "sharelinkId",
"CandidateId": "candidateId",
"VariantId": "variantId",
"VariantName": "variantName",
"Customer": "customer",
"Active": boolean,
"ContactFormMandatory": boolean,
"ExternalInfos": externalInfos,
"CustomerLink": "customerLink",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedAt": "2021-01-01T14:28:23.234Z",
"Feedback": [
{
"Type": "viewed" or "liked" or "disliked" or "question",
"Name": "name",
"Company": "company",
"Phone": "phone",
"Email": "email",
"Question": "question",
"CreatedAt": "2021-01-01T14:28:23.234Z"
},
…
]
},
…
]
},
…
],
"VisibleToAllUsers": boolean,
"ExternalInfos": externalInfos,
"Status": "status",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedAt": "2021-01-01T14:28:23.234Z"
}
http-Header:
"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel
http-Body:
{
"CandidateId": "candidateId",
"CandidateData": { (optional)
"person": {
"name": {
"given": "Marilena",
"family": "Mustermann",
"formattedName": "Marilena Mustermann",
"preferredSalutationCode": "Frau" or "Herr" or ""
},
"nationality": "Deutsch",
"maritalStatus": "ledig",
"birthDate": "birthDate (any format)",
"age": "32",
"placeOfBirth": "Berlin",
"picture": {
"imageB64": "base64",
"format": "jpeg"
},
"email": "marilena@email.de",
"phone": "+49 162 9876543",
"address": {
"line": "Bödekerstraße 77",
"postalCode": "22506",
"city": "Hamburg",
"countryCode": "DE",
"country": "Deutschland",
"formattedAddress": "Bödekerstraße 77 22506 Hamburg Deutschland"
},
"summary": "Persönliches",
"personalNumber": "Personalnummer"
},
"job": {
"jobTitle": "Jobtitel",
"jobReferenceNumber": "Referenznummer"
},
"employment": [
{
"organization": {
"name": "name"
},
"title": "title",
"start": "start",
"end": "end",
"location": {
"city": "city"
},
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"sidejobs": [
{
"organization": {
"name": "name"
},
"title": "title",
"start": "start",
"end": "end",
"location": {
"city": "city"
},
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"internships": [
{
"organization": {
"name": "name"
},
"title": "title",
"start": "start",
"end": "end",
"location": {
"city": "city"
},
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"education": [
{
"institution": {
"name": "name"
},
"location": {
"city": "city"
},
"area": "area",
"studyType": "studyType",
"start": "start",
"end": "end",
"graduation": "graduation",
"graduationGrade": "graduationGrade",
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"study": [
{
"institution": {
"name": "name"
},
"location": {
"city": "city"
},
"area": "area",
"studyType": "studyType",
"start": "start",
"end": "end",
"graduation": "graduation",
"graduationGrade": "graduationGrade",
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"apprenticeship": [
{
"institution": {
"name": "name"
},
"location": {
"city": "city"
},
"area": "area",
"studyType": "studyType",
"start": "start",
"end": "end",
"graduation": "graduation",
"graduationGrade": "graduationGrade",
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"schooling": [
{
"institution": {
"name": "name"
},
"location": {
"city": "city"
},
"area": "area",
"studyType": "studyType",
"start": "start",
"end": "end",
"graduation": "graduation",
"graduationGrade": "graduationGrade",
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"betterment": [
{
"institution": {
"name": "name"
},
"location": {
"city": "city"
},
"area": "area",
"studyType": "studyType",
"start": "start",
"end": "end",
"graduation": "graduation",
"graduationGrade": "graduationGrade",
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"skills": [
{
"name": "name",
"level": 0 or 1 or 2 or 3 or 4 or 5
},
{
"description": "Unterkategorie1",
"content": [
{
"name": "name",
"level": 0 or 1 or 2 or 3 or 4 or 5
},
...
]
},
...
],
"languages": [
{
"language": "language",
"level": 0 or 1 or 2 or 3 or 4 or 5
},
...
],
"interests": [
{
"name": "name"
},
...
],
"certificates": [
{
"organization": {
"name": "name"
},
"title": "title",
"rating": 1 - 6
},
...
],
"employmentInfo": {
"earliestStart": "Verfügbar ab",
"desiredSalary": "Einkommensvorstellung",
"grouping": "Eingruppierung Tarif",
"costRate": "Verrechnungssatz",
"provision": "Vermittlungsprovision",
"additionalInfo": "Weitere Informationen",
"fixum": "Fixum",
"variableSalary": "Variables Gehalt",
"companyVehicle": "Firmenwagen erwünscht",
"noticePeriod": "Kündigungsfrist",
"move": "Umzugsbereitschaft",
"travel": "Reisebereitschaft",
"competion": "Konkurrenzklausel",
"motivationToChange": "Wechselmotivation"
},
"contactPersons": {
"name": "name",
"email": "email",
"phone": "phone",
"avatar": {
"format": "JPEG",
"imageB64": "base64"
}
},
"additionalInfos": "Ergänzende Informationen"
},
"Config": {
"VisibleToAllUsers": boolean (optional)
},
"ExternalInfos": {
"CandidateId": "candidateId (optional)",
"UserId": "userId (optional)",
"CustomerId": "customerId (optional)",
"Additional": {
Optionale benutzerdefinierte Informationen als JSON
}
}
}
Das Attribut ‘ExternalInfos‘ ist optional und dient zum Aktualisieren externer Informationen zum Kandidaten.
Im Kandidaten wird eine neue Variante erzeugt mit den Informationen aus dem Attribut „CandidateData“.
Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.
{
"CandidateId": "candidateId",
"OverviewLink": "overviewLink",
"Variants": [
{
"VariantId": "variantId",
"VariantName": "variantName",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"EditLink": "editLink",
"Sharelinks": [
{
"SharelinkId": "sharelinkId",
"CandidateId": "candidateId",
"VariantId": "variantId",
"VariantName": "variantName",
"Customer": "customer",
"Active": boolean,
"ContactFormMandatory": boolean,
"ExternalInfos": externalInfos,
"CustomerLink": "customerLink",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedAt": "2021-01-01T14:28:23.234Z",
"Feedback": [
{
"Type": "viewed" or "liked" or "disliked" or "question",
"Name": "name",
"Company": "company",
"Phone": "phone",
"Email": "email",
"Question": "question",
"CreatedAt": "2021-01-01T14:28:23.234Z"
},
…
]
},
…
]
},
…
],
"VisibleToAllUsers": boolean,
"ExternalInfos": externalInfos,
"Status": "status",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedAt": "2021-01-01T14:28:23.234Z"
}
http-Header:
"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel
http-Body:
{
"CandidateId": "candidateId"
}
Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.
{
"CandidateId": "candidateId",
"OverviewLink": "overviewLink",
"Variants": [
{
"VariantId": "variantId",
"VariantName": "variantName",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"EditLink": "editLink",
"Sharelinks": [
{
"SharelinkId": "sharelinkId",
"CandidateId": "candidateId",
"VariantId": "variantId",
"VariantName": "variantName",
"Customer": "customer",
"Active": boolean,
"ContactFormMandatory": boolean,
"ExternalInfos": externalInfos,
"CustomerLink": "customerLink",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedAt": "2021-01-01T14:28:23.234Z",
"Feedback": [
{
"Type": "viewed" or "liked" or "disliked" or "question",
"Name": "name",
"Company": "company",
"Phone": "phone",
"Email": "email",
"Question": "question",
"CreatedAt": "2021-01-01T14:28:23.234Z"
},
…
]
},
…
]
},
…
],
"VisibleToAllUsers": boolean,
"ExternalInfos": externalInfos,
"Status": "status",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedAt": "2021-01-01T14:28:23.234Z"
}
http-Header:
"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel
http-Body:
{
"Page": int (optional),
"Limit": int (optional),
"ExternalInfos": {
"CandidateId": "candidateId (optional)",
"UserId": "userId (optional)",
"CustomerId": "customerId (optional)"
}
}
Sollten Sie mehrere ExternalInfos angeben, werden diese in der Suche mit UND verknüpft.
Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.
{
" docs": [
{
"CandidateId": "candidateId",
"GivenName": "givenName",
"FamilyName": "familyName",
"VisibleToAllUsers": boolean,
"ExternalInfos": externalInfos,
"CreatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedAt": "2021-01-01T14:28:23.234Z"
},
…
],
"total": 6,
"limit": 3,
"page": 1,
"pages": 2
}
http-Header:
"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel
http-Body:
{
"CandidateId": "candidateId"
"ExportAttachments": boolean
}
Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.
{
{
"CandidateId": "candidateId",
"Variants": [
{
"meta": {
"profileId": "variantId",
"creationDate": "2021-01-01T14:28:23.234Z",
"profileVariant": "variantName"
},
"person": {
"name": {
"given": "Marilena",
"family": "Mustermann",
"formattedName": "Marilena Mustermann",
"preferredSalutationCode": "Frau" or "Herr" or ""
},
"nationality": "Deutsch",
"maritalStatus": "ledig",
"birthDate": "birthDate (any format)",
"age": "32",
"placeOfBirth": "Berlin",
"picture": {
"imageB64": "base64",
"format": "jpeg"
},
"email": "marilena@email.de",
"phone": "+49 162 9876543",
"address": {
"line": "Bödekerstraße 77",
"postalCode": "22506",
"city": "Hamburg",
"countryCode": "DE",
"country": "Deutschland",
"formattedAddress": "Bödekerstraße 77 22506 Hamburg Deutschland"
},
"summary": "Persönliches",
"personalNumber": "Personalnummer"
},
"job": {
"jobTitle": "Jobtitel",
"jobReferenceNumber": "Referenznummer"
},
"employment": [
{
"organization": {
"name": "name"
},
"title": "title",
"start": "start",
"end": "end",
"location": {
"city": "city"
},
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"sidejobs": [
{
"organization": {
"name": "name"
},
"title": "title",
"start": "start",
"end": "end",
"location": {
"city": "city"
},
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"internships": [
{
"organization": {
"name": "name"
},
"title": "title",
"start": "start",
"end": "end",
"location": {
"city": "city"
},
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"education": [
{
"institution": {
"name": "name"
},
"location": {
"city": "city"
},
"area": "area",
"studyType": "studyType",
"start": "start",
"end": "end",
"graduation": "graduation",
"graduationGrade": "graduationGrade",
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"study": [
{
"institution": {
"name": "name"
},
"location": {
"city": "city"
},
"area": "area",
"studyType": "studyType",
"start": "start",
"end": "end",
"graduation": "graduation",
"graduationGrade": "graduationGrade",
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"apprenticeship": [
{
"institution": {
"name": "name"
},
"location": {
"city": "city"
},
"area": "area",
"studyType": "studyType",
"start": "start",
"end": "end",
"graduation": "graduation",
"graduationGrade": "graduationGrade",
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"schooling": [
{
"institution": {
"name": "name"
},
"location": {
"city": "city"
},
"area": "area",
"studyType": "studyType",
"start": "start",
"end": "end",
"graduation": "graduation",
"graduationGrade": "graduationGrade",
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"betterment": [
{
"institution": {
"name": "name"
},
"location": {
"city": "city"
},
"area": "area",
"studyType": "studyType",
"start": "start",
"end": "end",
"graduation": "graduation",
"graduationGrade": "graduationGrade",
"info": "info",
"assignments": [
"assignment1",
"assignment2",
...
]
},
...
],
"skills": [
{
"name": "name",
"level": 0 or 1 or 2 or 3 or 4 or 5
},
{
"description": "Unterkategorie1",
"content": [
{
"name": "name",
"level": 0 or 1 or 2 or 3 or 4 or 5
},
...
]
},
...
],
"languages": [
{
"language": "language",
"level": 0 or 1 or 2 or 3 or 4 or 5
},
...
],
"interests": [
{
"name": "name"
},
...
],
"certificates": [
{
"organization": {
"name": "name"
},
"title": "title",
"rating": 1 - 6,
"attachmentID": "attachmentID" (Referenz auf das zugehörige Attachment)
},
...
],
"employmentInfo": {
"earliestStart": "Verfügbar ab",
"desiredSalary": "Einkommensvorstellung",
"grouping": "Eingruppierung Tarif",
"costRate": "Verrechnungssatz",
"provision": "Vermittlungsprovision",
"additionalInfo": "Weitere Informationen",
"fixum": "Fixum",
"variableSalary": "Variables Gehalt",
"companyVehicle": "Firmenwagen erwünscht",
"noticePeriod": "Kündigungsfrist",
"move": "Umzugsbereitschaft",
"travel": "Reisebereitschaft",
"competion": "Konkurrenzklausel",
"motivationToChange": "Wechselmotivation"
},
"contactPersons": {
"name": "name",
"email": "email",
"phone": "phone",
"avatar": {
"format": "JPEG",
"imageB64": "base64"
}
},
"additionalInfos": "Ergänzende Informationen"
},
...
],
"Attachments": [
{
"type": "Deckblatt",
"content": [
{
"pages": [
{
"imageB64": "base64",
"format": "jpeg",
"ImageHeight": 3508,
"ImageWidth": 2481,
"paragraphs": [
{
"CropNo": 1,
"x": 840.2018244013683,
"xEndpoint": 1639.3836944127706,
"y": 2376.843208383716,
"yEndpoint": 2470.1636436920594,
"width": 799.1818700114025,
"height": 93.32043530834335,
"scaleY": 0.7072405929304447,
"scaleX": 0.7069729947601774,
"Text": "Word1 Word2\n",
"TextConfidence": 93,
"words": [
{
"x": 22.631698973774228,
"y": 22.623135832325673,
"w": 295.6265678449259,
"h": 57.97178557033454,
"text": "Word1",
"confidence": 91
},
{
"x": 343.7189281641961,
"y": 28.278919790407095,
"w": 432.83124287343213,
"h": 52.316001612253125,
"text": "Word2",
"confidence": 96
}
],
"textlines": [
{
"text": "Word1 Word2\n\n",
"confidence": 93,
"fontsize": 29,
"x": 8.486887115165336,
"y": 8.483675937122127,
"w": 782.2080957810718,
"h": 84.83675937122128
}
]
},
...
]
},
...
],
"id": "attachmentID"
},
...
]
},
{
"type": "Anschreiben",
"content": [
{
"pages": [
{
"imageB64": "base64",
"format": "jpeg",
"ImageHeight": 3508,
"ImageWidth": 2481,
"paragraphs": [
{
"CropNo": 1,
"x": 840.2018244013683,
"xEndpoint": 1639.3836944127706,
"y": 2376.843208383716,
"yEndpoint": 2470.1636436920594,
"width": 799.1818700114025,
"height": 93.32043530834335,
"scaleY": 0.7072405929304447,
"scaleX": 0.7069729947601774,
"Text": "Word1 Word2\n",
"TextConfidence": 93,
"words": [
{
"x": 22.631698973774228,
"y": 22.623135832325673,
"w": 295.6265678449259,
"h": 57.97178557033454,
"text": "Word1",
"confidence": 91
},
{
"x": 343.7189281641961,
"y": 28.278919790407095,
"w": 432.83124287343213,
"h": 52.316001612253125,
"text": "Word2",
"confidence": 96
}
],
"textlines": [
{
"text": "Word1 Word2\n\n",
"confidence": 93,
"fontsize": 29,
"x": 8.486887115165336,
"y": 8.483675937122127,
"w": 782.2080957810718,
"h": 84.83675937122128
}
]
},
...
]
},
...
],
"id": "attachmentID"
},
...
]
},
{
"type": "Lebenslauf",
"content": [
{
"pages": [
{
"imageB64": "base64",
"format": "jpeg",
"ImageHeight": 3508,
"ImageWidth": 2481,
"paragraphs": [
{
"CropNo": 1,
"x": 840.2018244013683,
"xEndpoint": 1639.3836944127706,
"y": 2376.843208383716,
"yEndpoint": 2470.1636436920594,
"width": 799.1818700114025,
"height": 93.32043530834335,
"scaleY": 0.7072405929304447,
"scaleX": 0.7069729947601774,
"Text": "Word1 Word2\n",
"TextConfidence": 93,
"words": [
{
"x": 22.631698973774228,
"y": 22.623135832325673,
"w": 295.6265678449259,
"h": 57.97178557033454,
"text": "Word1",
"confidence": 91
},
{
"x": 343.7189281641961,
"y": 28.278919790407095,
"w": 432.83124287343213,
"h": 52.316001612253125,
"text": "Word2",
"confidence": 96
}
],
"textlines": [
{
"text": "Word1 Word2\n\n",
"confidence": 93,
"fontsize": 29,
"x": 8.486887115165336,
"y": 8.483675937122127,
"w": 782.2080957810718,
"h": 84.83675937122128
}
]
},
...
]
},
...
],
"id": "attachmentID"
},
...
]
},
{
"type": "Arbeitszeugnis",
"content": [
{
"pages": [
{
"imageB64": "base64",
"format": "jpeg",
"ImageHeight": 3508,
"ImageWidth": 2481,
"paragraphs": [
{
"CropNo": 1,
"x": 840.2018244013683,
"xEndpoint": 1639.3836944127706,
"y": 2376.843208383716,
"yEndpoint": 2470.1636436920594,
"width": 799.1818700114025,
"height": 93.32043530834335,
"scaleY": 0.7072405929304447,
"scaleX": 0.7069729947601774,
"Text": "Word1 Word2\n",
"TextConfidence": 93,
"words": [
{
"x": 22.631698973774228,
"y": 22.623135832325673,
"w": 295.6265678449259,
"h": 57.97178557033454,
"text": "Word1",
"confidence": 91
},
{
"x": 343.7189281641961,
"y": 28.278919790407095,
"w": 432.83124287343213,
"h": 52.316001612253125,
"text": "Word2",
"confidence": 96
}
],
"textlines": [
{
"text": "Word1 Word2\n\n",
"confidence": 93,
"fontsize": 29,
"x": 8.486887115165336,
"y": 8.483675937122127,
"w": 782.2080957810718,
"h": 84.83675937122128
}
]
},
...
]
},
...
],
"id": "attachmentID"
},
...
]
},
{
"type": "Zeugnisse/Certifikate",
"content": [
{
"pages": [
{
"imageB64": "base64",
"format": "jpeg",
"ImageHeight": 3508,
"ImageWidth": 2481,
"paragraphs": [
{
"CropNo": 1,
"x": 840.2018244013683,
"xEndpoint": 1639.3836944127706,
"y": 2376.843208383716,
"yEndpoint": 2470.1636436920594,
"width": 799.1818700114025,
"height": 93.32043530834335,
"scaleY": 0.7072405929304447,
"scaleX": 0.7069729947601774,
"Text": "Word1 Word2\n",
"TextConfidence": 93,
"words": [
{
"x": 22.631698973774228,
"y": 22.623135832325673,
"w": 295.6265678449259,
"h": 57.97178557033454,
"text": "Word1",
"confidence": 91
},
{
"x": 343.7189281641961,
"y": 28.278919790407095,
"w": 432.83124287343213,
"h": 52.316001612253125,
"text": "Word2",
"confidence": 96
}
],
"textlines": [
{
"text": "Word1 Word2\n\n",
"confidence": 93,
"fontsize": 29,
"x": 8.486887115165336,
"y": 8.483675937122127,
"w": 782.2080957810718,
"h": 84.83675937122128
}
]
},
...
]
},
...
],
"id": "attachmentID"
},
...
]
},
{
"type": "Sonstiges",
"content": [
{
"pages": [
{
"imageB64": "base64",
"format": "jpeg",
"ImageHeight": 3508,
"ImageWidth": 2481,
"paragraphs": [
{
"CropNo": 1,
"x": 840.2018244013683,
"xEndpoint": 1639.3836944127706,
"y": 2376.843208383716,
"yEndpoint": 2470.1636436920594,
"width": 799.1818700114025,
"height": 93.32043530834335,
"scaleY": 0.7072405929304447,
"scaleX": 0.7069729947601774,
"Text": "Word1 Word2\n",
"TextConfidence": 93,
"words": [
{
"x": 22.631698973774228,
"y": 22.623135832325673,
"w": 295.6265678449259,
"h": 57.97178557033454,
"text": "Word1",
"confidence": 91
},
{
"x": 343.7189281641961,
"y": 28.278919790407095,
"w": 432.83124287343213,
"h": 52.316001612253125,
"text": "Word2",
"confidence": 96
}
],
"textlines": [
{
"text": "Word1 Word2\n\n",
"confidence": 93,
"fontsize": 29,
"x": 8.486887115165336,
"y": 8.483675937122127,
"w": 782.2080957810718,
"h": 84.83675937122128
}
]
},
...
]
},
...
],
"id": "attachmentID"
},
...
]
}
],
"ExternalInfos": externalInfos,
"Status": "status",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedAt": "2021-01-01T14:28:23.234Z"
}
http-Header:
"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel
http-Body:
{
"CandidateId": "candidateId"
}
Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.
{
"message": "Candidate successfully deleted."
}
http-Header:
"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel
http-Body:
{
"CandidateId": "candidateId"
"VariantId": "variantId"
}
Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.
{
"message": "Variant and related sharelinks successfully deleted."
}
Exposé-Varianten können auf folgende Arten aktualisiert werden:
http-Header:
"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel
http-Body:
{
"CandidateId": "candidateId",
"Documents": [
{
"format": "pdf",
"doc": "base64"
},
{
"format": "jpeg",
"doc": "base64"
},
...
],
"VariantId": "variantId"
}
Die Größe der Dateien pro Anfrage darf 20 MB nicht überschreiten. Zudem müssen die Dateien in einem Base64 enkodierten String vorliegen und UTF-8 kodiert sein.
Wir akzeptieren die Formate PDF, JPG, JPEG, PNG
Die entsprechende Variante wird mit den extrahierten Informationen aus den Dokumenten ergänzt, dabei werden die ursprünglichen Daten nicht überschrieben.
Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.
{
"CandidateId": "candidateId",
"OverviewLink": "overviewLink",
"Variants": [
{
"VariantId": "variantId",
"VariantName": "variantName",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"EditLink": "editLink",
"Sharelinks": [
{
"SharelinkId": "sharelinkId",
"CandidateId": "candidateId",
"VariantId": "variantId",
"VariantName": "variantName",
"Customer": "customer",
"Active": boolean,
"ContactFormMandatory": boolean,
"ExternalInfos": externalInfos,
"CustomerLink": "customerLink",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedAt": "2021-01-01T14:28:23.234Z",
"Feedback": [
{
"Type": "viewed" or "liked" or "disliked" or "question",
"Name": "name",
"Company": "company",
"Phone": "phone",
"Email": "email",
"Question": "question",
"CreatedAt": "2021-01-01T14:28:23.234Z"
},
…
]
},
…
]
},
…
],
"VisibleToAllUsers": boolean,
"ExternalInfos": externalInfos,
"Status": "status",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedAt": "2021-01-01T14:28:23.234Z"
}
http-Header:
"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel
http-Body:
{
"CandidateId": "candidateId",
"VariantId": "variantId",
"Customer": "customer",
"Config": {
"ContactFormMandatory": boolean (optional)
},
"ExternalInfos": {
"CandidateId": "candidateId (optional)",
"UserId": "userId (optional)",
"CustomerId": "customerId (optional)",
"Additional": {
Optionale benutzerdefinierte Informationen als JSON
}
}
}
Das Attribut 'ExternalInfos' ist optional und dient zum Speichern externer Informationen zum Sharelink.
Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.
{
"SharelinkId": "sharelinkId",
"CandidateId": "candidateId",
"VariantId": "variantId",
"VariantName": "variantName",
"Customer": "customer",
"Active": boolean,
"ContactFormMandatory": boolean,
"ExternalInfos": externalInfos,
"CustomerLink": "customerLink",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedAt": "2021-01-01T14:28:23.234Z"
}
http-Header:
"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel
http-Body:
{
"SharelinkId": "sharelinkId"
}
Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.
{
"SharelinkId": "sharelinkId",
"CandidateId": "candidateId",
"VariantId": "variantId",
"VariantName": "variantName",
"Customer": "customer",
"Active": boolean,
"ContactFormMandatory": boolean,
"ExternalInfos": externalInfos,
"CustomerLink": "customerLink",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedAt": "2021-01-01T14:28:23.234Z",
"Feedback": [
{
"Type": "viewed" or "liked" or "disliked" or "question",
"Name": "name",
"Company": "company",
"Phone": "phone",
"Email": "email",
"Question": "question",
"CreatedAt": "2021-01-01T14:28:23.234Z"
},
…
]
}
Das Feedback des Kunden zum Kandidaten ist von Neu nach Alt sortiert und die Attribute sind abhängig vom Typ und der Konfiguration.
http-Header:
"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel
http-Body:
{
"SharelinkId": "sharelinkId",
"Customer": "customer",
"Config": {
"ContactFormMandatory": boolean (optional),
"Active": boolean (optional)
},
"ExternalInfos": {
"CandidateId": "candidateId (optional)",
"UserId": "userId (optional)",
"CustomerId": "customerId (optional)",
"Additional": {
Optionale benutzerdefinierte Informationen als JSON
}
}
}
Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.
{
"SharelinkId": "sharelinkId",
"CandidateId": "candidateId",
"VariantId": "variantId",
"VariantName": "variantName",
"Customer": "customer",
"Active": boolean,
"ContactFormMandatory": boolean,
"ExternalInfos": externalInfos,
"CustomerLink": "customerLink",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedAt": "2021-01-01T14:28:23.234Z",
"Feedback": [
{
"Type": "viewed" or "liked" or "disliked" or "question",
"Name": "name",
"Company": "company",
"Phone": "phone",
"Email": "email",
"Question": "question",
"CreatedAt": "2021-01-01T14:28:23.234Z"
},
…
]
}
Das Feedback des Kunden zum Kandidaten ist von Neu nach Alt sortiert und die Attribute sind abhängig vom Typ und der Konfiguration.
http-Header:
"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel
http-Body:
{
"SharelinkId": "sharelinkId"
}
Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.
{
"message": "Sharelink successfully deleted."
}