POST dosconnect/document-list

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
ApplicationNumber	string	None.
ApplicationModuleDD	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1",
  "ApplicationNumber": "sample string 2",
  "ApplicationModuleDD": 1
}

application/xml, text/xml

Sample:

<DocumentListInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <APIKey>sample string 1</APIKey>
  <ApplicationModuleDD>1</ApplicationModuleDD>
  <ApplicationNumber>sample string 2</ApplicationNumber>
</DocumentListInput>

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 'DocumentListInput'.

Response Information

Resource Description

DocumentListOutput

Name	Description	Type	Additional information
Files		Collection of DocumentListItem	None.
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Files": [
    {
      "DocumentID": 1,
      "DocumentTypeID": 1,
      "DocumentName": "sample string 2"
    },
    {
      "DocumentID": 1,
      "DocumentTypeID": 1,
      "DocumentName": "sample string 2"
    }
  ],
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<DocumentListOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <ReturnStatus xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Core">
    <Results>1</Results>
    <ReturnCode>1</ReturnCode>
    <ReturnMessage>sample string 2</ReturnMessage>
  </ReturnStatus>
  <Files>
    <DocumentListItem>
      <DocumentID>1</DocumentID>
      <DocumentName>sample string 2</DocumentName>
      <DocumentTypeID>1</DocumentTypeID>
    </DocumentListItem>
    <DocumentListItem>
      <DocumentID>1</DocumentID>
      <DocumentName>sample string 2</DocumentName>
      <DocumentTypeID>1</DocumentTypeID>
    </DocumentListItem>
  </Files>
</DocumentListOutput>