Trips

Authenticatie vereist

Met deze resource kunnen trips 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

Resource Containments

Depth Resource
0 Geen containments
1
2

Velden

Veld Beschrijving Zichbaar Aanpasbaar Vereist bij aanmaken
id Het indificatie nummer van de trip. Ja Nee Nee
client_id Nee Nee Nee
car_id Ja Ja Ja
type
  1. Zakelijk
  2. Privé
 Ja Ja Ja
driver Ja Ja Ja
date Ja Ja Ja
from Ja Ja Ja
from_contact_id Ja Ja Nee
to Ja Ja Ja
to_contact_id Ja Ja Nee
km_start Ja Ja Ja
km_end Ja Ja Ja
created Ja Nee Nee
memo Ja Ja Nee
project_id Nee Nee Nee
invoice_status Ja Ja Nee

Collectie GET

GET Collectie

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

https://api.workspace.nl/api/v1/trips.json
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "count": 1,
            "Trips": [
                {
                    "Trip": {
                        "id": "761",
                        "car_id": "18",
                        "type": "1",
                        "driver": "test",
                        "date": "2014-02-15",
                        "from": "",
                        "from_contact_id": null,
                        "to": "",
                        "to_contact_id": "520",
                        "km_start": "80000",
                        "km_end": "80336",
                        "created": "2014-02-15 23:29:06",
                        "memo": "",
                        "invoice_status": "3"
                    },
                    "FromContact": [],
                    "ToContact": [],
                    "Car": []
                }
            ]
        }
    }
}

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
GET 404 Not Found Trips 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/trips.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 enkele trip.

https://api.workspace.nl/api/v1/trips/{id}.json
Parameters
{id} Het indentificatie nummer van de trip in formaat (0-9)
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "Trip": {
                "id": "761",
                "car_id": "18",
                "type": "1",
                "driver": "test",
                "date": "2014-02-15",
                "from": "",
                "from_contact_id": null,
                "to": "",
                "to_contact_id": "520",
                "km_start": "80000",
                "km_end": "80336",
                "created": "2014-02-15 23:29:06",
                "memo": "",
                "invoice_status": "3"
            },
            "FromContact": [],
            "ToContact": [],
            "Car": []
        }
    }
}

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/trips/{id}.json
Parameters
{id} Het indentificatie nummer van de trip 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 Trip 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/trips/{id}.json
Parameters
{id} Het indentificatie nummer van de trip in formaat (0-9)

Mogelijke fout meldingen Errors

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