openapi: 3.0.1 info: title: Vehicles description: API to handle vehicle management version: v1 servers: - url: https://gateway-preview.be-mo.io/vehicles/v1 paths: '/api/accounts/{accountId}/vehicles': get: summary: GetVehicleList description: Retrieves a list of vehicles. operationId: get-vehicle-list parameters: - name: accountId in: path description: Your team's private identifier for the Sandbox environment (received by email). required: true schema: type: string - name: limit in: query schema: type: number - name: offset in: query schema: type: number - name: expand in: query description: Use this parameter to include external identifiers in vehicles response. schema: enum: - externalid type: string - name: group in: query description: Use this parameter to filter the vehicles by groups. schema: type: string - name: Authorization in: header description: Access Token required: true schema: type: string responses: '200': description: '' headers: accept-range: description: Accepted range. schema: type: integer prev-range: description: Previous range Url. schema: type: string next-range: description: Next range Url. schema: type: string content: application/json: example: version: 1 data: - id: 88acd2-f788d463-e132-4758-ab69-82abd75ab93c model: Zoe connectors: - iec_62196_t2_cable year: 2016 brand: Renault to: '2020-12-31T01:00:00.0000000+00:00' allowedProducts: - E_Standard accountId: dc425ffa-c2a8-42db-b7d0-42b1a1565df7 from: '2019-10-21T02:00:00.0000000+00:00' group: subsidiary powerMax: 59 vehicleProfileId: 97 tags: - Jockey externalIdentifiers: - externalIdType: RFID externalIdValue: '**********AZ' - id: 88acd2-81399240-60a8-4c1c-b544-39839b507c5f model: Zoe connectors: - iec_62196_t2_cable year: 2016 brand: Renault to: '2020-12-31T01:00:00.0000000+00:00' allowedProducts: - E_Standard accountId: dc425ffa-c2a8-42db-b7d0-42b1a1565df7 from: '2019-10-21T02:00:00.0000000+00:00' group: subsidiary powerMax: 59 tags: - Jockey externalIdentifiers: - externalIdType: RFID externalIdValue: '**********A1' - id: 88acd2-71302031-03dc-4cb8-914f-5c5ee2580bf2 model: Zoe connectors: - iec_62196_t2_cable year: 2016 brand: Renault to: '2020-12-31T01:00:00.0000000+00:00' allowedProducts: - E_Standard accountId: dc425ffa-c2a8-42db-b7d0-42b1a1565df7 from: '2019-10-21T02:00:00.0000000+00:00' group: subsidiary powerMax: 59 externalIdentifiers: - id: 88acd2-433c281f-424d-4361-9528-b8265f0f3c00 model: Zoe connectors: - iec_62196_t2_cable year: 2016 brand: Renault to: '2020-12-31T01:00:00.0000000+00:00' allowedProducts: - E_Standard accountId: dc425ffa-c2a8-42db-b7d0-42b1a1565df7 from: '2019-10-21T02:00:00.0000000+00:00' group: subsidiary powerMax: 59 externalIdentifiers: status: Success '401': description: 401 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: anyOf: - InvalidJWT: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' - TokenExpired: status: Error errors: - code: TokenExpired message: 'Lifetime validation failed, the JWT is expired.' version: '1.0' - TokenNotPresent: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/shell' examples: tokenmissing: description: test value: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' incorrecttoken: description: test value: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '500': description: 500 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: version: '1.0' status: Error errors: - code: ErrorCode message: Error message/description. post: summary: CreateVehicle description: Allows to create a new vehicle operationId: create-vehicle parameters: - name: accountId in: path description: ' Your team''s private identifier for the Sandbox environment (received by email).' required: true schema: type: string - name: Content-Type in: header description: Content type required: true schema: enum: - application/json type: string default: application/json - name: Authorization in: header description: Access Token required: true schema: type: string requestBody: content: application/json: schema: example: to: '2020-12-31T01:00:00.0000000+00:00' model: Taycan connectors: - iec_62196_t2_cable - iec_62196_t2_combo_cable year: 2019 brand: Porsche from: '2019-10-21T02:00:00.0000000+00:00' group: subsidiary allowedProducts: - E_Standard - E_Accelerated - E_Fast_AC - E_Fast_DC - E_UltraFast externalVehicleId: 1 powerMax: 270 vehicleProfileId: 97 tags: - Jockey example: to: '2020-12-31T01:00:00.0000000+00:00' model: Taycan connectors: - iec_62196_t2_cable - iec_62196_t2_combo_cable year: 2019 brand: Porsche from: '2019-10-21T02:00:00.0000000+00:00' group: subsidiary allowedProducts: - E_Standard - E_Accelerated - E_Fast_AC - E_Fast_DC - E_UltraFast externalVehicleId: '1' powerMax: 270 vehicleProfileId: 97 tags: - Jockey responses: '201': description: '' content: application/json: example: version: 1 data: id: fd2d11-18255ef7-4f84-4624-b37e-9fd1e73cd34a model: Zoe connectors: - iec_62196_t2_cable year: 2016 brand: Renault to: '2020-12-31T01:00:00.0000000+00:00' allowedProducts: - E_Standard accountId: 4e0f3b25-3525-48ef-b87c-b89bb5ab3d7c from: '2019-10-21T02:00:00.0000000+00:00' group: subsidiary powerMax: 270 vehicleProfileId: 97 tags: - Jockey status: Success '401': description: 401 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: anyOf: - InvalidJWT: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' - TokenExpired: status: Error errors: - code: TokenExpired message: 'Lifetime validation failed, the JWT is expired.' version: '1.0' - TokenNotPresent: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/shell' examples: tokenmissing: description: test value: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' incorrecttoken: description: test value: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '500': description: 500 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: version: '1.0' status: Error errors: - code: ErrorCode message: Error message/description. '/api/accounts/{accountId}/vehicles/{vehicleId}': get: summary: GetVehicle description: Allows to get vehicle information operationId: get-vehicle parameters: - name: accountId in: path required: true schema: type: string - name: vehicleId in: path required: true schema: type: string - name: expand in: query description: Use this parameter to include external identifiers in vehicles response. schema: enum: - externalid type: string - name: Authorization in: header description: Access Token required: true schema: type: string responses: '200': description: '' content: application/json: example: version: 1 data: id: fd2d11-18255ef7-4f84-4624-b37e-9fd1e73cd34a model: Zoe connectors: - iec_62196_t2_cable year: 2016 brand: Renault to: '2020-12-31T01:00:00.0000000+00:00' allowedProducts: - E_Standard accountId: 4e0f3b25-3525-48ef-b87c-b89bb5ab3d7c from: '2019-10-21T02:00:00.0000000+00:00' group: subsidiary powerMax: 59 vehicleProfileId: 112 tags: - Jockey externalIdentifiers: - externalIdType: RFID externalIdValue: '**********AZ' status: Success '401': description: 401 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: anyOf: - InvalidJWT: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' - TokenExpired: status: Error errors: - code: TokenExpired message: 'Lifetime validation failed, the JWT is expired.' version: '1.0' - TokenNotPresent: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/shell' examples: tokenmissing: description: test value: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' incorrecttoken: description: test value: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/shell' example: status: Error errors: - code: Not found message: Item not found. version: '1.0' '500': description: 500 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: version: '1.0' status: Error errors: - code: ErrorCode message: Error message/description. delete: summary: DeleteVehicle description: Allows to delete a vehicle operationId: delete-vehicle parameters: - name: accountId in: path description: Your team's private identifier for the Sandbox environment (received by email). required: true schema: type: string - name: vehicleId in: path description: Id of the vehicle. required: true schema: type: string - name: Authorization in: header description: Access Token required: true schema: type: string responses: '204': description: '' '401': description: 401 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: anyOf: - InvalidJWT: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' - TokenExpired: status: Error errors: - code: TokenExpired message: 'Lifetime validation failed, the JWT is expired.' version: '1.0' - TokenNotPresent: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/shell' examples: tokenmissing: description: test value: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' incorrecttoken: description: test value: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/shell' example: status: Error errors: - code: Not found message: Item not found. version: '1.0' '500': description: 500 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: version: '1.0' status: Error errors: - code: ErrorCode message: Error message/description. patch: summary: UpdateVehicle description: Allows to update a vehicle operationId: update-vehicle parameters: - name: accountId in: path description: Your team's private identifier for the Sandbox environment (received by email). required: true schema: type: string - name: vehicleId in: path description: Id of the vehicle. required: true schema: type: string - name: Content-Type in: header description: Content type required: true schema: enum: - application/json type: string default: application/json - name: Authorization in: header description: Access Token required: true schema: type: string requestBody: content: application/json: schema: example: suspendedUntil: '2020-12-01T01:00:00.0000000+00:00' model: Zoe connectors: - iec_62196_t2_cable year: 2016 brand: Renault to: '2020-12-31T01:00:00.0000000+00:00' allowedProducts: - E_Standard externalVehicleId: 123 powerMax: 59 group: subsidiary vehicleProfileId: 112 tags: - Jockey example: suspendedUntil: '2020-12-01T01:00:00.0000000+00:00' model: Zoe connectors: - iec_62196_t2_cable year: 2016 brand: Renault to: '2020-12-31T01:00:00.0000000+00:00' allowedProducts: - E_Standard externalVehicleId: 123 powerMax: 59 group: subsidiary vehicleProfileId: 112 tags: - Jockey responses: '200': description: '' content: application/json: example: version: 1 data: id: fd2d11-18255ef7-4f84-4624-b37e-9fd1e73cd34a model: Zoe connectors: - iec_62196_t2_cable year: 2016 brand: Renault to: '2020-12-31T01:00:00.0000000+00:00' allowedProducts: - E_Standard accountId: 4e0f3b25-3525-48ef-b87c-b89bb5ab3d7c from: '2019-10-21T02:00:00.0000000+00:00' group: subsidiary powerMax: 59 vehicleProfileId: 112 tags: - Jockey status: Success '401': description: 401 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: anyOf: - InvalidJWT: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' - TokenExpired: status: Error errors: - code: TokenExpired message: 'Lifetime validation failed, the JWT is expired.' version: '1.0' - TokenNotPresent: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/shell' examples: tokenmissing: description: test value: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' incorrecttoken: description: test value: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/shell' example: status: Error errors: - code: Not found message: Item not found. version: '1.0' '500': description: 500 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: version: '1.0' status: Error errors: - code: ErrorCode message: Error message/description. '/api/accounts/{accountId}/vehicles/externalid/{externalVehicleId}': get: summary: GetVehicleByExternalVehicleId description: Allows to get vehicle informations by external identifier operationId: get-vehicle-by-external-vehicle-id parameters: - name: accountId in: path description: Your team's private identifier for the Sandbox environment (received by email). required: true schema: type: string - name: externalVehicleId in: path description: External Id of the vehicle. required: true schema: type: string - name: Authorization in: header description: Access Token required: true schema: type: string responses: '200': description: Successful vehicle response content: application/json: example: suspendedUntil: '2020-12-01T01:00:00.0000000+00:00' model: Zoe connectors: - iec_62196_t2_cable year: 2016 brand: Renault to: '2020-12-31T01:00:00.0000000+00:00' allowedProducts: - E_Standard externalVehicleId: 123 group: subsidiary powerMax: 59 vehicleProfileId: 112 tags: - Jockey '401': description: 401 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: anyOf: - InvalidJWT: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' - TokenExpired: status: Error errors: - code: TokenExpired message: 'Lifetime validation failed, the JWT is expired.' version: '1.0' - TokenNotPresent: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/shell' examples: tokenmissing: description: test value: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' incorrecttoken: description: test value: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/shell' example: status: Error errors: - code: Not found message: Item not found. version: '1.0' '500': description: 500 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: version: '1.0' status: Error errors: - code: ErrorCode message: Error message/description. '/api/accounts/{accountId}/vehicles/{vehicleId}/token': get: summary: GetVehicleToken description: Allows to get vehicle token operationId: get-vehicle-token parameters: - name: accountId in: path description: Your team's private identifier for the Sandbox environment (received by email). required: true schema: type: string - name: vehicleId in: path description: Id of the vehicle. required: true schema: type: string - name: Authorization in: header description: Access Token required: true schema: type: string responses: '200': description: Get token content: application/json: example: status: Success errors: data: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c trace: version: '1.0' '401': description: 401 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: anyOf: - InvalidJWT: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' - TokenExpired: status: Error errors: - code: TokenExpired message: 'Lifetime validation failed, the JWT is expired.' version: '1.0' - TokenNotPresent: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/shell' examples: tokenmissing: description: test value: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' incorrecttoken: description: test value: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/shell' example: status: Error errors: - code: Not found message: Item not found. version: '1.0' '500': description: 500 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: version: '1.0' status: Error errors: - code: ErrorCode message: Error message/description. '/api/accounts/{accountId}/vehicles/{vehicleId}/externalids/{externalIdType}': post: summary: EnrollExternalId description: Allows to add a vehicle external identifier operationId: enroll-external-id parameters: - name: accountId in: path description: Your team's private identifier for the Sandbox environment (received by email). required: true schema: type: string - name: vehicleId in: path description: Id of the vehicle. required: true schema: type: string - name: externalIdType in: path description: RFID required: true schema: enum: - RFID type: string - name: Content-Type in: header description: Content type required: true schema: enum: - application/json type: string default: application/json - name: Authorization in: header description: A JwtToken generated by GetVehicleToken required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/externalid' example: externalIdValue: ABCDEFGHIJKLMNOPQRST responses: '201': description: '' content: application/json: example: trace: data: externalIdType: VIN externalIdValue: '***************PQRST' status: Success errors: version: 1 '400': description: '' content: application/json: example: anyOf: - RfidAlreadyExist: trace: '' data: status: Error errors: - code: ArgumentException message: "The vehicle RFID already exists.\r\nParameter name: externalIdType" version: '1.0' - RfidValueMaxCharacter: trace: '' data: status: Error errors: - code: ArgumentException message: ExternalIdValue should contain up to 20 character maximum version: '1.0' '401': description: 401 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: anyOf: - InvalidJWT: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' - TokenExpired: status: Error errors: - code: TokenExpired message: 'Lifetime validation failed, the JWT is expired.' version: '1.0' - TokenNotPresent: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '404': description: 401 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: anyOf: - InvalidJWT: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' - TokenExpired: status: Error errors: - code: TokenExpired message: 'Lifetime validation failed, the JWT is expired.' version: '1.0' - TokenNotPresent: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '500': description: 500 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: version: '1.0' status: Error errors: - code: ErrorCode message: Error message/description. patch: summary: UpdateExternalId description: Allows to update a vehicle external identifier operationId: update-external-Id parameters: - name: accountId in: path description: Your team's private identifier for the Sandbox environment (received by email). required: true schema: type: string - name: vehicleId in: path description: ' Id of the vehicle.' required: true schema: type: string - name: externalIdType in: path description: RFID required: true schema: enum: - RFID type: string - name: Content-Type in: header description: Content type required: true schema: enum: - application/json type: string default: application/json - name: Authorization in: header description: A JwtToken generated by GetVehicleToken required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/externalid' example: externalIdValue: ABCDEFGHIJKLMNOPQRST responses: '200': description: '' content: application/json: example: trace: data: externalIdType: RFID externalIdValue: '***************PQRST' status: Success errors: version: 1 '400': description: '' content: application/json: example: trace: '' data: status: Error errors: - code: ArgumentException message: ExternalIdValue should contain up to 20 character maximum version: '1.0' '401': description: 401 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: anyOf: - InvalidJWT: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' - TokenExpired: status: Error errors: - code: TokenExpired message: 'Lifetime validation failed, the JWT is expired.' version: '1.0' - TokenNotPresent: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '500': description: 500 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: version: '1.0' status: Error errors: - code: ErrorCode message: Error message/description. get: summary: GetExternalId description: Allows to get a vehicle external id by type. operationId: get-external-id parameters: - name: accountId in: path description: Your team's private identifier for the Sandbox environment (received by email). required: true schema: type: string - name: vehicleId in: path description: Id of the vehicle. required: true schema: type: string - name: externalIdType in: path description: RFID required: true schema: enum: - RFID type: string - name: Authorization in: header description: A JwtToken generated by GetVehicleToken required: true schema: type: string responses: '200': description: '' content: application/json: example: trace: data: externalIdType: RFID externalIdValue: '*****B-CC' status: Success errors: version: 1 '401': description: 401 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: anyOf: - InvalidJWT: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' - TokenExpired: status: Error errors: - code: TokenExpired message: 'Lifetime validation failed, the JWT is expired.' version: '1.0' - TokenNotPresent: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/shell' example: status: Error errors: - code: Not found message: Item not found. version: '1.0' '500': description: 500 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: version: '1.0' status: Error errors: - code: ErrorCode message: Error message/description. delete: summary: DeleteExternalId description: Allows to delete a vehicle external identifier. operationId: delete-external-id parameters: - name: accountId in: path description: Your team's private identifier for the Sandbox environment (received by email). required: true schema: type: string - name: vehicleId in: path description: ' Id of the vehicle.' required: true schema: type: string - name: externalIdType in: path description: RFID required: true schema: enum: - RFID type: string - name: Authorization in: header description: A JwtToken generated by GetVehicleToken required: true schema: type: string responses: '204': description: '' '401': description: 401 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: anyOf: - InvalidJWT: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' - TokenExpired: status: Error errors: - code: TokenExpired message: 'Lifetime validation failed, the JWT is expired.' version: '1.0' - TokenNotPresent: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/shell' example: status: Error errors: - code: Not found message: Item not found. version: '1.0' '500': description: 500 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: version: '1.0' status: Error errors: - code: ErrorCode message: Error message/description. '/api/accounts/{accountId}/vehicles/{vehicleId}/externalids': get: summary: GetExternalIdList description: Allows to get a vehicle external id list. operationId: get-external-id-list parameters: - name: accountId in: path description: Your team's private identifier for the Sandbox environment (received by email). required: true schema: type: string - name: vehicleId in: path description: Id of the vehicle. required: true schema: type: string - name: Authorization in: header description: A JwtToken generated by GetVehicleToken required: true schema: type: string responses: '200': description: '' content: application/json: example: trace: data: - externalIdType: RFID externalIdValue: '*****B-CC' status: Success errors: version: 1 '401': description: 401 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: anyOf: - InvalidJWT: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' - TokenExpired: status: Error errors: - code: TokenExpired message: 'Lifetime validation failed, the JWT is expired.' version: '1.0' - TokenNotPresent: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '500': description: 500 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: version: '1.0' status: Error errors: - code: ErrorCode message: Error message/description. /api/vehicleprofiles: get: summary: GetVehicleProfiles description: Retrieves a list of vehicle profiles. operationId: get-vehicle-profiles parameters: - name: limit in: query schema: type: number - name: offset in: query schema: type: number - name: Authorization in: header description: Access Token required: true schema: type: string responses: '200': description: '' headers: accept-range: description: Accepted range. schema: type: integer prev-range: description: Previous range Url. schema: type: string next-range: description: Next range Url. schema: type: string content: application/json: example: version: 1 data: - id: 8786946b-9fe5-492a-b580-6e03154d84f1 externalId: 5f043d78bc262f1627fc0325 vehicleDetails: make: Ford carModel: Mustang Mach-E edition: version: ER RWD battery: usableKwh: 88 fullKwh: 98.7 fastChargingSupport: false range: best: 405 worst: 359 connectors: - power: 11 speed: 46 standard: IEC_62196_T2 time: 570 - power: 90 speed: 430 standard: IEC_62196_T2_COMBO time: 43 adapters: [ ] body: seats: 5 media: image: id: 5f1aa848657bebdd4a63893d url: https://cars.chargetrip.io/5f1aa848657bebdd4a63893d.png width: height: 432 type: 3 thumbnailUrl: thumbnailWidth: thumbnailHeight: brand: id: 5f6af138efe6759090895eda url: https://cars.chargetrip.io/5f6af138efe6759090895eda.png width: height: 864 type: 1 thumbnailUrl: thumbnailWidth: thumbnailHeight: availability: status: 2 type: fastCharging: - id: 9c8022a0-ebe0-478a-91ec-a8be41bdabed externalId: 5f043b66bc262f1627fc0253 vehicleDetails: make: Tesla carModel: Model S edition: version: '70' battery: usableKwh: 69 fullKwh: 75 fastChargingSupport: false range: best: 383 worst: 340 connectors: - power: 11 speed: 43 standard: IEC_62196_T2 time: 450 - power: 95 speed: 420 standard: TESLA_S time: 32 adapters: - power: 110 speed: 460 standard: IEC_62196_T2_COMBO time: 40 - power: 110 speed: 460 standard: CHADEMO time: 40 - power: 16.5 speed: 66 standard: IEC_62196_T2 time: 420 body: seats: 5 media: image: id: 5f1aa836657beb4b7c6388f7 url: https://cars.chargetrip.io/5f1aa836657beb4b7c6388f7.png width: height: 432 type: 3 thumbnailUrl: thumbnailWidth: thumbnailHeight: brand: id: 5f59fef933bb0764f9ca842b url: https://cars.chargetrip.io/5f59fef933bb0764f9ca842b.png width: height: 864 type: 1 thumbnailUrl: thumbnailWidth: thumbnailHeight: availability: status: 0 type: fastCharging: - id: e038742c-bc66-432f-98e0-372f08a7955b externalId: 5f9823867473fe7e2fbb8137 vehicleDetails: make: Lucid carModel: Air edition: version: Pure battery: usableKwh: 85 fullKwh: 88 fastChargingSupport: false range: best: 437 worst: 387 connectors: - power: 22 speed: 110 standard: IEC_62196_T2 time: 285 - power: 240 speed: 1410 standard: IEC_62196_T2_COMBO time: 16 adapters: [ ] body: seats: 5 media: image: id: 5fa4001c8de02a7a27e8444b url: https://cars.chargetrip.io/5fa4001c8de02a7a27e8444b.png width: height: 432 type: 3 thumbnailUrl: thumbnailWidth: thumbnailHeight: brand: id: 5fa400248de02a699be8444c url: https://cars.chargetrip.io/5fa400248de02a699be8444c.png width: height: 864 type: 1 thumbnailUrl: thumbnailWidth: thumbnailHeight: availability: status: 2 type: fastCharging: - id: 5568ff75-2d03-4471-babb-8ba19003ca3f externalId: 5f043b3fbc262f1627fc0241 vehicleDetails: make: Volkswagen carModel: e-Golf edition: version: battery: usableKwh: 20.5 fullKwh: 24.2 fastChargingSupport: false range: best: 128 worst: 113 connectors: - power: 3.7 speed: 19 standard: IEC_62196_T2 time: 405 - power: 41 speed: 240 standard: IEC_62196_T2_COMBO time: 22 adapters: [ ] body: seats: 5 media: image: id: 5f1aa834657bebb91a6388f0 url: https://cars.chargetrip.io/5f1aa834657bebb91a6388f0.png width: height: 432 type: 3 thumbnailUrl: thumbnailWidth: thumbnailHeight: brand: id: 5f1aafdf657beb7e1d638998 url: https://cars.chargetrip.io/5f1aafdf657beb7e1d638998.png width: height: 864 type: 1 thumbnailUrl: thumbnailWidth: thumbnailHeight: availability: status: 0 type: fastCharging: status: Success '401': description: 401 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: anyOf: - InvalidJWT: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' - TokenExpired: status: Error errors: - code: TokenExpired message: 'Lifetime validation failed, the JWT is expired.' version: '1.0' - TokenNotPresent: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/shell' examples: tokenmissing: description: test value: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' incorrecttoken: description: test value: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '500': description: 500 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: version: '1.0' status: Error errors: - code: ErrorCode message: Error message/description. '/api/accounts/{accountId}/groups': get: summary: GetGroups description: Retrieves the list of all vehicles groups. operationId: get-groups parameters: - name: accountId in: path description: Your team's private identifier for the Sandbox environment (received by email). required: true schema: type: string - name: Authorization in: header description: Access Token required: true schema: type: string responses: '200': description: '' content: application/json: example: version: 1 data: - subsidiary-fr - subsidiary-de - subsidiary-be status: Success '401': description: 401 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: anyOf: - InvalidJWT: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' - TokenExpired: status: Error errors: - code: TokenExpired message: 'Lifetime validation failed, the JWT is expired.' version: '1.0' - TokenNotPresent: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/shell' examples: tokenmissing: description: test value: status: Error errors: - code: InvalidJWT message: Unable to decode the JWT. version: '1.0' incorrecttoken: description: test value: status: Error errors: - code: TokenNotPresent message: JWT not present. version: '1.0' '500': description: 500 description content: application/json: schema: type: object properties: status: type: string errors: type: array items: required: - code - message type: object properties: code: type: string message: type: string version: type: string example: version: '1.0' status: Error errors: - code: ErrorCode message: Error message/description. components: schemas: externalid: required: - externalIdValue properties: externalIdValue: maxLength: 20 type: string description: 'Value of the externalId, 20 character maximum' example: externalIdValue: ABCDEFGHIJKLMNOPQRST shell: properties: status: enum: - Success - Error type: string description: Code describing the status of the response errors: type: array items: $ref: '#/components/schemas/error' version: type: string description: Version number of the response error: required: - code - message type: object properties: code: type: string description: Code of the error. message: type: string description: Readable message describing the error. securitySchemes: apiKeyHeader: type: apiKey name: Api-Subscription-Key in: header apiKeyQuery: type: apiKey name: api-subscription-key in: query security: - apiKeyHeader: [ ] - apiKeyQuery: [ ]