Skip to content

Add Devices and Create Cars API to API index #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Mar 17, 2017
Merged

Add Devices and Create Cars API to API index #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5d0f341
fix bad link on index of devices routes
josephpage Feb 8, 2017
ae829c4
add Devices API to the API index
josephpage Feb 14, 2017
5165aa1
add Create Car to the index API + add method name
josephpage Feb 14, 2017
5c1d8bb
add missing me/cars route in Users index
josephpage Feb 14, 2017
f616b92
fix bad tab
josephpage Feb 14, 2017
bc1f82f
fix bad link in Users API index
josephpage Feb 15, 2017
4a22933
Merge branch 'master' into patch-1
josephpage Feb 24, 2017
1ac11fd
change xeeId to deviceId in API index
josephpage Feb 24, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 35 additions & 21 deletions api/api/v3/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ The process is quite simple, don't be afraid!

|API|Description|
|---|---|
|[`/auth/auth`](auth/auth.md)|For the authentication page|
|[`/auth/access_token`](auth/access_token.md)|For the *access token* API|
|[`GET /auth/auth`](auth/auth.md)|For the authentication page|
|[`POST /auth/access_token`](auth/access_token.md)|For the *access token* API|

## API

Expand All @@ -46,10 +46,11 @@ This is the first route of our API, from this, you can get the logged in user da

|API|Description|
|---|---|
|[`/users/me`](users/me.md)|Get the connected user|
|[`/users/me/cars`](users/me/cars.md)|Get all the cars for the connected user|
|[`/users/{userId}`](users/user_id.md)|Get a specific user|
|[`/users/{userId}/cars`](users/cars.md)|Get all the cars from a user|
|[`GET /users/me`](users/me.md)|Get the connected user|
|[`GET /users/me/cars`](users/me/cars.md)|Get all the cars for the connected user|
|[`GET /users/{userId}`](users/user_id.md)|Get a specific user|
|[`GET /users/{userId}/cars`](users/cars.md)|Get all the cars from a user|
|[`POST /users/{userId}/cars`](users/cars_create.md)|Create a car for this user|

### Cars

Expand All @@ -59,14 +60,14 @@ This is the second route of our API, from this, you can get all the *raw* car da

