POST api/Site/DocumentList

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DocumentNum	integer	None.
ReturnListFlag	string	None.
Option	string	None.
KeyNum	integer	None.
KeyType	string	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "DocumentNum": 1,
  "ReturnListFlag": "sample string 1",
  "Option": "sample string 2",
  "KeyNum": 1,
  "KeyType": "sample string 3",
  "SessionNum": 4,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 5",
  "StagesURL": "sample string 6"
}

application/xml, text/xml

Sample:

<DocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 6</StagesURL>
  <ApplicationCode>sample string 5</ApplicationCode>
  <SessionNum>4</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <KeyNum>1</KeyNum>
  <KeyType>sample string 3</KeyType>
  <DocumentNum>1</DocumentNum>
  <Option>sample string 2</Option>
  <ReturnListFlag>sample string 1</ReturnListFlag>
</DocumentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DocumentListQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of DocumentListResult	None.
Success	boolean	None.
UserErrorMessage	string	None.
ErrorTypeNum	integer	None.
SqlConnectionLost	boolean	None.
ClientVersion	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ExcludeColumnList": [
    "sample string 1",
    "sample string 2"
  ],
  "ResultSet": [
    {
      "BarcodePrinterFlag": true,
      "Count": 1,
      "Date": "2025-05-03T22:28:46.7314442-07:00",
      "Description": "sample string 1",
      "DocumentNum": 1,
      "KeyNum": 1,
      "KeyType": "sample string 2",
      "Label": "sample string 3",
      "Option": "sample string 4",
      "PageCount": 1,
      "Prefix": "sample string 5",
      "PrinterName": "sample string 6",
      "ShortName": "sample string 7"
    },
    {
      "BarcodePrinterFlag": true,
      "Count": 1,
      "Date": "2025-05-03T22:28:46.7314442-07:00",
      "Description": "sample string 1",
      "DocumentNum": 1,
      "KeyNum": 1,
      "KeyType": "sample string 2",
      "Label": "sample string 3",
      "Option": "sample string 4",
      "PageCount": 1,
      "Prefix": "sample string 5",
      "PrinterName": "sample string 6",
      "ShortName": "sample string 7"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<DocumentListQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Stages">
  <ClientVersion>sample string 5</ClientVersion>
  <ErrorTypeNum>3</ErrorTypeNum>
  <SqlConnectionLost>true</SqlConnectionLost>
  <Success>true</Success>
  <UserErrorMessage>sample string 2</UserErrorMessage>
  <ExcludeColumnList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeColumnList>
  <ResultSet>
    <DocumentListResult>
      <BarcodePrinterFlag>true</BarcodePrinterFlag>
      <Count>1</Count>
      <Date>2025-05-03T22:28:46.7314442-07:00</Date>
      <Description>sample string 1</Description>
      <DocumentNum>1</DocumentNum>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 2</KeyType>
      <Label>sample string 3</Label>
      <Option>sample string 4</Option>
      <PageCount>1</PageCount>
      <Prefix>sample string 5</Prefix>
      <PrinterName>sample string 6</PrinterName>
      <ShortName>sample string 7</ShortName>
    </DocumentListResult>
    <DocumentListResult>
      <BarcodePrinterFlag>true</BarcodePrinterFlag>
      <Count>1</Count>
      <Date>2025-05-03T22:28:46.7314442-07:00</Date>
      <Description>sample string 1</Description>
      <DocumentNum>1</DocumentNum>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 2</KeyType>
      <Label>sample string 3</Label>
      <Option>sample string 4</Option>
      <PageCount>1</PageCount>
      <Prefix>sample string 5</Prefix>
      <PrinterName>sample string 6</PrinterName>
      <ShortName>sample string 7</ShortName>
    </DocumentListResult>
  </ResultSet>
</DocumentListQueryResult>