JobAllocations
Overview
An instance of a Job being allocated to a Resource.
System fields
System fields are read-only fields found on most objects. These fields are automatically updated during API operations. To learn more see System Fields.
Standard fields
| Field Name | Details | Required |
|---|---|---|
| DeclineDescription | Type Text Description Additional information as to why the Job Allocation was declined. Must be between 0 and 255 characters |
No |
| DeclineReason | Type Picklist Description The reason why a Resource has declined the work. Valid values are: - Sick - OnLeave - Conflict - Other Custom valuesThe values for this field may be modified via the Skedulo web app or via the Skedulo REST API. |
No |
| Duration | Type Duration Description The duration, in minutes, for which the associated Resource is scheduled to work. |
No |
| End | Type DateTime Description The scheduled end date and time of the allocation. |
No |
| EstimatedTravelDistance | Type Decimal Description The estimated travel distance (in meters) to the Job geolocation. This is calculated from the current geolocation of the associated resource when they update the status to ‘En Route’ via the Skedulo mobile app. The calculation considers the real-time location of the resource in relation to the geolocation of the Job, which may differ from the specified address. Must be a decimal with precision 12 and scale 2 |
No |
| EstimatedTravelTime | Type Duration Description The estimated travel time (in minutes) to the Job geolocation. This is calculated from the current geolocation of the associated Resource when they update the status to ‘En Route’ via the Skedulo mobile app. The calculation considers the real-time location of the resource in relation to the geolocation of the Job, which may differ from the specified address. |
No |
| GeoCheckedInLatitude | Type Decimal Description The latitude of the associated resource’s current geolocation when the status is updated to ‘Checked In’ via the Skedulo mobile app. Must be a decimal with precision 9 and scale 6 |
No |
| GeoCheckedInLongitude | Type Decimal Description The longitude of the associated resource’s current geolocation when the status is updated to ‘Checked In’ via the Skedulo mobile app. Must be a decimal with precision 9 and scale 6 |
No |
| GeoCompletedLatitude | Type Decimal Description The latitude of the associated resource’s current geolocation when the status is updated to ‘Complete’ via the Skedulo mobile app. Must be a decimal with precision 9 and scale 6 |
No |
| GeoCompletedLongitude | Type Decimal Description The longitude of the associated resource’s current geolocation when the status is updated to ‘Complete’ via the Skedulo mobile app. Must be a decimal with precision 9 and scale 6 |
No |
| GeoInProgressLatitude | Type Decimal Description The latitude of the associated resource’s current geolocation when the status is updated to ‘In Progress’ via the Skedulo mobile app. Must be a decimal with precision 9 and scale 6 |
No |
| GeoInProgressLongitude | Type Decimal Description The longitude of the associated resource’s current geolocation when the status is updated to ‘In Progress’ via the Skedulo mobile app. Must be a decimal with precision 9 and scale 6 |
No |
| GeoStartTravelLatitude | Type Decimal Description The latitude of the associated resource’s current geolocation when the status is updated to ‘En Route’ via the Skedulo mobile app. Must be a decimal with precision 9 and scale 6 |
No |
| GeoStartTravelLongitude | Type Decimal Description The longitude of the associated resource’s current geolocation when the status is updated to ‘En Route’ via the Skedulo mobile app by the associated resource. Must be a decimal with precision 9 and scale 6 |
No |
| Job | Type Lookup (Jobs) Description The Job associated with the Job Allocation. |
Yes |
| JobId | Type ID Description The Job associated with the Job Allocation. |
Yes |
| Name | Type Text Description The generated name of the Job Allocation. For example, JA-1234. Must be between 0 and 80 characters |
Yes |
| NotificationType | Type Picklist Description Specifies the the alternative method for notifying a resource of a Job Allocation. If unspecified, the ’notification type’ set on the resource record is used. Valid values are: - push - sms - other Custom valuesThe values for this field may be modified via the Skedulo REST API. |
No |
| PhoneResponse | Type Text Description The response captured from the associated resource when the ’notification type’ is set to ‘other’. Must be between 0 and 255 characters |
No |
| Resource | Type Lookup (Resources) Description The Resource associated with the Job Allocation. |
Yes |
| ResourceId | Type ID Description The Resource associated with the Job Allocation. |
Yes |
| ResourceRequirement | Type Lookup (ResourceRequirements) Description The Resource Requirement associated with the Job Allocation (if any). |
No |
| ResourceRequirementId | Type ID Description The Resource Requirement associated with the Job Allocation (if any). |
No |
| Start | Type DateTime Description The scheduled start date and time of the allocation. |
No |
| Status | Type Picklist Description The status of the Job Allocation. Valid values are: - Pending Dispatch - Dispatched - Confirmed - En Route - Checked In - In Progress - Complete - Declined - Modified - Deleted WarningThe values for this field are not able to be modified. |
Yes |
| TeamLeader | Type Checkbox Description Indicates if the associated resource has been designated as the Team Leader. |
Yes |
| TimeCheckedIn | Type DateTime Description The timestamp of when the status is updated to ‘Checked In’ via the Skedulo mobile app by the associated resource. |
No |
| TimeCompleted | Type DateTime Description The timestamp of when the status is updated to ‘Complete’ via the Skedulo mobile app by the associated resource. |
No |
| TimeInProgress | Type DateTime Description The timestamp of when the status is updated to ‘In Progress’ via the Skedulo mobile app by the associated resource. |
No |
| TimePublished | Type DateTime Description The timestamp when the Job Allocation was dispatched to the associated resource. |
No |
| TimeResponded | Type DateTime Description The timestamp of when the status is updated to ‘Confirmed’ or ‘Declined’ via the Skedulo mobile app by the associated resource. |
No |
| TimeStartTravel | Type DateTime Description The timestamp of when the status is updated to ‘En Route’ via the Skedulo mobile app by the associated resource. |
No |
| TravelDistance | Type Decimal Description The actual travel distance (in meters) between the ‘En Route’ and ‘On Site’ status transitions. Must be a decimal with precision 12 and scale 2 |
No |
| TravelTime | Type Duration Description The actual travel distance (in meters) based on the route taken from ‘En Route’ to ‘On Site’ status. |
No |
Feedback
Was this page helpful?