---
updatedAt: 2026-07-02T10:57:17.000Z
agentTools:
  projectIndex: https://developer.2hire.io/llms.txt
---

# Specific

A set of commands supported only on a subset of vehicles

<br />

# OpenAPI definition

```json
{
  "openapi": "3.0.2",
  "info": {
    "version": "1.0.0",
    "title": "2hireAsAdapter API - Prod",
    "description": "2hireAsAdapter API lets you manage and control one vehicle and a thousand vehicle alike.",
    "contact": {
      "name": "2hire",
      "email": "info@2hire.io",
      "url": "https://2hire.io"
    }
  },
  "servers": [
    {
      "url": "https://adapter.2hire.io"
    }
  ],
  "tags": [
    {
      "name": "Commands",
      "description": "Send a command to a vehicle"
    }
  ],
  "paths": {
    "/api/v1/vehicle/{uuid}/command/specific/{command}": {
      "post": {
        "tags": [
          "Commands"
        ],
        "security": [
          {
            "Bearer": []
          }
        ],
        "summary": "Specific",
        "operationId": "commandSpecific",
        "description": "A set of commands supported only on a subset of vehicles",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "Identifier of the vehicle",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "command",
            "in": "path",
            "description": "Name of the specific command based on the vehicles' protocol",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "x-application",
            "in": "header",
            "description": "Application identifier",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "x-user",
            "in": "header",
            "description": "User identifier",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "RAW_BODY": {
                    "type": "string",
                    "description": "Body depends on the vehicles's protocol",
                    "default": "{}",
                    "format": "json"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/SuccessCommandResponse"
          },
          "400": {
            "$ref": "#/components/responses/BadRequestCommandError"
          },
          "401": {
            "$ref": "#/components/responses/AuthenticationError"
          },
          "403": {
            "$ref": "#/components/responses/AuthorizationError"
          },
          "404": {
            "$ref": "#/components/responses/VehicleNotFoundError"
          },
          "409": {
            "$ref": "#/components/responses/CommandConflictError"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "responses": {
      "SuccessCommandResponse": {
        "description": "Success Command Response, Vehicle Interaction Error Response and Vehicle Status Error Response",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/SuccessCommandResponse"
                },
                {
                  "$ref": "#/components/schemas/VehicleInteractionErrorResponse"
                },
                {
                  "$ref": "#/components/schemas/VehicleStatusErrorResponse"
                }
              ]
            },
            "examples": {
              "Success Command Response": {
                "value": {
                  "success": true
                }
              },
              "Vehicle Interaction Error Response": {
                "value": {
                  "success": false,
                  "code": "VEHICLE_INTERACTION_ERROR",
                  "details": {
                    "cause": "VEHICLE_OFFLINE"
                  },
                  "errorId": "21127d29-1587-4cc7-92c6-d74b98497e56"
                }
              },
              "Vehicle Status Error Response": {
                "value": {
                  "success": false,
                  "code": "VEHICLE_STATUS_ERROR",
                  "details": {
                    "cause": "OPEN_TRUNK"
                  },
                  "errorId": "21127d29-1587-4cc7-92c6-d74b98497e56"
                }
              }
            }
          }
        }
      },
      "InternalError": {
        "description": "Internal Error Response",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/InternalError"
            },
            "examples": {
              "Internal Error": {
                "value": {
                  "code": "INTERNAL_ERROR",
                  "details": {
                    "cause": "INTERNAL_ERROR"
                  },
                  "errorId": "21127d29-1587-4cc7-92c6-d74b98497e56"
                }
              }
            }
          }
        }
      },
      "BadRequestCommandError": {
        "description": "Bad Request Error Response",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/BadRequestError"
            },
            "examples": {
              "Invalid uuid": {
                "summary": "Invalid uuid",
                "value": {
                  "code": "BAD_REQUEST_ERROR",
                  "details": {
                    "cause": "INVALID_UUID"
                  },
                  "errorId": "f39add1e-7cd0-4929-bf0b-e5e1baebdc11"
                }
              }
            }
          }
        }
      },
      "AuthenticationError": {
        "description": "Authentication Error Response",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AuthenticationError"
            },
            "examples": {
              "Token expired": {
                "summary": "Token Expired",
                "value": {
                  "code": "AUTHENTICATION_ERROR",
                  "details": {
                    "cause": "TOKEN_EXPIRED"
                  },
                  "errorId": "21127d29-1587-4cc7-92c6-d74b98497e56"
                }
              }
            }
          }
        }
      },
      "AuthorizationError": {
        "description": "Authorization Error Response",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AuthorizationError"
            },
            "examples": {
              "Authorization Error": {
                "value": {
                  "code": "AUTHORIZATION_ERROR",
                  "details": {
                    "cause": "INSUFFICIENT_PERMISSIONS"
                  },
                  "errorId": "21127d29-1587-4cc7-92c6-d74b98497e56"
                }
              }
            }
          }
        }
      },
      "VehicleNotFoundError": {
        "description": "VehicleNotFound Error Response",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/VehicleNotFoundError"
            },
            "examples": {
              "Vehicle Not Registered": {
                "summary": "Vehicle Not Registered",
                "value": {
                  "code": "NOT_FOUND_ERROR",
                  "details": {
                    "cause": "VEHICLE_NOT_REGISTERED"
                  },
                  "errorId": "21127d29-1587-4cc7-92c6-d74b98497e56"
                }
              }
            }
          }
        }
      },
      "CommandConflictError": {
        "description": "Conflict Error response",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ConflictErrorPendingAction"
            },
            "examples": {
              "Vehicle Command Conflict": {
                "summary": "Vehicle Command Conflict",
                "value": {
                  "code": "CONFLICT_ERROR",
                  "details": {
                    "cause": "PENDING_ACTION"
                  },
                  "errorId": "21127d29-1587-4cc7-92c6-d74b98497e56"
                }
              }
            }
          }
        }
      }
    },
    "schemas": {
      "SuccessCommandResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ],
            "description": "Command was successful"
          }
        }
      },
      "VehicleInteractionErrorResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ],
            "description": "Command wasn't successful"
          },
          "code": {
            "type": "string",
            "description": "Code of the error",
            "enum": [
              "VEHICLE_INTERACTION_ERROR"
            ]
          },
          "details": {
            "type": "object",
            "properties": {
              "cause": {
                "type": "string",
                "description": "Specific cause of the error.",
                "enum": [
                  "VEHICLE_OFFLINE",
                  "COMMAND_TIMEOUT",
                  "COMMAND_FAILED",
                  "UNKNOWN_ERROR",
                  "GATEWAY_ERROR"
                ]
              }
            }
          },
          "errorId": {
            "type": "string",
            "description": "uuid generated in order to track logs"
          }
        }
      },
      "VehicleStatusErrorResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ],
            "description": "Command wasn't successful"
          },
          "code": {
            "type": "string",
            "description": "Code of the error",
            "enum": [
              "VEHICLE_STATUS_ERROR"
            ]
          },
          "details": {
            "type": "object",
            "properties": {
              "cause": {
                "type": "string",
                "description": "Specific cause of the error",
                "enum": [
                  "OPEN_TRUNK"
                ]
              }
            }
          },
          "errorId": {
            "type": "string",
            "description": "uuid generated in order to track logs"
          }
        }
      },
      "InternalErrorCause": {
        "type": "object",
        "properties": {
          "cause": {
            "type": "string",
            "description": "Specific cause of the error",
            "enum": [
              "INTERNAL_ERROR"
            ]
          }
        }
      },
      "QRCodeNotFoundCause": {
        "type": "object",
        "properties": {
          "cause": {
            "type": "string",
            "description": "Specific cause of the error",
            "enum": [
              "QR_CODE_NOT_FOUND"
            ]
          }
        }
      },
      "InternalError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Code of the error",
            "enum": [
              "INTERNAL_ERROR"
            ]
          },
          "details": {
            "type": "object",
            "oneOf": [
              {
                "$ref": "#/components/schemas/InternalErrorCause"
              },
              {
                "$ref": "#/components/schemas/QRCodeNotFoundCause"
              }
            ]
          },
          "errorId": {
            "type": "string",
            "description": "uuid generated in order to track logs"
          }
        }
      },
      "BadRequestCause": {
        "type": "object",
        "properties": {
          "cause": {
            "type": "string",
            "description": "Specific cause of the error",
            "enum": [
              "BAD_REQUEST"
            ]
          }
        }
      },
      "InvalidUUIDCause": {
        "type": "object",
        "properties": {
          "cause": {
            "type": "string",
            "description": "Specific cause of the error",
            "enum": [
              "INVALID_UUID"
            ]
          }
        }
      },
      "InvalidSignalNameCause": {
        "type": "object",
        "properties": {
          "cause": {
            "type": "string",
            "description": "Specific cause of the error",
            "enum": [
              "INVALID_SIGNAL_NAME"
            ]
          }
        }
      },
      "BadFormatCause": {
        "type": "object",
        "properties": {
          "cause": {
            "type": "string",
            "description": "Specific cause of the error",
            "enum": [
              "BAD_FORMAT"
            ]
          }
        }
      },
      "BadRequestError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Code of the error",
            "enum": [
              "BAD_REQUEST_ERROR"
            ]
          },
          "details": {
            "type": "object",
            "oneOf": [
              {
                "$ref": "#/components/schemas/BadRequestCause"
              },
              {
                "$ref": "#/components/schemas/InvalidUUIDCause"
              },
              {
                "$ref": "#/components/schemas/InvalidSignalNameCause"
              },
              {
                "$ref": "#/components/schemas/BadFormatCause"
              }
            ]
          },
          "errorId": {
            "type": "string",
            "description": "uuid generated in order to track logs"
          }
        }
      },
      "AuthorizationError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Code of the error",
            "enum": [
              "AUTHORIZATION_ERROR"
            ]
          },
          "cause": {
            "type": "string",
            "description": "Specific cause of the error",
            "enum": [
              "INSUFFICIENT_PERMISSIONS",
              "UNKNOWN"
            ]
          },
          "errorId": {
            "type": "string",
            "description": "uuid generated in order to track logs"
          }
        }
      },
      "AuthenticationError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Code of the error",
            "enum": [
              "AUTHENTICATION_ERROR"
            ]
          },
          "details": {
            "type": "object",
            "properties": {
              "cause": {
                "type": "string",
                "description": "Specific cause of the error",
                "enum": [
                  "HEADER_MALFORMED",
                  "HEADER_MISSING",
                  "TOKEN_AUDIENCE_NOT_ALLOWED",
                  "TOKEN_CREATION_FAILED",
                  "TOKEN_EXPIRED",
                  "TOKEN_KEY_ERROR",
                  "TOKEN_SIGN_ERROR",
                  "TOKEN_VERIFICATION_FAILED",
                  "GET_THIRD_PARTY_TOKEN_FAILED"
                ]
              }
            }
          },
          "errorId": {
            "type": "string",
            "description": "uuid generated in order to track logs"
          }
        }
      },
      "VehicleNotFoundError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Code of the error",
            "enum": [
              "NOT_FOUND_ERROR"
            ]
          },
          "details": {
            "type": "object",
            "properties": {
              "cause": {
                "type": "string",
                "description": "Specific cause of the error",
                "enum": [
                  "VEHICLE_NOT_REGISTERED"
                ]
              }
            }
          },
          "errorId": {
            "type": "string",
            "description": "uuid generated in order to track logs"
          }
        }
      },
      "ConflictErrorPendingAction": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Code of the error",
            "enum": [
              "CONFLICT_ERROR"
            ]
          },
          "details": {
            "type": "object",
            "properties": {
              "cause": {
                "type": "string",
                "description": "Specific cause of the error",
                "enum": [
                  "PENDING_ACTION"
                ]
              }
            }
          },
          "errorId": {
            "type": "string",
            "description": "uuid generated in order to track logs"
          }
        }
      }
    }
  }
}
```