Raster

Mit dieser Api werden die Raster ausgegeben.

Felder

property title required default type examples
rid Eindeutige ID des Datensatzes integer
name Name string
description Beschreibung string
definition Definition string
locale Text je Sprache object
erpID Eindeutige ID im Drittsystem; Datum für den Datenaustausch mit Drittsystemen string
erpName Name des Drittsystems; Datum für den Datenaustausch mit Drittsystemen string
erpNumber Eindeutige Nummer im Drittsystem; Datum für den Datenaustausch mit Drittsystemen string
erpLastUpdate Letzte Aktualisierung; Datum für den Datenaustausch mit Drittsystemen 1970-01-01 01:00:00 string
erpCreation Erstellungsdatum; Datum für den Datenaustausch mit Drittsystemen 1970-01-01 01:00:00 string
archived Archivierungsflag; false: in Verwendung; true: Datensatz ist archiviert boolean

Eine Raster auslesen

Die URL /api/commerce/item/catalog/raster/[AUID] liefert eine Raster zurück

{
    "dataset": {
        "48063fc3-2c99-43dc-83ad-eeff946e7618": {
            "rid": 1,
            "name": "Raster",
            "description": "Beschreibung",
            "definition": [
                "54",
                "7",
                "16"
            ],
            "locale": {
                "de": {
                    "text": "",
                    "name": ""
                },
                "nl": {
                    "text": "",
                    "name": ""
                },
                "en": {
                    "text": "",
                    "name": ""
                }
            },
            "erpID": "",
            "erpName": "",
            "erpNumber": "",
            "erpLastUpdate": "0000-01-01T00:00:00",
            "erpCreation": "1970-01-01T00:59:59",
            "archived": false
        }
    },
    "sys": {
        "pagination": {
            "total": 1,
            "currentPage": 1,
            "objectsPerPage": 20,
            "offset": 0,
            "nextOffset": null,
            "prevOffset": null,
            "pages": 1
        },
        "message": "200 OK",
        "code": 200
    }
}

Raster auslesen

Die URL /api/commerce/item/catalog/raster?page=[SEITE]&count=[ANZAHL DER OBJEKTE]&orderby=[SORTIERUNG] liefert alle Rasteren zurück. Mit dem Pagestepper kann durch die Daten navigiert werden.

Beispiel : /api/commerce/item/catalog/raster?page=0&count=5

{
    "dataset": {
        "66681c38-1094-4490-e416-9d431fa5ef57": {},
        "caec026c-b9a0-4ea7-af27-0b36e8c47cbd": {},
        "9f9a232a-efc4-4079-f091-035fdb8f1b4c": {},
        "1b3da6a2-994f-4060-a47d-38c12a19a416": {},
        "7555bb79-f8d0-461b-d488-008819447df2": {}
    },
    "sys": {
        "pagination": {
            "total": 47,
            "currentPage": 3,
            "objectsPerPage": 5,
            "offset": 10,
            "nextOffset": 15,
            "prevOffset": 5,
            "pages": 10
        },
        "message": "200 OK",
        "code": 200
    }
}

Raster suchen

Über die URL /api/commerce/item/catalog/raster/search?q=[QUERY] kann nach Raster gesucht werden

Beispiel: /api/commerce/item/catalog/raster/search?q=rid%3D1