AMCS Group ValidateVehicle API

openapi: 3.0.1
info:
  title: Core AccessGroup ValidateVehicle API
  version: core
tags:
- name: ValidateVehicle
paths:
  /integrator/validateVehicles:
    get:
      tags:
      - ValidateVehicle
      summary: Find with GUID
      description: "| Property\t\t\t\t\t\t\t\t\t\t\t\t| Description                                                                       |\r\n|-------------------------------------------------------|-----------------------------------------------------------------------------------|\r\n| SubscriberGUID\t\t\t\t\t\t\t\t\t\t| The subscriber GUID Filterable.\t\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| Registration\t\t\t\t\t\t\t\t\t\t\t| The vehicle registration optional if Vehicle RFID has value. Filterable.\t\t\t|\r\n| RFID\t\t\t\t\t\t\t\t\t\t\t\t\t| The vehicle RFID optional if Vehicle registration has value. Filterable.\t\t\t|\r\n| IsDriverRequired\t\t\t\t\t\t\t\t\t\t| IF DriverNameRegex from SysConfig has value set to true else false.\t\t\t\t|\r\n| DriverNameRegex\t\t\t\t\t\t\t\t\t\t| IF DriverNameRegex from SysConfig.\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| Vehicles[]\t\t\t\t\t\t\t\t\t\t\t| The vehicle associated with the subscriber.\t\t\t\t\t\t\t\t\t\t|\r\n| Vehicles[].VehicleGUID\t\t\t\t\t\t\t\t| The vehicle GUID.\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| Vehicles[].Registration\t\t\t\t\t\t\t\t| The vehicle registration.\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| Vehicles[].VehicleType\t\t\t\t\t\t\t\t| The vehicle vehicleType description .\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| Vehicles[].VehicleTypeGUID\t\t\t\t\t\t\t| The vehicle vehicleType GUID.\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| Vehicles[].TransportSupplierSiteGUID\t\t\t\t\t| The vehicle transportSupplierSiteGUID.\t\t\t\t\t\t\t\t\t\t\t|\r\n| Vehicles[].MaxWeight\t\t\t\t\t\t\t\t\t| The vehicle maxWeight.\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| Vehicles[].LiveTare\t\t\t\t\t\t\t\t\t| The vehicle liveTare.\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| Vehicles[].LastDriver\t\t\t\t\t\t\t\t\t| The vehicle lastDriver.\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| Vehicles[].IsExternalVehicle \t\t\t\t\t\t\t| The vehicle isExternalVehicle.\t\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| Vehicles[].IsValid\t\t\t\t\t\t\t\t\t| The vehicle isValid.\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| Vehicles[].Carriers[]\t\t\t\t\t\t\t\t\t| The vehicle supplier site.\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| Vehicles[].SubscriberOutlet[]\t\t\t\t\t\t\t| The vehicle company outlet.\t\t\t\t\t\t\t\t\t\t\t\t\t\t|"
      operationId: ValidateVehicle_GetCollection
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: filter
        in: query
        required: false
        type: string
      - name: search
        in: query
        required: false
        type: string
      - name: order
        in: query
        required: false
        type: string
      - name: max
        in: query
        required: false
        type: integer
        format: int32
      - name: page
        in: query
        required: false
        type: integer
        format: int32
      - name: includeCount
        in: query
        required: false
        type: boolean
      - name: includeDeleted
        in: query
        required: false
        type: boolean
      - name: links
        in: query
        required: false
        type: string
      - name: udf
        in: query
        required: false
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ApiResourceResultCollection[ApiValidateVehicleResource]'
definitions:
  ApiVehicleResource:
    type: object
    properties:
      VehicleGUID:
        format: uuid
        type: string
        example: 00000000-0000-0000-0000-000000000000
      Registration:
        type: string
      VehicleType:
        type: string
      VehicleTypeGUID:
        format: uuid
        type: string
        example: 00000000-0000-0000-0000-000000000000
      TransportSupplierSiteGUID:
        format: uuid
        type: string
        example: 00000000-0000-0000-0000-000000000000
      MaxWeight:
        format: double
        type: number
      LiveTare:
        format: double
        type: number
      LastDriver:
        type: string
      IsExternalVehicle:
        type: boolean
      IsValid:
        type: boolean
      SubscriberOutlet:
        type: array
        items:
          $ref: '#/definitions/ApiVehicleSubscriberOutletResource'
      Carriers:
        type: array
        items:
          $ref: '#/definitions/ApiVehicleCarrierResource'
  ApiVehicleSubscriberOutletResource:
    type: object
    properties:
      OutletGUID:
        format: uuid
        type: string
        example: 00000000-0000-0000-0000-000000000000
      AbbreviatedDescription:
        type: string
      IsStoreTareAllowed:
        type: boolean
  ApiResourceErrors:
    type: object
    properties:
      errors:
        type: string
  ApiVehicleCarrierResource:
    type: object
    properties:
      SupplierSiteGUID:
        format: uuid
        type: string
        example: 00000000-0000-0000-0000-000000000000
      SupplierSite:
        type: string
      WasteCarrierLicense:
        type: string
  ApiValidateVehicleResource:
    type: object
    properties:
      SubscriberGUID:
        format: uuid
        type: string
        example: 00000000-0000-0000-0000-000000000000
      Registration:
        type: string
      RFID:
        type: string
      IsDriverRequired:
        type: boolean
      DriverNameRegex:
        type: string
      Vehicles:
        type: array
        items:
          $ref: '#/definitions/ApiVehicleResource'
      GUID:
        format: uuid
        type: string
        example: 00000000-0000-0000-0000-000000000000
  ApiResourceStatus:
    type: object
    properties:
      id:
        format: int32
        type: integer
      isSuccess:
        type: boolean
  ApiResourceResultCollectionExtra:
    type: object
    properties:
      count:
        format: int32
        type: integer
  ApiResourceResultCollection[ApiValidateVehicleResource]:
    type: object
    properties:
      resource:
        type: array
        items:
          $ref: '#/definitions/ApiValidateVehicleResource'
      extra:
        $ref: '#/definitions/ApiResourceResultCollectionExtra'
      errors:
        $ref: '#/definitions/ApiResourceErrors'
      status:
        $ref: '#/definitions/ApiResourceStatus'