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-routeassignment-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 Assignment 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: 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 |\n| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |\n| GUID| The GUID associated to the routeAssignment.| No |\n| RelatedOrderGuid| The GUID of the RelatedOrder associated to the routeAssignment.| Yes |\n| ActionListItem| The GUID and description of the Action associated to the routeAssignment.| Yes |\n| ContainerTypeListItem| The GUID and description of the ContainerType associated to the routeAssignment.| Yes |\n| PickupIntervalListItem| The GUID and description of the PickupInterval associated to the routeAssignment.| Yes |\n| DayOfWeekListItem| The GUID and description of the DayOfWeek associated to the routeAssignment.| No |\n| DayOfOccurrenceInMonthListItem| The GUID and description of the Day of Occurrence in month associated to the routeAssignment.| No |\n| RelatedRouteTemplateGuid| The GUID of the RelatedRouteTemplate associated to the routeAssignment.| No |\n| Position| The position associated to the routeAssignment.| No |\n| StartDate| The start date associated to the routeAssignment. | No |\n| EndDate| The end date associated to the routeAssignment.| No |\n| RequestedBy| Who is the routeAssignment requested by?| No |\n| Notes| The notes associated to the routeAssignment.| No |\n| MaxLiftQuantity| The max lift quantity associated to the routeAssignment.| No |\n| MinLiftQuantity| The min lift quantity associated to the routeAssignment.| No |\n| RequiresQuantity| Does the routeAssignment require quantity?| No |\n| IsGpsAutoMatchingDisabled| Is the GPS auto matching disabled for the routeAssignment?| No |\n| IsNoPlannedDate| Is there no planned date for the routeAssignment?| No |\n| IsNoBinOnSiteExcluded| Is the bin on site excluded for the routeAssignment? | No |\n| RelatedContainerGuid| The RelatedContainerGuid associated to the routeAssignment.| No |\n| AccessTimes[0]| A list of objects containing route assignment access time.| No |\n| AccessTimes[0].Guid | The GUID associated to the route assignment access time.| No |\n| AccessTimes[0].AccessContact | The access contact name to associated route assignment.| No |\n| AccessTimes[0].AccessNotes | The access notes to associated route assignment.| No |\n| AccessTimes[0].FromExclusion | The exclusion fo access to associated route assignment.| Yes |\n| AccessTimes[0].AccessStartTime | The access start time to associated route assignment.| Yes |\n| AccessTimes[0].AccessEndTime | The access end time to associated route assignment.| Yes |\n| AccessTimes[0].DayOfWeekListItem | The GUID and description of the day of week to access.| Yes |\n| Details[0] | A list of objects containing route assignment details.| No |\n| Details[0].Guid | The GUID associated to the route assignment details.| No |\n| Details[0].PlannedQuantity | The planned quantity associated to the routeAssignment.| Yes |\n| Details[0].ContainerTypeListItem | The GUID and description of the ContainerType associated to the routeAssignment detail.| Yes |\n\n**Extra validations**\n\n| Condition | Error message |\n| --------- | ------------- |\n| 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 |\n| 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 |\n| 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 | \n| If position is set to 0 and relatedRouteTemplateGuid has a value | Failed to save Route Assignment. Position cannot be set to zero when relatedRouteTemplateGuid has a value |\n| If position has a value and relatedRouteTemplateGuid is null | Failed to save Route Assignment. Position cannot have a value if relatedRouteTemplateGuid is set to null |\n| If the given action does not have primary action type of Assign To Round | Failed to save Route Assignment. ActionListItem.Guid is not supported for Route Assignment |\n| If the given container type is not priced in the service agreement | Failed to save Route Assignment. ContainerTypeListItem.Guid is not supported for Route Assignment |\n| If the given container type is not associated with Route Assignment container type | Failed to save Route Assignment. Details.ContainerTypeListItem.Guid is not supported for Route Assignment Detail |"
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 |\n| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |\n| GUID| The GUID associated to the routeAssignment.| No |\n| RelatedOrderGuid| The GUID of the RelatedOrder associated to the routeAssignment.| Yes |\n| ActionListItem| The GUID and description of the Action associated to the routeAssignment.| Yes |\n| ContainerTypeListItem| The GUID and description of the ContainerType associated to the routeAssignment.| Yes |\n| PickupIntervalListItem| The GUID and description of the PickupInterval associated to the routeAssignment.| Yes |\n| DayOfWeekListItem| The GUID and description of the DayOfWeek associated to the routeAssignment.| No |\n| DayOfOccurrenceInMonthListItem| The GUID and description of the Day of Occurrence in month associated to the routeAssignment.| No |\n| RelatedRouteTemplateGuid| The GUID of the RelatedRouteTemplate associated to the routeAssignment.| No |\n| Position| The position associated to the routeAssignment.| No |\n| StartDate| The start date associated to the routeAssignment. | No |\n| EndDate| The end date associated to the routeAssignment.| No |\n| RequestedBy| Who is the routeAssignment requested by?| No |\n| Notes| The notes associated to the routeAssignment.| No |\n| MaxLiftQuantity| The max lift quantity associated to the routeAssignment.| No |\n| MinLiftQuantity| The min lift quantity associated to the routeAssignment.| No |\n| RequiresQuantity| Does the routeAssignment require quantity?| No |\n| IsGpsAutoMatchingDisabled| Is the GPS auto matching disabled for the routeAssignment?| No |\n| IsNoPlannedDate| Is there no planned date for the routeAssignment?| No |\n| IsNoBinOnSiteExcluded| Is the bin on site excluded for the routeAssignment? | No |\n| RelatedContainerGuid| The RelatedContainerGuid associated to the routeAssignment.| No |\n| AccessTimes[0]| A list of objects containing route assignment access time.| No |\n| AccessTimes[0].Guid | The GUID associated to the route assignment access time.| No |\n| AccessTimes[0].AccessContact | The access contact name to associated route assignment.| No |\n| AccessTimes[0].AccessNotes | The access notes to associated route assignment.| No |\n| AccessTimes[0].FromExclusion | The exclusion of access to associated route assignment.| Yes |\n| AccessTimes[0].AccessStartTime | The access start time to associated route assignment.| Yes |\n| AccessTimes[0].AccessEndTime | The access end time to associated route assignment.| Yes |\n| AccessTimes[0].DayOfWeekListItem | The GUID and description of the day of week to access.| Yes |\n| Details[0] | A list of objects containing route assignment details.| No |\n| Details[0].Guid | The GUID associated to the route assignment details.| No |\n| Details[0].PlannedQuantity | The planned quantity associated to the routeAssignment.| Yes |\n| Details[0].ContainerTypeListItem | The GUID and description of the ContainerType associated to the routeAssignment detail.| Yes |\n\n**Extra validations**\n\n| Condition | Error message |\n| --------- | ------------- |\n| 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 |\n| 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 |\n| 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 | \n| If position is set to 0 and relatedRouteTemplateGuid has a value | Failed to save Route Assignment. Position cannot be set to zero when relatedRouteTemplateGuid has a value |\n| If position has a value and relatedRouteTemplateGuid is null | Failed to save Route Assignment. Position cannot have a value if relatedRouteTemplateGuid is set to null |\n| If the given action does not have primary action type of Assign To Round | Failed to save Route Assignment. ActionListItem.Guid is not supported for Route Assignment |\n| If the given container type is not priced in the service agreement | Failed to save Route Assignment. ContainerTypeListItem.Guid is not supported for Route Assignment |\n| If the given container type is not associated with Route Assignment container type | Failed to save Route Assignment. Details.ContainerTypeListItem.Guid is not supported for Route Assignment Detail |\n"
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:
ApiResourceId:
type: object
properties:
resource:
type: string
format: uuid
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
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
ApiResourceStatus:
type: object
properties:
id:
type: integer
format: int32
isSuccess:
type: boolean
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
ApiResourceErrors:
type: object
properties:
errors:
type: string
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'
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'
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
ApiResourceResultCollectionExtra:
type: object
properties:
count:
type: integer
format: int32
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'
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
ApiIntegratorListItemResource:
type: object
properties:
Description:
type: string
Guid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000