Index Multiple Documents

API Technical Specs Policies FAQs Documents Release Notes

POST /v9/index/(indexId)/documents

Adds multiple documents to an index.

Notes

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )
Documents parsed by an account without AI Matching enabled will never be able to be used for matching/searching. For more information on enabling AI Matching reach out to sales@sovren.com

Path Parameters

Parameter	Data Type	Description
indexId	string	The id for the index where the documents should be added (case-insensitive).

Request Body

DocumentIdrequiredstring

The id of the current document. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.

ParsedDocumentrequiredstring

Parsed JSON from the Sovren Resume or Job Order Parser.

CustomIdsrequiredstring[]

The custom ids you want the current document to have.

Sample Request

[ ...
{
"DocumentId" : "","ParsedDocument" : "",+-"CustomIds" : [ ...
""]}]

Response Body

Infoobject

Information explaining the outcome of the transaction.

›Show Child Properties

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.

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.

›Show Child Properties

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

{ ...
+-"Info" :  { ...
"Code" :  "","Message" :  ""},+-"Value" :  [ ...
{
"DocumentId" :  "","Code" :  "","SubCode" :  "","Message" :  ""}]}