Closure Signals - smartcar

Doors

GET /vehicles/{vehicleId}/signals/closure-doors An object containing information about the vehicle’s doors.

body

object

Show body properties

values

array

required

An array of objects containing information about the state of the vehicle’s doors.

Show Array item properties

row

number

Represents the row position of a specific door, front to back (0 to Doors.rowCount-1).

column

number

Represents the column position of a specific door, left to right (0 to Door.ColumnCount-1).

isOpen

boolean

Indicates if the door is open.

isLocked

boolean

Indicates if the door is locked.

rowCount

number

Indicates the total number of door rows present in the vehicle. This field, along with columnCount, provides information about the vehicle’s door layout and the total number of doors available.

columnCount

number

Indicates the total number of door columns present in the vehicle. This field, along with rowCount, provides information about the vehicle’s door layout and the total number of doors available.

Example

{
  "rowCount": 2,
  "columnCount": 2,
  "doors": [
    {
      "row": 0,
      "column": 0,
      "isOpen": false,
      "isLocked": true
    },
    {
      "row": 0,
      "column": 1,
      "isOpen": false,
      "isLocked": true
    },
    {
      "row": 1,
      "column": 0,
      "isOpen": false,
      "isLocked": true
    },
    {
      "row": 1,
      "column": 1,
      "isOpen": false,
      "isLocked": true
    }
  ]
}

EngineCover

GET /vehicles/{vehicleId}/signals/closure-enginecover An object containing information about the state of the vehicle’s engine cover for ICE or PHEV vehicles.

body

object

Show body properties

isOpen

boolean

Indicates if the trunk is open.

Example

{
  "isOpen": false
}

FrontTrunk

GET /vehicles/{vehicleId}/signals/closure-fronttrunk An object containing information about the state of the vehicle’s front trunk.

body

object

Show body properties

isOpen

boolean

Indicates if the trunk is open.

isLocked

boolean

Indicates if the trunk is locked.

Example

{
  "isLocked": true,
  "isOpen": false
}

IsLocked

GET /vehicles/{vehicleId}/signals/closure-islocked A boolean value indicating whether the vehicle’s closures are currently locked.

body

object

Show body properties

value

boolean

Example

{
  "value": true
}

RearTrunk

GET /vehicles/{vehicleId}/signals/closure-reartrunk An object containing information about the state of the vehicle’s rear trunk.

body

object

Show body properties

isOpen

boolean

Indicates if the trunk is open.

isLocked

boolean

Indicates if the trunk is locked.

Example

{
  "isLocked": true,
  "isOpen": false
}

Sunroof

GET /vehicles/{vehicleId}/signals/closure-sunroof An object containing information about the state of the vehicle’s sunroof.

body

object

Show body properties

isOpen

boolean

Indicates if the trunk is open.

Example

{
  "isOpen": false
}

Tailgate

GET /vehicles/{vehicleId}/signals/closure-tailgate An object containing information about the state of the vehicle’s tailgate.

body

object

Show body properties

isOpen

boolean

Indicates if the tailgate is open.

isLocked

boolean

Indicates if the tailgate is locked.

Example

{
  "isLocked": true,
  "isOpen": false
}

Windows

GET /vehicles/{vehicleId}/signals/closure-windows An object containing information about the vehicle’s windows.

body

object

Show body properties

values

array

required

An array of objects, where each object represents a specific window in the vehicle.

Show Array item properties

row

number

Represents the row position of a specific window, front to back (0 to Windows.rowCount-1).

column

number

Represents the column position of a specific window, left to right (0 to Windows.columnCount-1).

isOpen

boolean

Indicates if the window is open.

rowCount

number

Indicates the total number of window rows present in the vehicle. This field, along with columnCount, provides information about the vehicle’s window layout and the total number of windows available.

columnCount

number

Indicates the total number of window columns present in the vehicle. This field, along with rowCount, provides information about the vehicle’s window layout and the total number of windows available.

Example

{
  "rowCount": 2,
  "columnCount": 2,
  "windows": [
    {
      "row": 0,
      "column": 0,
      "isOpen": false
    },
    {
      "row": 0,
      "column": 1,
      "isOpen": false
    },
    {
      "row": 1,
      "column": 0,
      "isOpen": false
    },
    {
      "row": 1,
      "column": 1,
      "isOpen": false
    }
  ]
}

Smartcar Signals & Attributes

Documentation Index

​Doors

​EngineCover

​FrontTrunk

​IsLocked

​RearTrunk

​Sunroof

​Tailgate

​Windows

Doors

EngineCover

FrontTrunk

IsLocked

RearTrunk

Sunroof

Tailgate

Windows