GET api/v{version}/laboratory/{laboratoryId}/document?FolderID={FolderID}&PostedByUserAsSubject={PostedByUserAsSubject}&Title={Title}&IncludePrivate={IncludePrivate}&MIMEType={MIMEType}&TopCount={TopCount}&GraphicsOnly={GraphicsOnly}&OnDate={OnDate}&Size={Size}

Gets a list of documents belonging to the specified Laboratory.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
laboratoryId

integer

Required

FolderID

Gets or sets the folder identifier.

integer

None.

PostedByUserAsSubject

Gets or sets the posted by user as subject.

integer

None.

Title

Gets or sets the title.

string

None.

IncludePrivate

Gets or sets a value indicating whether [include private].

boolean

None.

MIMEType

Gets or sets the type of the MIME.

string

None.

TopCount

Gets or sets the top count.

integer

None.

GraphicsOnly

Gets or sets a value indicating whether [graphics only].

boolean

None.

OnDate

Gets or sets the on date.

date

None.

Size

Gets or sets the size.

DocumentSize

None.

version

string

None.

Body Parameters

None.

Response Information

Resource Description

ResponseOfIEnumerableOfDocumentListModel
NameDescriptionTypeAdditional information
Data

Collection of DocumentListModel

None.

StatusCode

Gets or sets the status code.

HttpStatusCode

None.

StatusDescription

Gets or sets the status description.

string

None.

Errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "data": [
    {
      "documentID": 1,
      "laboratoryID": 1,
      "title": "sample string 1",
      "mimeType": "sample string 2",
      "lastModifiedBy": "sample string 3",
      "folderName": "sample string 4",
      "documentStatus": "sample string 5",
      "checkedOut": true,
      "allowRevisions": true,
      "checkedOutBy": "sample string 8",
      "description": "sample string 9",
      "locked": "sample string 10",
      "photoTypeID": 11,
      "currentRevisionID": 1,
      "folderID": 1,
      "lastChangedDate": "2025-02-06T09:15:04.1114952-07:00",
      "graphicContents": "sample string 12"
    },
    {
      "documentID": 1,
      "laboratoryID": 1,
      "title": "sample string 1",
      "mimeType": "sample string 2",
      "lastModifiedBy": "sample string 3",
      "folderName": "sample string 4",
      "documentStatus": "sample string 5",
      "checkedOut": true,
      "allowRevisions": true,
      "checkedOutBy": "sample string 8",
      "description": "sample string 9",
      "locked": "sample string 10",
      "photoTypeID": 11,
      "currentRevisionID": 1,
      "folderID": 1,
      "lastChangedDate": "2025-02-06T09:15:04.1114952-07:00",
      "graphicContents": "sample string 12"
    }
  ],
  "statusCode": 100,
  "statusDescription": "sample string 1",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<ResponseOfArrayOfDocumentListModeluskxzdf5 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Response">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <StatusCode>Continue</StatusCode>
  <StatusDescription>sample string 1</StatusDescription>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Models">
    <d2p1:DocumentListModel>
      <d2p1:AllowRevisions>true</d2p1:AllowRevisions>
      <d2p1:CheckedOut>true</d2p1:CheckedOut>
      <d2p1:CheckedOutBy>sample string 8</d2p1:CheckedOutBy>
      <d2p1:CurrentRevisionID>1</d2p1:CurrentRevisionID>
      <d2p1:Description>sample string 9</d2p1:Description>
      <d2p1:DocumentID>1</d2p1:DocumentID>
      <d2p1:DocumentStatus>sample string 5</d2p1:DocumentStatus>
      <d2p1:FolderID>1</d2p1:FolderID>
      <d2p1:FolderName>sample string 4</d2p1:FolderName>
      <d2p1:GraphicContents>sample string 12</d2p1:GraphicContents>
      <d2p1:LaboratoryID>1</d2p1:LaboratoryID>
      <d2p1:LastChangedDate>2025-02-06T09:15:04.1114952-07:00</d2p1:LastChangedDate>
      <d2p1:LastModifiedBy>sample string 3</d2p1:LastModifiedBy>
      <d2p1:Locked>sample string 10</d2p1:Locked>
      <d2p1:MIMEType>sample string 2</d2p1:MIMEType>
      <d2p1:PhotoTypeID>11</d2p1:PhotoTypeID>
      <d2p1:Title>sample string 1</d2p1:Title>
    </d2p1:DocumentListModel>
    <d2p1:DocumentListModel>
      <d2p1:AllowRevisions>true</d2p1:AllowRevisions>
      <d2p1:CheckedOut>true</d2p1:CheckedOut>
      <d2p1:CheckedOutBy>sample string 8</d2p1:CheckedOutBy>
      <d2p1:CurrentRevisionID>1</d2p1:CurrentRevisionID>
      <d2p1:Description>sample string 9</d2p1:Description>
      <d2p1:DocumentID>1</d2p1:DocumentID>
      <d2p1:DocumentStatus>sample string 5</d2p1:DocumentStatus>
      <d2p1:FolderID>1</d2p1:FolderID>
      <d2p1:FolderName>sample string 4</d2p1:FolderName>
      <d2p1:GraphicContents>sample string 12</d2p1:GraphicContents>
      <d2p1:LaboratoryID>1</d2p1:LaboratoryID>
      <d2p1:LastChangedDate>2025-02-06T09:15:04.1114952-07:00</d2p1:LastChangedDate>
      <d2p1:LastModifiedBy>sample string 3</d2p1:LastModifiedBy>
      <d2p1:Locked>sample string 10</d2p1:Locked>
      <d2p1:MIMEType>sample string 2</d2p1:MIMEType>
      <d2p1:PhotoTypeID>11</d2p1:PhotoTypeID>
      <d2p1:Title>sample string 1</d2p1:Title>
    </d2p1:DocumentListModel>
  </Data>
</ResponseOfArrayOfDocumentListModeluskxzdf5>