AMCS Group RouteVisitPrice API
The RouteVisitPrice API from AMCS Group — 2 operation(s) for routevisitprice.
OpenAPI Specification
openapi: 3.0.1
info:
title: Core AccessGroup RouteVisitPrice API
version: core
tags:
- name: RouteVisitPrice
paths:
/transport/routeVisitPrices/{guid}:
get:
tags:
- RouteVisitPrice
summary: Find with GUID
description: "| Property | Description |\r\n| ------------------------------------- | ----------------------------------------------------------------------------- |\r\n| Guid| The GUID associated to the route visit price.|\r\n| RelatedRouteVisitGuid| Used to filter on the related route visit GUID.|\r\n| RelatedPriceGuid| Used to filter on the related price GUID.|\r\n| Quantity| The quantity associated to the route visit price.|\r\n\r\n"
operationId: RouteVisitPrice_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[ApiIntegratorRouteVisitPriceResource]'
/transport/routeVisitPrices:
get:
tags:
- RouteVisitPrice
summary: Find with Filters
description: "| Property | Description |\r\n| ------------------------------------- | ----------------------------------------------------------------------------- |\r\n| Guid| The GUID associated to the route visit price.|\r\n| RelatedRouteVisitGuid| Used to filter on the related route visit GUID.|\r\n| RelatedPriceGuid| Used to filter on the related price GUID.|\r\n| Quantity| The quantity associated to the route visit price.|\r\n\r\n"
operationId: RouteVisitPrice_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[ApiIntegratorRouteVisitPriceResource]'
post:
tags:
- RouteVisitPrice
summary: Create or update
description: "| Property | Description | Required |\r\n| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |\r\n| GUID| The GUID associated to the route visit price.| No |\r\n| RelatedRouteVisitGuid| The GUID associated to the route visit.| Yes |\r\n| RelatedPriceGuid| The GUID associated to the price.| Yes |\r\n| Quantity| The Quantity associated to the route visit price.| Yes |\r\n\r\n**Extra validations**\r\n\r\n| Condition| Error message|\r\n| ----------------------------------------------------- | ----------------------------- |\r\n| If RelatedRouteVisitGUID is null on insert| The mandatory property RelatedRouteVisitGUID has a null value. The request could not be processed. Supply a value for the RelatedRouteVisitGUID property of the submitted resource.|\r\n| If RelatedPriceGUID is null on insert| The mandatory property RelatedPriceGUID has a null value. The request could not be processed. Supply a value for the RelatedPriceGUID property of the submitted resource.|\r\n| If Quantity is null on insert| The mandatory property Quantity has a null value. The request could not be processed. Supply a value for the Quantity property of the submitted resource.|\r\n"
operationId: RouteVisitPrice_Create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorRouteVisitPriceResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
components:
schemas:
ApiIntegratorRouteVisitPriceResource:
type: object
properties:
RelatedRouteVisitGUID:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedPriceGUID:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
Quantity:
type: integer
format: int32
GUID:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
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
ApiResourceResultCollectionExtra:
type: object
properties:
count:
type: integer
format: int32
ApiResourceResultEntity[ApiIntegratorRouteVisitPriceResource]:
type: object
properties:
resource:
$ref: '#/components/schemas/ApiIntegratorRouteVisitPriceResource'
links:
$ref: '#/components/schemas/ApiResourceResultEntityLinks'
extra:
$ref: '#/components/schemas/ApiResourceResultEntityExtra'
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
ApiResourceResultCollection[ApiIntegratorRouteVisitPriceResource]:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorRouteVisitPriceResource'
extra:
$ref: '#/components/schemas/ApiResourceResultCollectionExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
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
ApiResourceStatus:
type: object
properties:
id:
type: integer
format: int32
isSuccess:
type: boolean