AMCS Group RouteAssignment API
The RouteAssignment API from AMCS Group — 2 operation(s) for routeassignment.
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-routeassignment-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 Assignment 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: RouteAssignment
paths:
/transport/routeAssignments/{guid}:
get:
tags:
- RouteAssignment
summary: Find with GUID
description: '| Property | Description |
| ------------------------- | ------------------------------------------------------------------------ |
| GUID| The GUID associated to the routeAssignment.|
| RelatedOrderGuid| The GUID of the RelatedOrder associated to the routeAssignment.|
| ActionListItem| The GUID and description of the Action associated to the routeAssignment.|
| ContainerTypeListItem| The GUID and description of the ContainerType associated to the routeAssignment.|
| PickupIntervalListItem| The GUID and description of the PickupInterval associated to the routeAssignment.|
| DayOfWeekListItem| The GUID and description of the DayOfWeek associated to the routeAssignment.|
| DayOfOccurrenceInMonthListItem| The GUID and description of the Day of Occurrence in month associated to the routeAssignment.|
| RelatedRouteTemplateGuid| The GUID of the RelatedRouteTemplate associated to the routeAssignment.|
| Position| The position associated to the routeAssignment.|
| StartDate| The start date associated to the routeAssignment. |
| EndDate| The end date associated to the routeAssignment.|
| RequestedBy| Who is the routeAssignment requested by?|
| Notes| The notes associated to the routeAssignment.|
| MaxLiftQuantity| The max lift quantity associated to the routeAssignment.|
| MinLiftQuantity| The min lift quantity associated to the routeAssignment.|
| RequiresQuantity| Does the routeAssignment require quantity?|
| IsGpsAutoMatchingDisabled| Is the GPS auto matching disabled for the routeAssignment?|
| IsNoPlannedDate| Is there no planned date for the routeAssignment?|
| IsNoBinOnSiteExcluded| Is the bin on site excluded for the routeAssignment? |
| RelatedContainerGuid| The RelatedContainerGuid associated to the routeAssignment.|
| AccessTimes[0]| A list of objects containing route assignment access time.|
| AccessTimes[0].Guid | The GUID associated to the route assignment access time.|
| AccessTimes[0].AccessContact | The access contact name to associated route assignment.|
| AccessTimes[0].AccessNotes | The access notes to associated route assignment.|
| AccessTimes[0].FromExclusion | The exclusion of access to associated route assignment.|
| AccessTimes[0].AccessStartTime | The access start time to associated route assignment.|
| AccessTimes[0].AccessEndTime | The access end time to associated route assignment.|
| AccessTimes[0].DayOfWeekListItem | The GUID and description of the day of week to access.|
| Details[0] | A list of objects containing route assignment details.|
| Details[0].Guid | The GUID associated to the route assignment details.|
| Details[0].PlannedQuantity | The planned quantity associated to the routeAssignment.|
| Details[0].ContainerTypeListItem | The GUID and description of the ContainerType associated to the routeAssignment detail.|'
operationId: RouteAssignment_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_ApiIntegratorRouteAssignmentResource'
put:
tags:
- RouteAssignment
summary: Partial update
description: '| Property | Description | Required |
| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |
| GUID| The GUID associated to the routeAssignment.| No |
| RelatedOrderGuid| The GUID of the RelatedOrder associated to the routeAssignment.| Yes |
| ActionListItem| The GUID and description of the Action associated to the routeAssignment.| Yes |
| ContainerTypeListItem| The GUID and description of the ContainerType associated to the routeAssignment.| Yes |
| PickupIntervalListItem| The GUID and description of the PickupInterval associated to the routeAssignment.| Yes |
| DayOfWeekListItem| The GUID and description of the DayOfWeek associated to the routeAssignment.| No |
| DayOfOccurrenceInMonthListItem| The GUID and description of the Day of Occurrence in month associated to the routeAssignment.| No |
| RelatedRouteTemplateGuid| The GUID of the RelatedRouteTemplate associated to the routeAssignment.| No |
| Position| The position associated to the routeAssignment.| No |
| StartDate| The start date associated to the routeAssignment. | No |
| EndDate| The end date associated to the routeAssignment.| No |
| RequestedBy| Who is the routeAssignment requested by?| No |
| Notes| The notes associated to the routeAssignment.| No |
| MaxLiftQuantity| The max lift quantity associated to the routeAssignment.| No |
| MinLiftQuantity| The min lift quantity associated to the routeAssignment.| No |
| RequiresQuantity| Does the routeAssignment require quantity?| No |
| IsGpsAutoMatchingDisabled| Is the GPS auto matching disabled for the routeAssignment?| No |
| IsNoPlannedDate| Is there no planned date for the routeAssignment?| No |
| IsNoBinOnSiteExcluded| Is the bin on site excluded for the routeAssignment? | No |
| RelatedContainerGuid| The RelatedContainerGuid associated to the routeAssignment.| No |
| AccessTimes[0]| A list of objects containing route assignment access time.| No |
| AccessTimes[0].Guid | The GUID associated to the route assignment access time.| No |
| AccessTimes[0].AccessContact | The access contact name to associated route assignment.| No |
| AccessTimes[0].AccessNotes | The access notes to associated route assignment.| No |
| AccessTimes[0].FromExclusion | The exclusion fo access to associated route assignment.| Yes |
| AccessTimes[0].AccessStartTime | The access start time to associated route assignment.| Yes |
| AccessTimes[0].AccessEndTime | The access end time to associated route assignment.| Yes |
| AccessTimes[0].DayOfWeekListItem | The GUID and description of the day of week to access.| Yes |
| Details[0] | A list of objects containing route assignment details.| No |
| Details[0].Guid | The GUID associated to the route assignment details.| No |
| Details[0].PlannedQuantity | The planned quantity associated to the routeAssignment.| Yes |
| Details[0].ContainerTypeListItem | The GUID and description of the ContainerType associated to the routeAssignment detail.| Yes |
**Extra validations**
| Condition | Error message |
| --------- | ------------- |
| If the DayOfOccurrenceInMonthListItem is not equal to the week of month of the StartDate | Failed to save Route Assignment. Start date must be associated to the correct DayOfOccurenceInMonthId |
| If startDate and DayOfWeekListItem are set when IsNoPlannedDate is true | Failed to save Route Assignment. Start date and DayOfWeekListItem cannot be set when IsNoPlannedDate is true |
| If the DayOfOccurrenceInMonthListItem has a value and PickUpInterval is Weekly/ Fortnightly/ Every Three Weeks or Every Four Weeks. | Failed to save Route Assignment. DayOfOccurrenceInMonthListItem cannot be set when PickupIntervalId is Weekly/ Fortnightly/ Every Three Weeks or Every Four Weeks |
| If position is set to 0 and relatedRouteTemplateGuid has a value | Failed to save Route Assignment.'
operationId: RouteAssignment_Update
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorRouteAssignmentResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
/transport/routeAssignments:
get:
tags:
- RouteAssignment
summary: Find with Filters
description: '| Property | Description |
| ------------------------- | ------------------------------------------------------------------------ |
| GUID| The GUID associated to the routeAssignment.|
| RelatedOrderGuid| The GUID of the RelatedOrder associated to the routeAssignment.|
| ActionListItem| The GUID and description of the Action associated to the routeAssignment.|
| ContainerTypeListItem| The GUID and description of the ContainerType associated to the routeAssignment.|
| PickupIntervalListItem| The GUID and description of the PickupInterval associated to the routeAssignment.|
| DayOfWeekListItem| The GUID and description of the DayOfWeek associated to the routeAssignment.|
| DayOfOccurrenceInMonthListItem| The GUID and description of the Day of Occurrence in month associated to the routeAssignment.|
| RelatedRouteTemplateGuid| The GUID of the RelatedRouteTemplate associated to the routeAssignment.|
| Position| The position associated to the routeAssignment.|
| StartDate| The start date associated to the routeAssignment. |
| EndDate| The end date associated to the routeAssignment.|
| RequestedBy| Who is the routeAssignment requested by?|
| Notes| The notes associated to the routeAssignment.|
| MaxLiftQuantity| The max lift quantity associated to the routeAssignment.|
| MinLiftQuantity| The min lift quantity associated to the routeAssignment.|
| RequiresQuantity| Does the routeAssignment require quantity?|
| IsGpsAutoMatchingDisabled| Is the GPS auto matching disabled for the routeAssignment?|
| IsNoPlannedDate| Is there no planned date for the routeAssignment?|
| IsNoBinOnSiteExcluded| Is the bin on site excluded for the routeAssignment? |
| RelatedContainerGuid| The RelatedContainerGuid associated to the routeAssignment.|
| AccessTimes[0]| A list of objects containing route assignment access time.|
| AccessTimes[0].Guid | The GUID associated to the route assignment access time.|
| AccessTimes[0].AccessContact | The access contact name to associated route assignment.|
| AccessTimes[0].AccessNotes | The access notes to associated route assignment.|
| AccessTimes[0].FromExclusion | The exclusion of access to associated route assignment.|
| AccessTimes[0].AccessStartTime | The access start time to associated route assignment.|
| AccessTimes[0].AccessEndTime | The access end time to associated route assignment.|
| AccessTimes[0].DayOfWeekListItem | The GUID and description of the day of week to access.|
| Details[0] | A list of objects containing route assignment details.|
| Details[0].Guid | The GUID associated to the route assignment details.|
| Details[0].PlannedQuantity | The planned quantity associated to the routeAssignment.|
| Details[0].ContainerTypeListItem | The GUID and description of the ContainerType associated to the routeAssignment detail.|'
operationId: RouteAssignment_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_ApiIntegratorRouteAssignmentResource'
post:
tags:
- RouteAssignment
summary: Create or update
description: '| Property | Description | Required |
| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |
| GUID| The GUID associated to the routeAssignment.| No |
| RelatedOrderGuid| The GUID of the RelatedOrder associated to the routeAssignment.| Yes |
| ActionListItem| The GUID and description of the Action associated to the routeAssignment.| Yes |
| ContainerTypeListItem| The GUID and description of the ContainerType associated to the routeAssignment.| Yes |
| PickupIntervalListItem| The GUID and description of the PickupInterval associated to the routeAssignment.| Yes |
| DayOfWeekListItem| The GUID and description of the DayOfWeek associated to the routeAssignment.| No |
| DayOfOccurrenceInMonthListItem| The GUID and description of the Day of Occurrence in month associated to the routeAssignment.| No |
| RelatedRouteTemplateGuid| The GUID of the RelatedRouteTemplate associated to the routeAssignment.| No |
| Position| The position associated to the routeAssignment.| No |
| StartDate| The start date associated to the routeAssignment. | No |
| EndDate| The end date associated to the routeAssignment.| No |
| RequestedBy| Who is the routeAssignment requested by?| No |
| Notes| The notes associated to the routeAssignment.| No |
| MaxLiftQuantity| The max lift quantity associated to the routeAssignment.| No |
| MinLiftQuantity| The min lift quantity associated to the routeAssignment.| No |
| RequiresQuantity| Does the routeAssignment require quantity?| No |
| IsGpsAutoMatchingDisabled| Is the GPS auto matching disabled for the routeAssignment?| No |
| IsNoPlannedDate| Is there no planned date for the routeAssignment?| No |
| IsNoBinOnSiteExcluded| Is the bin on site excluded for the routeAssignment? | No |
| RelatedContainerGuid| The RelatedContainerGuid associated to the routeAssignment.| No |
| AccessTimes[0]| A list of objects containing route assignment access time.| No |
| AccessTimes[0].Guid | The GUID associated to the route assignment access time.| No |
| AccessTimes[0].AccessContact | The access contact name to associated route assignment.| No |
| AccessTimes[0].AccessNotes | The access notes to associated route assignment.| No |
| AccessTimes[0].FromExclusion | The exclusion of access to associated route assignment.| Yes |
| AccessTimes[0].AccessStartTime | The access start time to associated route assignment.| Yes |
| AccessTimes[0].AccessEndTime | The access end time to associated route assignment.| Yes |
| AccessTimes[0].DayOfWeekListItem | The GUID and description of the day of week to access.| Yes |
| Details[0] | A list of objects containing route assignment details.| No |
| Details[0].Guid | The GUID associated to the route assignment details.| No |
| Details[0].PlannedQuantity | The planned quantity associated to the routeAssignment.| Yes |
| Details[0].ContainerTypeListItem | The GUID and description of the ContainerType associated to the routeAssignment detail.| Yes |
**Extra validations**
| Condition | Error message |
| --------- | ------------- |
| If the DayOfOccurrenceInMonthListItem is not equal to the week of month of the StartDate | Failed to save Route Assignment. Start date must be associated to the correct DayOfOccurenceInMonthId |
| If startDate and DayOfWeekListItem are set when IsNoPlannedDate is true | Failed to save Route Assignment. Start date and DayOfWeekListItem cannot be set when IsNoPlannedDate is true |
| If the DayOfOccurrenceInMonthListItem has a value and PickUpInterval is Weekly/ Fortnightly/ Every Three Weeks or Every Four Weeks. | Failed to save Route Assignment. DayOfOccurrenceInMonthListItem cannot be set when PickupIntervalId is Weekly/ Fortnightly/ Every Three Weeks or Every Four Weeks |
| If position is set to 0 and relatedRouteTemplateGuid has a value | Failed to save Route Assignment.'
operationId: RouteAssignment_Create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorRouteAssignmentResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
components:
schemas:
ApiResourceResultCollectionExtra:
type: object
properties:
count:
type: integer
format: int32
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
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
ApiResourceResultEntity_ApiIntegratorRouteAssignmentResource:
type: object
properties:
resource:
$ref: '#/components/schemas/ApiIntegratorRouteAssignmentResource'
links:
$ref: '#/components/schemas/ApiResourceResultEntityLinks'
extra:
$ref: '#/components/schemas/ApiResourceResultEntityExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiIntegratorRouteAssignmentAccessTimeResource:
type: object
properties:
Guid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
AccessContact:
type: string
AccessNotes:
type: string
FromExclusion:
type: boolean
AccessStartTime:
type: string
format: zonedDateTime
example:
DateTime: '2000-01-01'
TimeZone: Europe/London
AccessEndTime:
type: string
format: zonedDateTime
example:
DateTime: '2000-01-01'
TimeZone: Europe/London
DayOfWeekListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
ApiResourceId:
type: object
properties:
resource:
type: string
format: uuid
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiIntegratorListItemResource:
type: object
properties:
Description:
type: string
Guid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiResourceStatus:
type: object
properties:
id:
type: integer
format: int32
isSuccess:
type: boolean
ApiIntegratorRouteAssignmentDetailResource:
type: object
properties:
Guid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ContainerTypeListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
PlannedQuantity:
type: number
format: double
ApiResourceErrors:
type: object
properties:
errors:
type: string
ApiIntegratorRouteAssignmentResource:
type: object
properties:
RelatedOrderGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ActionListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
ContainerTypeListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
PickupIntervalListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
DayOfWeekListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
DayOfOccurrenceInMonthListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
RelatedRouteTemplateGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
Position:
type: integer
format: int32
StartDate:
type: string
format: localDate
example: '2000-01-01'
EndDate:
type: string
format: localDate
example: '2000-01-01'
RequestedBy:
type: string
Notes:
type: string
MaxLiftQuantity:
type: integer
format: int32
MinLiftQuantity:
type: integer
format: int32
RequiresQuantity:
type: boolean
IsGpsAutoMatchingDisabled:
type: boolean
IsNoPlannedDate:
type: boolean
IsNoBinOnSiteExcluded:
type: boolean
RelatedContainerGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
AccessTimes:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorRouteAssignmentAccessTimeResource'
Details:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorRouteAssignmentDetailResource'
GUID:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiResourceResultCollection_ApiIntegratorRouteAssignmentResource:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorRouteAssignmentResource'
extra:
$ref: '#/components/schemas/ApiResourceResultCollectionExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'