Contactgroepen

Authenticatie vereist

Met deze resource kunnen contactgroepen van u opgehaald worden.

Resource mogelijkheden

HTTP Request Type Resource Type Vereisten Rechten
GET Collectie Contacts.read
GET Element

Velden

Veld Beschrijving Zichbaar Aanpasbaar Vereist bij aanmaken
id Het indificatie nummer van het contactgroup record. Ja Nee Nee
client_id   Nee Nee Nee
name   Ja Ja Ja
description   Ja Ja Ja
created   Ja Nee Nee

Collectie GET

GET Collectie

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

https://api.workspace.nl/api/v1/contactgroups.json
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "count": 3,
            "Contactgroups": [
                {
                    "ContactGroup": {
                        "id": "330",
                        "name": "Algemeen",
                        "description": "Algemene contacten",
                        "created": "2013-02-19 14:21:55"
                    }
                },
                {
                    "ContactGroup": {
                        "id": "331",
                        "name": "Zakelijk",
                        "description": "Zakelijke klanten",
                        "created": "2013-02-19 14:25:19"
                    }
                },
                {
                    "ContactGroup": {
                        "id": "332",
                        "name": "Particulier",
                        "description": "Particuliere klanten",
                        "created": "2013-02-19 14:25:29"
                    }
                }
            ]
        }
    }
}

Mogelijke fout meldingen Errors

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

ELEMENT GET

GET Element

Een GET request op het element zal resulteren op een enkele contactgroep.

https://api.workspace.nl/api/v1/contactgroups/{id}.json
Parameters
{id} Het indentificatie nummer van de contactgroep in formaat (0-9)
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "ContactGroup": {
                "id": "330",
                "name": "Algemeen",
                "description": "Algemene contacten",
                "created": "2013-02-19 14:21:55"
            }
        }
    }
}

Mogelijke fout meldingen Errors

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