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.

Path Parameters

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

Request Body

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

Sample Request

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

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

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
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. If using sub-accounts, this is the maximum number of concurent requests across all accounts, not just this single sub-account.
Value.CustomerDetails.ExpirationDatedate
The date that the current credits expire.
Valueobject[]
An array of objects representing the individual document add responses. This is used to determine which documents failed in the event of an error.
Value[i].DocumentIdstring
Id of the specific document represented in the response
Value[i].Codestring
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
Value[i].SubCodestring
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
Value[i].Messagestring
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" :  ""
}
]
}