swagger: '2.0' info: title: Navistream Activity API description: >- This API is for accessing Navistream activity related functionality. Access to this API requires prior authorization from [Streamline Transportation Technologies Inc.](https://stti.freshdesk.com/support/home)
Release version: SLS-1.4.0 termsOfService: 'https://api.mynavistream.com/terms/' contact: name: API Support url: 'https://stti.freshdesk.com/support/home' email: api@stti.ca license: name: Usage subject to NDA url: 'https://stti.freshdesk.com/support/home' version: 1.0.2 host: api.mynavistream.com basePath: /v1/activity schemes: - https consumes: - application/json produces: - application/json tags: - name: activities description: List completed activities - name: breadcrumbs description: Locations and events - name: completedInspections description: Completed vehicle inspections - name: fuelTaxMileage description: Location and odometer readings to support fuel tax calculations - name: selectedVehicles description: Driver selects a vehicle - name: speedSamples description: Speed and location readings paths: /activities: get: tags: - activities summary: List activities description: List activities operationId: listActivities parameters: - $ref: '#/parameters/Organization' - $ref: '#/parameters/Vehicle' - $ref: '#/parameters/User' - $ref: '#/parameters/CreatedSinceDate' - $ref: '#/parameters/UpdatedSinceDate' - $ref: '#/parameters/StartDate' - $ref: '#/parameters/EndDate' - $ref: '#/parameters/Offset' - $ref: '#/parameters/Limit' responses: '200': $ref: '#/responses/ActivityList' default: $ref: '#/responses/UnexpectedError' /breadcrumbs: get: tags: - breadcrumbs summary: List locations and events description: List locations and events operationId: listBreadcrumbs parameters: - $ref: '#/parameters/Organization' - $ref: '#/parameters/Vehicle' - $ref: '#/parameters/User' - $ref: '#/parameters/SinceDate' - $ref: '#/parameters/StartDate' - $ref: '#/parameters/EndDate' - $ref: '#/parameters/IncludeSpeedSamples' - $ref: '#/parameters/SpeedSampleInterval' - $ref: '#/parameters/Offset' - $ref: '#/parameters/Limit' responses: '200': $ref: '#/responses/BreadcrumbList' default: $ref: '#/responses/UnexpectedError' /completedInspections: get: tags: - completedInspections summary: List completed vehicle inspections description: List completed vehicle inspections operationId: listCompletedInspections parameters: - $ref: '#/parameters/Organization' - $ref: '#/parameters/Vehicle' - $ref: '#/parameters/SinceDate' - $ref: '#/parameters/StartDate' - $ref: '#/parameters/EndDate' - $ref: '#/parameters/Offset' - $ref: '#/parameters/Limit' responses: '200': $ref: '#/responses/CompletedInspectionList' default: $ref: '#/responses/UnexpectedError' /fuelTaxMileage: get: tags: - fuelTaxMileage summary: List location and odometer readings description: List location and odometer readings operationId: listFuelTaxMileage parameters: - $ref: '#/parameters/Organization' - $ref: '#/parameters/Vehicle' - $ref: '#/parameters/SinceDate' - $ref: '#/parameters/StartDate' - $ref: '#/parameters/EndDate' - $ref: '#/parameters/Interval' - $ref: '#/parameters/Offset' - $ref: '#/parameters/Limit' responses: '200': $ref: '#/responses/FuelTaxMileageList' default: $ref: '#/responses/UnexpectedError' /selectedVehicles: get: tags: - selectedVehicles summary: List vehicles selected by drivers description: List selected vehicles operationId: listSelectedVehicles parameters: - $ref: '#/parameters/Organization' - $ref: '#/parameters/Vehicle' - $ref: '#/parameters/User' - $ref: '#/parameters/SinceDate' - $ref: '#/parameters/StartDate' - $ref: '#/parameters/EndDate' - $ref: '#/parameters/Offset' - $ref: '#/parameters/Limit' responses: '200': $ref: '#/responses/SelectedVehicleList' default: $ref: '#/responses/UnexpectedError' /speedSamples: get: tags: - speedSamples summary: List speed and location readings description: List speed and location readings operationId: listSpeedSamples parameters: - $ref: '#/parameters/Organization' - $ref: '#/parameters/Vehicle' - $ref: '#/parameters/User' - $ref: '#/parameters/SinceDate' - $ref: '#/parameters/StartDate' - $ref: '#/parameters/EndDate' - $ref: '#/parameters/Interval' - $ref: '#/parameters/Offset' - $ref: '#/parameters/Limit' responses: '200': $ref: '#/responses/SpeedSampleList' default: $ref: '#/responses/UnexpectedError' definitions: Activity: title: Activity description: A trip/driver related activity properties: id: $ref: '#/definitions/ResourceId' startedAt: type: string format: date-time example: '2017-05-24T08:30:00.000Z' description: UTC date/time the activity started endedAt: type: string format: date-time example: '2017-05-24T09:30:00.000Z' description: UTC date/time the activity ended createdAt: $ref: '#/definitions/CreatedAt' updatedAt: $ref: '#/definitions/UpdatedAt' activityType: $ref: '#/definitions/ActivityType' distance: type: integer format: int32 example: 25 description: Distance travelled in metres organization: $ref: '#/definitions/Resource' vehicle: $ref: '#/definitions/Resource' users: type: array items: $ref: '#/definitions/Resource' device: $ref: '#/definitions/Device' durations: properties: activity: $ref: '#/definitions/Duration' wait: $ref: '#/definitions/Duration' idling: $ref: '#/definitions/Duration' engineOn: $ref: '#/definitions/Duration' vehicleStatus: properties: vehicleOdometer: $ref: '#/definitions/VehicleOdometer' engineOdometer: $ref: '#/definitions/EngineOdometer' engineTime: $ref: '#/definitions/EngineTime' fuel: properties: added: type: number format: float example: 400 description: Fuel added in litres addedDef: type: number format: float example: 10 description: Diesel Exhaust Fluid added in liters consumed: type: number format: float example: 250 description: Fuel consumed in litres fuelType: type: string enum: - Diesel - Gas - LNG example: null description: Type of fuel added idling: type: number format: float example: 32 description: Fuel consumed while idling in litres total: type: number format: float example: 261400.5 description: Fuel odometer in liters (.5 increments). A running value of the lifetime fuel used provided by the vehicle's ECM startLocation: $ref: '#/definitions/LocationAndType' endLocation: $ref: '#/definitions/LocationAndType' context: properties: stateEntered: type: string example: BC description: Province/state entered (on StateEntered activities) Breadcrumb: title: Breadcrumb description: Locations and events type: object properties: eventAt: $ref: '#/definitions/EventAt' createdAt: $ref: '#/definitions/CreatedAt' eventType: $ref: '#/definitions/EventType' organization: $ref: '#/definitions/Resource' vehicle: $ref: '#/definitions/Resource' user: $ref: '#/definitions/Resource' device: $ref: '#/definitions/Device' location: $ref: '#/definitions/Location' vehicleStatus: properties: odometer: $ref: '#/definitions/VehicleOdometer' speed: $ref: '#/definitions/VehicleSpeed' heading: $ref: '#/definitions/VehicleHeading' context: properties: dutyStatus: $ref: '#/definitions/DutyStatus' averageSpeed: $ref: '#/definitions/AverageSpeed' maximumSpeed: $ref: '#/definitions/MaximumSpeed' CompletedInspection: title: CompletedInspection description: Completed vehicle inspections type: object properties: eventAt: $ref: '#/definitions/EventAt' createdAt: $ref: '#/definitions/CreatedAt' vehicle: $ref: '#/definitions/Resource' organization: $ref: '#/definitions/Resource' vehicleStatus: properties: vehicleOdometer: $ref: '#/definitions/VehicleOdometer' engineOdometer: $ref: '#/definitions/EngineOdometer' engineTime: $ref: '#/definitions/EngineTime' trailers: type: array items: properties: trailer: $ref: '#/definitions/Resource' trailerStatus: properties: hubOdometer: $ref: '#/definitions/VehicleOdometer' FuelTaxMileage: title: FuelTaxMileage description: Location and odometer reading type: object properties: eventAt: $ref: '#/definitions/EventAt' createdAt: $ref: '#/definitions/CreatedAt' organization: $ref: '#/definitions/Resource' vehicle: $ref: '#/definitions/Resource' device: $ref: '#/definitions/Device' location: $ref: '#/definitions/Coordinate' vehicleStatus: properties: odometer: $ref: '#/definitions/VehicleOdometer' SelectedVehicle: title: SelectedVehicle description: Vehicles selected by drivers type: object properties: eventAt: $ref: '#/definitions/EventAt' createdAt: $ref: '#/definitions/CreatedAt' organization: $ref: '#/definitions/Resource' vehicle: $ref: '#/definitions/Resource' trailers: type: array items: properties: trailer: $ref: '#/definitions/Resource' user: $ref: '#/definitions/Resource' location: $ref: '#/definitions/Coordinate' SpeedSample: title: SpeedSample description: Speed and location reading type: object properties: eventAt: $ref: '#/definitions/EventAt' createdAt: $ref: '#/definitions/CreatedAt' organization: $ref: '#/definitions/Resource' vehicle: $ref: '#/definitions/Resource' user: $ref: '#/definitions/Resource' device: $ref: '#/definitions/Device' location: $ref: '#/definitions/Coordinate' vehicleStatus: properties: speed: $ref: '#/definitions/VehicleSpeed' heading: $ref: '#/definitions/VehicleHeading' EventAt: type: string format: date-time example: '2017-07-20T07:00:00.000Z' description: UTC date/time the event occurred at CreatedAt: type: string format: date-time example: '2017-07-20T07:05:00.000Z' description: UTC date/time the data was saved at UpdatedAt: type: string format: date-time example: '2017-07-20T08:10:00.000Z' description: UTC date/time the data was updated at ActivityType: type: string enum: - BrakeCheck - Break - DriverSelectedVehicle - Driving - FerryDelay - Fuelling - HookingTrailers - HookingTrailersCancelled - Inspection - InspectionCancelled - LoadInspection - Loading - LoadingCancelled - OtherActivity - OtherDelay - PersonalUse - ScaleIn - ScaleOut - ShiftEnded - ShiftStarted - StateEntered - Stopped - UnhookingTrailers - UnhookingTrailersCancelled - Unloading - UnloadingCancelled - UserLoggedIn - UserLoggedOut EventType: type: string enum: - BrakeCheckCompleted - BrakeCheckEntered - BrakeCheckExited - BrakeCheckStarted - BreakEnded - BreakStarted - CustomGeozoneEntered - CustomGeozoneExited - DriverSelectedVehicle - DutyStatusChange - EngineTurnedOff - EngineTurnedOn - FerryDelayEnded - FerryDelayStarted - FuellingCompleted - FuellingStarted - FuellingStationEntered - FuellingStationExited - HookingTrailersCancelled - HookingTrailersCompleted - HookingTrailersStarted - InspectionCancelled - InspectionCompleted - InspectionStarted - LoadDelayOccurred - LoadingCancelled - LoadingCompleted - LoadingStarted - LoadInspectionCompleted - LoadInspectionStarted - LoadLocationEntered - LoadLocationExited - MessageAcknowledged - MessageRead - MessageReceived - MessageSent - OffHighwayEntered - OffHighwayExited - OfficeEntered - OfficeExited - OtherActivityEnded - OtherActivityStarted - OtherDelayEnded - OtherDelayStarted - PersonalUseEnded - PersonalUseStarted - RestaurantEntered - RestaurantExited - ScaleEntered - ScaleExited - ShiftEnded - ShiftStarted - ShopEntered - ShopExited - SpeedSampled - SpeedViolationEnded - SpeedViolationStarted - StateEntered - StateExited - UnhookingTrailersCancelled - UnhookingTrailersCompleted - UnhookingTrailersStarted - UnloadDelayOccurred - UnloadingCancelled - UnloadingCompleted - UnloadingStarted - UnloadLocationEntered - UnloadLocationExited - UserLoggedIn - UserLoggedOut - YardMovementEnded - YardMovementStarted DutyStatus: type: string enum: - Driving - On Duty Not Driving - Off Duty - Sleeper Berth Duration: type: number format: float example: 135.977 description: Duration in seconds VehicleOdometer: type: integer format: int32 example: 85234 description: Vehicle odometer in meters VehicleSpeed: type: number format: float example: 25.959 description: Vehicle speed in meters/second VehicleHeading: type: number format: float example: 71.05370330810547 description: Vehicle heading in degrees (0 - 360) EngineOdometer: type: integer format: int32 example: 85234 description: Engine odometer in meters EngineTime: type: integer format: int32 example: 1500 description: Engine time in seconds ResourceId: type: integer format: int64 example: 5657626673103424 description: Key to the applicable resource ResourceExternalId: type: string example: ABC123 description: 3rd party key for the applicable resource ResourceName: type: string example: Resource Name description: Name of the applicable resource AverageSpeed: type: number format: float example: 26.22546833937836 description: Average vehicle speed in meters/second MaximumSpeed: type: number format: float example: 28.175 description: Maximum vehicle speed in meters/second Device: properties: id: $ref: '#/definitions/ResourceId' assetTag: type: string example: STTI-123 description: Asset tag/name for the device Coordinate: properties: latitude: type: number format: float example: 50.68886 description: Latitude from the GPS coordinates for the location longitude: type: number format: float example: -120.35761 description: Longitude from the GPS coordinates for the location Location: properties: id: $ref: '#/definitions/ResourceId' externalId: $ref: '#/definitions/ResourceExternalId' name: $ref: '#/definitions/ResourceName' latitude: type: number format: float example: 50.68886 description: Latitude from the GPS coordinates for the location longitude: type: number format: float example: -120.35761 description: Longitude from the GPS coordinates for the location LocationAndType: properties: latitude: type: number format: float example: 50.68886 description: Latitude from the GPS coordinates for the location longitude: type: number format: float example: -120.35761 description: Longitude from the GPS coordinates for the location id: $ref: '#/definitions/ResourceId' externalId: $ref: '#/definitions/ResourceExternalId' name: $ref: '#/definitions/ResourceName' typeId: $ref: '#/definitions/ResourceId' typeExternalId: $ref: '#/definitions/ResourceExternalId' typeName: $ref: '#/definitions/ResourceName' Resource: properties: id: $ref: '#/definitions/ResourceId' externalId: $ref: '#/definitions/ResourceExternalId' name: $ref: '#/definitions/ResourceName' Paging: type: object properties: offset: type: integer format: int32 example: 100 description: Offset within the full list of entries limit: type: integer format: int32 example: 50 description: Maximum number of entries returned in current result set count: type: integer format: int32 example: 50 description: Number of entries returned in current result set nextPage: type: string example: https://api.mynavistream.com/v1/activity/activities?createdSinceDate=2017-07-20T07:05:00.000Z&offset=150&limit=50 description: URL to use for the next request or null if there is no more data available Error: title: Error description: Common model for error responses type: object properties: error: type: object properties: code: type: string example: InvalidParameter description: Indicates the type or category of the error target: type: string example: Vehicle description: Indicates the parameter or property the error relates to message: type: string example: Check the format of the data provided description: Developer oriented error message details: type: array items: properties: code: type: string example: FormatError description: Indicates multiple errors target: type: string example: PropertyN description: Indicates multiple errors message: type: string example: Check the format of the PropertyN description: Indicates multiple errors parameters: Organization: name: organizationId in: query description: Limit results to a specified organization type: integer format: int64 Vehicle: name: vehicleId in: query description: Limit results to a specified vehicle type: integer format: int64 User: name: userId in: query description: Limit results to a specified driver/user type: integer format: int64 CreatedSinceDate: name: createdSinceDate in: query description: Limit entries to those saved to the database on or after the specified date and time type: string format: date-time UpdatedSinceDate: name: updatedSinceDate in: query description: Limit entries to those updated in the database on or after the specified date and time type: string format: date-time SinceDate: name: sinceDate in: query description: Limit entries to those saved to the database on or after the specified date and time type: string format: date-time StartDate: name: startDate in: query description: Limit results to those on or after a specified date and time type: string format: date-time EndDate: name: endDate in: query description: Limit results to those before a specified date and time type: string format: date-time IncludeSpeedSamples: name: includeSpeedSamples in: query description: Option to include speed samples in results type: boolean default: false Interval: name: interval in: query description: Sampling interval in minutes type: integer format: int32 default: 5 SpeedSampleInterval: name: speedSampleInterval in: query description: Sampling interval in minutes type: integer format: int32 default: 5 Offset: name: offset in: query description: Zero based starting location type: integer format: int32 default: 0 Limit: name: limit in: query description: Number of entries to return type: integer format: int32 maximum: 1000 responses: UnexpectedError: description: Unexpected error schema: $ref: '#/definitions/Error' ActivityList: description: List of trip activities schema: type: object properties: data: type: array items: $ref: '#/definitions/Activity' paging: $ref: '#/definitions/Paging' BreadcrumbList: description: List of locations and activity schema: type: object properties: data: type: array items: $ref: '#/definitions/Breadcrumb' paging: $ref: '#/definitions/Paging' CompletedInspectionList: description: List of completed inspections schema: type: object properties: data: type: array items: $ref: '#/definitions/CompletedInspection' paging: $ref: '#/definitions/Paging' FuelTaxMileageList: description: List of location and odometer readings schema: type: object properties: data: type: array items: $ref: '#/definitions/FuelTaxMileage' paging: $ref: '#/definitions/Paging' SelectedVehicleList: description: List of vehicles selected by drivers schema: type: object properties: data: type: array items: $ref: '#/definitions/SelectedVehicle' paging: $ref: '#/definitions/Paging' SpeedSampleList: description: List of speed and location readings schema: type: object properties: data: type: array items: $ref: '#/definitions/SpeedSample' paging: $ref: '#/definitions/Paging' securityDefinitions: api_key: type: apiKey description: API key format = "NAV2 api-token" name: Authorization in: header security: - api_key: [] externalDocs: description: Find out more about Streamline url: 'http://stti.ca'