Objekte

CompanyReference

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

Steht für 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ät

Ein für die Registrierung registriertes Android-Gerät.

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

DeviceIdentifier (Geräte-ID)

Hardware- und Produkt-IDs zur Identifizierung des Geräts eines Herstellers

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 Mobilfunkgeräte sind imei und manufacturer erforderlich.
  • Für Geräte, die ausschließlich über WLAN genutzt werden, sind serialNumber, manufacturer und model erforderlich.
Feldname Datentyp Beschreibung
imei string Die IMEI-Nummer des Geräts. Überprüft bei Eingabe.
serialNumber string Die Seriennummer des Herstellers. Dieser Wert ist möglicherweise nicht für verschiedene Gerätemodelle eindeutig.
meid string Die MEID-Nummer des Geräts.
manufacturer string Der Name des Geräteherstellers. Stimmt mit dem von android.os.Build.MANUFACTURER zurückgegebenen integrierten Wert des Geräts überein. Die zulässigen Werte sind unter manufacturers aufgeführt.
model string Der Name des Gerätemodells. Stimmt mit dem von android.os.Build.MODEL zurückgegebenen integrierten Wert des Geräts überein. Die zulässigen Werte sind unter Modelle aufgeführt.

Vorgang

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, es sind jedoch Fehler aufgetreten. Alle Fehler sind in der Liste deviceErrors aufgeführt.
  • FAILED: Der Vorgang ist fehlgeschlagen und es wird kein operationId zurückgegeben.
Feldname Datentyp Beschreibung
operationId string Die Vorgangs-ID mit dem Präfix samsung/ oder google/. Wenn leer,entspricht state FAILED.
operationType enum(operationType) Der Vorgangstyp: CLAIM_DEVICES oder UNCLAIM_DEVICES.
state enum(operationState) Der Vorgangsstatus: IN_PROGRESS, COMPLETE, COMPLETE_WITH_ERRORS, FAILED.
deviceErrors Liste mit object(DeviceOperationError) Liste der Fehler beim Betrieb des Geräts.
vendorParams map Zusätzliche Felder in vom Anbieter angegebenen Schlüssel/Wert-Paaren.

DeviceOperationError

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

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

CommonException

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

Property-Name Wert Beschreibung
error object(Error) Fehler beim synchronen Vorgang.

Fehler

Ein Objekt mit Details zu einem Fehler.

Property-Name Wert Beschreibung
code enum(ErrorCode) Der Fehlercode. Beispiel: INVALID_REQUESET oder PERMISSION_DENIED
message string Die Fehlermeldung.
vendorMsg string Eine detaillierte Erläuterung des Fehlers durch den Anbieter.
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 Nicht angegebener ungültiger Eingabeparameter. Weitere Informationen finden Sie in der ZuliefererMsg.
INVALID_PAGE_TOKEN Das angegebene pageToken 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 resellerId ist ungültig.
INVALID_MANUFACTURER Der angegebene Hersteller ist ungültig oder wird nicht unterstützt.
INVALID_IDENTIFIER_SET Die angegebenen Kennzeichnungen sind für den Antrag nicht ausreichend. Weitere Informationen zu zulässigen ID-Sätzen finden Sie unter DeviceIdentifier.
INVALID_MODEL Das angegebene Modell ist ungültig oder wird nicht unterstützt.
INVALID_DEVICE_ID Die angegebene Geräte-ID ist ungültig.
INVALID_DEVICE Das angegebene Gerät ist nicht vorhanden. Dies ist ein Samsung-spezifischer Fehlercode.
DUPLICATE_DEVICE Das Gerät wurde zuvor für denselben Kunden beansprucht. Es sind keine Korrekturmaßnahmen erforderlich.
DEVICE_UPLOAD_COUNT_EXCEEDED Die Anfrage umfasst mehr Geräte, die den Höchstwert überschreiten (derzeit 100.000).
AUTHORIZATION_FAIL Sie haben keinen Zugriff auf eine bestimmte Ressource (z.B. ein Gerät oder einen Kunden) oder die Ressource existiert nicht. Weitere Informationen findest du unter vendorMsg.
INTERNAL_SERVER_ERROR Unbekannter interner Serverfehler. Weitere Informationen finden Sie unter „vendorMsg“. Je nach Art des Serverfehlers können diese Anfragen wiederholt werden.
NOT_IMPLEMENTED Die Anfragemethode wird vom Server nicht unterstützt.