Lytx Driver ID (DriveCam) API

openapi: 3.2.0
info:
  title: Driver ID (DriveCam) API
  version: 1.0.0
  description: Legacy API to retrieve vehicle trips, including drivers and vehicles assigned to each trip. Uses obsolete X-APIKey authentication.
servers:
- url: https://lytx-api.prod2.ph.lytx.com/driverId
- url: https://lytx-api.prod5.ph.lytx.com/driverId
- url: https://lytx-api.prod6.lv.lytx.com/driverId
- url: https://lytx-api.prod7.lv.lytx.com/driverId
- url: https://lytx-api.prod8.lv.lytx.com/driverId
security:
- APIKey: []
tags:
- name: Driver ID (DriveCam)
  description: Legacy API to retrieve vehicle trips, including drivers and vehicles assigned to each trip. Uses obsolete X-APIKey authentication.
paths:
  /trips:
    post:
      tags:
      - Driver ID (DriveCam)
      summary: Return All Trips Specified by Query Terms
      operationId: Trip_SearchTrips
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetTripsRequest'
        required: true
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTripsApiResponse'
        '400':
          description: The parameters given in the request are invalid.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          description: The request could not be authenticated. It can occur due to inputting an invalid key or invalid pod.
          content:
            application/json:
              schema:
                type: string
        '403':
          description: Access is denied to query trips for the specified group id. The given API key's context does not have the proper permissions.
        '500':
          description: ''
          content:
            application/json:
              schema:
                type: string
components:
  schemas:
    Trip:
      type: object
      additionalProperties: false
      properties:
        identificationType:
          type: integer
          description: 'The product used to identify the driver associated to the trip.

            Possible values:

            0 (None),

            1 (Lytx Badge Scan),

            2 (Vehicle Assignment), or

            3 (Dispatch API).'
          format: int32
        interval:
          description: The trip time interval.
          type:
          - object
          - 'null'
          oneOf:
          - $ref: '#/components/schemas/Interval'
        driver:
          description: The driver associated to the trip.
          type:
          - object
          - 'null'
          oneOf:
          - $ref: '#/components/schemas/Driver'
        vehicle:
          description: The vehicle associated to the trip.
          type:
          - object
          - 'null'
          oneOf:
          - $ref: '#/components/schemas/Vehicle'
        device:
          description: The device associated to the trip.
          type:
          - object
          - 'null'
          oneOf:
          - $ref: '#/components/schemas/Device'
        group:
          description: The group associated to the trip.
          type:
          - object
          - 'null'
          oneOf:
          - $ref: '#/components/schemas/Group'
        startLocation:
          description: The trip's start location. It is associated with the vehicle's GPS data at the time of ignition on (if provided).
          type:
          - object
          - 'null'
          oneOf:
          - $ref: '#/components/schemas/Location'
        endLocation:
          description: The trip's end location. It is associated with the vehicle's GPS data at the time of ignition off (if provided).
          type:
          - object
          - 'null'
          oneOf:
          - $ref: '#/components/schemas/Location'
    Device:
      type: object
      additionalProperties: false
      properties:
        serialNumber:
          type:
          - string
          - 'null'
    Driver:
      type: object
      additionalProperties: false
      properties:
        firstName:
          type:
          - string
          - 'null'
        lastName:
          type:
          - string
          - 'null'
        fullName:
          type:
          - string
          - 'null'
        employeeId:
          type:
          - string
          - 'null'
    Vehicle:
      type: object
      additionalProperties: false
      properties:
        name:
          type:
          - string
          - 'null'
    GetTripsApiResponse:
      type: object
      additionalProperties: false
      properties:
        totalCount:
          type: integer
          description: The total number of trips that matches the query, ignoring pagination.
          format: int32
        results:
          type:
          - array
          - 'null'
          description: List of paginated trips that matches the query.
          items:
            $ref: '#/components/schemas/Trip'
    Location:
      type: object
      additionalProperties: false
      properties:
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
    Group:
      type: object
      additionalProperties: false
      properties:
        name:
          type:
          - string
          - 'null'
    GetTripsRequest:
      type: object
      additionalProperties: false
      properties:
        startTime:
          type: string
          description: Trips that began after this date (inclusive).
          format: date-time
        endTime:
          type: string
          description: Trips that began before this date (inclusive).
          format: date-time
        groupId:
          type:
          - string
          - 'null'
          description: Group Id (and its subgroups) associated to a trip's vehicle.
          format: guid
          deprecated: true
          x-deprecatedMessage: 'US35029: Transitioning from groupID to groupIds'
        groupIds:
          type:
          - array
          - 'null'
          description: Group Ids (not including subgroups) associated to a trip's vehicle.
          items:
            type: string
            format: guid
        driverId:
          type:
          - string
          - 'null'
          description: Driver Id associated to trip.
          format: guid
        vehicleId:
          type:
          - string
          - 'null'
          description: Vehicle Id associated to trip.
          format: guid
        sortColumn:
          type:
          - string
          - 'null'
          description: 'Column used to sort trips.

            Possible values:

            ScheduleEnd (default),

            ScheduleStart,

            VehicleName,

            DriverName,

            EmployeeId, or

            DriverIdentificationType'
        sortDirection:
          type:
          - string
          - 'null'
          description: 'Sort direction of the sort column. Possible values: asc (default) or desc.'
        pageNumber:
          type: integer
          description: The page number of the list of trips. Default value is 1.
          format: int32
          maximum: 2147483647
          minimum: 1
          example: 1
        pageSize:
          type: integer
          description: The number of trips to return per page. Default value is 1000.
          format: int32
          maximum: 2147483647
          minimum: 1
          example: 1000
    Interval:
      type: object
      additionalProperties: false
      properties:
        startTime:
          type: string
          description: The trip start time.
          format: date-time
        endTime:
          type:
          - string
          - 'null'
          description: The trip end time. If the trip has not completed, no end time will be provided.
          format: date-time
  securitySchemes:
    APIKey:
      type: apiKey
      description: Enter your API key
      name: X-APIKey
      in: header
x-generator: NSwag v13.8.2.0 (NJsonSchema v10.2.1.0 (Newtonsoft.Json v12.0.0.0))