class Response extends Alvine

Ergebnis der API-Anfrage

Diese Hilfsklasse interpretiert die Antowrt und bereitet den JSON String für die weitere Verarbeitung auf.

Constants

FIELD_MESSAGE

Name des Message-Schlüssels

FIELD_STATUS

Name des Ergebnis-Schlüssels

FIELD_ERROR_CODE

Name des Ergebnis-Schlüssels

FIELD_RESPONSE

Name des Ergebnis-Schlüssels

FIELD_DATA

Ergebnis der Anfrage

FIELD_DATACOUNT

Anzahl der Ergebnisse

FIELD_DATAMORE

Gibt es weitere Einträge

FIELD_OBJECTS

Objekte

STATUS_OK

Neues Droplet / wird erstellt

STATUS_ERROR

Neues Droplet / wird erstellt

ERROR_UNAUTH

Konnte nicht angemeldet werden

ERROR_INVLDINPUT

Fehlerhafte Input Daten

ERROR_MAXAPI

Maximale Anzahl an Requests

Properties

protected string $status
protected ArrayHelper $responseData Daten

Methods

__construct(Response $response)

Neues Ergebnisobjekt

string
getStatus()

Status

ArrayHelper
getPayload(string $key)

Übergebene Daten

Details

at line 129
__construct(Response $response)

Neues Ergebnisobjekt

Parameters

Response $response Ergebnis der Anfrage

at line 151
string getStatus()

Status

Return Value

string Status

at line 162
ArrayHelper getPayload(string $key)

Übergebene Daten

Parameters

string $key Schlüssel der Nutzlast

Return Value

ArrayHelper Daten