GET v1/Documents

Document Search

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ReferenceNumber

Number of entity that the document is in reference to (e.g. Policy or Quote Number, Agency Id). See: Reference Type

string

String length: inclusive between 0 and 30

ReferenceType

The type of the entity the document is in reference to

DocumentReferenceTypeEnum

None.

SystemType

System which the document is stored for.

SystemTypeEnum

None.

Category

Document category

DocumentCategoryCustomEnum

None.

CreationDate

Upload Date

Collection of string

None.

Limit

Maximum number of records to return

integer

Range: inclusive between 1 and 2147483647

Offset

Number of records to skip during search, useful for pagination

integer

Range: inclusive between 0 and 2147483647

Total

Flag to indicate if the total number of records matching the search should be computed. Default: False. WARNING: Setting to True will considerably slow down search performance when searching large datasets.

boolean

None.

SortDirection

Direction of sort: Ascending or Descending

SortDirection

None.

Sort

Comma separated list of field names to sort by

string

None.

Expand

Comma separated list of expansions to include in results

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of DocumentDTO
NameDescriptionTypeAdditional information
FileName

Name of the document file

string

None.

Path

Name of the document file

string

None.

Description

Description of the document

string

None.

Category

Document category

DocumentCategoryCustomEnum

None.

SizeKB

File size of the document

decimal number

None.

CreationDate

Upload date of the document

date

None.

SystemType

SystemTypeEnum

None.

Id

Primary Id

integer

None.

WarningMessages

List of warning messages encountered while servicing request

Collection of string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "FileName": "sample string 1",
    "Path": "sample string 2",
    "Description": "sample string 3",
    "Category": "AgentProfile",
    "SizeKB": 4.0,
    "CreationDate": "2022-01-20T03:11:51.8092995-10:00",
    "SystemType": "Unknown",
    "Id": 5
  },
  {
    "FileName": "sample string 1",
    "Path": "sample string 2",
    "Description": "sample string 3",
    "Category": "AgentProfile",
    "SizeKB": 4.0,
    "CreationDate": "2022-01-20T03:11:51.8092995-10:00",
    "SystemType": "Unknown",
    "Id": 5
  }
]

application/xml, text/xml

Sample:
<ArrayOfDocumentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <DocumentDTO>
    <Id>5</Id>
    <Category>AgentProfile</Category>
    <CreationDate>2022-01-20T03:11:51.8092995-10:00</CreationDate>
    <Description>sample string 3</Description>
    <FileName>sample string 1</FileName>
    <Path>sample string 2</Path>
    <SizeKB>4</SizeKB>
    <SystemType>Unknown</SystemType>
  </DocumentDTO>
  <DocumentDTO>
    <Id>5</Id>
    <Category>AgentProfile</Category>
    <CreationDate>2022-01-20T03:11:51.8092995-10:00</CreationDate>
    <Description>sample string 3</Description>
    <FileName>sample string 1</FileName>
    <Path>sample string 2</Path>
    <SizeKB>4</SizeKB>
    <SystemType>Unknown</SystemType>
  </DocumentDTO>
</ArrayOfDocumentDTO>