GET api/{siteCode}/Document/GetListOfDocuments?jobNumber={jobNumber}&custAccNum={custAccNum}

Gets the list of document properties stored against the specified Job Number where the documents have been published to the specified customer account number.

Request Information

URI Parameters

Name	Description	Type	Additional information
siteCode	The site code.	integer	Required
jobNumber	The job number.	string	Required
custAccNum	The customer account number.	string	Required

Body Parameters

None.

Response Information

Resource Description

A list of document properties

Collection of Document

Name	Description	Type	Additional information
DocumentID		integer	None.
DocumentName	The familiar name of the document.	string	None.
StoredDate		date	None.
Comment		string	None.
DocumentByteArray		Collection of byte	None.
FileName	The actual name and type extension.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DocumentID": 1,
    "DocumentName": "sample string 2",
    "StoredDate": "2025-02-05T06:38:25.203633+00:00",
    "Comment": "sample string 3",
    "DocumentByteArray": "QEA=",
    "FileName": "sample string 4"
  },
  {
    "DocumentID": 1,
    "DocumentName": "sample string 2",
    "StoredDate": "2025-02-05T06:38:25.203633+00:00",
    "Comment": "sample string 3",
    "DocumentByteArray": "QEA=",
    "FileName": "sample string 4"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDocument xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Document>
    <DocumentID>1</DocumentID>
    <DocumentName>sample string 2</DocumentName>
    <StoredDate>2025-02-05T06:38:25.203633+00:00</StoredDate>
    <Comment>sample string 3</Comment>
    <DocumentByteArray>QEA=</DocumentByteArray>
    <FileName>sample string 4</FileName>
  </Document>
  <Document>
    <DocumentID>1</DocumentID>
    <DocumentName>sample string 2</DocumentName>
    <StoredDate>2025-02-05T06:38:25.203633+00:00</StoredDate>
    <Comment>sample string 3</Comment>
    <DocumentByteArray>QEA=</DocumentByteArray>
    <FileName>sample string 4</FileName>
  </Document>
</ArrayOfDocument>