Introduction
The Sharepool API is designed according to the principles of REST set up. Several endpoints are available:
All access is via HTTPS.
Information about the integration of the Sharepool component.
With the Sharepool component, you can share high-quality candidate profiles with your customers as interactive web profiles. The key added value of this component is that you can share as many candidate profiles as you like with as many customers as you like using just one link.
The Sharepool API is designed according to the principles of REST set up. Several endpoints are available:
All access is via HTTPS.
Each user of our API receives individual access data. If you are interested in integrating our service, please send us a short email to info@verlingo.de
You simply specify these credentials as the API key via the HTTP Authorization Header.
Below is a list of the most important HTTP status codes that the verlingo API outputs and how you can interpret them. In general, 200 codes represent a successful request, 400 codes represent an error in the request data (for example, a mandatory parameter is missing), and 500 codes represent an error on our servers.
Code | Meaning |
---|---|
200 OK | A successful request |
400 Bad Request | This is usually due to a syntax error in the request body. |
401 Unauthorized | Incorrect or missing authentication |
404 Not Found | The resource could not be found |
406 Not Acceptable | The format of the request is not supported |
417 Expectation Failed | The information submitted is incorrect or incomplete |
500, 502, 503 Server Error | Server error. Repeat the request after a short time and report to us if the error occurs permanently |
http-Header:
"Content-Type": "application/json"
"Authorization": YOUR_API key
http-Body:
{
"Title": "title",
"Description": "description",
"Logo": {
"Format": "png | jpeg",
"ImageB64": "base64"
},
"CandidatesAndVariants": [
{
"CandidateId": "candidateId",
"VariantId": "variantId",
"ExternalInfos": {
Optional user-defined information as JSON
}
},
…
],
"Config": {
"ContactFormMandatory": boolean (optional),
"UseUserOfExternalUserId": boolean (optional)
},
"ExternalInfos": {
"UserId": "userId (optional)",
"Additional": {
Optional user-defined information as JSON
}
}
}
If the 'Config.UseUserOfExternalUserId' attribute is set to true, the 'ExternalInfos.UserId' attribute must also be submitted and the action will then be performed under that user.
You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.
{
"SharepoolId": "sharepoolId",
"Title": "title",
"Description": "description",
"CandidatesAndVariants": [
{
"CandidateId": "candidateId",
"VariantId": "variantId",
"Variant": {
"VariantId": "variantId",
"VariantName": "variantName",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"CreatedBy": "createdBy",
"UpdatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedBy": "updatedBy",
"EditLink": "editLink"
},
"ExternalInfos": externalInfos
},
…
],
"Active": boolean,
"ContactFormMandatory": boolean,
"ExternalInfos": externalInfos,
"RemainingDaysUntilAutoDeactivation": 28,
"DateOfAutoDeactivation": "2022-09-20",
"CreatedAt": "2022-08-23T15:43:01.042Z",
"UpdatedAt": "2022-08-23T15:43:01.042Z",
"CreatedBy": "createdBy",
"UpdatedBy": "updatedBy"
}
http-Header:
"Content-Type": "application/json"
"Authorization": YOUR_API key
http-Body:
{
"SharepoolId": "sharepoolId"
}
You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.
{
"SharepoolId": "sharepoolId",
"Title": "title",
"Description": "description",
"CandidatesAndVariants": [
{
"CandidateId": "candidateId",
"VariantId": "variantId",
"Variant": {
"VariantId": "variantId",
"VariantName": "variantName",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"CreatedBy": "createdBy",
"UpdatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedBy": "updatedBy",
"EditLink": "editLink"
},
"ExternalInfos": externalInfos
},
…
],
"Active": boolean,
"ContactFormMandatory": boolean,
"ExternalInfos": externalInfos,
"RemainingDaysUntilAutoDeactivation": 28,
"DateOfAutoDeactivation": "2022-09-20",
"CreatedAt": "2022-08-23T15:43:01.042Z",
"UpdatedAt": "2022-08-23T15:43:01.042Z",
"CreatedBy": "createdBy",
"UpdatedBy": "updatedBy"
}
http-Header:
"Content-Type": "application/json"
"Authorization": YOUR_API key
http-Body:
{
"SharepoolId": "sharepoolId",
"Title": "title",
"Description": "description",
"Logo": {
"Format": "png | jpeg",
"ImageB64": "base64"
},
"CandidatesAndVariants": [
{
"CandidateId": "candidateId",
"VariantId": "variantId",
"ExternalInfos": {
Optional user-defined information as JSON
}
},
…
],
"Active": boolean,
"Config": {
"ContactFormMandatory": boolean,
"UseUserOfExternalUserId": boolean
},
"ExternalInfos": {
"UserId": "userId",
"Additional": {
Optional user-defined information as JSON
}
}
}
If the 'Config.UseUserOfExternalUserId' attribute is set to true, the 'ExternalInfos.UserId' attribute must also be submitted and the action will then be performed under that user.
You can pass only the information that should be updated.
You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.
{
"SharepoolId": "sharepoolId",
"Title": "title",
"Description": "description",
"CandidatesAndVariants": [
{
"CandidateId": "candidateId",
"VariantId": "variantId",
"Variant": {
"VariantId": "variantId",
"VariantName": "variantName",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"CreatedBy": "createdBy",
"UpdatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedBy": "updatedBy",
"EditLink": "editLink"
},
"ExternalInfos": externalInfos
},
…
],
"Active": boolean,
"ContactFormMandatory": boolean,
"ExternalInfos": externalInfos,
"RemainingDaysUntilAutoDeactivation": 28,
"DateOfAutoDeactivation": "2022-09-20",
"CreatedAt": "2022-08-23T15:43:01.042Z",
"UpdatedAt": "2022-08-23T15:43:01.042Z",
"CreatedBy": "createdBy",
"UpdatedBy": "updatedBy"
}
http-Header:
"Content-Type": "application/json"
"Authorization": YOUR_API key
http-Body:
{
"SharepoolId": "sharepoolId",
"Config": {
"UseUserOfExternalUserId": boolean
},
"ExternalInfos": {
"UserId": "userId"
}
}
If the 'Config.UseUserOfExternalUserId' attribute is set to true, the 'ExternalInfos.UserId' attribute must also be submitted and the action will then be performed under that user.
You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.
{
"message": "Sharepool successfully deleted."
}
http-Header:
"Content-Type": "application/json"
"Authorization": YOUR_API key
http-Body:
{
"SharepoolId": "sharepoolId",
"AddCandidateId": "candidateId",
"AddVariantId": "variantId",
"AddExternalInfos": {
Optional user-defined information as JSON
},
"Config": {
"UseUserOfExternalUserId": boolean
},
"ExternalInfos": {
"UserId": "userId"
}
}
If the 'Config.UseUserOfExternalUserId' attribute is set to true, the 'ExternalInfos.UserId' attribute must also be submitted and the action will then be performed under that user.
You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.
{
"SharepoolId": "sharepoolId",
"Title": "title",
"Description": "description",
"CandidatesAndVariants": [
{
"CandidateId": "candidateId",
"VariantId": "variantId",
"Variant": {
"VariantId": "variantId",
"VariantName": "variantName",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"CreatedBy": "createdBy",
"UpdatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedBy": "updatedBy",
"EditLink": "editLink"
},
"ExternalInfos": externalInfos
},
…
],
"Active": boolean,
"ContactFormMandatory": boolean,
"ExternalInfos": externalInfos,
"RemainingDaysUntilAutoDeactivation": 28,
"DateOfAutoDeactivation": "2022-09-20",
"CreatedAt": "2022-08-23T15:43:01.042Z",
"UpdatedAt": "2022-08-23T15:43:01.042Z",
"CreatedBy": "createdBy",
"UpdatedBy": "updatedBy"
}
http-Header:
"Content-Type": "application/json"
"Authorization": YOUR_API key
http-Body:
{
"SharepoolId": "sharepoolId",
"RemoveCandidateId": "candidateId",
"RemoveVariantId": "variantId",
"Config": {
"UseUserOfExternalUserId": boolean
},
"ExternalInfos": {
"UserId": "userId"
}
}
If the 'Config.UseUserOfExternalUserId' attribute is set to true, the 'ExternalInfos.UserId' attribute must also be submitted and the action will then be performed under that user.
You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.
{
"SharepoolId": "sharepoolId",
"Title": "title",
"Description": "description",
"CandidatesAndVariants": [
{
"CandidateId": "candidateId",
"VariantId": "variantId",
"Variant": {
"VariantId": "variantId",
"VariantName": "variantName",
"CreatedAt": "2021-01-01T14:28:23.234Z",
"CreatedBy": "createdBy",
"UpdatedAt": "2021-01-01T14:28:23.234Z",
"UpdatedBy": "updatedBy",
"EditLink": "editLink"
},
"ExternalInfos": externalInfos
},
…
],
"Active": boolean,
"ContactFormMandatory": boolean,
"ExternalInfos": externalInfos,
"RemainingDaysUntilAutoDeactivation": 28,
"DateOfAutoDeactivation": "2022-09-20",
"CreatedAt": "2022-08-23T15:43:01.042Z",
"UpdatedAt": "2022-08-23T15:43:01.042Z",
"CreatedBy": "createdBy",
"UpdatedBy": "updatedBy"
}
http-Header:
"Content-Type": "application/json"
"Authorization": YOUR_API key
http-Body:
{
"SharepoolId": "sharepoolId",
"Customer": "customer",
"Config": {
"UseUserOfExternalUserId": boolean
},
"ExternalInfos": {
"UserId": "userId"
}
}
If the 'Config.UseUserOfExternalUserId' attribute is set to true, the 'ExternalInfos.UserId' attribute must also be submitted and the action will then be performed under that user.
The 'Customer' attribute is mandatory and is used to identify the recipient and track the actions performed by him/her.
You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.
{
"SharepoolId": "sharepoolId",
"Active": boolean,
"ContactFormMandatory": boolean,
"RemainingDaysUntilAutoDeactivation": 28,
"DateOfAutoDeactivation": "2022-09-20",
"Customer": "customer",
"CustomerLink": "customerLink",
"PreviewLink": "previewLink"
}