Artikelgroepen

Authenticatie vereist

Met deze resource kunnen artikelgroepen van u opgehaald worden.

Resource mogelijkheden

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

Velden

Veld Beschrijving Zichbaar Aanpasbaar Vereist bij aanmaken
id Het indificatie nummer van het articlegroup record. Ja Nee Nee
name   Ja Ja Ja
created   Ja Nee Nee
modified   Ja Nee Nee

Collectie GET

GET Collectie

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

https://api.workspace.nl/api/v1/articlegroups.json
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "count": 2,
            "Articlegroups": {
                "0": {
                    "ArticleGroup": {
                        "id": "148",
                        "name": "Algemeen",
                        "created": "2013-02-19 14:21:55",
                        "modified": "2013-02-19 14:21:55"
                    }
                },
                "2": {
                    "ArticleGroup": {
                        "...": "..."
                    }
                }
            }
        }
    }
}

Mogelijke fout meldingen Errors

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

ELEMENT GET

GET Element

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

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

Mogelijke fout meldingen Errors

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