Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/public_html/admin1/vendor/square/square/doc/models/ |
Upload File : |
# Search Shifts Request
A request for a filtered and sorted set of `Shift` objects.
## Structure
`SearchShiftsRequest`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `query` | [`?ShiftQuery`](/doc/models/shift-query.md) | Optional | The parameters of a `Shift` search query, which includes filter and sort options. | getQuery(): ?ShiftQuery | setQuery(?ShiftQuery query): void |
| `limit` | `?int` | Optional | The number of resources in a page (200 by default).<br>**Constraints**: `>= 1`, `<= 200` | getLimit(): ?int | setLimit(?int limit): void |
| `cursor` | `?string` | Optional | An opaque cursor for fetching the next page. | getCursor(): ?string | setCursor(?string cursor): void |
## Example (as JSON)
```json
{
"query": {
"filter": {
"location_ids": [
"location_ids4",
"location_ids5"
],
"employee_ids": [
"employee_ids9",
"employee_ids0"
],
"status": "OPEN",
"start": {
"start_at": "start_at0",
"end_at": "end_at2"
},
"end": {
"start_at": "start_at4",
"end_at": "end_at8"
},
"workday": {
"date_range": {
"start_date": "start_date6",
"end_date": "end_date2"
},
"match_shifts_by": "INTERSECTION",
"default_timezone": "default_timezone4"
},
"team_member_ids": [
"team_member_ids1",
"team_member_ids2",
"team_member_ids3"
]
},
"sort": {
"field": "CREATED_AT",
"order": "DESC"
}
},
"limit": 172,
"cursor": "cursor6"
}
```