AMCS Group Route API
The Route API from AMCS Group — 3 operation(s) for route.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amcs-group-route-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Core AccessGroup Route API
version: core
servers:
- url: https://rstapi-sbx-svc-core.amcsplatform.com/erp/api/integrator/erp
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Route
paths:
/transport/routes/changes:
get:
tags:
- Route
summary: Retrieve changes
description: '| Property| Description |
| --------------------------------------------- | ----------------------------------------------------------------------------- |
| GUID| The GUID associated to the route.|
| RouteManagementTypeListItem| The GUID and description of the RouteManagementType associated to the route. |
| AreaOfOriginListItem| The GUID and description of the AreaOfOrigin associated to the route. |
| VehicleTypeListItem| The GUID and description of the VehicleType associated to the route. |
| MaterialListItem| The GUID and description of the Material associated to the route. |
| CompanyOutletListItem| The GUID and description of the CompanyOutlet associated to the route.|
| DefaultTipMaterialListItem| The GUID and description of the DefaultTipMaterial associated to the route.|
| Notes| The notes associated to the Route. Filterable.|
| IsDiffReasonRequired| Does the route need a Diff Reason?|
| IsWeighingsComplete| Are the route weighings complete?|
| IsCompleted| Is the route completed?|
| IsDeleted| Whether the route is deleted. |
| IsMissedReasonRequired| Is the route missed reason required?|
| IsPromptForLiftsOnVisitCompletion| Prompt for lifts on visit completion?|
| IsOrderSupplierUsedForCostGeneration| Is the order supplier used for cost generation?|
| RelatedRouteTemplateGuid| The GUID of the RouteTemplate associated to the route|
| IsNoTagStopEnabled| Is no tag stop enabled?|
| IsSubContracted| Is the route sub contracted?|
| RelatedLocationDestinationGuid| Used to filter on the related destination location GUID.|
| RelatedVehicleGuid| Used to filter on the related vehicle GUID.|
| RelatedMasterRouteGuid| Used to filter on the related master route GUID.|
| RelatedSupplierSiteGuid| Used to filter on the related supplier site GUID.|
| RelatedSupplierSiteTransportGuid| Used to filter on the related supplier site transport GUID.|
| RelatedUserStartDefectCheckGuid| Used to filter on the related start defect check user GUID.|
| RelatedUserEndDefectCheckGuid| Used to filter on the related end defect check user GUID.|
| StartLeaveYardTime| The leave yard time associated to the route.|
| EndYardLeaveTime| The return yard time associated to the route.|
| StartPlannedTime| The planned start time associated to the route.|
| EndPlannedTime| The planned end time associated to the route.|
| StartRouteTime| The start route time associated to the route.|
| EndRouteTime| The end route time associated to the route.|
| RouteDate| The date associated to the route.Filterable.|
| Description| The description associated to the route.|
| RouteNo| The route no associated to the route.Filterable.|
| DistanceTravelled| The distance travelled associated to the route.|
| FuelUsed| The fuel used associated to the route.|
| FuelCost| The fuel cost associated to the route.|
| FleetPlannerTripNo| The fleet planner trip no associated to the route.|
| AcceptedMaterials| An array of accepted materials.|
| AcceptedMaterials[0].Guid| The GUID of accepted material.|
| AcceptedMaterials[0].IsDeleted| Whether accepted material is deleted.|
| AcceptedMaterials[0].MaterialClassListItem| The GUID and description of material class|
| Driver| The driver object.|
| Driver.RelatedUserDriverGuid| Guid of the Related user driver.|
| Driver.ClockOnTime| The clock on time associated to the route.|
| Driver.ClockOffTime| The clock off time associated to the route.|
| Driver.CrewNumber| The crew number associated to the route.|
| VehicleChecks| The vehicle checks object.|
| VehicleChecks.StartMileage| The start mileage associated to the route.|
| VehicleChecks.StartHubometerTime| The hubometer start time associated to the route.|
| VehicleChecks.EndHubometerTime| The hubometer end time associated to the route.|
| VehicleChecks.EndMileage| The end mileage associated to the route.|
| VehicleChecks.Notes| The notes associated to the route.|
| VehicleChecks.StartSafetyCheck| The start safety check associated to the route.|
| VehicleChecks.StartDefectTicketNo| The start defect ticket number associated to the route.|
| VehicleChecks.StartNotes| The start notes associated to the route.|
| VehicleChecks.EndSafetyCheck| The end safety check associated to the route.|
| VehicleChecks.EndDefectTicketNo| The end defect ticket number associated to the route.|
| VehicleChecks.EndNotes| The end notes associated to the route.|
| VehicleChecks.StartHubometerDistance| The hubometer start distance associated to the route.|
| VehicleChecks.EndHubometerDistance| The hubometer end distance associated to the route.|
| VehicleChecks.CrewMembers[0]| The crew members associated to the vehicle check.|
| VehicleChecks.CrewMembers[0].RelatedSysUserGuid| The related system user guid associated to the crew member of the vehicle check.|
| VehicleChecks.CrewMembers[0].IsDeleted| Whether the crew member is deleted|
| VehicleChecks.CrewMembers[0].Guid| The Guid associated to the crew member of the vehicle check.|
| IsLiftsMatchingConfirmation| Is lifts matching confirmation enabled?|
| RelatedUserDriverGuidFilter| Used to filter on the related driver GUID.|
| RelatedSysUserGuidFilter| Used to filter on the related system user GUID.|
| IsPromptForForceQuantityConfirmation| Prompt for Quantity Confirmation?|
'
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 |
| --------------------------------------------- | ----------------------------------------------------------------------------- |
| GUID| The GUID associated to the route.|
| RouteManagementTypeListItem| The GUID and description of the RouteManagementType associated to the route. |
| AreaOfOriginListItem| The GUID and description of the AreaOfOrigin associated to the route. |
| VehicleTypeListItem| The GUID and description of the VehicleType associated to the route. |
| MaterialListItem| The GUID and description of the Material associated to the route. |
| CompanyOutletListItem| The GUID and description of the CompanyOutlet associated to the route.|
| DefaultTipMaterialListItem| The GUID and description of the DefaultTipMaterial associated to the route.|
| Notes| The notes associated to the Route. Filterable.|
| IsDiffReasonRequired| Does the route need a Diff Reason?|
| IsWeighingsComplete| Are the route weighings complete?|
| IsCompleted| Is the route completed?|
| IsDeleted| Whether the route is deleted. |
| IsMissedReasonRequired| Is the route missed reason required?|
| IsPromptForLiftsOnVisitCompletion| Prompt for lifts on visit completion?|
| IsOrderSupplierUsedForCostGeneration| Is the order supplier used for cost generation?|
| RelatedRouteTemplateGuid| The GUID of the RouteTemplate associated to the route|
| IsNoTagStopEnabled| Is no tag stop enabled?|
| IsSubContracted| Is the route sub contracted?|
| RelatedLocationDestinationGuid| Used to filter on the related destination location GUID.|
| RelatedVehicleGuid| Used to filter on the related vehicle GUID.|
| RelatedMasterRouteGuid| Used to filter on the related master route GUID.|
| RelatedSupplierSiteGuid| Used to filter on the related supplier site GUID.|
| RelatedSupplierSiteTransportGuid| Used to filter on the related supplier site transport GUID.|
| RelatedUserStartDefectCheckGuid| Used to filter on the related start defect check user GUID.|
| RelatedUserEndDefectCheckGuid| Used to filter on the related end defect check user GUID.|
| StartLeaveYardTime| The leave yard time associated to the route.|
| EndYardLeaveTime| The return yard time associated to the route.|
| StartPlannedTime| The planned start time associated to the route.|
| EndPlannedTime| The planned end time associated to the route.|
| StartRouteTime| The start route time associated to the route.|
| EndRouteTime| The end route time associated to the route.|
| RouteDate| The date associated to the route.Filterable.|
| Description| The description associated to the route.|
| RouteNo| The route no associated to the route.Filterable.|
| DistanceTravelled| The distance travelled associated to the route.|
| FuelUsed| The fuel used associated to the route.|
| FuelCost| The fuel cost associated to the route.|
| FleetPlannerTripNo| The fleet planner trip no associated to the route.|
| AcceptedMaterials| An array of accepted materials.|
| AcceptedMaterials[0].Guid| The GUID of accepted material.|
| AcceptedMaterials[0].IsDeleted| Whether accepted material is deleted.|
| AcceptedMaterials[0].MaterialClassListItem| The GUID and description of material class|
| Driver| The driver object.|
| Driver.RelatedUserDriverGuid| Guid of the Related user driver.|
| Driver.ClockOnTime| The clock on time associated to the route.|
| Driver.ClockOffTime| The clock off time associated to the route.|
| Driver.CrewNumber| The crew number associated to the route.|
| VehicleChecks| The vehicle checks object.|
| VehicleChecks.StartMileage| The start mileage associated to the route.|
| VehicleChecks.StartHubometerTime| The hubometer start time associated to the route.|
| VehicleChecks.EndHubometerTime| The hubometer end time associated to the route.|
| VehicleChecks.EndMileage| The end mileage associated to the route.|
| VehicleChecks.Notes| The notes associated to the route.|
| VehicleChecks.StartSafetyCheck| The start safety check associated to the route.|
| VehicleChecks.StartDefectTicketNo| The start defect ticket number associated to the route.|
| VehicleChecks.StartNotes| The start notes associated to the route.|
| VehicleChecks.EndSafetyCheck| The end safety check associated to the route.|
| VehicleChecks.EndDefectTicketNo| The end defect ticket number associated to the route.|
| VehicleChecks.EndNotes| The end notes associated to the route.|
| VehicleChecks.StartHubometerDistance| The hubometer start distance associated to the route.|
| VehicleChecks.EndHubometerDistance| The hubometer end distance associated to the route.|
| VehicleChecks.CrewMembers[0]| The crew members associated to the vehicle check.|
| VehicleChecks.CrewMembers[0].RelatedSysUserGuid| The related system user guid associated to the crew member of the vehicle check.|
| VehicleChecks.CrewMembers[0].IsDeleted| Whether the crew member is deleted|
| VehicleChecks.CrewMembers[0].Guid| The Guid associated to the crew member of the vehicle check.|
| IsLiftsMatchingConfirmation| Is lifts matching confirmation enabled?|
| RelatedUserDriverGuidFilter| Used to filter on the related driver GUID.|
| RelatedSysUserGuidFilter| Used to filter on the related system user GUID.|
| IsPromptForForceQuantityConfirmation| Prompt for Quantity Confirmation?|
'
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 |
| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |
| GUID| The GUID associated to the route.| No |
| RouteManagementTypeListItem| The GUID and description of the RouteManagementType associated to the route. | Yes |
| AreaOfOriginListItem| The GUID and description of the AreaOfOrigin associated to the route. | No |
| VehicleTypeListItem| The GUID and description of the VehicleType associated to the route. | No |
| MaterialListItem | The GUID and description of the Material associated to the route. | No |
| CompanyOutletListItem| The GUID and description of the CompanyOutlet associated to the route.| No |
| Notes| The notes associated to the route. Editable.| No |
| DefaultTipMaterialListItem| The GUID and description of the DefaultTipMaterial associated to the route.| No |
| IsDiffReasonRequired| Does the route need a Diff Reason?| No |
| IsWeighingsComplete| Are the route weighings complete?| No |
| IsCompleted| Is the route completed?| No |
| IsDeleted| Whether the route is deleted.| No |
| IsMissedReasonRequired| Is the route missed reason required?| No |
| IsPromptForLiftsOnVisitCompletion| Prompt for lifts on visit completion?| No |
| IsOrderSupplierUsedForCostGeneration| Is the order supplier used for cost generation?| No |
| RelatedRouteTemplateGuid| The GUID of the RouteTemplate associated to the route| Yes |
| IsNoTagStopEnabled| Is no tag stop enabled?| No |
| IsSubContracted| Is the route sub contracted?| No |
| RelatedLocationDestinationGuid| Used to filter on the related destination location GUID.| No |
| RelatedVehicleGuid| Used to filter on the related vehicle GUID.| No |
| RelatedMasterRouteGuid| Used to filter on the related master route GUID.| No |
| RelatedSupplierSiteGuid| Used to filter on the related supplier site GUID.| No |
| RelatedSupplierSiteTransportGuid| Used to filter on the related supplier site transport GUID.| No |
| RelatedUserStartDefectCheckGuid| Used to filter on the related start defect check user GUID.| No |
| RelatedUserEndDefectCheckGuid| Used to filter on the related end defect check user GUID.| No |
| StartLeaveYardTime| The leave yard time associated to the route.| No |
| EndYardLeaveTime| The return yard time associated to the route.| No |
| StartPlannedTime| The planned start time associated to the route.| No |
| EndPlannedTime| The planned end time associated to the route.| No |
| StartRouteTime| The start route time associated to the route.| No |
| EndRouteTime| The end route time associated to the route.| No |
| RouteDate| The date associated to the route.| No |
| Description| The description associated to the route.| Yes |
| RouteNo| The route no associated to the route.| No |
| DistanceTravelled| The distance travelled associated to the route.| No |
| FuelUsed| The fuel used associated to the route.| No |
| FuelCost| The fuel cost associated to the route.| No |
| FleetPlannerTripNo| The fleet planner trip no associated to the route.| No |
| AcceptedMaterials| An array of accepted materials.| No |
| AcceptedMaterials.Guid| Guid of accepted material.| No |
| AcceptedMaterials.IsDeleted| Whether the accepted material is deleted.| Yes |
| AcceptedMaterials.MaterialClassItem| Guid and description of material class.| Yes |
| Driver| The driver object.| No |
| Driver.RelatedUserDriverGuid| Guid of the Related user driver.| No |
| Driver.ClockOnTime| The clock on time associated to the route.| No |
| Driver.ClockOffTime| The clock off time associated to the route.| No |
| Driver.CrewNumber| The crew number associated to the route.| No |
| VehicleChecks| The vehicle checks object.| No |
| VehicleChecks.StartMileage| The start mileage associated to the route.| No |
| VehicleChecks.StartHubometerTime| The hubometer start time associated to the route.| No |
| VehicleChecks.EndHubometerTime| The hubometer end time associated to the route.| No |
| VehicleChecks.EndMileage| The end mileage associated to the route.| No |
| VehicleChecks.Notes| The notes associated to the route.| No |
| VehicleChecks.StartSafetyCheck| The start safety check associated to the route.| No |
| VehicleChecks.StartDefectTicketNo| The start defect ticket number associated to the route.| No |
| VehicleChecks.StartNotes| The start notes associated to the route.| No |
| VehicleChecks.EndSafetyCheck| The end safety check associated to the route.| No |
| VehicleChecks.EndDefectTicketNo| The end defect ticket number associated to the route.| No |
| VehicleChecks.EndNotes| The end notes associated to the route.| No |
| VehicleChecks.StartHubometerDistance| The hubometer start distance associated to the route.| No |
| VehicleChecks.EndHubometerDistance| The hubometer end distance associated to the route.| No |
| VehicleChecks.CrewMembers[0]| The crew members associated to the vehicle check.| No |
| VehicleChecks.CrewMembers[0].RelatedSysUserGuid| The related system user guid associated to the crew member of the vehicle check.| No |
| VehicleChecks.CrewMembers[0].IsDeleted| Whether the crew member is deleted| No |
| VehicleChecks.CrewMembers[0].Guid| The Guid associated to the crew member of the vehicle check.| No |
| IsLiftsMatchingConfirmation| Is lifts matching confirmation enabled?| No |
| RelatedUserDriverGuidFilter| Used to filter on the related driver GUID.| No |
| RelatedSysUserGuidFilter| Used to filter on the related system user GUID.| No |
| IsPromptForForceQuantityConfirmation| Prompt for Quantity Confirmation?| No |
**Extra validations**
| Condition | Error message |
| --------- | ------------- |
| RouteManagementTypeListItem is being edited | RouteManagementTypeListItem.Guid is a read-only property. |
| RelatedMasterRouteGuid is being edited | RelatedMasterRouteGuid is a read-only property. |
| Description is being edited | Description is a read-only property. |
| IsDiffReasonRequired is being edited | IsDiffReasonRequired is a read-only property. |
| IsMissedReasonRequired is being edited | IsMissedReasonRequired is a read-only property. |
| IsOrderSupplierUsedForCostGeneration is being edited | IsOrderSupplierUsedForCostGeneration is a read-only property. |
| RouteNo is being edited | RouteNo is a read-only property. |
| DistanceTravelled is being edited | DistanceTravelled is a read-only property. |
| FuelUsed is being edited | FuelUsed is a read-only property. |
| FuelCost is being edited | FuelCost is a read-only property. |
| IsNoTagStopEnabled is being edited | IsNoTagStopEnabled is a read-only property. |
| FleetPlannerTripNo is being edited | FleetPlannerTripNo is a read-only property. |
| RouteDate is being edited | RouteDate is a read-only property. |
| StartLeaveYardTime is being edited | StartLeaveYardTime is a read-only property. |
| EndYardLeaveTime is being edited | EndYardLeaveTime is a read-only property. |
| StartPlannedTime is being edited | StartPlannedTime is a read-only property. |
| EndPlannedTime is being edited | EndPlannedTime is a read-only property. |
| Driver.CrewNumber is being edited | Driver.CrewNumber is a read-only property. |
| Driver.ClockOnTime is being edited | Driver.ClockOnTime is a read-only property. |
| Driver.ClockOffTime is being edited | Driver.ClockOffTime is a read-only property. |
| VehicleChecks.RelatedUserStartDefectCheckGuid is being edited | VehicleChecks.RelatedUserStartDefectCheckGuid is a read-only property. |
| VehicleChecks.RelatedUserEndDefectCheckGuid is being edited | VehicleChecks.RelatedUserEndDefectCheckGuid is a read-only property. |
| VehicleChecks.StartSafetyCheck is being edited | VehicleChecks.StartSafetyCheck is a read-only property. |
| VehicleChecks.StartDefectTicketNo is being edited | VehicleChecks.StartDefectTicketNo is a read-only property. |
| VehicleChecks.StartNotes is being edited | VehicleChecks.StartNotes is a read-only property. |
| VehicleChecks.EndSafetyCheck is being edited | VehicleChecks.EndSafetyCheck is a read-only property. |
| VehicleChecks.EndDefectTicketNo is being edited | VehicleChecks.EndDefectTicketNo is a read-only property. |
| VehicleChecks.EndNotes is being edited | VehicleChecks.EndNotes is a read-only property. |
| VehicleChecks.StartHubometerDistance is being edited | VehicleChecks.StartHubometerDistance is a read-only property. |
| VehicleChecks.EndHubometerDistance is being edited | VehicleChecks.EndHubometerDistance is a read-only property. |
| 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. |
| 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. |
| If IsDeleted is true | IsDeleted is TRUE. Could not process the request. Resources can not be deleted via the REST API. |
| Updating a deleted Route | Failed to save/update Route because attempt to update a deleted Route is not allowed. Could not process the request. |
| AcceptedMaterials.MaterialClassListItem is being edited | AcceptedMaterials.MaterialClassListItem is a read-only property. |
| AcceptedMaterials.MaterialClassListItem.Guid is duplicate | The MaterialClassListItem must be unique per AcceptedMaterials |
| 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. |
| 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 |
| --------------------------------------------- | ----------------------------------------------------------------------------- |
| GUID| The GUID associated to the route.|
| RouteManagementTypeListItem| The GUID and description of the RouteManagementType associated to the route. |
| AreaOfOriginListItem| The GUID and description of the AreaOfOrigin associated to the route. |
| VehicleTypeListItem| The GUID and description of the VehicleType associated to the route. |
| MaterialListItem| The GUID and description of the Material associated to the route. |
| CompanyOutletListItem| The GUID and description of the CompanyOutlet associated to the route.|
| DefaultTipMaterialListItem| The GUID and description of the DefaultTipMaterial associated to the route.|
| Notes| The notes associated to the Route. Filterable.|
| IsDiffReasonRequired| Does the route need a Diff Reason?|
| IsWeighingsComplete| Are the route weighings complete?|
| IsCompleted| Is the route completed?|
| IsDeleted| Whether the route is deleted. |
| IsMissedReasonRequired| Is the route missed reason required?|
| IsPromptForLiftsOnVisitCompletion| Prompt for lifts on visit completion?|
| IsOrderSupplierUsedForCostGeneration| Is the order supplier used for cost generation?|
| RelatedRouteTemplateGuid| The GUID of the RouteTemplate associated to the route|
| IsNoTagStopEnabled| Is no tag stop enabled?|
| IsSubContracted| Is the route sub contracted?|
| RelatedLocationDestinationGuid| Used to filter on the related destination location GUID.|
| RelatedVehicleGuid| Used to filter on the related vehicle GUID.|
| RelatedMasterRouteGuid| Used to filter on the related master route GUID.|
| RelatedSupplierSiteGuid| Used to filter on the related supplier site GUID.|
| RelatedSupplierSiteTransportGuid| Used to filter on the related supplier site transport GUID.|
| RelatedUserStartDefectCheckGuid| Used to filter on the related start defect check user GUID.|
| RelatedUserEndDefectCheckGuid| Used to filter on the related end defect check user GUID.|
| StartLeaveYardTime| The leave yard time associated to the route.|
| EndYardLeaveTime| The return yard time associated to the route.|
| StartPlannedTime| The planned start time associated to the route.|
| EndPlannedTime| The planned end time associated to the route.|
| StartRouteTime| The start route time associated to the route.|
| EndRouteTime| The end route time associated to the route.|
| RouteDate| The date associated to the route.Filterable.|
| Description| The description associated to the route.|
| RouteNo| The route no associated to the route.Filterable.|
| DistanceTravelled| The distance travelled associated to the route.|
| FuelUsed| The fuel used associated to the route.|
| FuelCost| The fuel cost associated to the route.|
| FleetPlannerTripNo| The fleet planner trip no associated to the route.|
| AcceptedMaterials| An array of accepted materials.|
| AcceptedMaterials[0].Guid| The GUID of accepted material.|
| AcceptedMaterials[0].IsDeleted| Whether accepted material is deleted.|
| AcceptedMaterials[0].MaterialClassListItem| The GUID and description of material class|
| Driver| The driver object.|
| Driver.RelatedUserDriverGuid| Guid of the Related user driver.|
| Driver.ClockOnTime| The clock on time associated to the route.|
| Driver.ClockOffTime| The clock off time associated to the route.|
| Driver.CrewNumber| The crew number associated to the route.|
| VehicleChecks| The vehicle checks object.|
| VehicleChecks.StartMileage| The start mileage associated to the route.|
| VehicleChecks.StartHubometerTime| The hubometer start time associated to the route.|
| VehicleChecks.EndHubometerTime| The hubometer end time associated to the route.|
| VehicleChecks.EndMileage| The end mileage associated to the route.|
| VehicleChecks.Notes| The notes associated to the route.|
| VehicleChecks.StartSafetyCheck| The start safety check associated to the route.|
| VehicleChecks.StartDefectTicketNo| The start defect ticket number associated to the route.|
| VehicleChecks.StartNotes| The start notes associated to the route.|
| VehicleChecks.EndSafetyCheck| The end safety check associated to the route.|
| VehicleChecks.EndDefectTicketNo| The end defect ticket number associated to the route.|
| VehicleChecks.EndNotes| The end notes associated to the route.|
| VehicleChecks.StartHubometerDistance| The hubometer start distance associated to the route.|
| VehicleChecks.EndHubometerDistance| The hubometer end distance associated to the route.|
| VehicleChecks.CrewMembers[0]| The crew members associated to the vehicle check.|
| VehicleChecks.CrewMembers[0].RelatedSysUserGuid| The related system user guid associated to the crew member of the vehicle check.|
| VehicleChecks.CrewMembers[0].IsDeleted| Whether the crew member is deleted|
| VehicleChecks.CrewMembers[0].Guid| The Guid associated to the crew member of the vehicle check.|
| IsLiftsMatchingConfirmation| Is lifts matching confirmation enabled?|
| RelatedUserDriverGuidFilter| Used to filter on the related driver GUID.|
| RelatedSysUserGuidFilter| Used to filter on the related system user GUID.|
| IsPromptForForceQuantityConfirmation| Prompt for Quantity Confirmation?|
'
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 |
| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |
| GUID| The GUID associated to the route.| No |
| RouteManagementTypeListItem| The GUID and description of the RouteManagementType associated to the route. | Yes |
| AreaOfOriginListItem| The GUID and description of the AreaOfOrigin associated to the route. | No |
| VehicleTypeListItem| The GUID and description of the VehicleType associated to the route. | No |
| MaterialListItem | The GUID and description of the Material associated to the route. | No |
| CompanyOutletListItem| The GUID and description of the CompanyOutlet associated to the route.| No |
| Notes| The notes associated to the route. Editable.| No |
| DefaultTipMaterialListItem| The GUID and description of the De
# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amcs-group/refs/heads/main/openapi/amcs-group-route-api-openapi.yml