What’s New
With the release of FieldAware Web 1.34.15, the Time Slots and Planned Effort for jobs and field quotes can now be read via the FieldAware API. This additional data is available at the GET /job/{job_ref} and GET /fieldquote/{webquote_ref} endpoints.
Note: At this time, the time slot data is read-only; it is not possible to create or update Time Slots through the API.
Details
The Job and Field Quote response JSON has been updated to include the time slot information. The time slot data contains;
The scheduled date and time of the slot
The slot duration (in minutes)
The slot UUID
The crew members assigned to the slot
The Planned Effort of the time slots is also returned. This value is also in minutes.
Fig. 1: Excerpt from API response for jobs and field quotes
timeSlots data is read-only via the API. Time slots can only be modified in the webapp. The duration of each timeSlots entry is expressed in minutes.
The value for plannedEffort is a calculated field based on the number of time slots, their duration, and the number of assignees per time slot. The units for planned effort are minutes. This field is read-only.
startLocation and endLocation for crew workedHours cannot be set via the API. This field is read-only.
scheduledState can not be set directly via the API presently, only via Planning Mode in the web application. scheduledState on an unassigned job will be updated indirectly from tentative or confirmed to dispatched if a job lead is set via the API. A job created without a job lead will return with a scheduledState of tentative.
This change is backwards compatible so existing API clients will continue to function as normal. For more, see the FieldAware API documentation.