|API|Description|
|---|---|
|[`/cars/{carId}`](cars/car_id.md)|Get a specific car from its *id*|
|[`/cars/{carId}/status`](cars/status.md)|Get car *status*|
|[`/cars/{carId}/locations`](cars/locations.md)|Get car *locations* history|
|[`/cars/{carId}/locations.geojson`](cars/locations-geojson.md)|Get car *locations* history in a [geojson](http://geojson.org/) format|
|[`/cars/{carId}/signals`](cars/signals.md)|Get car *signals* history|
|[`/cars/{carId}/trips`](cars/trips.md)|Get car *trips*|
|[`/cars/{carId}/stats/mileage`](cars/stats/mileage.md)|Get car *mileage* statistic|
|[`/cars/{carId}/stats/usedtime`](cars/stats/usedtime.md)|Get car *used time* statistic|
|[`GET /cars/{carId}`](cars/car_id.md)|Get a specific car from its *id*|
|[`GET /cars/{carId}/status`](cars/status.md)|Get car *status*|
|[`GET /cars/{carId}/locations`](cars/locations.md)|Get car *locations* history|
|[`GET /cars/{carId}/locations.geojson`](cars/locations-geojson.md)|Get car *locations* history in a [geojson](http://geojson.org/) format|
|[`GET /cars/{carId}/signals`](cars/signals.md)|Get car *signals* history|
|[`GET /cars/{carId}/trips`](cars/trips.md)|Get car *trips*|
|[`GET /cars/{carId}/stats/mileage`](cars/stats/mileage.md)|Get car *mileage* statistic|
|[`GET /cars/{carId}/stats/usedtime`](cars/stats/usedtime.md)|Get car *used time* statistic|

### Trips

Expand All @@ -76,13 +77,26 @@ This is the third route of our API, from this, you can get all the *trips relate

|API|Description|
|---|---|
|[`/trips/{tripId}`](trips/trip_id.md)|Get a specific *trip* from its *id*|
|[`/trips/{tripId}/locations`](trips/locations.md)|Get all locations from a *car* during a specific *trip*|
|[`/trips/{tripId}/locations.geojson`](trips/locations-geojson.md)|Get all locations from a *car* during a specific *trip* in a [geojson](http://geojson.org/) format|
|[`/trips/{tripId}/signals`](trips/signals.md)|Get all signals from a *car* during a specific *trip*|
|[`/trips/{tripId}/stats`](trips/trip_id/stats.md)|Get a specific *trip* statistics|
|[`/trips/{tripId}/stats/mileage`](trips/trip_id/stats/mileage.md)|Get a specific *trip* mileage|
|[`/trips/{tripId}/stats/usedtime`](trips/trip_id/stats/usedtime.md)|Get a specific *trip* duration|
|[`GET /trips/{tripId}`](trips/trip_id.md)|Get a specific *trip* from its *id*|
|[`GET /trips/{tripId}/locations`](trips/locations.md)|Get all locations from a *car* during a specific *trip*|
|[`GET /trips/{tripId}/locations.geojson`](trips/locations-geojson.md)|Get all locations from a *car* during a specific *trip* in a [geojson](http://geojson.org/) format|
|[`GET /trips/{tripId}/signals`](trips/signals.md)|Get all signals from a *car* during a specific *trip*|
|[`GET /trips/{tripId}/stats`](trips/trip_id/stats.md)|Get a specific *trip* statistics|
|[`GET /trips/{tripId}/stats/mileage`](trips/trip_id/stats/mileage.md)|Get a specific *trip* mileage|
|[`GET /trips/{tripId}/stats/usedtime`](trips/trip_id/stats/usedtime.md)|Get a specific *trip* duration|

### Devices

This is the fourth route of our API, from this, you can manage your associated devices.
These routes are quite private, and the required scope to call them is not accessible to all the applications.

> [Devices API](devices/README.md) Associate devices to an given user, to a given car ...

|API|Description|
|---|---|
|[`POST /devices/{deviceId}/associate?carId={carId}`](devices/associate_car.md)|Associate a car to the given device|
|[`POST /devices/{deviceId}/associate?pin={pin}`](devices/associate_user.md)|Associate a user to the given device|
|[`POST /devices/{deviceId}/dissociate`](devices/dissociate.md)|Dissociate the given device from it's car|

## Errors

Expand Down
2 changes: 1 addition & 1 deletion api/api/v3/devices/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Interact with device. These routes are quite private, and the required scope to
|---|---|
|[`POST /devices/{deviceId}/associate?carId={carId}`](associate_car.md)|Associate a car to the given device|
|[`POST /devices/{deviceId}/associate?pin={pin}`](associate_user.md)|Associate a user to the given device|
|[`POST /devices/{deviceId}/dissociate`](dissoiate.md)|Dissociate the given device from it's car|
|[`POST /devices/{deviceId}/dissociate`](dissociate.md)|Dissociate the given device from it's car|
3 changes: 2 additions & 1 deletion api/api/v3/users/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Get the logged in user information.
|Method|API|Description|
|---|---|---|
|GET|[`/users/me`](me.md)|Get the connected user|
|GET|[`/users/me/cars`](me/cars.md)|Get all the cars for the connected user|
|GET|[`/users/{userId}`](user_id.md)|Get a specific user|
|GET|[`/users/{userId}/cars`](cars.md)|Get all the cars from a user|
|POST|[`/users/{userId}/cars`](cars.md)|Create a car for this user|
|POST|[`/users/{userId}/cars`](cars_create.md)|Create a car for this user|