AMCS Group VehicleEventGeoSummary API
The VehicleEventGeoSummary API from AMCS Group — 3 operation(s) for vehicleeventgeosummary.
OpenAPI Specification
openapi: 3.0.1
info:
title: Core AccessGroup VehicleEventGeoSummary API
version: core
tags:
- name: VehicleEventGeoSummary
paths:
/fleet/vehicleEventGeoSummaries/changes:
get:
tags:
- VehicleEventGeoSummary
summary: Retrieve changes
description: "| Property | Description |\r\n| ------------------------- | ------------------------------------------------------------------------ |\r\n| GUID| The GUID associated to the VehicleEventGeoSummary.|\r\n| DemoRegion | The Demo Region associated to the VehicleEventGeoSummary. | \r\n| FromTimeStamp| The From Time Stamp associated to the VehicleEventGeoSummary.|\r\n| GeoJSON | The Geo JSON associated to the VehicleEventGeoSummary.|\r\n| NumberOfVehicleEvents | The Number Of Vehicle Events associated to the VehicleEventGeoSummary.|\r\n| ToTimeStamp | The To Time Stamp associated to the VehicleEventGeoSummary.|\r\n| RelatedVehicleGuid | The Related Vehicle Guid associated to the VehicleEventGeoSummary. Filterable.|\r\n| Version | The Version associated to the VehicleEventGeoSummary.|\r\n| IsDeleted | Is the VehicleEventGeoSummary Deleted. |\r\n"
operationId: VehicleEventGeoSummary_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[ApiIntegratorVehicleEventGeoSummaryResource]'
/fleet/vehicleEventGeoSummaries/{guid}:
get:
tags:
- VehicleEventGeoSummary
summary: Find with GUID
description: "| Property | Description |\r\n| ------------------------- | ------------------------------------------------------------------------ |\r\n| GUID| The GUID associated to the VehicleEventGeoSummary.|\r\n| DemoRegion | The Demo Region associated to the VehicleEventGeoSummary. | \r\n| FromTimeStamp| The From Time Stamp associated to the VehicleEventGeoSummary.|\r\n| GeoJSON | The Geo JSON associated to the VehicleEventGeoSummary.|\r\n| NumberOfVehicleEvents | The Number Of Vehicle Events associated to the VehicleEventGeoSummary.|\r\n| ToTimeStamp | The To Time Stamp associated to the VehicleEventGeoSummary.|\r\n| RelatedVehicleGuid | The Related Vehicle Guid associated to the VehicleEventGeoSummary. Filterable.|\r\n| Version | The Version associated to the VehicleEventGeoSummary.|\r\n| IsDeleted | Is the VehicleEventGeoSummary Deleted. |\r\n"
operationId: VehicleEventGeoSummary_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[ApiIntegratorVehicleEventGeoSummaryResource]'
put:
tags:
- VehicleEventGeoSummary
summary: Partial update
description: "| Property | Description | Required |\r\n| --------------------- | ---------------------------------------------------------------------- | -------- |\r\n| GUID | The GUID associated to the external vehicle. | No |\r\n| DemoRegion | The Demo Region associated to the VehicleEventGeoSummary. | No |\r\n| FromTimeStamp | The From Time Stamp associated to the VehicleEventGeoSummary. | No |\r\n| GeoJSON | The Geo JSON associated to the VehicleEventGeoSummary. | No |\r\n| NumberOfVehicleEvents | The Number Of Vehicle Events associated to the VehicleEventGeoSummary. | No |\r\n| ToTimeStamp | The To Time Stamp associated to the VehicleEventGeoSummary. | No |\r\n| RelatedVehicleGuid | The Related Vehicle Guid associated to the VehicleEventGeoSummary. | Yes |\r\n| Version | The Version associated to the VehicleEventGeoSummary. | No |\r\n| IsDeleted | Is the VehicleEventGeoSummary Deleted. | No |\r\n\r\n**Extra validations**\r\n\r\n| Condition | Error message |\r\n| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\r\n| Invalid RelatedVehicleGuid | Failed to retrieve Vehicle with RelatedVehicleGuid of {Guid} |\r\n| RelatedVehicleGuid Is Null Or Not Provided | The mandatory property RelatedVehicleGuid has a null value. The request could not be processed. Supply a value for the RelatedVehicleGuid property of the submitted resource. |\r\n| RelatedVehicleGuid belongs to a deleted Vehicle | The provided RelatedVehicleGuid is deleted. Could not update the resource. Please check the relevant list end point for the available options. |\r\n"
operationId: VehicleEventGeoSummary_Update
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorVehicleEventGeoSummaryResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
/fleet/vehicleEventGeoSummaries:
get:
tags:
- VehicleEventGeoSummary
summary: Find with Filters
description: "| Property | Description |\r\n| ------------------------- | ------------------------------------------------------------------------ |\r\n| GUID| The GUID associated to the VehicleEventGeoSummary.|\r\n| DemoRegion | The Demo Region associated to the VehicleEventGeoSummary. | \r\n| FromTimeStamp| The From Time Stamp associated to the VehicleEventGeoSummary.|\r\n| GeoJSON | The Geo JSON associated to the VehicleEventGeoSummary.|\r\n| NumberOfVehicleEvents | The Number Of Vehicle Events associated to the VehicleEventGeoSummary.|\r\n| ToTimeStamp | The To Time Stamp associated to the VehicleEventGeoSummary.|\r\n| RelatedVehicleGuid | The Related Vehicle Guid associated to the VehicleEventGeoSummary. Filterable.|\r\n| Version | The Version associated to the VehicleEventGeoSummary.|\r\n| IsDeleted | Is the VehicleEventGeoSummary Deleted. |\r\n"
operationId: VehicleEventGeoSummary_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[ApiIntegratorVehicleEventGeoSummaryResource]'
post:
tags:
- VehicleEventGeoSummary
summary: Create or update
description: "| Property | Description | Required |\r\n| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |\r\n| GUID| The GUID associated to the external vehicle. | No |\r\n| DemoRegion | The Demo Region associated to the VehicleEventGeoSummary. | No |\r\n| FromTimeStamp| The From Time Stamp associated to the VehicleEventGeoSummary.| No |\r\n| GeoJSON | The Geo JSON associated to the VehicleEventGeoSummary.| No |\r\n| NumberOfVehicleEvents | The Number Of Vehicle Events associated to the VehicleEventGeoSummary.| No |\r\n| ToTimeStamp | The To Time Stamp associated to the VehicleEventGeoSummary.| No |\r\n| RelatedVehicleGuid | The Related Vehicle Guid associated to the VehicleEventGeoSummary. | Yes |\r\n| Version | The Version associated to the VehicleEventGeoSummary.| No |\r\n| IsDeleted | Is the VehicleEventGeoSummary Deleted. | No |\r\n\r\n**Extra validations**\r\n\r\n| Condition | Error message |\r\n| --------- | ------------- |\r\n| Invalid RelatedVehicleGuid | Failed to retrieve Vehicle with RelatedVehicleGuid of {Guid} |\r\n| RelatedVehicleGuid Is Null Or Not Provided | The mandatory property RelatedVehicleGuid has a null value. The request could not be processed. Supply a value for the RelatedVehicleGuid property of the submitted resource.|\r\n| RelatedVehicleGuid belongs to a deleted Vehicle | The provided RelatedVehicleGuid is deleted. Could not update the resource. Please check the relevant list end point for the available options.|\r\n\r\n"
operationId: VehicleEventGeoSummary_Create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorVehicleEventGeoSummaryResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
components:
schemas:
ApiResourceResultUpdatesExtra:
type: object
properties:
until:
type: string
cursor:
type: string
ApiResourceResultCollection[ApiIntegratorVehicleEventGeoSummaryResource]:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorVehicleEventGeoSummaryResource'
extra:
$ref: '#/components/schemas/ApiResourceResultCollectionExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceId:
type: object
properties:
resource:
type: string
format: uuid
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceChanges[ApiIntegratorVehicleEventGeoSummaryResource]:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorVehicleEventGeoSummaryResource'
extra:
$ref: '#/components/schemas/ApiResourceResultUpdatesExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceResultEntity[ApiIntegratorVehicleEventGeoSummaryResource]:
type: object
properties:
resource:
$ref: '#/components/schemas/ApiIntegratorVehicleEventGeoSummaryResource'
links:
$ref: '#/components/schemas/ApiResourceResultEntityLinks'
extra:
$ref: '#/components/schemas/ApiResourceResultEntityExtra'
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
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
ApiIntegratorVehicleEventGeoSummaryResource:
type: object
properties:
DemoRegion:
type: string
FromTimeStamp:
type: string
format: offsetDateTime
example: '2000-01-01T00:00:00+01:00'
GeoJSON:
type: string
format: byte
NumberOfVehicleEvents:
type: integer
format: int32
ToTimeStamp:
type: string
format: offsetDateTime
example: '2000-01-01T00:00:00+01:00'
RelatedVehicleGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
Version:
type: integer
format: int32
IsDeleted:
type: boolean
GUID:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
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