Patch Customer #

Aktualisiert einen bestimmten Satz von Eigenschaften eines Kunden. Für Änderungen verwendet dies das Patch-Format JSON Patch.

PATCH /v1.0/customers/{CUSTOMER_TENANT_ID}

Beispiel #

Diese Anfrage aktualisiert den API-Schlüssel der Verbindung PBX und aktiviert ihn.

Anfrage #

PATCH <https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/> HTTP/1.1
Inhaltstyp: application/json
Akzeptanz-Gebühren: Wahr
Autorisierung: Inhaber {TOKEN}
Verbindung: am Leben bleiben
[{
		"op": "ersetzen",
		"Pfad": "/aktiviert",
		"Wert": falsch
	}, {
		"op": "ersetzen",
		"path": "/pbxConnectionProfile/apiKey",
		"value": "newapikey"
	}
][{
		"op": "replace",
		"path": "/enabled",
		"value": false
	}, {
		"op": "replace",
		"path": "/pbxConnectionProfile/apiKey",
		"value": "newapikey"
	}
]

Reaktion #

HTTP/1.1 200 OK
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: xx
Anfrage-Kontext: appId=cid-v1:d24f4c80-0a0a-432e-85aa-a6f91f13a038
{
	"Status": "Erfolg",
	"Zeitstempel": "2019-11-29T15:16:54.2586208Z"
}

Fehler #

Unautorisiert #

Wenn der Token nicht bereitgestellt wird, ungültig oder abgelaufen ist

HTTP/1.1 401 Unautorisiert

Schlechte Anfrage (1) #

Wenn die angegebene Mieter-ID nicht im richtigen Format ist

HTTP/1.1 400 Bad Request
Datum: Do, 06. Feb 2020 12:45:27 GMT
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: 149
{
	"Fehler": 400,
	"Nachricht": "Der Wert '<tenant id>'ist nicht gültig.",
	"status": "fehler",
	"Zeitstempel": "2020-02-06T12:45:27.5903465Z"
}

Schlechte Anfrage (2) #

Beim Versuch, eine ungültige Eigenschaft zu patchen.

HTTP/1.1 400 Bad Request
Datum: Do, 06. Feb 2020 12:45:27 GMT
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: 149
{
	"Fehler": 400,
	"Nachricht": "Der vom Pfadsegment angegebene Zielort '<invalid property>'wurde nicht gefunden.",
	"status": "fehler",
	"Zeitstempel": "2020-02-06T12:45:27.5903465Z"
}

Nicht gefunden #

Wenn es keine Kunden gibt, die eine passende Mieter-ID haben

HTTP/1.1 404 Nicht gefunden
Datum: Do, 06. Feb 2020 12:46:58 GMT
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: 95
{
	"error": 404,
	"Nachricht": "Nicht gefunden",
	"status": "fehler",
	"Zeitstempel": "2020-02-06T12:46:58.7669535Z"
}