Skip to main

API Technical Specs

Learn how to configure and leverage our services to achieve your toughest recruiting needs.
SaaS     |

Update a Skills List

PUT /v10/skills/(key)

Update a specified list to be optionally used during parsing.

This feature is not recommended and only available in special cases. Reach out to support@sovren.com for more information.

Notes

  • You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center )
  • For custom skills implementation, we recommend using the Sovren Skills Editor utility, which provides a rich GUI for skills management. You can download the utility from My Sovren Portal.

Path Parameters

ParameterData TypeDescription
keystringThe key for the skill data list to update.

Request Body

Contentrequiredstring[]
The Content of data being uploaded. Pass Taxonomy SDF in the first array element and Skills SDF in the second array element.

Sample Request

{ ... 
[ ... 
"",
],
}

Response Body

Infoobject
Information explaining the outcome of the transaction.
Info.Codestring
A response code elaborating on the HTTP status code.
The following is a list of codes that can be returned by the service:

Success – Successful transaction

MissingParameter - A required parameter wasn't provided

InvalidParameter - A parameter was incorrectly specified

AuthenticationError - An error occurred with the credentials provided

DataNotFound - Data with the specified name wasn't found
Info.Messagestring
This message further describes the code providing additional detail.
Info.TransactionIdstring
The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.
Info.EngineVersionstring
The version of the parsing/matching engine running under-the-hood.
Info.ApiVersionstring
The version of the API.
Info.TotalElapsedMillisecondsinteger
How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.
Info.TransactionCostdecimal
How many credits the transaction costs.How many credits the transaction costs.
Info.CustomerDetailsobject
Information about the customer who made the API call.
Value.CustomerDetails.AccountIdstring
The AccountId for the account.
Value.CustomerDetails.Namestring
The customer name on the account.
Value.CustomerDetails.IPAddressstring
The client IP Address where the API call originated.
Value.CustomerDetails.Regionstring
The region for the account, also known as the 'Data Center'.
Value.CustomerDetails.CreditsRemainingdecimal
The number of credits remaining to be used by the account.
Value.CustomerDetails.CreditsUseddecimal
The number of credits used by the account.
Value.CustomerDetails.MaximumConcurrentRequestsinteger
The number of requests that can be made at one time.
Value.CustomerDetails.ExpirationDatedate
The date that the current credits expire.
Valueobject
Contains response data for the transaction.
Value.Keystring
The unique Key for the updated data list.
Value.Namestring
The Name of the updated data list

Sample Response

{ ... 
{ ... 
Code :  "string",Message :  "string",TransactionId :  "string",EngineVersion :  "string",ApiVersion :  "string",TotalElapsedMilliseconds :  0,TransactionCost :  0,{ ... 
AccountId :  "string",Name :  "string",IPAddress :  "string",Region :  "string",CreditsRemaining :  0,CreditsUsed :  0,ExpirationDate :  "2021-12-31",MaximumConcurrentRequests :  0,
},
},
{ ... 
Key :  "",Name :  "",
},
}