GET documents/getDocumentDetailById?DocumentId={DocumentId}&TenantId={TenantId}&UserId={UserId}

Request Information

URI Parameters

Name	Type	Additional information
DocumentId	integer	Required
TenantId	integer	Required
UserId	integer	Required

Body Parameters

None.

Response Information

Resource Description

DocumentHeader

Name	Type	Additional information
DocumentId	integer	None.
DocumentType	string	None.
LinkedTo	string	None.
CaptureDate	date	None.
CaptureUser	string	None.
Notes	string	None.
DocIcon	string	None.
DocReference	string	None.
CanActivate	boolean	None.
Url	string	None.
OpenDirect	boolean	None.
WasSuccessful	boolean	None.
Message	string	None.
RefId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "DocumentId": 1,
  "DocumentType": "sample string 2",
  "LinkedTo": "sample string 3",
  "CaptureDate": "2026-04-17T11:36:40.2016175+00:00",
  "CaptureUser": "sample string 5",
  "Notes": "sample string 6",
  "DocIcon": "sample string 7",
  "DocReference": "sample string 8",
  "CanActivate": true,
  "Url": "sample string 9",
  "OpenDirect": true,
  "WasSuccessful": true,
  "Message": "sample string 12",
  "RefId": 13
}

text/html

Sample:

{"DocumentId":1,"DocumentType":"sample string 2","LinkedTo":"sample string 3","CaptureDate":"2026-04-17T11:36:40.2016175+00:00","CaptureUser":"sample string 5","Notes":"sample string 6","DocIcon":"sample string 7","DocReference":"sample string 8","CanActivate":true,"Url":"sample string 9","OpenDirect":true,"WasSuccessful":true,"Message":"sample string 12","RefId":13}

application/xml, text/xml

Sample:

<DocumentHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Documents">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Common">sample string 12</Message>
  <RefId xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Common">13</RefId>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Common">true</WasSuccessful>
  <CanActivate>true</CanActivate>
  <CaptureDate>2026-04-17T11:36:40.2016175+00:00</CaptureDate>
  <CaptureUser>sample string 5</CaptureUser>
  <DocIcon>sample string 7</DocIcon>
  <DocReference>sample string 8</DocReference>
  <DocumentId>1</DocumentId>
  <DocumentType>sample string 2</DocumentType>
  <LinkedTo>sample string 3</LinkedTo>
  <Notes>sample string 6</Notes>
  <OpenDirect>true</OpenDirect>
  <Url>sample string 9</Url>
</DocumentHeader>