Shared Schemes
- 01 Aug 2023
- 1 Minute to read
- Contributors
Shared Schemes
- Updated on 01 Aug 2023
- 1 Minute to read
- Contributors
Article summary
Did you find this summary helpful?
Thank you for your feedback
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:
|
| qOperator | String | Applicable only if qType equals 'partial'. One of:
|
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 equals ‘partial’. Found in 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.
| Value | Description |
|---|---|
| full | Full search [default] |
| partial | Partial search. Partial search query can include qOperator. |
Was this article helpful?