GET api/{siteCode}/Document/GetDocumentByID/{ID}

Gets the document by identifier.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteCode

The site code.

 integer

Required
ID

The identifier.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

The Document

Document
NameDescriptionTypeAdditional 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:48:48.3438789+00:00",
  "Comment": "sample string 3",
  "DocumentByteArray": "QEA=",
  "FileName": "sample string 4"
}

application/xml, text/xml

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