This api is obsolete since V2. Please use Administrator V2 Api
Get one partner
Format - uuid.
Returns a partner
{
"id": "string",
"name": "string",
"active": true,
"logoUrl": "string"
}
Bad Request
Get Partners
Returns a list of partners
[
{
"id": "string",
"name": "string",
"active": true,
"logoUrl": "string"
}
]
Bad Request
Get users
Format - int32. The offset used for pagination
Format - int32. The number of records to return. Default set to 100
Returns a list of users
[
{
"id": "string",
"externalId": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"ssoUserId": "string",
"displayName": "string",
"active": true,
"createdOn": "string",
"phone": "string",
"nationality": "string",
"atsClientId": "string",
"createdByClientId": "string",
"clusterIds": [
"string"
],
"domainIds": [
"string"
],
"schoolIds": [
"string"
],
"competences": [
{
"competenceId": "string",
"score": 0.0,
"outDated": true,
"rank": 0,
"reportRank": 0
}
]
}
]
Bad Request
Put partner
The partner to create or update
The created or updated partner
{
"id": "string",
"name": "string",
"active": true,
"logoUrl": "string"
}
Bad Request
Send email
Success
{
"fromAddress": "string",
"destinationAddresses": [
"string"
],
"ccAddresses": [
"string"
],
"bccAddresses": [
"string"
],
"subject": "string",
"htmlBody": "string",
"templateRequest": {
"templateName": "string",
"twoLetterIsoLanguageCode": "string",
"placeholders": {}
}
}
Accepted http response code
Bad Request
Get Clients
Returns a list of clients
[
{
"id": "string",
"name": "string",
"partnerId": "string",
"theme": "string",
"talentScanUrl": "string",
"displayName": "string"
}
]
Bad Request
Get one client
Format - uuid.
Returns a client
{
"id": "string",
"name": "string",
"partnerId": "string",
"theme": "string",
"talentScanUrl": "string",
"displayName": "string"
}
Bad Request
Get clients by partner id
Format - uuid.
Returns a list of clients of the specified partner
[
{
"id": "string",
"name": "string",
"partnerId": "string",
"theme": "string",
"talentScanUrl": "string",
"displayName": "string"
}
]
Bad Request
Get template
Contains the template name, language and placeholders
Success
string
Bad Request
Get one partner
Format - uuid.
Returns a partner
{
"id": "string",
"name": "string",
"active": true,
"logoUrl": "string"
}
Bad Request
Get Partners
Returns a list of partners
[
{
"id": "string",
"name": "string",
"active": true,
"logoUrl": "string"
}
]
Bad Request
Get users
Format - int32. The offset used for pagination
Format - int32. The number of records to return. Default set to 100
Returns a list of users
[
{
"id": "string",
"externalId": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"ssoUserId": "string",
"displayName": "string",
"active": true,
"createdOn": "string",
"phone": "string",
"nationality": "string",
"atsClientId": "string",
"createdByClientId": "string",
"clusterIds": [
"string"
],
"domainIds": [
"string"
],
"schoolIds": [
"string"
],
"competences": [
{
"competenceId": "string",
"score": 0.0,
"outDated": true,
"rank": 0,
"reportRank": 0
}
]
}
]
Bad Request
Put partner
The partner to create or update
The created or updated partner
{
"id": "string",
"name": "string",
"active": true,
"logoUrl": "string"
}
Bad Request
Send email
Success
{
"fromAddress": "string",
"destinationAddresses": [
"string"
],
"ccAddresses": [
"string"
],
"bccAddresses": [
"string"
],
"subject": "string",
"htmlBody": "string",
"templateRequest": {
"templateName": "string",
"twoLetterIsoLanguageCode": "string",
"placeholders": {}
}
}
Accepted http response code
Bad Request
Get Clients
Returns a list of clients
[
{
"id": "string",
"name": "string",
"partnerId": "string",
"theme": "string",
"talentScanUrl": "string",
"displayName": "string"
}
]
Bad Request
Get one client
Format - uuid.
Returns a client
{
"id": "string",
"name": "string",
"partnerId": "string",
"theme": "string",
"talentScanUrl": "string",
"displayName": "string"
}
Bad Request
Get clients by partner id
Format - uuid.
Returns a list of clients of the specified partner
[
{
"id": "string",
"name": "string",
"partnerId": "string",
"theme": "string",
"talentScanUrl": "string",
"displayName": "string"
}
]
Bad Request
Get template
Contains the template name, language and placeholders
Success
string
Bad Request