Voertuigen

Authenticatie vereist

Met deze resource kunnen voertuigen van u opgehaald en aangemaakt worden.

Resource mogelijkheden

HTTP Request Type Resource Type Vereisten Rechten
GET Collectie Trips.read
POST Collectie Trips.write
GET Element Trips.read
POST Element Trips.write
DELETE Element Trips.write

Velden

Veld Beschrijving Zichbaar Aanpasbaar Vereist bij aanmaken
id Het indificatie nummer van het voertuig. Ja Nee Nee
client_id   Nee Nee Nee
user_id   Nee Nee Nee
brand   Ja Ja Ja
model   Ja Ja Ja
plate   Ja Ja Ja
km_reading   Ja Ja Ja
memo   Ja Ja Nee

Collectie GET

GET Collectie

Een GET request op de collectie zal resulteren in een volledige lijst van uw voertuigen.

https://api.workspace.nl/api/v1/cars.json
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "count": 2,
            "Cars": [
                {
                    "Car": {
                        "id": "18",
                        "brand": "Mercedes",
                        "model": "Vito",
                        "plate": "12-ABC-3",
                        "km_reading": "81028",
                        "memo": "Blauw"
                    }
                },
                {
                    "Car": {
                        "id": "38",
                        "brand": "Fiat",
                        "model": "500",
                        "plate": "55-XYZ-9",
                        "km_reading": "1000",
                        "memo": ""
                    }
                }
            ]
        }
    }
}

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
GET 404 Not Found Cars not found.

Collectie POST

POST Collectie

Een POST request op de collectie zal resulteren in het aanmaken van een nieuw element.

https://api.workspace.nl/api/v1/cars.json

Let op

Bij een POST Request via het HTTP protocol wordt de header Content-Type: application/x-www-form-urlencoded verwacht.

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
POST 400 Bad Request Something went wrong while saving the data.

ELEMENT GET

GET Element

Een GET request op het element zal resulteren op een enkel voertuig.

https://api.workspace.nl/api/v1/cars/{id}.json
Parameters
{id} Het indentificatie nummer van het voertuig in formaat (0-9)
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "Car": {
                "id": "18",
                "brand": "Mercedes",
                "model": "Vito",
                "plate": "12-ABC-3",
                "km_reading": "81028",
                "memo": "Blauw"
            }
        }
    }
}

ELEMENT POST

POST Element

Een POST request op het element zal resulteren in het aanpassen van het element. Alleen specifieke velden zijn aanpasbaar.

https://api.workspace.nl/api/v1/cars/{id}.json
Parameters
{id} Het indentificatie nummer van het voertuig in formaat (0-9)

Let op

Bij een POST Request via het HTTP protocol wordt de header Content-Type: application/x-www-form-urlencoded verwacht.

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
POST 400 Bad Request Something went wrong while saving the data.
POST 404 Not Found Car not found.

ELEMENT DELETE

DELETE Element

Een DELETE request op het element zal resulteren in het verwijderen van het element.

https://api.workspace.nl/api/v1/cars/{id}.json
Parameters
{id} Het indentificatie nummer van het voertuig in formaat (0-9)

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
DELETE 404 Not Found Car not found.