Schedules
The schedule object is used to specify whether providers should Arrive at a specific date and time, Complete work between specific hours, or Complete work anytime over a date range. You can set these options using the schedule > service_window object.
Note: When you use UTC dates and times, the Field Nation Platform will automatically assign the correct time zone. Your local time zone information is included in the schedule Response. Passing UTC dates and times will also ensure the correct time zone when you're using a Remote Location.
Below is a list of the service_window parameters, along with a JSON example for each option.
Arrive at a specific date and time
| Parameter | Type | Example | Mapping/Notes |
|---|---|---|---|
| mode | string | "mode":"exact" | Arrive at start date and time. |
| start | object | "start": { "utc":"2025-11-07 13:00:00" } | UTC date and time in the format of YYYY-MM-DD HH:MM:SS. |
| schedule_note | string | "schedule_note":"Site would not be available from 12 to 1 PM" | Additional information about the schedule or site. |
Exact Date/Time Examples
Complete work between specific hours
| Parameter | Type | Example | Mapping/Notes |
|---|---|---|---|
| mode | string | "mode":"hours" | Complete work from start date to end date, only between the hours of start time and end time. |
| start | object | "start": { "utc":"2025-11-07 13:00:00" } | Start date and earliest time. UTC date and time in the format of YYYY-MM-DD HH:MM:SS. |
| end | object | "end": { "utc":"2025-11-08 15:00:00" } | End date and latest time for each day. The end date can be the same as the start date. UTC date and time in the format of YYYY-MM-DD HH:MM:SS, The arrival window must be at least 45 minutes. |
| schedule_option | integer | "schedule_option":1 | Possible value 0 or 1.
|
| schedule_note | string | "schedule_note":"If you are coming in the morning, please call." | Additional information about the schedule. |
Between Specific Hours Examples
Complete work anytime over a date range
| Parameter | Type | Example | Mapping/Notes |
|---|---|---|---|
| mode | string | "mode":"between" | Complete work from start date/time to end date/time. |
| start | object | "start": { "utc":"2025-11-07 13:00:00" } | Start date and time. UTC date and time in the format of YYYY-MM-DD HH:MM:SS. |
| end | object | "end": { "utc":"2025-11-08 22:00:00" } | End date and time. UTC date and time in the format of YYYY-MM-DD HH:MM:SS, The arrival window must be at least 45 minutes. |
| schedule_option | integer | "schedule_option":1 | Possible value 0 or 1.
|
| schedule_note | string | "schedule_note":"Please arrive by lunchtime if possible" | Additional information about the schedule. |
Anytime Over Date Range Examples
Work Order Schedule Response
You can locate schedule information in the work order > schedule object.
"schedule": { }