Benutzer¶
Mit dieser Api werden die Benutzer ausgegeben.
Hinweis
Über die Facetten können weitere Informationen geladen werden. Siehe Facetten
Felder¶
| property | title | default | type | examples |
|---|---|---|---|---|
| uid | Benutzer ID | 0 | integer | 20 |
| name | Banutzername | string | b2c@example.com | |
| state | Status | 0 | integer | 0 |
| creation | Erstelldatum | null | ||
| lastupdate | Änderungsdatum | string | 2017-02-01T21:53:06 | |
| ranking | Gewichtung | string | 0 | |
| erpID | ERP ID | string | ||
| erpName | ERP Name | string | ||
| erpNumber | ERP Nummer | string | ||
| erpLastUpdate | ERP Änderungsdatum | string | 2013-12-15T16:43:53 | |
| erpCreation | ERP Erstelldatum | string | 0000-01-01T00:00:00 | |
| archived | archiviert | string | 0 |
Einen Benutzer auslesen¶
Die URL /api/account/user/[uid] liefert einen Benutzer zurück, die Facette personal wird mitgeliefert wenn keine Facette definiert wird
{
"dataset": {
"39887013-301b-4f06-a3ca-096b109c9e86": {
"uid": 20,
"name": "[email protected]",
"state": 0,
"creation": null,
"lastupdate": "2017-02-01T21:53:06",
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "0000-01-01T00:00:00",
"erpCreation": "0000-01-01T00:00:00",
"archived": false,
"ranking": "0",
"personal": {
"dataset": {
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "0000-01-01T00:00:00",
"erpCreation": "0000-01-01T00:00:00",
"pid": 42,
"uid": 20,
"alias": "",
"formOfAddress": "Sehr geehrter Herr",
"salutation": "Herr",
"firstname": "Max",
"name1": "Mustermann",
"name2": "",
"title": "dr",
"custom1": "",
"custom2": "",
"birthday": "1977-04-01T00:00:00",
"lastUpdate": "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
}
}Einen Benutzer anlegen¶
Mit der Methode POST auf die URL /api/account/user kann der Benutzer angelegt werden.
Die Personal Daten können direkt mit angelegt werden. Alle anderen Facetten müssen seperat hinzugefügt werden.
Hinweis
Es müssen die Gruppen beim anlegen mitgeliefert werden. Ansonsten wird ein 400 Statuscode gesendet. Der Benutzer muss darf nur mit Gruppen angelegt werden, für die Sie berechtigt sind.
{
"dataset": [
{
"name": "[email protected]",
"state": 1,
"memberships": {
"dataset": [
{
"gid": 8
},
{
"gid": 16
}]},
"personal": {
"dataset": {
"alias": "",
"formOfAddress": "Sehr geehrter Herr",
"salutation": "Herr",
"firstname": "Hans",
"name1": "Mustermann",
"name2": "",
"title": "Dr",
"custom1": "",
"custom2": "",
"birthday": "1990-10-01"
}
}
}
]
}{
"dataset": [
{
"dataset": {
"uid": 69,
"name": "[email protected]",
"state": 1,
"erpID": "erp-id",
"erpName": "erp-name",
"erpNumber": "erm-number",
"erpLastUpdate": "1990-01-01T00:00:00",
"erpCreation": "2017-11-11T00:08:09",
"archived": false,
"personal": {
"dataset": {
"uid": 69,
"pid": 47,
"erpID": null,
"erpName": null,
"erpNumber": null,
"erpLastUpdate": null,
"erpCreation": null,
"alias": "",
"formOfAddress": "Sehr geehrter Herr",
"salutation": "Herr",
"firstname": "Hans",
"name1": "Mustermann",
"name2": "",
"title": "Dr",
"custom1": "",
"custom2": "",
"birthday": "1990-10-01",
"lastUpdate": "2017-02-01"
},
"sys": {
"created": "2018-12-17T07:47:43",
"message": "201 Created",
"code": "201"
}
}
},
"sys": {
"created": "2018-12-17T07:47:43",
"message": "201 Created",
"code": 201
}
}
],
"sys": {
"message": "201 Created",
"code": 201
}
}Einen Benutzer ändern¶
Mit der Methode PUT auf die URL /api/account/user kann der Benutzer geändert werden.
Hinweis
Bei Änderungen muss immer der komplette Datensatz übergeben werden, die Felder die nicht übergeben werden, werden gelöscht. Also alle Felder des Benutzer Datensatzes
In diesem Beispiel wird der Benutzer mit den Facetten personal und property geändert
{
"dataset": [
{
"uid": 20000,
"namename": "[email protected]",
"state": 0,
"creation": null,
"lastupdate": "0000-01-01T00:00:00",
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "2011-02-19T21:02:31",
"erpCreation": "0000-01-01T00:00:00",
"archived": "0",
"ranking": "0",
"personal": {
"dataset": {
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "2018-03-16T12:03:34",
"erpCreation": "0000-01-01T00:00:00",
"pid": 19037,
"uid": 20000,
"alias": "",
"formOfAddress": "Herr",
"salutation": "",
"firstname": "Max",
"name1": "Mustermann",
"name2": "",
"title": "",
"custom1": "",
"custom2": "",
"birthday": "0000-01-01T00:00:00",
"lastUpdate": "0000-01-01T00:00:00"
}
},
"property": {
"dataset": [
{
"pid": 233,
"name": "shop.addon.crm.rating",
"value": "C",
"language": "",
"country": ""
}
]
}
}
]
}{
"dataset": [
{
"dataset": {
"uid": 20000,
"namename": "[email protected]",
"state": 0,
"creation": null,
"lastupdate": "0000-01-01T00:00:00",
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "2011-02-19T21:02:31",
"erpCreation": "0000-01-01T00:00:00",
"archived": "0",
"ranking": "0",
"personal": {
"dataset": {
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "2018-03-16T12:03:34",
"erpCreation": "0000-01-01T00:00:00",
"pid": 19037,
"uid": 20000,
"alias": "",
"formOfAddress": "Herr",
"salutation": "",
"firstname": "Max",
"name1": "Mustermann",
"name2": "",
"title": "",
"custom1": "",
"custom2": "",
"birthday": "0000-01-01T00:00:00",
"lastUpdate": "0000-01-01T00:00:00"
},
"sys": {
"updated": "2018-08-13T04:25:14",
"message": "200 OK",
"code": 200
}
},
"property": {
"dataset": [
{
"dataset": {
"pid": 233,
"uid": 6,
"name": "shop.addon.crm.rating",
"value": "C",
"language": "",
"country": ""
},
"sys": {
"updated": "2018-09-28T12:48:39",
"message": "200 OK",
"code": 200
}
}
],
"sys": {
"message": "200 OK",
"code": 200
}
}
},
"sys": {
"updated": "2018-08-13T04:25:14",
"message": "200 OK",
"code": 200
}
}
],
"sys": {
"message": "200 OK",
"code": 200
}
}Einen Benutzer eine Eigenschaft hinzufügen¶
In diesem Beispiel wird einem Benutzer die Eigenschaft example.test hinzugefügt.
{
"dataset": [
{
"uid": 12,
"namename": "[email protected]",
"state": 0,
"creation": null,
"lastupdate": "0000-01-01T00:00:00",
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "2008-07-23T03:02:09",
"erpCreation": "0000-01-01T00:00:00",
"archived": "0",
"ranking": "0",
"property": {
"dataset": [
{
"name": "example.test",
"value": "das ist ein test",
"language": "",
"country": ""
}
]
}
}]
}{
"dataset": [
{
"sys": {
"updated": "2018-09-28T13:36:35",
"message": "200 OK",
"code": 200
},
"dataset": {
"uid": 12,
"namename": "[email protected]",
"state": 0,
"creation": null,
"lastupdate": "0000-01-01T00:00:00",
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "2008-07-23T03:02:09",
"erpCreation": "0000-01-01T00:00:00",
"archived": "0",
"ranking": "0",
"property": {
"dataset": [
{
"sys": {
"message": "201 Created",
"code": 201,
"created": "2018-09-28T13:36:35"
},
"dataset": {
"uid": 12,
"name": "example.test",
"value": "das ist ein test",
"language": "",
"country": "",
"pid": "26979639"
}
}
],
"sys": {
"message": "200 OK",
"code": 200
}
}
}
}
],
"sys": {
"message": "200 OK",
"code": 200
}
}Einen Benutzer eine Adresse hinzufügen¶
In diesem Beispiel wird einem Benutzer eine neue Adresse hinzugefügt.
{
"dataset": [
{
"uid": 12,
"namename": "[email protected]",
"state": 0,
"creation": null,
"lastupdate": "0000-01-01T00:00:00",
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "2008-07-23T03:02:09",
"erpCreation": "0000-01-01T00:00:00",
"archived": "0",
"ranking": "0",
"addresses": {
"dataset": [
{
"address1": "Eichenstrasse 26",
"city": "Landsberied",
"zipcode": "18597",
"country": "de",
"type": "0"
}
]
}
}]
}Einen Benutzer ein Kontakt hinzufügen¶
In diesem Beispiel bekommt der Benutzer eine neue E-Mail-Adresse
{
"dataset": [
{
"uid": 12,
"namename": "[email protected]",
"state": 0,
"creation": null,
"lastupdate": "0000-01-01T00:00:00",
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "2008-07-23T03:02:09",
"erpCreation": "0000-01-01T00:00:00",
"archived": "0",
"ranking": "0",
"communication": {
"dataset": [
{
"type": 1,
"description": "NeueE-MailAdresse",
"locator": "[email protected]",
"preset": "1",
"private": "0",
"scope": "0"
}
]
}
}]
}