%PDF- %GIF98; %PNG;
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/www/admin1/vendor/square/square/doc/models/ |
Upload File : |
# Shift Query
The parameters of a `Shift` search query, which includes filter and sort options.
## Structure
`ShiftQuery`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `filter` | [`?ShiftFilter`](/doc/models/shift-filter.md) | Optional | Defines a filter used in a search for `Shift` records. `AND` logic is<br>used by Square's servers to apply each filter property specified. | getFilter(): ?ShiftFilter | setFilter(?ShiftFilter filter): void |
| `sort` | [`?ShiftSort`](/doc/models/shift-sort.md) | Optional | Sets the sort order of search results. | getSort(): ?ShiftSort | setSort(?ShiftSort sort): void |
## Example (as JSON)
```json
{
"filter": {
"location_ids": [
"location_ids4"
],
"employee_ids": [
"employee_ids9"
],
"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_date4",
"end_date": "end_date8"
},
"match_shifts_by": "START_AT",
"default_timezone": "default_timezone4"
},
"team_member_ids": [
"team_member_ids1",
"team_member_ids2"
]
},
"sort": {
"field": "START_AT",
"order": "DESC"
}
}
```