openapi: 3.0.1 info: title: Core AccessGroup Route API version: core tags: - name: Route paths: /transport/routes/changes: get: tags: - Route summary: Retrieve changes description: "| Property| Description |\r\n| --------------------------------------------- | ----------------------------------------------------------------------------- |\r\n| GUID| The GUID associated to the route.|\r\n| RouteManagementTypeListItem| The GUID and description of the RouteManagementType associated to the route. |\r\n| AreaOfOriginListItem| The GUID and description of the AreaOfOrigin associated to the route. |\r\n| VehicleTypeListItem| The GUID and description of the VehicleType associated to the route. |\r\n| MaterialListItem| The GUID and description of the Material associated to the route. |\r\n| CompanyOutletListItem| The GUID and description of the CompanyOutlet associated to the route.|\r\n| DefaultTipMaterialListItem| The GUID and description of the DefaultTipMaterial associated to the route.|\r\n| Notes| The notes associated to the Route. Filterable.|\r\n| IsDiffReasonRequired| Does the route need a Diff Reason?|\r\n| IsWeighingsComplete| Are the route weighings complete?|\r\n| IsCompleted| Is the route completed?|\r\n| IsDeleted| Whether the route is deleted. |\r\n| IsMissedReasonRequired| Is the route missed reason required?|\r\n| IsPromptForLiftsOnVisitCompletion| Prompt for lifts on visit completion?|\r\n| IsOrderSupplierUsedForCostGeneration| Is the order supplier used for cost generation?|\r\n| RelatedRouteTemplateGuid| The GUID of the RouteTemplate associated to the route|\r\n| IsNoTagStopEnabled| Is no tag stop enabled?|\r\n| IsSubContracted| Is the route sub contracted?|\r\n| RelatedLocationDestinationGuid| Used to filter on the related destination location GUID.|\r\n| RelatedVehicleGuid| Used to filter on the related vehicle GUID.|\r\n| RelatedMasterRouteGuid| Used to filter on the related master route GUID.|\r\n| RelatedSupplierSiteGuid| Used to filter on the related supplier site GUID.|\r\n| RelatedSupplierSiteTransportGuid| Used to filter on the related supplier site transport GUID.|\r\n| RelatedUserStartDefectCheckGuid| Used to filter on the related start defect check user GUID.|\r\n| RelatedUserEndDefectCheckGuid| Used to filter on the related end defect check user GUID.|\r\n| StartLeaveYardTime| The leave yard time associated to the route.|\r\n| EndYardLeaveTime| The return yard time associated to the route.|\r\n| StartPlannedTime| The planned start time associated to the route.|\r\n| EndPlannedTime| The planned end time associated to the route.|\r\n| StartRouteTime| The start route time associated to the route.|\r\n| EndRouteTime| The end route time associated to the route.|\r\n| RouteDate| The date associated to the route.Filterable.|\r\n| Description| The description associated to the route.|\r\n| RouteNo| The route no associated to the route.Filterable.|\r\n| DistanceTravelled| The distance travelled associated to the route.|\r\n| FuelUsed| The fuel used associated to the route.|\r\n| FuelCost| The fuel cost associated to the route.|\r\n| FleetPlannerTripNo| The fleet planner trip no associated to the route.|\r\n| AcceptedMaterials| An array of accepted materials.|\r\n| AcceptedMaterials[0].Guid| The GUID of accepted material.|\r\n| AcceptedMaterials[0].IsDeleted| Whether accepted material is deleted.|\r\n| AcceptedMaterials[0].MaterialClassListItem| The GUID and description of material class|\r\n| Driver| The driver object.|\r\n| Driver.RelatedUserDriverGuid| Guid of the Related user driver.|\r\n| Driver.ClockOnTime| The clock on time associated to the route.|\r\n| Driver.ClockOffTime| The clock off time associated to the route.|\r\n| Driver.CrewNumber| The crew number associated to the route.|\r\n| VehicleChecks| The vehicle checks object.|\r\n| VehicleChecks.StartMileage| The start mileage associated to the route.|\r\n| VehicleChecks.StartHubometerTime| The hubometer start time associated to the route.|\r\n| VehicleChecks.EndHubometerTime| The hubometer end time associated to the route.|\r\n| VehicleChecks.EndMileage| The end mileage associated to the route.|\r\n| VehicleChecks.Notes| The notes associated to the route.|\r\n| VehicleChecks.StartSafetyCheck| The start safety check associated to the route.|\r\n| VehicleChecks.StartDefectTicketNo| The start defect ticket number associated to the route.|\r\n| VehicleChecks.StartNotes| The start notes associated to the route.|\r\n| VehicleChecks.EndSafetyCheck| The end safety check associated to the route.|\r\n| VehicleChecks.EndDefectTicketNo| The end defect ticket number associated to the route.|\r\n| VehicleChecks.EndNotes| The end notes associated to the route.|\r\n| VehicleChecks.StartHubometerDistance| The hubometer start distance associated to the route.|\r\n| VehicleChecks.EndHubometerDistance| The hubometer end distance associated to the route.|\r\n| VehicleChecks.CrewMembers[0]| The crew members associated to the vehicle check.|\r\n| VehicleChecks.CrewMembers[0].RelatedSysUserGuid| The related system user guid associated to the crew member of the vehicle check.|\r\n| VehicleChecks.CrewMembers[0].IsDeleted| Whether the crew member is deleted|\r\n| VehicleChecks.CrewMembers[0].Guid| The Guid associated to the crew member of the vehicle check.|\r\n| IsLiftsMatchingConfirmation| Is lifts matching confirmation enabled?|\r\n| RelatedUserDriverGuidFilter| Used to filter on the related driver GUID.|\r\n| RelatedSysUserGuidFilter| Used to filter on the related system user GUID.|\r\n| IsPromptForForceQuantityConfirmation| Prompt for Quantity Confirmation?|\r\n" operationId: Route_GetChanges parameters: - name: since in: query schema: type: string - name: cursor in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ApiResourceChanges[ApiIntegratorRouteResource]' /transport/routes/{guid}: get: tags: - Route summary: Find with GUID description: "| Property| Description |\r\n| --------------------------------------------- | ----------------------------------------------------------------------------- |\r\n| GUID| The GUID associated to the route.|\r\n| RouteManagementTypeListItem| The GUID and description of the RouteManagementType associated to the route. |\r\n| AreaOfOriginListItem| The GUID and description of the AreaOfOrigin associated to the route. |\r\n| VehicleTypeListItem| The GUID and description of the VehicleType associated to the route. |\r\n| MaterialListItem| The GUID and description of the Material associated to the route. |\r\n| CompanyOutletListItem| The GUID and description of the CompanyOutlet associated to the route.|\r\n| DefaultTipMaterialListItem| The GUID and description of the DefaultTipMaterial associated to the route.|\r\n| Notes| The notes associated to the Route. Filterable.|\r\n| IsDiffReasonRequired| Does the route need a Diff Reason?|\r\n| IsWeighingsComplete| Are the route weighings complete?|\r\n| IsCompleted| Is the route completed?|\r\n| IsDeleted| Whether the route is deleted. |\r\n| IsMissedReasonRequired| Is the route missed reason required?|\r\n| IsPromptForLiftsOnVisitCompletion| Prompt for lifts on visit completion?|\r\n| IsOrderSupplierUsedForCostGeneration| Is the order supplier used for cost generation?|\r\n| RelatedRouteTemplateGuid| The GUID of the RouteTemplate associated to the route|\r\n| IsNoTagStopEnabled| Is no tag stop enabled?|\r\n| IsSubContracted| Is the route sub contracted?|\r\n| RelatedLocationDestinationGuid| Used to filter on the related destination location GUID.|\r\n| RelatedVehicleGuid| Used to filter on the related vehicle GUID.|\r\n| RelatedMasterRouteGuid| Used to filter on the related master route GUID.|\r\n| RelatedSupplierSiteGuid| Used to filter on the related supplier site GUID.|\r\n| RelatedSupplierSiteTransportGuid| Used to filter on the related supplier site transport GUID.|\r\n| RelatedUserStartDefectCheckGuid| Used to filter on the related start defect check user GUID.|\r\n| RelatedUserEndDefectCheckGuid| Used to filter on the related end defect check user GUID.|\r\n| StartLeaveYardTime| The leave yard time associated to the route.|\r\n| EndYardLeaveTime| The return yard time associated to the route.|\r\n| StartPlannedTime| The planned start time associated to the route.|\r\n| EndPlannedTime| The planned end time associated to the route.|\r\n| StartRouteTime| The start route time associated to the route.|\r\n| EndRouteTime| The end route time associated to the route.|\r\n| RouteDate| The date associated to the route.Filterable.|\r\n| Description| The description associated to the route.|\r\n| RouteNo| The route no associated to the route.Filterable.|\r\n| DistanceTravelled| The distance travelled associated to the route.|\r\n| FuelUsed| The fuel used associated to the route.|\r\n| FuelCost| The fuel cost associated to the route.|\r\n| FleetPlannerTripNo| The fleet planner trip no associated to the route.|\r\n| AcceptedMaterials| An array of accepted materials.|\r\n| AcceptedMaterials[0].Guid| The GUID of accepted material.|\r\n| AcceptedMaterials[0].IsDeleted| Whether accepted material is deleted.|\r\n| AcceptedMaterials[0].MaterialClassListItem| The GUID and description of material class|\r\n| Driver| The driver object.|\r\n| Driver.RelatedUserDriverGuid| Guid of the Related user driver.|\r\n| Driver.ClockOnTime| The clock on time associated to the route.|\r\n| Driver.ClockOffTime| The clock off time associated to the route.|\r\n| Driver.CrewNumber| The crew number associated to the route.|\r\n| VehicleChecks| The vehicle checks object.|\r\n| VehicleChecks.StartMileage| The start mileage associated to the route.|\r\n| VehicleChecks.StartHubometerTime| The hubometer start time associated to the route.|\r\n| VehicleChecks.EndHubometerTime| The hubometer end time associated to the route.|\r\n| VehicleChecks.EndMileage| The end mileage associated to the route.|\r\n| VehicleChecks.Notes| The notes associated to the route.|\r\n| VehicleChecks.StartSafetyCheck| The start safety check associated to the route.|\r\n| VehicleChecks.StartDefectTicketNo| The start defect ticket number associated to the route.|\r\n| VehicleChecks.StartNotes| The start notes associated to the route.|\r\n| VehicleChecks.EndSafetyCheck| The end safety check associated to the route.|\r\n| VehicleChecks.EndDefectTicketNo| The end defect ticket number associated to the route.|\r\n| VehicleChecks.EndNotes| The end notes associated to the route.|\r\n| VehicleChecks.StartHubometerDistance| The hubometer start distance associated to the route.|\r\n| VehicleChecks.EndHubometerDistance| The hubometer end distance associated to the route.|\r\n| VehicleChecks.CrewMembers[0]| The crew members associated to the vehicle check.|\r\n| VehicleChecks.CrewMembers[0].RelatedSysUserGuid| The related system user guid associated to the crew member of the vehicle check.|\r\n| VehicleChecks.CrewMembers[0].IsDeleted| Whether the crew member is deleted|\r\n| VehicleChecks.CrewMembers[0].Guid| The Guid associated to the crew member of the vehicle check.|\r\n| IsLiftsMatchingConfirmation| Is lifts matching confirmation enabled?|\r\n| RelatedUserDriverGuidFilter| Used to filter on the related driver GUID.|\r\n| RelatedSysUserGuidFilter| Used to filter on the related system user GUID.|\r\n| IsPromptForForceQuantityConfirmation| Prompt for Quantity Confirmation?|\r\n" operationId: Route_Get parameters: - name: guid in: path required: true schema: type: string format: uuid - name: udf in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ApiResourceResultEntity[ApiIntegratorRouteResource]' put: tags: - Route summary: Partial update description: "| Property | Description | Required |\r\n| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |\r\n| GUID| The GUID associated to the route.| No |\r\n| RouteManagementTypeListItem| The GUID and description of the RouteManagementType associated to the route. | Yes |\r\n| AreaOfOriginListItem| The GUID and description of the AreaOfOrigin associated to the route. | No |\r\n| VehicleTypeListItem| The GUID and description of the VehicleType associated to the route. | No |\r\n| MaterialListItem | The GUID and description of the Material associated to the route. | No |\r\n| CompanyOutletListItem| The GUID and description of the CompanyOutlet associated to the route.| No |\r\n| Notes| The notes associated to the route. Editable.| No |\r\n| DefaultTipMaterialListItem| The GUID and description of the DefaultTipMaterial associated to the route.| No |\r\n| IsDiffReasonRequired| Does the route need a Diff Reason?| No |\r\n| IsWeighingsComplete| Are the route weighings complete?| No |\r\n| IsCompleted| Is the route completed?| No |\r\n| IsDeleted| Whether the route is deleted.| No |\r\n| IsMissedReasonRequired| Is the route missed reason required?| No |\r\n| IsPromptForLiftsOnVisitCompletion| Prompt for lifts on visit completion?| No |\r\n| IsOrderSupplierUsedForCostGeneration| Is the order supplier used for cost generation?| No |\r\n| RelatedRouteTemplateGuid| The GUID of the RouteTemplate associated to the route| Yes |\r\n| IsNoTagStopEnabled| Is no tag stop enabled?| No |\r\n| IsSubContracted| Is the route sub contracted?| No |\r\n| RelatedLocationDestinationGuid| Used to filter on the related destination location GUID.| No |\r\n| RelatedVehicleGuid| Used to filter on the related vehicle GUID.| No |\r\n| RelatedMasterRouteGuid| Used to filter on the related master route GUID.| No |\r\n| RelatedSupplierSiteGuid| Used to filter on the related supplier site GUID.| No |\r\n| RelatedSupplierSiteTransportGuid| Used to filter on the related supplier site transport GUID.| No |\r\n| RelatedUserStartDefectCheckGuid| Used to filter on the related start defect check user GUID.| No |\r\n| RelatedUserEndDefectCheckGuid| Used to filter on the related end defect check user GUID.| No |\r\n| StartLeaveYardTime| The leave yard time associated to the route.| No |\r\n| EndYardLeaveTime| The return yard time associated to the route.| No |\r\n| StartPlannedTime| The planned start time associated to the route.| No |\r\n| EndPlannedTime| The planned end time associated to the route.| No |\r\n| StartRouteTime| The start route time associated to the route.| No |\r\n| EndRouteTime| The end route time associated to the route.| No |\r\n| RouteDate| The date associated to the route.| No |\r\n| Description| The description associated to the route.| Yes |\r\n| RouteNo| The route no associated to the route.| No |\r\n| DistanceTravelled| The distance travelled associated to the route.| No |\r\n| FuelUsed| The fuel used associated to the route.| No |\r\n| FuelCost| The fuel cost associated to the route.| No |\r\n| FleetPlannerTripNo| The fleet planner trip no associated to the route.| No |\r\n| AcceptedMaterials| An array of accepted materials.| No |\r\n| AcceptedMaterials.Guid| Guid of accepted material.| No |\r\n| AcceptedMaterials.IsDeleted| Whether the accepted material is deleted.| Yes |\r\n| AcceptedMaterials.MaterialClassItem| Guid and description of material class.| Yes |\r\n| Driver| The driver object.| No |\r\n| Driver.RelatedUserDriverGuid| Guid of the Related user driver.| No |\r\n| Driver.ClockOnTime| The clock on time associated to the route.| No |\r\n| Driver.ClockOffTime| The clock off time associated to the route.| No |\r\n| Driver.CrewNumber| The crew number associated to the route.| No |\r\n| VehicleChecks| The vehicle checks object.| No |\r\n| VehicleChecks.StartMileage| The start mileage associated to the route.| No |\r\n| VehicleChecks.StartHubometerTime| The hubometer start time associated to the route.| No |\r\n| VehicleChecks.EndHubometerTime| The hubometer end time associated to the route.| No |\r\n| VehicleChecks.EndMileage| The end mileage associated to the route.| No |\r\n| VehicleChecks.Notes| The notes associated to the route.| No |\r\n| VehicleChecks.StartSafetyCheck| The start safety check associated to the route.| No |\r\n| VehicleChecks.StartDefectTicketNo| The start defect ticket number associated to the route.| No |\r\n| VehicleChecks.StartNotes| The start notes associated to the route.| No |\r\n| VehicleChecks.EndSafetyCheck| The end safety check associated to the route.| No |\r\n| VehicleChecks.EndDefectTicketNo| The end defect ticket number associated to the route.| No |\r\n| VehicleChecks.EndNotes| The end notes associated to the route.| No |\r\n| VehicleChecks.StartHubometerDistance| The hubometer start distance associated to the route.| No |\r\n| VehicleChecks.EndHubometerDistance| The hubometer end distance associated to the route.| No |\r\n| VehicleChecks.CrewMembers[0]| The crew members associated to the vehicle check.| No |\r\n| VehicleChecks.CrewMembers[0].RelatedSysUserGuid| The related system user guid associated to the crew member of the vehicle check.| No |\r\n| VehicleChecks.CrewMembers[0].IsDeleted| Whether the crew member is deleted| No |\r\n| VehicleChecks.CrewMembers[0].Guid| The Guid associated to the crew member of the vehicle check.| No |\r\n| IsLiftsMatchingConfirmation| Is lifts matching confirmation enabled?| No |\r\n| RelatedUserDriverGuidFilter| Used to filter on the related driver GUID.| No |\r\n| RelatedSysUserGuidFilter| Used to filter on the related system user GUID.| No |\r\n| IsPromptForForceQuantityConfirmation| Prompt for Quantity Confirmation?| No |\r\n\r\n**Extra validations**\r\n\r\n| Condition | Error message |\r\n| --------- | ------------- |\r\n| RouteManagementTypeListItem is being edited | RouteManagementTypeListItem.Guid is a read-only property. |\r\n| RelatedMasterRouteGuid is being edited | RelatedMasterRouteGuid is a read-only property. |\r\n| Description is being edited | Description is a read-only property. |\r\n| IsDiffReasonRequired is being edited | IsDiffReasonRequired is a read-only property. |\r\n| IsMissedReasonRequired is being edited | IsMissedReasonRequired is a read-only property. |\r\n| IsOrderSupplierUsedForCostGeneration is being edited | IsOrderSupplierUsedForCostGeneration is a read-only property. |\r\n| RouteNo is being edited | RouteNo is a read-only property. |\r\n| DistanceTravelled is being edited | DistanceTravelled is a read-only property. |\r\n| FuelUsed is being edited | FuelUsed is a read-only property. |\r\n| FuelCost is being edited | FuelCost is a read-only property. |\r\n| IsNoTagStopEnabled is being edited | IsNoTagStopEnabled is a read-only property. |\r\n| FleetPlannerTripNo is being edited | FleetPlannerTripNo is a read-only property. |\r\n| RouteDate is being edited | RouteDate is a read-only property. |\r\n| StartLeaveYardTime is being edited | StartLeaveYardTime is a read-only property. |\r\n| EndYardLeaveTime is being edited | EndYardLeaveTime is a read-only property. |\r\n| StartPlannedTime is being edited | StartPlannedTime is a read-only property. |\r\n| EndPlannedTime is being edited | EndPlannedTime is a read-only property. |\r\n| Driver.CrewNumber is being edited | Driver.CrewNumber is a read-only property. |\r\n| Driver.ClockOnTime is being edited | Driver.ClockOnTime is a read-only property. |\r\n| Driver.ClockOffTime is being edited | Driver.ClockOffTime is a read-only property. |\r\n| VehicleChecks.RelatedUserStartDefectCheckGuid is being edited | VehicleChecks.RelatedUserStartDefectCheckGuid is a read-only property. |\r\n| VehicleChecks.RelatedUserEndDefectCheckGuid is being edited | VehicleChecks.RelatedUserEndDefectCheckGuid is a read-only property. |\r\n| VehicleChecks.StartSafetyCheck is being edited | VehicleChecks.StartSafetyCheck is a read-only property. |\r\n| VehicleChecks.StartDefectTicketNo is being edited | VehicleChecks.StartDefectTicketNo is a read-only property. |\r\n| VehicleChecks.StartNotes is being edited | VehicleChecks.StartNotes is a read-only property. |\r\n| VehicleChecks.EndSafetyCheck is being edited | VehicleChecks.EndSafetyCheck is a read-only property. |\r\n| VehicleChecks.EndDefectTicketNo is being edited | VehicleChecks.EndDefectTicketNo is a read-only property. |\r\n| VehicleChecks.EndNotes is being edited | VehicleChecks.EndNotes is a read-only property. |\r\n| VehicleChecks.StartHubometerDistance is being edited | VehicleChecks.StartHubometerDistance is a read-only property. |\r\n| VehicleChecks.EndHubometerDistance is being edited | VehicleChecks.EndHubometerDistance is a read-only property. |\r\n| If IsCompleted true and IsWeighingsComplete false | Attempt to complete a route with incomplete weighings. Could not process the update. Ensure the weighings are complete and set the IsWeighingsComplete to true in the request. |\r\n| If IsCompleted updated from true to false and update any property | Attempt to update the properties of a completed route. Could not process the update. Set IsComplete to false individually to uncomplate the route before requesting an update. |\r\n| If IsDeleted is true | IsDeleted is TRUE. Could not process the request. Resources can not be deleted via the REST API. |\r\n| Updating a deleted Route | Failed to save/update Route because attempt to update a deleted Route is not allowed. Could not process the request. |\r\n| AcceptedMaterials.MaterialClassListItem is being edited | AcceptedMaterials.MaterialClassListItem is a read-only property. |\r\n| AcceptedMaterials.MaterialClassListItem.Guid is duplicate | The MaterialClassListItem must be unique per AcceptedMaterials |\r\n| If AreaOfOriginListItem.Guid is null and RelatedSupplierSiteTransportGuid is null | The mandatory property AreaOfOriginListItem.Guid has a null value. The request could not be processed. Supply a value for the AreaOfOriginListItem.Guid property of the submitted resource. |\r\n| If VehicleChecks.CrewMembers is being edited | VehicleChecks.CrewMembers is a read-only property |" operationId: Route_Update parameters: - name: guid in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ApiIntegratorRouteResource' required: true x-bodyName: null responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ApiResourceId' /transport/routes: get: tags: - Route summary: Find with Filters description: "| Property| Description |\r\n| --------------------------------------------- | ----------------------------------------------------------------------------- |\r\n| GUID| The GUID associated to the route.|\r\n| RouteManagementTypeListItem| The GUID and description of the RouteManagementType associated to the route. |\r\n| AreaOfOriginListItem| The GUID and description of the AreaOfOrigin associated to the route. |\r\n| VehicleTypeListItem| The GUID and description of the VehicleType associated to the route. |\r\n| MaterialListItem| The GUID and description of the Material associated to the route. |\r\n| CompanyOutletListItem| The GUID and description of the CompanyOutlet associated to the route.|\r\n| DefaultTipMaterialListItem| The GUID and description of the DefaultTipMaterial associated to the route.|\r\n| Notes| The notes associated to the Route. Filterable.|\r\n| IsDiffReasonRequired| Does the route need a Diff Reason?|\r\n| IsWeighingsComplete| Are the route weighings complete?|\r\n| IsCompleted| Is the route completed?|\r\n| IsDeleted| Whether the route is deleted. |\r\n| IsMissedReasonRequired| Is the route missed reason required?|\r\n| IsPromptForLiftsOnVisitCompletion| Prompt for lifts on visit completion?|\r\n| IsOrderSupplierUsedForCostGeneration| Is the order supplier used for cost generation?|\r\n| RelatedRouteTemplateGuid| The GUID of the RouteTemplate associated to the route|\r\n| IsNoTagStopEnabled| Is no tag stop enabled?|\r\n| IsSubContracted| Is the route sub contracted?|\r\n| RelatedLocationDestinationGuid| Used to filter on the related destination location GUID.|\r\n| RelatedVehicleGuid| Used to filter on the related vehicle GUID.|\r\n| RelatedMasterRouteGuid| Used to filter on the related master route GUID.|\r\n| RelatedSupplierSiteGuid| Used to filter on the related supplier site GUID.|\r\n| RelatedSupplierSiteTransportGuid| Used to filter on the related supplier site transport GUID.|\r\n| RelatedUserStartDefectCheckGuid| Used to filter on the related start defect check user GUID.|\r\n| RelatedUserEndDefectCheckGuid| Used to filter on the related end defect check user GUID.|\r\n| StartLeaveYardTime| The leave yard time associated to the route.|\r\n| EndYardLeaveTime| The return yard time associated to the route.|\r\n| StartPlannedTime| The planned start time associated to the route.|\r\n| EndPlannedTime| The planned end time associated to the route.|\r\n| StartRouteTime| The start route time associated to the route.|\r\n| EndRouteTime| The end route time associated to the route.|\r\n| RouteDate| The date associated to the route.Filterable.|\r\n| Description| The description associated to the route.|\r\n| RouteNo| The route no associated to the route.Filterable.|\r\n| DistanceTravelled| The distance travelled associated to the route.|\r\n| FuelUsed| The fuel used associated to the route.|\r\n| FuelCost| The fuel cost associated to the route.|\r\n| FleetPlannerTripNo| The fleet planner trip no associated to the route.|\r\n| AcceptedMaterials| An array of accepted materials.|\r\n| AcceptedMaterials[0].Guid| The GUID of accepted material.|\r\n| AcceptedMaterials[0].IsDeleted| Whether accepted material is deleted.|\r\n| AcceptedMaterials[0].MaterialClassListItem| The GUID and description of material class|\r\n| Driver| The driver object.|\r\n| Driver.RelatedUserDriverGuid| Guid of the Related user driver.|\r\n| Driver.ClockOnTime| The clock on time associated to the route.|\r\n| Driver.ClockOffTime| The clock off time associated to the route.|\r\n| Driver.CrewNumber| The crew number associated to the route.|\r\n| VehicleChecks| The vehicle checks object.|\r\n| VehicleChecks.StartMileage| The start mileage associated to the route.|\r\n| VehicleChecks.StartHubometerTime| The hubometer start time associated to the route.|\r\n| VehicleChecks.EndHubometerTime| The hubometer end time associated to the route.|\r\n| VehicleChecks.EndMileage| The end mileage associated to the route.|\r\n| VehicleChecks.Notes| The notes associated to the route.|\r\n| VehicleChecks.StartSafetyCheck| The start safety check associated to the route.|\r\n| VehicleChecks.StartDefectTicketNo| The start defect ticket number associated to the route.|\r\n| VehicleChecks.StartNotes| The start notes associated to the route.|\r\n| VehicleChecks.EndSafetyCheck| The end safety check associated to the route.|\r\n| VehicleChecks.EndDefectTicketNo| The end defect ticket number associated to the route.|\r\n| VehicleChecks.EndNotes| The end notes associated to the route.|\r\n| VehicleChecks.StartHubometerDistance| The hubometer start distance associated to the route.|\r\n| VehicleChecks.EndHubometerDistance| The hubometer end distance associated to the route.|\r\n| VehicleChecks.CrewMembers[0]| The crew members associated to the vehicle check.|\r\n| VehicleChecks.CrewMembers[0].RelatedSysUserGuid| The related system user guid associated to the crew member of the vehicle check.|\r\n| VehicleChecks.CrewMembers[0].IsDeleted| Whether the crew member is deleted|\r\n| VehicleChecks.CrewMembers[0].Guid| The Guid associated to the crew member of the vehicle check.|\r\n| IsLiftsMatchingConfirmation| Is lifts matching confirmation enabled?|\r\n| RelatedUserDriverGuidFilter| Used to filter on the related driver GUID.|\r\n| RelatedSysUserGuidFilter| Used to filter on the related system user GUID.|\r\n| IsPromptForForceQuantityConfirmation| Prompt for Quantity Confirmation?|\r\n" operationId: Route_GetCollection parameters: - name: filter in: query schema: type: string - name: max in: query schema: type: integer format: int32 - name: page in: query schema: type: integer format: int32 - name: includeCount in: query schema: type: boolean - name: udf in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ApiResourceResultCollection[ApiIntegratorRouteResource]' post: tags: - Route summary: Create or update description: "| Property | Description | Required |\r\n| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |\r\n| GUID| The GUID associated to the route.| No |\r\n| RouteManagementTypeListItem| The GUID and description of the RouteManagementType associated to the route. | Yes |\r\n| AreaOfOriginListItem| The GUID and description of the AreaOfOrigin associated to the route. | No |\r\n| VehicleTypeListItem| The GUID and description of the VehicleType associated to the route. | No |\r\n| MaterialListItem | The GUID and description of the Material associated to the route. | No |\r\n| CompanyOutletListItem| The GUID and description of the CompanyOutlet associated to the route.| No |\r\n| Notes| The notes associated to the route. Editable.| No |\r\n| DefaultTipMaterialListItem| The GUID and description of the DefaultTipMaterial associated to the route.| No |\r\n| IsDiffReasonRequired| Does the route need a Diff Reason?| No |\r\n| IsWeighingsComplete| Are the route weighings complete?| No |\r\n| IsCompleted| Is the route completed?| No |\r\n| IsDeleted| Whether the route is deleted. | No |\r\n| IsMissedReasonRequired| Is the route missed reason required?| No |\r\n| IsPromptForLiftsOnVisitCompletion| Prompt for lifts on visit completion?| No |\r\n| IsOrderSupplierUsedForCostGeneration| Is the order supplier used for cost generation?| No |\r\n| RelatedRouteTemplateGuid| The GUID of the RouteTemplate associated to the route| Yes |\r\n| IsNoTagStopEnabled| Is no tag stop enabled?| No |\r\n| IsSubContracted| Is the route sub contracted?| No |\r\n| RelatedLocationDestinationGuid| Used to filter on the related destination location GUID.| No |\r\n| RelatedVehicleGuid| Used to filter on the related vehicle GUID.| No |\r\n| RelatedMasterRouteGuid| Used to filter on the related master route GUID.| No |\r\n| RelatedSupplierSiteGuid| Used to filter on the related supplier site GUID.| No |\r\n| RelatedSupplierSiteTransportGuid| Used to filter on the related supplier site transport GUID.| No |\r\n| RelatedUserStartDefectCheckGuid| Used to filter on the related start defect check user GUID.| No |\r\n| RelatedUserEndDefectCheckGuid| Used to filter on the related end defect check user GUID.| No |\r\n| StartLeaveYardTime| The leave yard time associated to the route.| No |\r\n| EndYardLeaveTime| The return yard time associated to the route.| No |\r\n| StartPlannedTime| The planned start time associated to the route.| No |\r\n| EndPlannedTime| The planned end time associated to the route.| No |\r\n| StartRouteTime| The start route time associated to the route.| No |\r\n| EndRouteTime| The end route time associated to the route.| No |\r\n| RouteDate| The date associated to the route. | Yes |\r\n| Description| The description associated to the route.| Yes |\r\n| RouteNo| The route no associated to the route.| Yes |\r\n| DistanceTravelled| The distance travelled associated to the route.| No |\r\n| FuelUsed| The fuel used associated to the route.| No |\r\n| FuelCost| The fuel cost associated to the route.| No |\r\n| FleetPlannerTripNo| The fleet planner trip no associated to the route.| No |\r\n| AcceptedMaterials| An array of accepted materials.| No |\r\n| AcceptedMaterials.Guid| Guid of accepted material.| No |\r\n| AcceptedMaterials.IsDeleted| Whether the accepted material is deleted.| Yes |\r\n| AcceptedMaterials.MaterialClassItem| Guid and description of material class.| Yes |\r\n| Driver| The driver object.| No |\r\n| Driver.RelatedUserDriverGuid| Guid of the Related user driver.| No |\r\n| Driver.ClockOnTime| The clock on time associated to the route.| No |\r\n| Driver.ClockOffTime| The clock off time associated to the route.| No |\r\n| Driver.CrewNumber| The crew number associated to the route.| No |\r\n| VehicleChecks| The vehicle checks object.| No |\r\n| VehicleChecks.StartMileage| The start mileage associated to the route.| No |\r\n| VehicleChecks.StartHubometerTime| The hubometer start time associated to the route.| No |\r\n| VehicleChecks.EndHubometerTime| The hubometer end time associated to the route.| No |\r\n| VehicleChecks.EndMileage| The end mileage associated to the route.| No |\r\n| VehicleChecks.Notes| The notes associated to the route.| No |\r\n| VehicleChecks.StartSafetyCheck| The start safety check associated to the route.| No |\r\n| VehicleChecks.StartDefectTicketNo| The start defect ticket number associated to the route.| No |\r\n| VehicleChecks.StartNotes| The start notes associated to the route.| No |\r\n| VehicleChecks.EndSafetyCheck| The end safety check associated to the route.| No |\r\n| VehicleChecks.EndDefectTicketNo| The end defect ticket number associated to the route.| No |\r\n| VehicleChecks.EndNotes| The end notes associated to the route.| No |\r\n| VehicleChecks.StartHubometerDistance| The hubometer start distance associated to the route.| No |\r\n| VehicleChecks.EndHubometerDistance| The hubometer end distance associated to the route.| No |\r\n| VehicleChecks.CrewMembers[0]| The crew members associated to the vehicle check.| No |\r\n| VehicleChecks.CrewMembers[0].RelatedSysUserGuid| The related system user guid associated to the crew member of the vehicle check.| No |\r\n| VehicleChecks.CrewMembers[0].IsDeleted| Whether the crew member is deleted| No |\r\n| VehicleChecks.CrewMembers[0].Guid| The Guid associated to the crew member of the vehicle check.| No |\r\n| IsLiftsMatchingConfirmation| Is lifts matching confirmation enabled?| No |\r\n| RelatedUserDriverGuidFilter| Used to filter on the related driver GUID.| No |\r\n| RelatedSysUserGuidFilter| Used to filter on the related system user GUID.| No |\r\n| IsPromptForForceQuantityConfirmation| Prompt for Quantity Confirmation?| No |\r\n\r\n**Extra validations**\r\n\r\n| Condition | Error message |\r\n| --------- | ------------- |\r\n| RouteManagementTypeListItem is being edited | RouteManagementTypeListItem.Guid is a read-only property. |\r\n| RelatedMasterRouteGuid is being edited | RelatedMasterRouteGuid is a read-only property. |\r\n| Description is being edited | Description is a read-only property. |\r\n| IsDiffReasonRequired is being edited | IsDiffReasonRequired is a read-only property. |\r\n| IsMissedReasonRequired is being edited | IsMissedReasonRequired is a read-only property. |\r\n| IsPromptForLiftsOnVisitCompletion is being edited | IsPromptForLiftsOnVisitCompletion is a read-only property. |\r\n| IsOrderSupplierUsedForCostGeneration is being edited | IsOrderSupplierUsedForCostGeneration is a read-only property. |\r\n| RouteNo is being edited | RouteNo is a read-only property. |\r\n| DistanceTravelled is being edited | DistanceTravelled is a read-only property. |\r\n| FuelUsed is being edited | FuelUsed is a read-only property. |\r\n| FuelCost is being edited | FuelCost is a read-only property. |\r\n| IsNoTagStopEnabled is being edited | IsNoTagStopEnabled is a read-only property. |\r\n| FleetPlannerTripNo is being edited | FleetPlannerTripNo is a read-only property. |\r\n| RouteDate is being edited | RouteDate is a read-only property. |\r\n| StartLeaveYardTime is being edited | StartLeaveYardTime is a read-only property. |\r\n| EndYardLeaveTime is being edited | EndYardLeaveTime is a read-only property. |\r\n| StartPlannedTime is being edited | StartPlannedTime is a read-only property. |\r\n| EndPlannedTime is being edited | EndPlannedTime is a read-only property. |\r\n| Driver.CrewNumber is being edited | Driver.CrewNumber is a read-only property. |\r\n| Driver.ClockOnTime is being edited | Driver.ClockOnTime is a read-only property. |\r\n| Driver.ClockOffTime is being edited | Driver.ClockOffTime is a read-only property. |\r\n| VehicleChecks.RelatedUserStartDefectCheckGuid is being edited | VehicleChecks.RelatedUserStartDefectCheckGuid is a read-only property. |\r\n| VehicleChecks.RelatedUserEndDefectCheckGuid is being edited | VehicleChecks.RelatedUserEndDefectCheckGuid is a read-only property. |\r\n| VehicleChecks.StartSafetyCheck is being edited | VehicleChecks.StartSafetyCheck is a read-only property. |\r\n| VehicleChecks.StartDefectTicketNo is being edited | VehicleChecks.StartDefectTicketNo is a read-only property. |\r\n| VehicleChecks.StartNotes is being edited | VehicleChecks.StartNotes is a read-only property. |\r\n| VehicleChecks.EndSafetyCheck is being edited | VehicleChecks.EndSafetyCheck is a read-only property. |\r\n| VehicleChecks.EndDefectTicketNo is being edited | VehicleChecks.EndDefectTicketNo is a read-only property. |\r\n| VehicleChecks.EndNotes is being edited | VehicleChecks.EndNotes is a read-only property. |\r\n| VehicleChecks.StartHubometerDistance is being edited | VehicleChecks.StartHubometerDistance is a read-only property. |\r\n| VehicleChecks.EndHubometerDistance is being edited | VehicleChecks.EndHubometerDistance is a read-only property. |\r\n| If IsCompleted true and IsWeighingsComplete false | Attempt to complete a route with incomplete weighings. Could not process the update. Ensure the weighings are complete and set the IsWeighingsComplete to true in the request. |\r\n| If IsCompleted updated from true to false and update any property | Attempt to update the properties of a completed route. Could not process the update. Set IsComplete to false individually to uncomplate the route before requesting an update. |\r\n| If IsDeleted is true | IsDeleted is TRUE. Could not process the request. Resources can not be deleted via the REST API. |\r\n| Updating a deleted Route | Failed to save/update Route because attempt to update a deleted Route is not allowed. Could not process the request. |\r\n| AcceptedMaterials.MaterialClassListItem is being edited | AcceptedMaterials.MaterialClassListItem is a read-only property. |\r\n| AcceptedMaterials.MaterialClassListItem.Guid is duplicate | The MaterialClassListItem must be unique per AcceptedMaterials |\r\n| If AreaOfOriginListItem.Guid is null and RelatedSupplierSiteTransportGuid is null | The mandatory property AreaOfOriginListItem.Guid has a null value. The request could not be processed. Supply a value for the AreaOfOriginListItem.Guid property of the submitted resource. |\r\n| If IsWeighingsComplete is true on insert | Failed to save/update Route because IsWeighingsComplete property cannot be set to true upon creation. |\r\n| If IsCompleted is true on insert | Failed to save/update Route because IsCompleted property cannot be set to true upon creation. |\r\n| If DefaultTipMaterialListItem.Guid is null and RouteManagementTypeListItem is Handheld or On Vehicle on insert| Failed to save/update Route because DefaultTipMaterialListItem is required if RouteManagementType is Handheld or On Vehicle. |\r\n| If Driver.ClockOffTime is before the Driver.ClockOnTime on insert | Failed to save/update Route because Driver.ClockOffTime cannot be before Driver.ClockOnTime. |\r\n| If VehicleChecks.StartDefectTicketNo is more than 20 characters long on insert | Failed to save/update Route because VehicleChecks.StartDefectTicketNo must be no more than 20 characters long. |\r\n| If VehicleChecks.EndDefectTicketNo is more than 20 characters long on insert | Failed to save/update Route because VehicleChecks.EndDefectTicketNo must be no more than 20 characters long. |\r\n| If VehicleChecks.CrewMembers is not empty on insert | Failed to save/update Route because Crewmembers creation is not permitted. |\r\n| IsPromptForForceQuantityConfirmation is being edited | IsPromptForForceQuantityConfirmation is a read-only property. |\r\n" operationId: Route_Create requestBody: content: application/json: schema: $ref: '#/components/schemas/ApiIntegratorRouteResource' required: true x-bodyName: null responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ApiResourceId' components: schemas: ApiIntegratorListItemResource: type: object properties: Description: type: string Guid: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 ApiResourceResultUpdatesExtra: type: object properties: until: type: string cursor: type: string ApiResourceId: type: object properties: resource: type: string format: uuid errors: $ref: '#/components/schemas/ApiResourceErrors' status: $ref: '#/components/schemas/ApiResourceStatus' ApiIntegratorRouteDriverResource: type: object properties: RelatedUserDriverGuid: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 ClockOnTime: type: string format: zonedDateTime example: DateTime: '2000-01-01' TimeZone: Europe/London ClockOffTime: type: string format: zonedDateTime example: DateTime: '2000-01-01' TimeZone: Europe/London CrewNumber: type: integer format: int32 ApiResourceErrors: type: object properties: errors: type: string ApiIntegratorRouteResource: type: object properties: Description: type: string RouteManagementTypeListItem: $ref: '#/components/schemas/ApiIntegratorListItemResource' IsDiffReasonRequired: type: boolean IsWeighingsComplete: type: boolean IsCompleted: type: boolean IsDeleted: type: boolean IsMissedReasonRequired: type: boolean IsPromptForLiftsOnVisitCompletion: type: boolean IsOrderSupplierUsedForCostGeneration: type: boolean RelatedRouteTemplateGuid: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 RelatedLocationDestinationGuid: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 RelatedVehicleGuid: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 RelatedExternalVehicleGuid: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 RelatedMasterRouteGuid: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 RelatedSupplierSiteGuid: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 RelatedSupplierSiteTransportGuid: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 AreaOfOriginListItem: $ref: '#/components/schemas/ApiIntegratorListItemResource' VehicleTypeListItem: $ref: '#/components/schemas/ApiIntegratorListItemResource' MaterialListItem: $ref: '#/components/schemas/ApiIntegratorListItemResource' CompanyOutletListItem: $ref: '#/components/schemas/ApiIntegratorListItemResource' DefaultTipMaterialListItem: $ref: '#/components/schemas/ApiIntegratorListItemResource' RouteDate: type: string format: zonedDateTime example: DateTime: '2000-01-01' TimeZone: Europe/London RouteNo: type: integer format: int32 IsSubContracted: type: boolean StartLeaveYardTime: type: string format: zonedDateTime example: DateTime: '2000-01-01' TimeZone: Europe/London EndYardLeaveTime: type: string format: zonedDateTime example: DateTime: '2000-01-01' TimeZone: Europe/London StartPlannedTime: type: string format: zonedDateTime example: DateTime: '2000-01-01' TimeZone: Europe/London EndPlannedTime: type: string format: zonedDateTime example: DateTime: '2000-01-01' TimeZone: Europe/London StartRouteTime: type: string format: zonedDateTime example: DateTime: '2000-01-01' TimeZone: Europe/London EndRouteTime: type: string format: zonedDateTime example: DateTime: '2000-01-01' TimeZone: Europe/London DistanceTravelled: type: number format: double FuelUsed: type: number format: double FuelCost: type: number format: double IsNoTagStopEnabled: type: boolean FleetPlannerTripNo: type: string AcceptedMaterials: type: array items: $ref: '#/components/schemas/ApiIntegratorRouteAcceptedMaterialsResource' Driver: $ref: '#/components/schemas/ApiIntegratorRouteDriverResource' VehicleChecks: $ref: '#/components/schemas/ApiIntegratorRouteVehicleCheckResource' RelatedUserDriverGuidFilter: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 RelatedUserStartDefectCheckGuid: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 RelatedUserEndDefectCheckGuid: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 Notes: type: string IsLiftsMatchingConfirmation: type: boolean RelatedSysUserGuidFilter: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 IsPromptForForceQuantityConfirmation: type: boolean GUID: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 ApiResourceChanges[ApiIntegratorRouteResource]: type: object properties: resource: type: array items: $ref: '#/components/schemas/ApiIntegratorRouteResource' extra: $ref: '#/components/schemas/ApiResourceResultUpdatesExtra' errors: $ref: '#/components/schemas/ApiResourceErrors' status: $ref: '#/components/schemas/ApiResourceStatus' ApiIntegratorRouteAcceptedMaterialsResource: type: object properties: Guid: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 IsDeleted: type: boolean MaterialClassListItem: $ref: '#/components/schemas/ApiIntegratorListItemResource' ApiResourceResultCollectionExtra: type: object properties: count: type: integer format: int32 ApiIntegratorRouteVehicleCheckResource: type: object properties: StartMileage: type: number format: double EndMileage: type: number format: double Notes: type: string StartSafetyCheck: type: boolean StartDefectTicketNo: type: string RelatedUserStartDefectCheckGuid: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 StartNotes: type: string EndSafetyCheck: type: boolean EndDefectTicketNo: type: string RelatedUserEndDefectCheckGuid: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 EndNotes: type: string StartHubometerDistance: type: number format: double EndHubometerDistance: type: number format: double StartHubometerTime: type: number format: double EndHubometerTime: type: number format: double CrewMembers: type: array items: $ref: '#/components/schemas/ApiIntegratorRouteVehicleCheckCrewMembersResource' ApiResourceResultCollection[ApiIntegratorRouteResource]: type: object properties: resource: type: array items: $ref: '#/components/schemas/ApiIntegratorRouteResource' extra: $ref: '#/components/schemas/ApiResourceResultCollectionExtra' errors: $ref: '#/components/schemas/ApiResourceErrors' status: $ref: '#/components/schemas/ApiResourceStatus' ApiIntegratorRouteVehicleCheckCrewMembersResource: type: object properties: RelatedSysUserGuid: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 IsDeleted: type: boolean Guid: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 ApiResourceResultEntity[ApiIntegratorRouteResource]: type: object properties: resource: $ref: '#/components/schemas/ApiIntegratorRouteResource' links: $ref: '#/components/schemas/ApiResourceResultEntityLinks' extra: $ref: '#/components/schemas/ApiResourceResultEntityExtra' errors: $ref: '#/components/schemas/ApiResourceErrors' status: $ref: '#/components/schemas/ApiResourceStatus' ApiResourceResultEntityExtra: type: object properties: expand: type: object additionalProperties: type: object additionalProperties: type: object include: type: object additionalProperties: type: array items: type: object additionalProperties: type: object ApiResourceResultEntityLinks: type: object properties: self: type: string associations: type: array items: type: string expand: type: array items: type: string operations: type: array items: type: string ApiResourceStatus: type: object properties: id: type: integer format: int32 isSuccess: type: boolean