AMCS Group RouteVisit API
The RouteVisit API from AMCS Group — 3 operation(s) for routevisit.
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-routevisit-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 Visit 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: RouteVisit
paths:
/transport/routeVisits/changes:
get:
tags:
- RouteVisit
summary: Retrieve changes
description: '| Property| Description|
| -------------------------------------------------| --------------------------------------------------------------------------------------------------------------------------------- |
| Guid| The GUID associated to the route visit.|
| RelatedSiteOrderGuid| Used to filter on the related siter order GUID.|
| RelatedRouteGuid| Used to filter on the related route GUID.|
| ActionListItem| The GUID and description of the action associated to the route visit.|
| ContainerTypeListItem| The GUID and description of the container type associated to the route visit.|
| ExclusionTypeListItem| The GUID and description of the exclusion type associated to the route visit.|
| RelatedSiteOrderRouteAssignmentGuid| Used to filter on the related site order route assignment GUID.|
| TicketNo| Used to filter on the ticket no.|
| ManualTicketNo| Used to filter on the manual ticket no.|
| Position| The position associated to the route visit.|
| IntendedPrice| The intended price associated to the route visit.|
| IntendedVatListItem| The GUID and description of the intended VAT associated to the route visit.|
| DriverNotes| The driver notes associated to the route visit.|
| Notes| The notes associated to the route visit. Filterable.|
| Access[0].GUID| The Guid associated to the route visit access time.|
| Access[0].AccessNotes| The access notes associated to the route visit access time.|
| Access[0].AccessContact| The access contact associated to the route visit access time.|
| Access[0].StartTimeAccess| The access start time associated to the route visit access time.|
| Access[0].EndTimeAccess| The access end time associated to the route visit access time.|
| Access[0].DayOfWeekId | The day of the week associated to the route visit access time.|
| RejectedReasonListItem| The GUID and description of the Rejected Reason associated to the route visit.|
| RejectReasonAdditionalNotes| The reject reason additional notes associated to the route visit.|
| VisitStatusListItem| The GUID and description of the visit status associated to the route visit.|
| IsAcknowledgementRequired| Is acknowledgement required?|
| MaxLiftQuantity| The max lift quantity associated to the route visit.|
| MinLiftQuantity| The min lift quantity associated to the route visit.|
| IsQuantityRequired| Is the quantity required?|
| QuantityPlanned| The planned quantity associated to the route visit.|
| QuantityOverride| The quantity associated to the route visit.|
| Weight| The weight associated to the route visit.|
| QuantityNotPlannedReasonListItem| The GUID and description of the quantity not planned reason associated to the route visit.|
| QuantityConfirmed| The quantity confirmed associated to the route visit.|
| QuantityProblem| The quantity problem associated to the route visit.|
| MinBillLevelShortfall| The min bill level shortfall associated to the route visit.|
| StartTimeActual| The actual start time associated to the route visit.|
| EndTimeActual| The actual end time associated to the route visit.|
| IsFinanciallyConfirmed| Is the route visit financially confirmed?|
| RelatedUserFinanciallyConfirmedGuid| Used to filter on the related financially confirmed by user.|
| IsFleetPlannerCompleted| If fleet planner completed?|
| IsCancelled| Whether to cancel the route visit|
| OnDeallocatedReasonListItem| The GUID and description of the deallocated reason associated to the route visit.|
| PONumber| The PO number associated to the route visit.|
| OriginalDate| The original date associated to the route visit.|
| RelatedLocationDestinationGuid| The GUID related to the Location.|
| RelatedPictureBlobHashes| The array of related blob hashes and descriptions associated to the route visit.|
| RelatedPictureBlobHashes[0].Description| The description of the blob.|
| RelatedPictureBlobHashes[0].Hash| The hash of the blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted.|
| RelatedPictureBlobHashes[0].PictureSourceListItem| The GUID and description of the Picture Source associated to the route visit.|
| RelatedPictureBlobHashes[0].PictureTypeListItem| The GUID and description of the Picture Type associated to the route visit.|
| DriverFeedback| The driver feedback associated to the route visit. |
'
operationId: RouteVisit_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_ApiIntegratorRouteVisitResource'
/transport/routeVisits/{guid}:
get:
tags:
- RouteVisit
summary: Find with GUID
description: '| Property| Description|
| -------------------------------------------------| --------------------------------------------------------------------------------------------------------------------------------- |
| Guid| The GUID associated to the route visit.|
| RelatedSiteOrderGuid| Used to filter on the related siter order GUID.|
| RelatedRouteGuid| Used to filter on the related route GUID.|
| ActionListItem| The GUID and description of the action associated to the route visit.|
| ContainerTypeListItem| The GUID and description of the container type associated to the route visit.|
| ExclusionTypeListItem| The GUID and description of the exclusion type associated to the route visit.|
| RelatedSiteOrderRouteAssignmentGuid| Used to filter on the related site order route assignment GUID.|
| TicketNo| Used to filter on the ticket no.|
| ManualTicketNo| Used to filter on the manual ticket no.|
| Position| The position associated to the route visit.|
| IntendedPrice| The intended price associated to the route visit.|
| IntendedVatListItem| The GUID and description of the intended VAT associated to the route visit.|
| DriverNotes| The driver notes associated to the route visit.|
| Notes| The notes associated to the route visit. Filterable.|
| Access[0].GUID| The Guid associated to the route visit access time.|
| Access[0].AccessNotes| The access notes associated to the route visit access time.|
| Access[0].AccessContact| The access contact associated to the route visit access time.|
| Access[0].StartTimeAccess| The access start time associated to the route visit access time.|
| Access[0].EndTimeAccess| The access end time associated to the route visit access time.|
| Access[0].DayOfWeekId | The day of the week associated to the route visit access time.|
| RejectedReasonListItem| The GUID and description of the Rejected Reason associated to the route visit.|
| RejectReasonAdditionalNotes| The reject reason additional notes associated to the route visit.|
| VisitStatusListItem| The GUID and description of the visit status associated to the route visit.|
| IsAcknowledgementRequired| Is acknowledgement required?|
| MaxLiftQuantity| The max lift quantity associated to the route visit.|
| MinLiftQuantity| The min lift quantity associated to the route visit.|
| IsQuantityRequired| Is the quantity required?|
| QuantityPlanned| The planned quantity associated to the route visit.|
| QuantityOverride| The quantity associated to the route visit.|
| Weight| The weight associated to the route visit.|
| QuantityNotPlannedReasonListItem| The GUID and description of the quantity not planned reason associated to the route visit.|
| QuantityConfirmed| The quantity confirmed associated to the route visit.|
| QuantityProblem| The quantity problem associated to the route visit.|
| MinBillLevelShortfall| The min bill level shortfall associated to the route visit.|
| StartTimeActual| The actual start time associated to the route visit.|
| EndTimeActual| The actual end time associated to the route visit.|
| IsFinanciallyConfirmed| Is the route visit financially confirmed?|
| RelatedUserFinanciallyConfirmedGuid| Used to filter on the related financially confirmed by user.|
| IsFleetPlannerCompleted| If fleet planner completed?|
| IsCancelled| Whether to cancel the route visit|
| OnDeallocatedReasonListItem| The GUID and description of the deallocated reason associated to the route visit.|
| PONumber| The PO number associated to the route visit.|
| OriginalDate| The original date associated to the route visit.|
| RelatedLocationDestinationGuid| The GUID related to the Location.|
| RelatedPictureBlobHashes| The array of related blob hashes and descriptions associated to the route visit.|
| RelatedPictureBlobHashes[0].Description| The description of the blob.|
| RelatedPictureBlobHashes[0].Hash| The hash of the blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted.|
| RelatedPictureBlobHashes[0].PictureSourceListItem| The GUID and description of the Picture Source associated to the route visit.|
| RelatedPictureBlobHashes[0].PictureTypeListItem| The GUID and description of the Picture Type associated to the route visit.|
| DriverFeedback| The driver feedback associated to the route visit. |
'
operationId: RouteVisit_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_ApiIntegratorRouteVisitResource'
put:
tags:
- RouteVisit
summary: Partial update
description: '| Property | Description | Required |
| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |
| GUID| The GUID associated to the route visit job.| No |
| ActionListItem| The GUID and description associated to the action type.| Yes |
| ContainerTypeListItem| The GUID and description associated to the container type.| Yes |
| ExclusionTypeListItem| The GUID and description associated to the exclusion type.| No |
| IntendedVatListItem| The GUID and description associated to the intended vat.| No |
| RejectedReasonListItem| The GUID and description associated to the rejected reason.| No |
| VisitStatusListItem| The GUID and description associated to the visit status. | No |
| QuantityNotPlannedReasonListItem| The GUID and description associated to the reason for quantity not planned| No |
| RelatedSiteOrderGuid| The GUID related to the Site.| Yes |
| RelatedRouteGuid | The GUID related to the Route.| Yes |
| RelatedSiteOrderRouteAssignmentGuid| The GUID related to the Site Route Assignment. | No |
| RelatedUserFinanciallyConfirmedGuid| The GUID relaed to the user financially confirmed.| No |
| IsAcknowledgementRequired| Is the acknowledgement required?| Yes |
| IsQuantityRequired| Is the quantity required?| No |
| IsFleetPlannerCompleted| Is the fleet planner completed?| Yes |
| IsFinanciallyConfirmed| Is the financials confirmed?| Yes |
| TicketNo| The ticket number associated to the route visit job.| No |
| Position| The position associated to the route visit job.| No |
| IntendedPrice| The intended price associated to the route visit job.| No |
| RejectReasonAdditionalNotes| The reject reason for additional notes associated to the route visit job.| No |
| MaxLiftQuantity| The maximum lift quantity associated to the route visit job.| No |
| MinLiftQuantity| The minimum lift quantity associated to the route visit job.| No |
| QuantityPlanned| The quantity planned associated to the route visit job.| No |
| QuantityOverride| The quantity associated to the route visit job.| No |
| Weight | The weight associated to the route visit job.| No |
| QuantityConfirmed| The quantity confirmed associated to the route visit job.| No |
| QuantityProblem| The quantuty problem associated to the route visit job.| No |
| MinBillLevelShortfall| The minimum bill level shortfall associated to the route visit job. | No |
| StartTimeActual| The actual start time associated to the route visit job.| No |
| EndTimeActual| The actual end time associated to the route visit job.| No |
| OriginalDate| The originial date associated to the route visit job.| No |
| EndTimeActual| The actual end time associated to the route visit job.| No |
| ManualTicketNo | The associated to the route visit job.| No |
| DriverNotes| The manual ticket number associated to the route visit job.| No |
| Notes| The driver notes associated to the route visit job. Editable.| No |
| Access[0].GUID| The Guid associated to the route visit access time.| Yes |
| Access[0].AccessNotes| The access notes associated to the route visit access time.| No |
| Access[0].AccessContact| The access contact associated to the route visit access time.| No |
| Access[0].StartTimeAccess | The access start time associated to the route visit access time.| Yes |
| Access[0].EndTimeAccess | The access end time associated to the route visit access time.| Yes |
| Access[0].DayOfWeekId | The day of the week associated to the route visit access time.| Yes |
| PONumber| The PO number associated to the route visit job.| No |
| IsCancelled| Whether to cancel the route visit| No |
| OnDeallocatedReasonListItem| The GUID and description of the deallocated reason associated to the route visit.| No |
| RelatedLocationDestinationGuid| The GUID related to the Location.| No |
| RelatedPictureBlobHashes| The array of related blob hashes and descriptions associated to the route visit.| No |
| RelatedPictureBlobHashes[0].Description| The description of the blob.| No |
| RelatedPictureBlobHashes[0].Hash| The hash of the blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted. | No |
| DriverFeedback| The driver feedback associated to the route visit. | No |
**Extra validations**
| Condition | Error message |
| --------- | ------------- |
| If the Access.StartTimeAccess is greater than Access.EndTimeAccess | Failed to save. RouteVisit with Access cannot be set if StartTimeAccess is greater than EndTimeAccess. |
| Cancelling the route visit when the related route is already completed | The related route is already completed. This route visit cannot be cancelled. |
| Cancelling the route visit while it is assigned to an existing job | This route visit is assigned to an existing job. This route visit cannot be cancelled. |
| Updating QuantityPlanned when route is already completed | Failed to save/update QuantityPlanned because the related route is already completed. Could not process the request. |
| If RelatedRouteGuid is updated and the associated route is already completed | Failed to save/update RelatedRouteGuid because the related route is already completed. Could not process the request. |
| If RelatedRouteGuid is updated and the associated route is already deleted | Failed to save/update RouteVisit because the supplied Route is not valid. The update has been rejected. Change the RelatedRouteGuid to the Guid of a valid and undeleted Route |
| If IsCancelled is true and OnDeallocatedReasonListItem is null | The mandatory property OnDeallocatedReasonListItem.Guid has a null value. The request could not be processed. Supply a value for the OnDeallocatedReasonListItem.Guid property of the submitted resource. |
| If IsCancelled is false and OnDeallocatedReasonListItem has value | Failed to save/update RouteVisit because OnDeallocationReasonListItem property has been set, therefore IsCancelled property must be set to true. |
| If IsCancelled is true and OnDeallocatedReasonListItem is belong to Lift Problem Reason category | Invalid OnDeallocatedReasonListItem. Reason must be from ''Lift Problem'' reason category. |
| If DriverFeedback is more than 1000 characters long | Failed to save/update RouteVisit because DriverFeedback must be no more than 1000 characters long. |'
operationId: RouteVisit_Update
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorRouteVisitResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
/transport/routeVisits:
get:
tags:
- RouteVisit
summary: Find with Filters
description: '| Property| Description|
| -------------------------------------------------| --------------------------------------------------------------------------------------------------------------------------------- |
| Guid| The GUID associated to the route visit.|
| RelatedSiteOrderGuid| Used to filter on the related siter order GUID.|
| RelatedRouteGuid| Used to filter on the related route GUID.|
| ActionListItem| The GUID and description of the action associated to the route visit.|
| ContainerTypeListItem| The GUID and description of the container type associated to the route visit.|
| ExclusionTypeListItem| The GUID and description of the exclusion type associated to the route visit.|
| RelatedSiteOrderRouteAssignmentGuid| Used to filter on the related site order route assignment GUID.|
| TicketNo| Used to filter on the ticket no.|
| ManualTicketNo| Used to filter on the manual ticket no.|
| Position| The position associated to the route visit.|
| IntendedPrice| The intended price associated to the route visit.|
| IntendedVatListItem| The GUID and description of the intended VAT associated to the route visit.|
| DriverNotes| The driver notes associated to the route visit.|
| Notes| The notes associated to the route visit. Filterable.|
| Access[0].GUID| The Guid associated to the route visit access time.|
| Access[0].AccessNotes| The access notes associated to the route visit access time.|
| Access[0].AccessContact| The access contact associated to the route visit access time.|
| Access[0].StartTimeAccess| The access start time associated to the route visit access time.|
| Access[0].EndTimeAccess| The access end time associated to the route visit access time.|
| Access[0].DayOfWeekId | The day of the week associated to the route visit access time.|
| RejectedReasonListItem| The GUID and description of the Rejected Reason associated to the route visit.|
| RejectReasonAdditionalNotes| The reject reason additional notes associated to the route visit.|
| VisitStatusListItem| The GUID and description of the visit status associated to the route visit.|
| IsAcknowledgementRequired| Is acknowledgement required?|
| MaxLiftQuantity| The max lift quantity associated to the route visit.|
| MinLiftQuantity| The min lift quantity associated to the route visit.|
| IsQuantityRequired| Is the quantity required?|
| QuantityPlanned| The planned quantity associated to the route visit.|
| QuantityOverride| The quantity associated to the route visit.|
| Weight| The weight associated to the route visit.|
| QuantityNotPlannedReasonListItem| The GUID and description of the quantity not planned reason associated to the route visit.|
| QuantityConfirmed| The quantity confirmed associated to the route visit.|
| QuantityProblem| The quantity problem associated to the route visit.|
| MinBillLevelShortfall| The min bill level shortfall associated to the route visit.|
| StartTimeActual| The actual start time associated to the route visit.|
| EndTimeActual| The actual end time associated to the route visit.|
| IsFinanciallyConfirmed| Is the route visit financially confirmed?|
| RelatedUserFinanciallyConfirmedGuid| Used to filter on the related financially confirmed by user.|
| IsFleetPlannerCompleted| If fleet planner completed?|
| IsCancelled| Whether to cancel the route visit|
| OnDeallocatedReasonListItem| The GUID and description of the deallocated reason associated to the route visit.|
| PONumber| The PO number associated to the route visit.|
| OriginalDate| The original date associated to the route visit.|
| RelatedLocationDestinationGuid| The GUID related to the Location.|
| RelatedPictureBlobHashes| The array of related blob hashes and descriptions associated to the route visit.|
| RelatedPictureBlobHashes[0].Description| The description of the blob.|
| RelatedPictureBlobHashes[0].Hash| The hash of the blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted.|
| RelatedPictureBlobHashes[0].PictureSourceListItem| The GUID and description of the Picture Source associated to the route visit.|
| RelatedPictureBlobHashes[0].PictureTypeListItem| The GUID and description of the Picture Type associated to the route visit.|
| DriverFeedback| The driver feedback associated to the route visit. |
'
operationId: RouteVisit_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_ApiIntegratorRouteVisitResource'
post:
tags:
- RouteVisit
summary: Create or update
description: '| Property | Description | Required |
| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |
| GUID| The GUID associated to the route visit job.| No |
| ActionListItem| The GUID and description associated to the action type.| Yes |
| ContainerTypeListItem| The GUID and description associated to the container type.| Yes |
| ExclusionTypeListItem| The GUID and description associated to the exclusion type.| No |
| IntendedVatListItem| The GUID and description associated to the intended vat.| No |
| RejectedReasonListItem| The GUID and description associated to the rejected reason.| No |
| VisitStatusListItem| The GUID and description associated to the visit status. | No |
| QuantityNotPlannedReasonListItem| The GUID and description associated to the reason for quantity not planned| No |
| RelatedSiteOrderGuid| The GUID related to the Site.| Yes |
| RelatedRouteGuid | The GUID related to the Route.| Yes |
| RelatedSiteOrderRouteAssignmentGuid| The GUID related to the Site Route Assignment. | No |
| RelatedUserFinanciallyConfirmedGuid| The GUID relaed to the user financially confirmed.| No |
| IsAcknowledgementRequired| Is the acknowledgement required?| Yes |
| IsQuantityRequired| Is the quantity required?| No |
| IsFleetPlannerCompleted| Is the fleet planner completed?| Yes |
| IsFinanciallyConfirmed| Is the financials confirmed?| Yes |
| TicketNo| The ticket number associated to the route visit job.| No |
| Position| The position associated to the route visit job.| No |
| IntendedPrice| The intended price associated to the route visit job.| No |
| RejectReasonAdditionalNotes| The reject reason for additional notes associated to the route visit job.| No |
| MaxLiftQuantity| The maximum lift quantity associated to the route visit job.| No |
| MinLiftQuantity| The minimum lift quantity associated to the route visit job.| No |
| QuantityPlanned| The quantity planned associated to the route visit job.| No |
| QuantityOverride| The quantity associated to the route visit job.| No |
| Weight | The weight associated to the route visit job.| No |
| QuantityConfirmed| The quantity confirmed associated to the route visit job.| No |
| QuantityProblem| The quantuty problem associated to the route visit job.| No |
| MinBillLevelShortfall| The minimum bill level shortfall associated to the route visit job. | No |
| StartTimeActual| The actual start time associated to the route visit job.| No |
| EndTimeActual| The actual end time associated to the route visit job.| No |
| OriginalDate| The originial date associated to the route visit job.| No |
| EndTimeActual| The actual end time associated to the route visit job.| No |
| ManualTicketNo | The associated to the route visit job.| No |
| DriverNotes| The manual ticket number associated to the route visit job.| No |
| Notes| The driver notes associated to the route visit job. Editable.| No |
| Access[0].GUID| The Guid associated to the route visit access time.| No |
| Access[0].AccessNotes| The access notes associated to the route visit access time.| No |
| Access[0].AccessContact| The access contact associated to the route visit access time.| No |
| Access[0].StartTimeAccess | The access start time associated to the route visit access time.| Yes |
| Access[0].EndTimeAccess | The access end time associated to the route visit access time.| Yes |
| Access[0].DayOfWeekId | The day of the week associated to the route visit access time.| Yes |
| PONumber| The PO number associated to the route visit job.| No |
| IsCancelled| Whether to cancel the route visit| No |
| OnDeallocatedReasonListItem| The GUID and description of the deallocated reason associated to the route visit.| No |
| RelatedLocationDestinationGuid| The GUID related to the Location.| No |
| RelatedPictureBlobHashes| The array of related blob hashes and descriptions associated to the route visit.| No |
| RelatedPictureBlobHashes[0].Description| The description of the blob.| No |
| RelatedPictureBlobHashes[0].Hash| The hash of the blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted. | No |
| DriverFeedback| The driver feedback associated to the route visit. | No |
**Extra validations**
| Condition | Error message |
| --------- | ------------- |
| If the Access.StartTimeAccess is greater than Access.EndTimeAccess | Failed to save. RouteVisit with Access cannot be set if StartTimeAccess is greater than EndTimeAccess. |
| If Access.Guid is not null on insert | Access.Guid: is not supported. |
| If IsCancelled is true on insert | IsCancelled cannot be set to true on Create. |
| Cancelling the route visit when the related route is already completed | The related route is already completed. This route visit cannot be cancelled. |
| Cancelling the route visit while it is assigned to an existing job | This route visit is assigned to an existing job. This route visit cannot be cancelled. |
| Updating QuantityPlanned when route is already completed | Failed to save/update QuantityPlanned because the related route is already completed. Could not process the request. |
| If RelatedRouteGuid is updated and the associated route is already completed | Failed to save/update RelatedRouteGuid because the related route is already completed. Could not process the request. |
| If RelatedRouteGuid is updated and the associated route is already deleted | Failed to save/update RouteVisit because the supplied Route is not valid. The update has been rejected. Change the RelatedRouteGuid to the Guid of a valid and undeleted Route |
| If DriverFeedback is more than 1000 characters long | Failed to save/update RouteVisit because DriverFeedback must be no more than 1000 characters long. |'
operationId: RouteVisit_Create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorRouteVisitResource'
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'
ApiResourceStatus:
type: object
properties:
id:
type: integer
format: int32
isSuccess:
type: boolean
ApiResourceChanges_ApiIntegratorRouteVisitResource:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorRouteVisitResource'
extra:
$ref: '#/components/schemas/ApiResourceResultUpdatesExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceResultEntityExtra:
type: object
properties:
expand:
type: object
additionalProperties:
type: object
additionalProperties:
type: object
include:
type: object
additionalProperties:
type: array
items:
type: object
additionalProperties:
type: object
ApiResourceResultUpdatesExtra:
type: object
properties:
until:
type: string
cursor:
type: string
ApiIntegratorListItemResource:
type: object
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amcs-group/refs/heads/main/openapi/amcs-group-routevisit-api-openapi.yml