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:amcs-group-route-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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: AMCS Platform REST Route API
description: '
# Overview
## Who Should Read this Document
This document contains a technical description of the AMCS Platform REST API. It is intended for:
· System integrators
· Customer IT team looking to integrate AMCS Platform with another system
· Third parties looking to integrate their system with AMCS Platform
## Document Scope
This document introduces the technical aspects of the AMCS Platform REST API. The purpose of this document is to provide readers with detail on how to:
· Access the REST API
· Make calls to the API to retrieve, append and update resources
· Retrieve the incremental changes to a collection
· Find more detail on the end points that are available from an environment. ## Summary
AMCS Platform REST API is designed to support the integration of AMCS Platform with other systems. With care and additional infrastructure, the REST API can be used to build functionality on top of Platform but that is not it’s primary purpose. The ‘changes since’ process provides the main means of performing an initial synchronisation of the AMCS Platform and another system, and then keeping them synchronised. Methods are also provided to create and update resources. # Integration Patterns and Tools
The AMCS Platform provides a number of tools that can be used to connect systems. Care should be taken to match the right tooling to the intended pattern of integration. · When an extract-based approach is needed, use BI reporting. · When derived values are require, use the data mart. · When business processes on different systems need to be integrated by synchronising the data on each through an event style interface, use the REST API. An integration using the REST API will need to take full responsibility for all aspects of the integration including:
· Pulling change events from AMCS Platform
· Filtering the changed resources for the ones that are of interest
· Pulling additional resources from the REST API in order the retrieve all the properties needed by the destination
· Mashing resources to create the complete view required
· Translating that into the form required by the destination
· Validating this to ensure it meet the entry rules of the destination
· Pushing the result to the destination
In the early stages of designing the interface care should be taken to ensure that the need for caching/staging has been considered. The changes since functionality is effectively a means of pulling create/change events from platform. The only filters available enable retrieval of related resources to build a view external to AMCS Platform
# Basics
The AMCS REST API provides a RESTful interface that allows access to the primary business resources of the AMCS platform. The interface follows general HATEOAS compliance principles. ## Quick start
A quickstart walkthrough based on node.js and covering authentication and getting a page of customers can be found here. ## Interface definitions
Swagger documentation for the end points available on an environment can be found at:
Before 8.5: https://{environment domain name}/swagger/ui/index
From 8.5: https://{environment domain name}/erp/api/swagger/ui/index
## HTTP Interface
The following HTTP RESTful methods are provided as part of this API:
· GET: Provides read access to retrieve details of one or more resources. · POST: Creates or updates a single resource or a set of resources. · PUT: Updates a single resource or a set of resources. Note:
· DELETE methods are currently not provided as part of the API. The REST API URIs begin with
https://{environment domain name}/erp/api/integrator/erp
For example:
https://prod.amcs-at-mycompany.com/erp/api/integrator/erp
This should be used as the base of the URI.'
version: latest
servers:
- url: https://ete-p5-tst-svc-core.amcsplatform.com/erp/api/integrator/erp
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.'
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.'
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.'
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.'
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 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.'
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:
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
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'
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
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
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
ApiResourceResultUpdatesExtra:
type: object
properties:
until:
type: string
cursor:
type: string
ApiIntegratorListItemResource:
type: object
properties:
Description:
type: string
Guid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
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
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'
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'
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'
ApiIntegratorRouteAcceptedMaterialsResource:
type: object
properties:
Guid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
IsDeleted:
type: boolean
MaterialClassListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
ApiResourceStatus:
type: object
properties:
id:
type: integer
format: int32
isSuccess:
type: boolean
ApiResourceId:
type: object
properties:
resource:
type: string
format: uuid
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceErrors:
type: object
properties:
errors:
type: string