Objekte

Unternehmensreferenz

Identifiziert ein Unternehmen eindeutig.

Feldname Datentyp Beschreibung
companyId string Nur Ausgabe. Die ID des Unternehmens, die vom Server zugewiesen wird.
vendor enum Samsung oder Google.

Unternehmen

Ein Unternehmen

Feldname Datentyp Beschreibung
companyReference object(CompanyReference) Referenzobjekt des Unternehmens
companyName string Der Name des Unternehmens. Beispiel: XYZ Corp. Wird den Mitarbeitern des Unternehmens im Portal für die Zero-Touch-Registrierung angezeigt.
vendorParams map Zusätzliche Felder in vom Anbieter angegebenen Schlüssel/Wert-Paaren.

Geräte

Ein Android-Gerät, das für die Registrierung registriert ist.

Feldname Datentyp Beschreibung
deviceId string Nur Ausgabe. Die ID des Geräts, die vom Server zugewiesen wird.
deviceIdentifier object(DeviceIdentifier) Die Hardware-IDs, die auf ein hergestelltes Gerät verweisen.
customer object(CompanyReference) Die Unternehmens-IDs, die angeben, welchem Unternehmen die Geräte zugewiesen sind.
orderNumber string Die Bestellnummer.
vendorParams map Zusätzliche Felder in vom Anbieter angegebenen Schlüssel/Wert-Paaren.

DeviceIdentifier (Geräte-ID)

Kapselt Hardware- und Produkt-IDs, um das Gerät eines Herstellers zu identifizieren.

Bei Samsung-Geräten ist eines der folgenden Felder erforderlich:

  • IMEI
  • serialNumber
  • meid

Alle anderen Felder wie model werden ignoriert.

Für alle anderen Android-Geräte:

  • Für Mobilgeräte sind imei und manufacturer erforderlich.
  • Für reine WLAN-Geräte sind serialNumber, manufacturer und model erforderlich.
Feldname Datentyp Beschreibung
imei string Die IMEI-Nummer des Geräts. Bei Eingabe validiert.
serialNumber string Die Seriennummer des Herstellers für das Gerät. Dieser Wert ist möglicherweise nicht bei allen Gerätemodellen eindeutig.
meid string Die MEID-Nummer des Geräts.
manufacturer string Der Name des Geräteherstellers. Entspricht dem integrierten Wert des Geräts, der von android.os.Build.MANUFACTURER zurückgegeben wurde. Die zulässigen Werte sind unter manufacturers aufgeführt.
model string Der Name des Gerätemodells. Entspricht dem integrierten Wert des Geräts, der von android.os.Build.MODEL zurückgegeben wurde. Zulässige Werte sind in Modellen aufgeführt.

Aktion

Diese Ressource enthält den Status eines asynchronen API-Aufrufs. Es gibt vier mögliche Status:

  • IN_PROGRESS: Der Vorgang wird ausgeführt.
  • COMPLETE: Alle Geräte wurden verarbeitet.
  • COMPLETE_WITH_ERRORS: Der Vorgang wurde verarbeitet, aber es sind einige Fehler aufgetreten. Alle Fehler werden in der deviceErrors-Liste aufgeführt.
  • FAILED: Der Vorgang ist fehlgeschlagen und es wurde kein operationId zurückgegeben.
Feldname Datentyp Beschreibung
operationId string Die Vorgangs-ID mit dem Präfix samsung/ oder google/. Wenn leer, ist state FAILED.
operationType enum(operationType) Der Vorgangstyp: CLAIM_DEVICES oder UNCLAIM_DEVICES.
state enum(operationState) Der Status des Vorgangs: IN_PROGRESS, COMPLETE, COMPLETE_WITH_ERRORS, FAILED.
deviceErrors Liste der object(DeviceOperationError) Liste der Fehler beim Gerätebetrieb.
vendorParams map Zusätzliche Felder in vom Anbieter angegebenen Schlüssel/Wert-Paaren.

Gerätefehler

Ein gerätespezifischer Fehler in einem Operation. Jede Ressource enthält die gleichen deviceId und deviceIdentifier wie die Anfrage, die den Vorgang gestartet hat.

Feldname Datentyp Beschreibung
deviceId string Nur Ausgabe. Die ID des Geräts, die vom Server zugewiesen wird.
deviceIdentifier object(DeviceIdentifier) Die Hardware-IDs, die auf ein hergestelltes Gerät verweisen.
error object(Error) Fehler beim Betrieb des Geräts.

Allgemeine Ausnahme

Eine Ausnahme, die von allen synchronen APIs ausgelöst werden kann.

Attributname Wert Beschreibung
error object(Error) Synchroner Vorgangsfehler.

Fehler

Ein Objekt mit Details zu einem Fehler.

Attributname Wert Beschreibung
code enum(ErrorCode) Der Fehlercode. Beispiel: INVALID_REQUESET oder PERMISSION_DENIED
message string Die Fehlermeldung.
vendorMsg string Eine detaillierte Erklärung des Fehlers des Anbieters.
errorId string Die interne Fehlerkennung.
vendorParams map Zusätzliche Felder in vom Anbieter angegebenen Schlüssel/Wert-Paaren.

ErrorCode

Häufige Fehler

Enum Beschreibung
INVALID_PARAM_DEFAULT Der angegebene Eingabeparameter ist ungültig. Weitere Informationen finden Sie in der Anbieter-Msg.
INVALID_PAGE_TOKEN Das angegebene Seitentoken ist ungültig.
INVALID_CUSTOMER_ID Die angegebene Kundennummer ist ungültig.
INVALID_DEVICE_IMEI Ungültige IMEI.
INVALID_DEVICE_MEID Ungültige MEID.
INVALID_DEVICE_SERIAL Ungültige Seriennummer.
INVALID_OPERATION_ID Die angegebene Vorgangs-ID ist ungültig.
INVALID_RESELLER_ID Die angegebene Reseller-ID ist ungültig.
INVALID_MANUFACTURER Der angegebene Hersteller ist ungültig / nicht unterstützt.
INVALID_IDENTIFIER_SET Die angegebenen Kennungen sind für die Anfrage nicht ausreichend. Weitere Informationen zu zulässigen Kennzeichnungssätzen finden Sie unter DeviceIdentifier.
INVALID_MODEL Das bereitgestellte Modell ist ungültig oder wird nicht unterstützt.
INVALID_DEVICE_ID Die angegebene Geräte-ID ist ungültig.
INVALID_DEVICE Das bereitgestellte Gerät ist nicht vorhanden. Dies ist ein Samsung-spezifischer Fehlercode.
DUPLICATE_DEVICE Das Gerät wurde zuvor demselben Kunden zur Verfügung gestellt. Es sind keine Korrekturmaßnahmen erforderlich.
DEVICE_UPLOAD_COUNT_EXCEEDED Die Anfrage enthält mehr Geräte als das Limit (derzeit 100.000).
AUTHORIZATION_FAIL Sie haben keinen Zugriff auf eine bestimmte Ressource (z.B. Gerät, Kunde) oder die Ressource ist nicht vorhanden. Weitere Informationen erhältst du unter vendorMsg.
INTERNAL_SERVER_ERROR Unbekannter interner Serverfehler. Weitere Informationen finden Sie in der Anbieter-MSG. Diese Anfragen können je nach Art des Serverfehlers wiederholt werden.
NOT_IMPLEMENTED Die Anfragemethode wird vom Server nicht unterstützt.