GET api/docDocument/{id}

Return a single value from the Documents table using the primary key as ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The Documents Primary Key.

integer

Required

Body Parameters

None.

Response Information

Resource Description

docDocumentDb
NameDescriptionTypeAdditional information
DocumentID

integer

None.

CategoryID

integer

None.

CategoryName

string

None.

Title

string

Required

Max length: 120

Description

string

None.

InLibrary

boolean

None.

IsDeleted

boolean

None.

IsArchived

boolean

None.

CreatedBy

integer

None.

CreatedByName

string

None.

CreatedDate

date

None.

UpdatedBy

integer

None.

UpdatedByName

string

None.

UpdatedDate

date

None.

SetVersion

string

None.

ReferenceNumber

integer

None.

results

Collection of ValidationResult

None.

Response Formats

application/json, text/json

Sample:
{
  "results": null,
  "DocumentID": 1,
  "CategoryID": 1,
  "CategoryName": "sample string 2",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "InLibrary": true,
  "IsDeleted": true,
  "IsArchived": true,
  "CreatedBy": 8,
  "CreatedByName": "sample string 9",
  "CreatedDate": "2025-12-06T23:43:11.3936088+00:00",
  "UpdatedBy": 11,
  "UpdatedByName": "sample string 12",
  "UpdatedDate": "2025-12-06T23:43:11.3936088+00:00",
  "SetVersion": "sample string 14",
  "ReferenceNumber": 15
}

application/xml, text/xml

Sample:
<docDocumentDb xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
  <results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
  <CategoryID>1</CategoryID>
  <CategoryName>sample string 2</CategoryName>
  <CreatedBy>8</CreatedBy>
  <CreatedByName>sample string 9</CreatedByName>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:43:11.3936088Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <Description>sample string 4</Description>
  <DocumentID>1</DocumentID>
  <InLibrary>true</InLibrary>
  <IsArchived>true</IsArchived>
  <IsDeleted>true</IsDeleted>
  <ReferenceNumber>15</ReferenceNumber>
  <SetVersion>sample string 14</SetVersion>
  <Title>sample string 3</Title>
  <UpdatedBy>11</UpdatedBy>
  <UpdatedByName>sample string 12</UpdatedByName>
  <UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:43:11.3936088Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </UpdatedDate>
</docDocumentDb>