Contacten

Authenticatie vereist

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

Resource mogelijkheden

HTTP Request Type Resource Type Vereisten Rechten
GET Collectie Contacts
POST Collectie
GET Element
POST Element
DELETE Element

Resource Containments

Depth Resource
0 Geen containments
1
  • SubContact
2
  • SubContact

Velden

Veld Beschrijving Zichbaar Aanpasbaar Vereist bij aanmaken
id Het indificatie nummer van het contact record. Ja Nee Nee
client_reference   Ja Nee Ja
client_code   Ja Ja Nee
group De contact groep, standaard Algemeen Ja Nee Ja
type Het type contact 1 = Debiteur 2 = Crediteur Ja Nee Nee
name   Ja Ja Ja
location_address   Ja Ja Ja
location_postal   Ja Ja Nee
location_city   Ja Ja Ja
location_country   Ja Ja Nee
location_long   Ja Nee Nee
location_lat   Ja Nee Nee
invoice_address   Ja Ja Ja
invoice_postal   Ja Ja Ja
invoice_city   Ja Ja Ja
invoice_country   Ja Ja Nee
invoice_long   Ja Nee Nee
invoice_lat   Ja Nee Nee
phone   Ja Ja Ja
fax   Ja Ja Nee
website   Ja Ja Nee
btw   Ja Ja Nee
kvk   Ja Ja Nee
email   Ja Ja Ja
bank_name   Ja Ja Nee
bank_nr   Ja Ja Nee
created   Ja Nee Nee
modified   Ja Nee Nee
trashed   Ja Nee Nee
payment_term   Ja Ja Ja

Collectie GET

GET Collectie

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

https://api.workspace.nl/api/v1/contacts.json
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "count": 22,
            "Contacts": [
                {
                    "Contact": {
                        "id": "514",
                        "client_reference": "2",
                        "client_code": null,
                        "group": "Algemeen",
                        "type": "2",
                        "name": "Staples Amsterdam",
                        "location_address": "",
                        "location_postal": "",
                        "location_city": "",
                        "location_country": "",
                        "location_long": null,
                        "location_lat": null,
                        "invoice_address": null,
                        "invoice_postal": null,
                        "invoice_city": null,
                        "invoice_country": null,
                        "invoice_long": null,
                        "invoice_lat": null,
                        "phone": null,
                        "fax": null,
                        "website": null,
                        "btw": null,
                        "kvk": null,
                        "email": null,
                        "bank_name": null,
                        "bank_nr": null,
                        "created": "2013-02-19 14:26:25",
                        "modified": "2013-02-19 14:26:25",
                        "trashed": false,
                        "payment_term": "14"
                    },
                    "SubContact": []
                },
                {
                    "Contact": {
                        "id": "515",
                        "client_reference": "3",
                        "client_code": null,
                        "group": "Algemeen",
                        "type": "2",
                        "name": "Makro Rotterdam",
                        "location_address": "",
                        "location_postal": "",
                        "location_city": "",
                        "location_country": "",
                        "location_long": null,
                        "location_lat": null,
                        "invoice_address": null,
                        "invoice_postal": null,
                        "invoice_city": null,
                        "invoice_country": null,
                        "invoice_long": null,
                        "invoice_lat": null,
                        "phone": null,
                        "fax": null,
                        "website": null,
                        "btw": null,
                        "kvk": null,
                        "email": null,
                        "bank_name": null,
                        "bank_nr": null,
                        "created": "2013-02-19 14:26:36",
                        "modified": "2013-02-19 14:26:36",
                        "trashed": false,
                        "payment_term": "14"
                    },
                    "SubContact": []
                }
            ]
        }
    }
}

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
GET 404 Not Found Contacts 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/contacts.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 contact.

https://api.workspace.nl/api/v1/contacts/{id}.json
Parameters
{id} Het indentificatie nummer van de contact persoon in formaat (0-9)
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "Contact": {
                "id": "514",
                "client_reference": "2",
                "client_code": null,
                "group": "Algemeen",
                "type": "2",
                "name": "Staples Amsterdam",
                "location_address": "",
                "location_postal": "",
                "location_city": "",
                "location_country": "",
                "location_long": null,
                "location_lat": null,
                "invoice_address": null,
                "invoice_postal": null,
                "invoice_city": null,
                "invoice_country": null,
                "invoice_long": null,
                "invoice_lat": null,
                "phone": null,
                "fax": null,
                "website": null,
                "btw": null,
                "kvk": null,
                "email": null,
                "bank_name": null,
                "bank_nr": null,
                "created": "2013-02-19 14:26:25",
                "modified": "2013-02-19 14:26:25",
                "trashed": false,
                "payment_term": "14"
            },
            "SubContact": []
        }
    }
}

Mogelijke fout meldingen Errors

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

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/contacts/{id}.json
Parameters
{id} Het indentificatie nummer van de contact persoon 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 Contact 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/contacts/{id}.json
Parameters
{id} Het indentificatie nummer van de contact persoon in formaat (0-9)

Mogelijke fout meldingen Errors

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