Orders

Authenticatie vereist

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

Resource mogelijkheden

HTTP Request Type Resource Type Vereisten Rechten
GET Collectie Orders.read
POST Collectie Orders.write
GET Element Orders.read
POST Element Orders.write
DELETE Element Orders.write
Speciale acties:
GET Action post generate Invoice Orders.write

Resource Containments

Depth Resource
0 Geen containments
1
2

Velden

Veld Beschrijving Zichbaar Aanpasbaar Vereist bij aanmaken
id Het indificatie nummer van de order. Ja Nee Nee
name   Ja Ja Nee
code   Ja Nee Nee
contact_id Id van de contact persoon waar de order voor is. Ja Ja Ja
deadline   Ja Ja Nee
status De status van de order standaard 1 Ja Ja Nee
created   Ja Nee Nee
description   Ja Ja Nee
discount   Ja Ja Nee
total_price   Ja Nee Nee
total_price_vat   Ja Nee Nee
total_price_purchase   Ja Nee Nee

Collectie GET

GET Collectie

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

https://api.workspace.nl/api/v1/orders.json
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "count": 1,
            "Orders": [
                {
                    "Order": {
                        "id": "19",
                        "name": "Potten verf besteld",
                        "code": "2013-0001",
                        "user_id": "269",
                        "contact_id": "519",
                        "deadline": "2013-06-01",
                        "status": "2",
                        "created": "2013-02-19 14:42:59",
                        "description": null,
                        "discount": "10",
                        "total_price": "1007280",
                        "total_price_vat": "31979",
                        "total_price_purchase": "250000"
                    },
                    "Contact": [],
                    "OrderLine": []
                }
            ]
        }
    }
}

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
GET 404 Not Found Orders 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/orders.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 order.

https://api.workspace.nl/api/v1/orders/{id}.json
Parameters
{id} Het indentificatie nummer van de order in formaat (0-9)
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "Order": {
                "Order": {
                    "id": "19",
                    "name": "Potten verf besteld",
                    "code": "2013-0001",
                    "user_id": "269",
                    "contact_id": "519",
                    "deadline": "2013-06-01",
                    "status": "2",
                    "created": "2013-02-19 14:42:59",
                    "description": null,
                    "discount": "10",
                    "total_price": "1007280",
                    "total_price_vat": "31979",
                    "total_price_purchase": "250000"
                },
                "Contact": [],
                "OrderLine": []
            }
        }
    }
}

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

Mogelijke fout meldingen Errors

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