github/psa_car_controller
1
0
Fork 0
mirror of https://github.com/flobz/psa_car_controller.git synced 2026-08-22 17:36:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
030d02a7808844debde38d161ecd0bfaabba2ef0
psa_car_controller/api_spec.md
T
jumpjackandGitHub 65dce096bd fixed typos/formatting
2021-10-18 09:53:40 +02:00

238 lines
14 KiB
Markdown
Raw Blame History

# psa-connectedcar
*PSA B2C Connected Car API*
# Introduction
This is the description of the *Groupe PSA Connected Car V2 API*. The speccification is is based on **OpenAPI Specification version 3** and can be displayed via [ReDoc](https://github.com/Rebilly/ReDoc)a or [Swagger](http://swagger.io).
This API allows applications to fetch data from the connected Vehicles data platform.
# Authentication
PSA Connected Car APIs uses the [OAuth 2.0](https://tools.ietf.org/html/rfc6749) protocol for authentication and Authorization. any application require a valid [Access Token](https://tools.ietf.org/html/rfc6749#section-1.4) to access to user data.
# Errors
Error codes returned by all REST APIs comply with the standard. Nevertheless, PSA Services (callers) need to have more complete data structures (even when the answer is not Http-OK) to better detail the type of error by providing application code, message and a debugging code(for investigation purposes). The http code of the response is managed by the protocol itself (in the header).
**Errors are returned as a generic error response:**
* ```xError``` object model.
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: 4.0
- Package version: 4.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Documentation for API Endpoints
All URIs are relative to *https://api.groupe-psa.com/connectedcar/v4*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*TripsApi* | [**get_path_for_trip**](docs/api/TripsApi.md#get_path_for_trip) | **GET** /user/trips/{tid}/wayPoints | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_path_for_trip_0**](docs/api/TripsApi.md#get_path_for_trip_0) | **GET** /user/vehicles/{id}/trips/{tid}/wayPoints | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_telemetry_for_trip**](docs/api/TripsApi.md#get_telemetry_for_trip) | **GET** /user/trips/{tid}/telemetry | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_telemetry_for_trip_0**](docs/api/TripsApi.md#get_telemetry_for_trip_0) | **GET** /user/vehicles/{id}/trips/{tid}/telemetry | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_trip_by_vehicle**](docs/api/TripsApi.md#get_trip_by_vehicle) | **GET** /user/vehicles/{id}/trips/{tid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_trips_by_vehicle**](docs/api/TripsApi.md#get_trips_by_vehicle) | **GET** /user/trips/{tid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_trips_by_vehicle_0**](docs/api/TripsApi.md#get_trips_by_vehicle_0) | **GET** /user/trips/{tid}/ecoaching | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_trips_by_vehicle_1**](docs/api/TripsApi.md#get_trips_by_vehicle_1) | **GET** /user/vehicles/{id}/trips | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_trips_by_vehicle_2**](docs/api/TripsApi.md#get_trips_by_vehicle_2) | **GET** /user/vehicles/{id}/trips/{tid}/ecoaching | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_user_collision_by_tip_by_id**](docs/api/TripsApi.md#get_user_collision_by_tip_by_id) | **GET** /user/trips/{tid}/collisions/{cid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_user_collisions_by_trip_id**](docs/api/TripsApi.md#get_user_collisions_by_trip_id) | **GET** /user/trips/{tid}/collisions | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_user_trip_alert_by_aid**](docs/api/TripsApi.md#get_user_trip_alert_by_aid) | **GET** /user/trips/{tid}/alerts/{aid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_user_trip_alerts**](docs/api/TripsApi.md#get_user_trip_alerts) | **GET** /user/trips/{tid}/alerts | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_user_trips**](docs/api/TripsApi.md#get_user_trips) | **GET** /user/trips | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_vehicle_collision_by_tip_by_id**](docs/api/TripsApi.md#get_vehicle_collision_by_tip_by_id) | **GET** /user/vehicles/{id}/trips/{tid}/collisions/{cid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_vehicle_collisions_by_trip_id**](docs/api/TripsApi.md#get_vehicle_collisions_by_trip_id) | **GET** /user/vehicles/{id}/trips/{tid}/collisions | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_vehicle_trip_alert_by_aid**](docs/api/TripsApi.md#get_vehicle_trip_alert_by_aid) | **GET** /user/vehicles/{id}/trips/{tid}/alerts/{aid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*TripsApi* | [**get_vehicle_trip_alerts**](docs/api/TripsApi.md#get_vehicle_trip_alerts) | **GET** /user/vehicles/{id}/trips/{tid}/alerts | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*UserApi* | [**get_user**](docs/api/UserApi.md#get_user) | **GET** /user | User's information
*VehiclesApi* | [**delete_monitordd**](docs/api/VehiclesApi.md#delete_monitordd) | **DELETE** /user/vehicles/{id}/monitors/{mid} | Delete a Monitor. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*VehiclesApi* | [**get_car_last_position**](docs/api/VehiclesApi.md#get_car_last_position) | **GET** /user/vehicles/{id}/lastPosition | Last position identified
*VehiclesApi* | [**get_telemetry**](docs/api/VehiclesApi.md#get_telemetry) | **GET** /user/vehicles/{id}/telemetry | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*VehiclesApi* | [**get_vehicle_alerts**](docs/api/VehiclesApi.md#get_vehicle_alerts) | **GET** /user/vehicles/{id}/alerts |
*VehiclesApi* | [**get_vehicle_alerts_by_id**](docs/api/VehiclesApi.md#get_vehicle_alerts_by_id) | **GET** /user/vehicles/{id}/alerts/{aid} |
*VehiclesApi* | [**get_vehicle_byid**](docs/api/VehiclesApi.md#get_vehicle_byid) | **GET** /user/vehicles/{id} | Details of vehicule
*VehiclesApi* | [**get_vehicle_collision**](docs/api/VehiclesApi.md#get_vehicle_collision) | **GET** /user/vehicles/{id}/collisions | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*VehiclesApi* | [**get_vehicle_collision_by_id**](docs/api/VehiclesApi.md#get_vehicle_collision_by_id) | **GET** /user/vehicles/{id}/collisions/{cid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*VehiclesApi* | [**get_vehicle_maintenance**](docs/api/VehiclesApi.md#get_vehicle_maintenance) | **GET** /user/vehicles/{id}/maintenance |
*VehiclesApi* | [**get_vehicle_monitors**](docs/api/VehiclesApi.md#get_vehicle_monitors) | **GET** /user/vehicles/{id}/monitors | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*VehiclesApi* | [**get_vehicle_monitors_by_id**](docs/api/VehiclesApi.md#get_vehicle_monitors_by_id) | **GET** /user/vehicles/{id}/monitors/{mid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*VehiclesApi* | [**get_vehicle_status**](docs/api/VehiclesApi.md#get_vehicle_status) | **GET** /user/vehicles/{id}/status | Vehicle status.
*VehiclesApi* | [**get_vehicles_by_device**](docs/api/VehiclesApi.md#get_vehicles_by_device) | **GET** /user/vehicles | List of vehicules
*VehiclesApi* | [**set_fleet_vehicle_monitor_status**](docs/api/VehiclesApi.md#set_fleet_vehicle_monitor_status) | **PUT** /user/vehicles/{id}/monitors/{mid}/status | Set a new monitor status. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*VehiclesApi* | [**set_vehicle_monitor**](docs/api/VehiclesApi.md#set_vehicle_monitor) | **POST** /user/vehicles/{id}/monitors | Create a new Monitor. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
*VehiclesApi* | [**update_fleet_vehicle_monitor**](docs/api/VehiclesApi.md#update_fleet_vehicle_monitor) | **PUT** /user/vehicles/{id}/monitors/{mid} | Update and existing Monitor. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE
## Documentation For Models
- [Adas](docs/api/Adas.md)
- [AdasParkAssist](docs/api/AdasParkAssist.md)
- [Alert](docs/api/Alert.md)
- [AlertEndPosition](docs/api/AlertEndPosition.md)
- [AlertLinks](docs/api/AlertLinks.md)
- [AlertMsgEnum](docs/api/AlertMsgEnum.md)
- [Alerts](docs/api/Alerts.md)
- [AlertsEmbedded](docs/api/AlertsEmbedded.md)
- [Battery](docs/api/Battery.md)
- [BoundedProgram](docs/api/BoundedProgram.md)
- [ChargingStatusEnum](docs/api/ChargingStatusEnum.md)
- [CircleZone](docs/api/CircleZone.md)
- [CircleZoneCoordinates](docs/api/CircleZoneCoordinates.md)
- [CollectionResult](docs/api/CollectionResult.md)
- [Collision](docs/api/Collision.md)
- [CollisionLinks](docs/api/CollisionLinks.md)
- [CollisionObj](docs/api/CollisionObj.md)
- [CollisionObjFront](docs/api/CollisionObjFront.md)
- [Collisions](docs/api/Collisions.md)
- [CollisionsEmbedded](docs/api/CollisionsEmbedded.md)
- [CreatedAtField](docs/api/CreatedAtField.md)
- [DataMonitorTrigger](docs/api/DataMonitorTrigger.md)
- [DataTrigger](docs/api/DataTrigger.md)
- [DefaultAlertPush](docs/api/DefaultAlertPush.md)
- [DefaultAlertPushAttributes](docs/api/DefaultAlertPushAttributes.md)
- [DoorsState](docs/api/DoorsState.md)
- [DoorsStateOpening](docs/api/DoorsStateOpening.md)
- [ECoaching](docs/api/ECoaching.md)
- [ECoachingLinks](docs/api/ECoachingLinks.md)
- [ECoachingScores](docs/api/ECoachingScores.md)
- [Energy](docs/api/Energy.md)
- [Engine](docs/api/Engine.md)
- [EngineOil](docs/api/EngineOil.md)
- [Environment](docs/api/Environment.md)
- [EnvironmentLuminosity](docs/api/EnvironmentLuminosity.md)
- [Event](docs/api/Event.md)
- [EventLinks](docs/api/EventLinks.md)
- [Extension](docs/api/Extension.md)
- [ExtensionType](docs/api/ExtensionType.md)
- [Geometry](docs/api/Geometry.md)
- [Ignition](docs/api/Ignition.md)
- [IndexRange](docs/api/IndexRange.md)
- [Kinetic](docs/api/Kinetic.md)
- [Lighting](docs/api/Lighting.md)
- [Link](docs/api/Link.md)
- [Maintenance](docs/api/Maintenance.md)
- [MaintenanceLinks](docs/api/MaintenanceLinks.md)
- [MaintenanceObj](docs/api/MaintenanceObj.md)
- [Monitor](docs/api/Monitor.md)
- [MonitorId](docs/api/MonitorId.md)
- [MonitorLinks](docs/api/MonitorLinks.md)
- [MonitorParameter](docs/api/MonitorParameter.md)
- [MonitorParameterTriggerParam](docs/api/MonitorParameterTriggerParam.md)
- [MonitorRef](docs/api/MonitorRef.md)
- [MonitorRefLinks](docs/api/MonitorRefLinks.md)
- [MonitorStatus](docs/api/MonitorStatus.md)
- [MonitorStatusSetter](docs/api/MonitorStatusSetter.md)
- [MonitorSubscribe](docs/api/MonitorSubscribe.md)
- [MonitorSubscribeBatchNotify](docs/api/MonitorSubscribeBatchNotify.md)
- [MonitorSubscribeRetryPolicy](docs/api/MonitorSubscribeRetryPolicy.md)
- [MonitorTrigger](docs/api/MonitorTrigger.md)
- [MonitorWebhook](docs/api/MonitorWebhook.md)
- [MonitorWebhookAttributes](docs/api/MonitorWebhookAttributes.md)
- [Monitors](docs/api/Monitors.md)
- [MonitorsEmbedded](docs/api/MonitorsEmbedded.md)
- [OverallAutonomy](docs/api/OverallAutonomy.md)
- [Point](docs/api/Point.md)
- [PolygonZone](docs/api/PolygonZone.md)
- [Position](docs/api/Position.md)
- [PositionProperties](docs/api/PositionProperties.md)
- [Preconditioning](docs/api/Preconditioning.md)
- [PreconditioningAirConditioning](docs/api/PreconditioningAirConditioning.md)
- [PreconditioningProgram](docs/api/PreconditioningProgram.md)
- [Privacy](docs/api/Privacy.md)
- [Program](docs/api/Program.md)
- [ProgramOccurence](docs/api/ProgramOccurence.md)
- [Safety](docs/api/Safety.md)
- [ServiceType](docs/api/ServiceType.md)
- [Status](docs/api/Status.md)
- [StatusEmbedded](docs/api/StatusEmbedded.md)
- [StatusExtensionType](docs/api/StatusExtensionType.md)
- [StatusLinks](docs/api/StatusLinks.md)
- [TabLinks](docs/api/TabLinks.md)
- [Telemetry](docs/api/Telemetry.md)
- [TelemetryEmbedded](docs/api/TelemetryEmbedded.md)
- [TelemetryEnum](docs/api/TelemetryEnum.md)
- [TelemetryExtension](docs/api/TelemetryExtension.md)
- [TelemetryExtensionType](docs/api/TelemetryExtensionType.md)
- [TelemetryMessage](docs/api/TelemetryMessage.md)
- [TelemetryMessageEmbedded](docs/api/TelemetryMessageEmbedded.md)
- [TelemetryMessageVehicle](docs/api/TelemetryMessageVehicle.md)
- [TelemetryMessageVehicleBrakingSystem](docs/api/TelemetryMessageVehicleBrakingSystem.md)
- [TelemetryMessageVehicleTransmission](docs/api/TelemetryMessageVehicleTransmission.md)
- [TelemetryMessageVehicleTransmissionGearbox](docs/api/TelemetryMessageVehicleTransmissionGearbox.md)
- [TelemetryMessageVehicleTransmissionGearboxGear](docs/api/TelemetryMessageVehicleTransmissionGearboxGear.md)
- [TelemetryMessageVehicleTransmissionGearboxMode](docs/api/TelemetryMessageVehicleTransmissionGearboxMode.md)
- [TimeMonitorTrigger](docs/api/TimeMonitorTrigger.md)
- [TimeRange](docs/api/TimeRange.md)
- [TimeStamped](docs/api/TimeStamped.md)
- [TimeTrigger](docs/api/TimeTrigger.md)
- [TimeZoneMonitorTrigger](docs/api/TimeZoneMonitorTrigger.md)
- [TimeZoneTrigger](docs/api/TimeZoneTrigger.md)
- [Trip](docs/api/Trip.md)
- [TripAvgConsumption](docs/api/TripAvgConsumption.md)
- [TripLinks](docs/api/TripLinks.md)
- [Trips](docs/api/Trips.md)
- [TripsEmbedded](docs/api/TripsEmbedded.md)
- [UpdatedField](docs/api/UpdatedField.md)
- [Url](docs/api/Url.md)
- [User](docs/api/User.md)
- [UserEmbedded](docs/api/UserEmbedded.md)
- [UserLinks](docs/api/UserLinks.md)
- [Vect2D](docs/api/Vect2D.md)
- [Vehicle](docs/api/Vehicle.md)
- [VehicleEngine](docs/api/VehicleEngine.md)
- [VehicleLinks](docs/api/VehicleLinks.md)
- [VehicleOdometer](docs/api/VehicleOdometer.md)
- [Vehicles](docs/api/Vehicles.md)
- [VehiclesEmbedded](docs/api/VehiclesEmbedded.md)
- [WayPoints](docs/api/WayPoints.md)
- [WayPointsEmbedded](docs/api/WayPointsEmbedded.md)
- [XError](docs/api/XError.md)
- [ZoneMonitorTrigger](docs/api/ZoneMonitorTrigger.md)
- [ZoneTrigger](docs/api/ZoneTrigger.md)
- [ZoneTriggerPlace](docs/api/ZoneTriggerPlace.md)
- [ZoneTriggerPlaceCenter](docs/api/ZoneTriggerPlaceCenter.md)
## Documentation For Authorization
## Vehicle_auth
- **Type**: OAuth
- **Flow**: implicit
- **Authorization URL**:
- **Scopes**:
- **Collision_read**: read Collision related data
- **Maintenance_read**: read Maintenance related data
- **Status_read**: read Vehicle related status
- **Telemetry_read**: read Telemetry related data
- **Trip_read**: read Trip related data
- **Vehicle_read**: read Vehicle related data
- **alert_read**: read alert related data
- **alert_write**: create, modify or delete alerte
- **localisation_read**: read location related data
## client_id
- **Type**: API key
- **API key parameter name**: client_id
- **Location**: URL query string
## realm
- **Type**: API key
- **API key parameter name**: x-introspect-realm
- **Location**: HTTP header
## Author
Reference in New Issue View Git Blame Copy Permalink