POST api/GetDocument

Request Information

URI Parameters

None.

Body Parameters

DocumentInput
NameDescriptionTypeAdditional information
CandidateDocumentMappingID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CandidateDocumentMappingID": "sample string 1"
}

application/xml, text/xml

Sample:
<DocumentInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RESTWebAPIForPaperlessOnboarding.Models">
  <CandidateDocumentMappingID>sample string 1</CandidateDocumentMappingID>
</DocumentInput>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DocumentInput'.

Response Information

Resource Description

GetDocumentOutput
NameDescriptionTypeAdditional information
FilePath

string

None.

Ext

string

None.

File

string

None.

Link

string

None.

Status

string

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "FilePath": "sample string 1",
  "Ext": "sample string 2",
  "File": "sample string 3",
  "Link": "sample string 4",
  "Status": "sample string 5",
  "Message": "sample string 6"
}

application/xml, text/xml

Sample:
<GetDocumentOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RESTWebAPIForPaperlessOnboarding.Models">
  <Ext>sample string 2</Ext>
  <File>sample string 3</File>
  <FilePath>sample string 1</FilePath>
  <Link>sample string 4</Link>
  <Message>sample string 6</Message>
  <Status>sample string 5</Status>
</GetDocumentOutput>