Website logo
Docs
API Reference
Postman Collection
Release Notes
Navigate through spaces
⌘K
Introduction
Overview
Getting started with the OS1 Platform
Getting started with building Apps
Concepts
Working with Callbacks
Console UI Overview
Custom Code
Working with GraphQL
Custom Attributes Ownership
Attribute-Based Access Control (ABAC)
Data Listing and Query (DLQS) Search
Core API dev guides
Overview
Authentication And Authorization
Participant
Container
Dispatch
Orchestrator
Workflow
Secure Data Storage
File Management
State Machine
Entity
Notification
Motion Tracking System
Location
Platform Order Management
Address
Scheduler
Logistics Framework API Dev guides
Overview
LogisticsOrder API
User API
Facility API
Vehicle API
How-To Guides
Integrate Your Application with Console UI
Integrate with Participants
Integrate with Containers
Integrate with Users
Integrate with Vehicles
Integrate with Facilities
Integrate with Entities
Integrate with Dispatch
Integrate with Logistics Order
Integrate with Platform Order Management
Integrate with Location Service
Integrate with Orchestrator
GraphQl Schemas
GraphQL: Dispatch Queries
GraphQL: Order Queries
GraphQL: Workflow Queries
GraphQL: Container Queries
Platform SDKs
SDK Overview
Sample Apps
Vehicle Management App
Container App
Resources
FAQs
Glossary
Data Types Used in OS1
Development Guidelines
Entity, Event, and Reason Codes
Service/API Level Error Codes
Docs powered by Archbee
Logistics Framework API Dev gu...
Vehicle API

Vehicle Lifecycle

2min

The Vehicle Lifecycle defines the states that a Vehicle can be in from when it is acquired to when it is retired.

A Vehicle has the following five lifecycle states:

  • Onboarding: The Vehicle data is being entered and/or verified.
  • Active:
    • Available: The Vehicle is operational and is available for use.
    • In-use: The Vehicle is operational and is already being assigned a task.
    • Unavailable: The Vehicle is operational but not available for use (to be used after repair, maintenance, etc. downtime).
  • Inactive: The Vehicle is not operational.
Document image


To retrieve the current state of a Vehicle, call the Get Vehicle State endpoint.

To change the state of a Vehicle, call the Transition Vehicle State get the current state endpoint, and pass the following parameters in the request body:

Member

Description

toState

Any state associated with respect to event transition.

reasonCode (optional)

A valid reason code associated with the event.

eventCode (optional)

Event Code of the transition event

Request bodies are specified in JSON format. The following example request body shows how to change the state of the Vehicle:

JSON
{
  "eventCode": "E-456",
  "reasonCode": "R-123",
  "toState": "active:available"
}




Updated 03 Aug 2023
Did this page help you?
PREVIOUS
Creating Vehicles
NEXT
Integrate Your Application with Console UI
Docs powered by Archbee
Docs powered by Archbee