Table of Contents

Search Documents

This endpoint is used to search for documents.

Definitions

Route: /documents/search
Method: GET
OperationId: SearchDocuments

Permissions

The user must be a member of one of the following roles:

  • client:admin
  • documents:manager
  • documents:viewer

Request

Headers

Name Description Notes
accept The expected format of the response application/json
osg-client-id The unique identifier assigned to your organization
client_customer_id The unique identifier assigned to your client
correlation_id The unique identifier for correlation

Parameters

Responses

Status Description Body
200 The request was successful and is being processed. SearchResult

Failures

Status Description Body
400 The request was invalid. SearchResult
401 The request was not authorized. None
403 The request was not allowed. None
Default An unexpected error occurred. None

Schemas

SearchDocumentsQuery

  account_number=string
  account_discriminator=string
  start_date=string
  end_date=string
  page_size=number
  page_number=number
AccountNumber

The account number, or identifier, of the customer to whom the communication is being sent.

AccountDiscriminator

A discriminator used to differentiate between multiple accounts with the same account number. This allows you to send, and differentiate, mulitple communications to the same customer in a single request.
This field is required if the same AccountNumber is used for multiple communications in a single request.

StartDate

Limits documents to those that were created on or after this date. This value should be in the format "YYYY-MM-DD".

EndDate

Limits documents to those that were created on or before this date. This value should be in the format "YYYY-MM-DD".

PageNumber

The page within the result set to return.

PageSize

The number of documents requested per page.

Caller

SearchResult

{
  "documents": "Array::Object::DocumentSummary",
  "total_results": "number",
  "page_number": "number",
  "total_pages": "number",
  "page_size": "number",
  "result": "Object::ApiResult"
}
Documents

The collection of documents that met the search criteria.

TotalResults

The total number of results for this search.

PageNumber

The current page number within the result set.

TotalPages

The total number of pages for the result set.

PageSize

The number of results returned per page.

Result