Zielgruppe

Mit dieser Api werden die Zielgruppe ausgegeben.

Felder

property title required default type examples
auid Eindeutige ID des Datensatzes integer
name Name string
description Beschreibung string
locale Text je Sprache object
start Startdatum 1970-01-01 01:00:00 string
end Enddatum 1970-01-01 01:00:00 string
ranking Rangfolge der Datensätze; Sortierung der Einträge 0 string
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 Zielgruppe auslesen

Die URL /api/commerce/item/catalog/audience/[AUID] liefert eine Zielgruppe zurück

{
    "dataset": {
        "7e864522-6a41-4212-b4e8-336412d61590": {{
            "auid": 1,
            "name": "Leistungssportler",
            "description": "",
            "locale": {
                "de": {
                    "name": "Leistungssportler",
                    "description": ""
                },
                "en": {
                    "name": "athlete",
                    "description": ""
                },
                "fr": {
                    "name": "athlète",
                    "description": ""
                }
            },
            "start": "1970-01-01T00:59:59",
            "end": "1970-01-01T00:59:59",
            "ranking": "0",
            "erpID": "",
            "erpName": "",
            "erpNumber": "",
            "erpLastUpdate": "1970-01-01T00:59:59",
            "erpCreation": "1970-01-01T00:59:59",
            "archived": false
        }
    },
    "sys": {
        "pagination": {
            "total": 1,
            "currentPage": 1,
            "objectsPerPage": 5,
            "offset": 0,
            "nextOffset": null,
            "prevOffset": null,
            "pages": 1
        },
        "message": "200 OK",
        "code": 200
    }
}

Zielgruppe auslesen

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

Beispiel : /api/commerce/item/catalog/audience?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
    }
}

Zielgruppe suchen

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

Beispiel: /api/commerce/item/catalog/audience/search?q=auid%3D1