POST api/IndexPreview

Request Information

URI Parameters

None.

Body Parameters

Collection of Documents

Name	Description	Type	Additional information
DocumentName		string	None.
ExternalId		string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "DocumentName": "sample string 1",
    "ExternalId": "sample string 2"
  },
  {
    "DocumentName": "sample string 1",
    "ExternalId": "sample string 2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDocuments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPItest.Models">
  <Documents>
    <DocumentName>sample string 1</DocumentName>
    <ExternalId>sample string 2</ExternalId>
  </Documents>
  <Documents>
    <DocumentName>sample string 1</DocumentName>
    <ExternalId>sample string 2</ExternalId>
  </Documents>
</ArrayOfDocuments>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of IndexDetails

Name	Type	Additional information
Documentname	string	None.
PageCountStart	integer	None.
PageCountEnd	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Documentname": "sample string 1",
    "PageCountStart": 2,
    "PageCountEnd": 3
  },
  {
    "Documentname": "sample string 1",
    "PageCountStart": 2,
    "PageCountEnd": 3
  }
]

application/xml, text/xml

Sample:

<ArrayOfIndexDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPItest.Models">
  <IndexDetails>
    <Documentname>sample string 1</Documentname>
    <PageCountEnd>3</PageCountEnd>
    <PageCountStart>2</PageCountStart>
  </IndexDetails>
  <IndexDetails>
    <Documentname>sample string 1</Documentname>
    <PageCountEnd>3</PageCountEnd>
    <PageCountStart>2</PageCountStart>
  </IndexDetails>
</ArrayOfIndexDetails>