/dataAccess/archiveContainerQuery/

Perform an advanced search query against archived document containers.

Request

POST {{server}}/VPE/dataAccess/archiveContainerQuery/
Content-Type: application/json
Tid-Api-Key: xxx-xxx-xx
{
    "DeviceId": "device-id",
    "SessionId": "...",

    "DocumentHolderName": "Banderas"

    "ContainerScannedByUserId": "...",
    "ContainerBranchId": "...",
    "ContainerOrganisationId": "...",

    "ContainerCreatedAtRangeFrom": "...",
    "ContainerCreatedAtRangeUntil": "...",

    "Page": 1,
    "PageSize": 10,

    "SortingDirection": "Descending"
}

ArchiveContainerQueryRequest.DocumentHolderName

= DocumentHolderName

Matches the given document holder name against any document holder’s first name, middle name or surname.

ArchiveContainerQueryRequest.ContainerScannedByUserId

= ContainerScannedByUserId

Id for the user associated with the document container.

ArchiveContainerQueryRequest.ContainerBranchId

= ContainerBranchId

BranchId for the document container.

ArchiveContainerQueryRequest.ContainerOrganisationId

= ContainerOrganisationId

OrganisationId for the document container by reference to the container’s branch.

ArchiveContainerQueryRequest.ContainerCreatedAtRangeFrom

= ContainerCreatedAtRangeFrom

Date range from (container’s CreatedAt date).

ArchiveContainerQueryRequest.ContainerCreatedAtRangeUntil

= ContainerCreatedAtRangeUntil

Date range until (container’s CreatedAt date).

ArchiveContainerQueryRequest.FlexibleFieldSearchSpecifications

= FlexibleFieldSearchSpecifications

Specifies one or more application-level custom field search specifications. Each specification record supplied relates to a single flexible-field only, with a single data-type. However, each specification record can contain a list of several data points to match against, or indeed a range of values - depending on the flexible-field data-type concerned.

See also

FlexibleFieldSearchSpecification for more information about search criteria details.

ArchiveContainerQueryRequest.FlexibleFieldSpecificationSearchOperator

= FlexibleFieldSpecificationSearchOperator

With multiple application-level custom field specification records (ArchiveContainerQueryRequest.FlexibleFieldSearchSpecifications) present, this field specifies how these search criteria are combined as an OR (the default if not specified) or AND.

See also

FlexibleFieldSpecificationSearchOperator for more information about the search operator.

ArchiveContainerQueryRequest.Page

= Page

Index of the page to receive (0-indexed).

ArchiveContainerQueryRequest.PageSize

= PageSize

The maximum number of items to receive for the given page. If the page size is defined as 0, the default page size is used. Any value lower than 0 means that the page size is infinite and the entire result set is returned.

ArchiveContainerQueryRequest.SortingDirection

= SortingDirection

The sorting direction allows a client to choose to sort according to the Container.CreatedAt timestamp.

Response

{
    "Success": true,
    "Message": "Operation executed successfully.",
    "Containers": [
        ...
    ],
    "Page": 0,
    "PageSize": 250,
    "PaginationSupported": false,
    "TotalPages": 1,
    "TotalRecords": 8,
    "TotalRecordsMatched": 8
}

ArchiveContainerQueryResponse.DocumentContainers

= DocumentContainers

List of matched document containers covering the content of the current page.

ArchiveContainerQueryResponse.TotalRecords

= TotalRecords

Number of total records in the system.

ArchiveContainerQueryResponse.TotalRecordsMatched

= TotalRecordsMatched

The number of total records that matched the query.

ArchiveContainerQueryResponse.TotalPages

= TotalPages

The number of total pages for the result set according to the page size.

ArchiveContainerQueryResponse.PageSize

= PageSize

Number of records per page.

ArchiveContainerQueryResponse.Page

= Page

The index position of the current page (0-indexed).

ArchiveContainerQueryResponse.PaginationSupported

= PaginationSupported

true if the result has been paginated according to the given page and page size successfully. If pagination support is not available due to the internal constraints of the database system used, false is returned. false might also be returned if pagination is not relevant, based on the way this API endpoint was used. If pagination is not relevant or is not supported, then the result may only cover the first page, even if that is not the page that has been asked for.