Skip to main

API Technical Specs

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

Index Multiple Job Orders

POST /v10/index/(indexId)/joborders

Adds multiple job orders to an index.

  • You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )
  • Skills Normalization must be included to index documents using V2 Skills Taxonomy. These algorithms ignore raw skills and only consider the normalized skill concepts for skills category scoring. This leads to improved scoring and ranking because normalization produces less false negatives than simple exact keyword matching.

Path Parameters

ParameterData TypeDescription
indexIdstringThe id for the index where the documents should be added (case-insensitive).

Request Body

The list of jobs to index.
The id of the current document. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.
The parsed JobData from the Sovren Job Order Parser. See Parse a Job Order
The user-defined tags you want the current document to have.

Sample Request

{ ... 
[ ... 
"DocumentId" :  "","JobData" :  "...",[ ... 

Response Body

Information explaining the outcome of the transaction.
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

SomeErrors – Some items in the bulk request failed

MissingParameter - A required parameter wasn't provided

InvalidParameter - A parameter was incorrectly specified

AuthenticationError - An error occurred with the credentials provided

Unauthorized - Your account doesn't have permission to perform this operation

DataNotFound - Data with the specified name wasn't found

ConstraintError - Data in the request is not allowed with the specific action being requested.
This message further describes the code providing additional detail.
The (GUID) id for a specific API transaction. Use this when contacting about issues.
The version of the parsing/matching engine running under-the-hood.
The version of the API.
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.
How many credits the transaction costs.How many credits the transaction costs.
Information about the customer who made the API call.
The AccountId for the account.
The customer name on the account.
The client IP Address where the API call originated.
The region for the account, also known as the 'Data Center'.
The number of credits remaining to be used by the account.
The number of credits used by the account.
The number of requests that can be made at one time. If using sub-accounts, this is the maximum number of concurent requests across all accounts, not just this single sub-account.
The date that the current credits expire.
An array of objects representing the individual document add responses. This is used to determine which documents failed in the event of an error.
Id of the specific document represented in the response
The following is a list of codes that can be returned by the service:

Success – Successful transaction

Error – The specified document had an error during indexing
The following is a list of subcodes that can be returned by the service:

Success – Successful transaction

InvalidParameter - A parameter was incorrectly specified

UnhandledException - Unexpected error occurred
This message further describes the code/subcode providing additional detail.

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
[ ... 
"DocumentId" :  "","Code" :  "","SubCode" :  "","Message" :  ""