Kommunikation¶

Mit dieser Api werden die Kommunikation ausgegeben.

Felder¶

Eine Kommunikation auslesen¶

Die URL /api/account/communication/[CID] liefert eine Kommunikation zurück

{
    "dataset": {
        "485db45f-b697-4271-8a9c-5a19c45557b4": {
            "cid": 1,
            "uid": 1,
            "type": 1,
            "description": "",
            "locator": "[email protected]",
            "preset": "1",
            "private": "",
            "scope": "0",
            "lastUpdate": "0000-01-01T00:00:00",
            "erpID": "",
            "erpName": "",
            "erpNumber": "",
            "erpLastUpdate": "0000-01-01T00:00:00",
            "erpCreation": "0000-01-01T00:00:00"
        }
    },
    "sys": {
        "pagination": {
            "total": 1,
            "currentPage": 1,
            "objectsPerPage": 20,
            "offset": 0,
            "nextOffset": null,
            "prevOffset": null,
            "pages": 1
        },
        "message": "200 OK",
        "code": 200
    }
}

Kommunikationen auslesen¶

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

Beispiel : /api/account/communication?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
    }
}

Kommunikationen suchen¶

Über die URL /api/account/communication/search?q=[QUERY] können Kommunikationen gesucht werden. Mit dem Pagestepper kann durch die Daten navigiert werden.

Beispiel suche nach Postleitzahlen: /api/account/communication/search?q=locator%3D%[email protected]%22

{
    "dataset": {
        "1": {},
        "187": {},
        "362": {},
    },
    "sys": {
        "pagination": {
            "total": 47,
            "currentPage": 3,
            "objectsPerPage": 5,
            "offset": 10,
            "nextOffset": 15,
            "prevOffset": 5,
            "pages": 10
        },
        "message": "200 OK",
        "code": 200
    }
}

Kommunikationen hinzufügen¶

mit der Methode POST an die URL /api/account/communication können Kommunikationen hinzugefügt werden.

Hinweis

Beim Hinzufügen muss die uid des Benutzers übergeben werden

{
    "dataset": [
         {
            "uid": 1,
            "type": 1,
            "description": "",
            "locator": "[email protected]",
            "preset": "1",
            "private": "",
            "scope": "0",
            "lastUpdate": "0000-01-01T00:00:00",
            "erpID": "",
            "erpName": "",
            "erpNumber": "",
            "erpLastUpdate": "0000-01-01T00:00:00",
            "erpCreation": "0000-01-01T00:00:00"
        }
    ]
}

Antwort

{
    "dataset": [
        {
            "sys": {
                "message": "201 Created",
                "code": 201,
                "created": "2018-08-11T04:10:51"
            },
            "dataset": {
               "cid": 100,
               "uid": 1,
               "type": 1,
               "description": "",
               "locator": "[email protected]",
               "preset": "1",
               "private": "",
               "scope": "0",
               "lastUpdate": "0000-01-01T00:00:00",
               "erpID": "",
               "erpName": "",
               "erpNumber": "",
               "erpLastUpdate": "0000-01-01T00:00:00",
               "erpCreation": "0000-01-01T00:00:00"
            }
        }
    ],
    "sys": {
        "message": "201 Created",
        "code": 201
    }
}

Kommunikationen ändern¶

Mit der Methode PUT auf die URL /api/account/communication können Kommunikationen geändert werden.

Hinweis

Bei Änderungen muss immer der komplette Datensatz übergeben werden, die Felder die nicht übergeben werden, werden gelöscht.

{
    "dataset": [
      {
            "cid": 100,
            "uid": 1,
            "type": 1,
            "description": "",
            "locator": "[email protected]",
            "preset": "1",
            "private": "",
            "scope": "0",
            "lastUpdate": "0000-01-01T00:00:00",
            "erpID": "",
            "erpName": "",
            "erpNumber": "",
            "erpLastUpdate": "0000-01-01T00:00:00",
            "erpCreation": "0000-01-01T00:00:00"
        }
    ]
}

Antwort

{
    "dataset": [
        {
            "sys": {
                "updated": "2018-08-11T04:15:42",
                "message": "200 OK",
                "code": 200
            },
            "dataset": {
               "cid": 100,
               "uid": 1,
               "type": 1,
               "description": "",
               "locator": "[email protected]",
               "preset": "1",
               "private": "",
               "scope": "0",
               "lastUpdate": "0000-01-01T00:00:00",
               "erpID": "",
               "erpName": "",
               "erpNumber": "",
               "erpLastUpdate": "0000-01-01T00:00:00",
               "erpCreation": "0000-01-01T00:00:00"
            }
        }
    ],
    "sys": {
        "message": "200 OK",
        "code": 200
    }
}

Kommunikation löschen¶

Mit der Methode DELETE auf die URL /api/account/communication/[CID] kann eine Kommunikation gelöscht werden.

{
    "sys": {
        "message": "200 OK",
        "code": 200
    }
}

Kommunikation Mehrfachlöschung¶

Mit der Methode DELETE auf die URL /api/account/communication können mehrere Kommunikationen gelöscht werden.

{
   "dataset": [
     { "cid": 56 },
     { "cid": 57 },
     { "cid": 58 }
   ]
}