---
title: "Shared Schemes"
slug: "shared-schemes"
updated: 2023-08-01T07:55:41Z
published: 2023-08-01T07:55:41Z
canonical: "support.perimeter81.com/shared-schemes"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.perimeter81.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Shared Schemes

### SearchQueryDto

DTO for query of search options.

| Property | Data Type | Description |
| --- | --- | --- |
| q | String | Search string or URL encoded JSON. |
| qType | String | Type of search. One of: - full [default] - partial |
| qOperator | String | Applicable only if **qType**equals 'partial'. One of: - and - or [default] |

### SortQueryDto

DTO for query of sort options.

| Property | Data Type | Description |
| --- | --- | --- |
| sort | String | Map of fields and sort order. Example: ?sort=[field1]=asc&sort[field2]=desc |

### PaginatedList

Object for a paginated list.

| Property | Data Type | Description |
| --- | --- | --- |
| page* | Number | Page number. |
| totalPage* | Number | Number of pages in list. |
| itemsTotal* | Number | Number of items in list. |

### PaginationQueryDto

DTO for query about pagination options.

| Property | Data Type | Description |
| --- | --- | --- |
| page | Integer | Page to start from. Minimum 1. |
| limit | Integer | Number of records per page. Maximum 100. |

### 

### 

### qOperator

Search operation only applicable if [qType](https://support.perimeter81.com/docs/api#qtype) equals ‘partial’. Found in [SearchQueryDto](https://support.perimeter81.com/docs/api#searchquerydto).

| Value | Description |
| --- | --- |
| and | Boolean operator for all values required. |
| or | Boolean operator for at least one value is required [default]. |

### qType

Type of search. Found in [SearchQueryDto](https://support.perimeter81.com/docs/api#searchquerydto).

| Value | Description |
| --- | --- |
| full | Full search [default] |
| partial | Partial search. Partial search query can include [qOperator](https://support.perimeter81.com/docs/api#qoperator). |