Obiekty

CompanyReference

Jednoznacznie identyfikuje firmę.

Nazwa pola Typ danych Opis
companyId string Tylko dane wyjściowe. Identyfikator firmy przypisany przez serwer.
vendor enum Samsung lub Google.

Firma

reprezentuje firmę.

Nazwa pola Typ danych Opis
companyReference object(CompanyReference) Obiekt referencyjny firmy.
companyName string Nazwa firmy. Przykład: XYZ Corp. Wyświetlane pracownikom firmy w portalu rejestracji typu zero-touch.
vendorParams map Dodatkowe pola w parach klucz-wartość określonych przez dostawcę.

Urządzenie

Urządzenie z Androidem zarejestrowane do rejestracji.

Nazwa pola Typ danych Opis
deviceId string Tylko dane wyjściowe. Identyfikator urządzenia przypisany przez serwer.
deviceIdentifier object(DeviceIdentifier) Identyfikatory sprzętu, które identyfikują wyprodukowane urządzenie.
customer object(CompanyReference) Identyfikatory firmy określające firmę, do której przypisane są urządzenia.
orderNumber string Numer zamówienia.
vendorParams map Dodatkowe pola w parach klucz-wartość określonych przez dostawcę.

DeviceIdentifier (identyfikator urządzenia)

Obejmuje identyfikatory sprzętu i produktów, które umożliwiają identyfikację urządzenia producenta.

Urządzenia Samsung wymagają wypełnienia jednego z tych pól:

  • IMEI
  • serialNumber
  • meid

Wszystkie pozostałe pola, np. model, są ignorowane.

W przypadku pozostałych urządzeń z Androidem:

  • Urządzenia komórkowe wymagają imei i manufacturer.
  • Urządzenia obsługujące tylko Wi-Fi wymagają interfejsów serialNumber, manufacturer i model.
Nazwa pola Typ danych Opis
imei string Numer IMEI urządzenia. Zweryfikowano po podaniu.
serialNumber string Numer seryjny producenta urządzenia. Ta wartość może nie być niepowtarzalna na różnych modelach urządzeń.
meid string Numer MEID urządzenia.
manufacturer string Nazwa producenta urządzenia. Pasuje do wbudowanej wartości urządzenia zwracanej z metody android.os.Build.MANUFACTURER. Dozwolone wartości są podane w informacjach o producentach.
model string Nazwa modelu urządzenia. Pasuje do wbudowanej wartości urządzenia zwracanej z metody android.os.Build.MODEL. Dozwolone wartości są wymienione w modelach.

Operacja

Ten zasób zawiera stan asynchronicznego wywołania interfejsu API. Istnieją cztery możliwe stany:

  • IN_PROGRESS: operacja jest w toku.
  • COMPLETE: wszystkie urządzenia zostały przetworzone.
  • COMPLETE_WITH_ERRORS: operacja została przetworzona, ale wystąpiły błędy. Wszystkie błędy są wymienione na liście deviceErrors.
  • FAILED: operacja nie powiodła się, nie został zwrócony żaden element operationId.
Nazwa pola Typ danych Opis
operationId string Identyfikator operacji poprzedzony prefiksem samsung/ lub google/. Jeśli pole jest puste,state ma wartość FAILED.
operationType enum(operationType) Typ operacji: CLAIM_DEVICES lub UNCLAIM_DEVICES.
state enum(operationState) Stan operacji: IN_PROGRESS, COMPLETE, COMPLETE_WITH_ERRORS, FAILED.
deviceErrors Lista object(DeviceOperationError) Lista błędów działania urządzenia.
vendorParams map Dodatkowe pola w parach klucz-wartość określonych przez dostawcę.

DeviceOperationError

Błąd dotyczący konkretnego urządzenia w Operation. Każdy zasób zawiera deviceId i deviceIdentifier jako żądanie, które rozpoczęło operację.

Nazwa pola Typ danych Opis
deviceId string Tylko dane wyjściowe. Identyfikator urządzenia przypisany przez serwer.
deviceIdentifier object(DeviceIdentifier) Identyfikatory sprzętu, które identyfikują wyprodukowane urządzenie.
error object(Error) Błąd działania urządzenia.

CommonException

Wyjątek, który może być zgłaszany przez wszystkie synchroniczne interfejsy API.

Nazwa usługi Wartość Opis
error object(Error) Błąd operacji synchronicznej.

Błąd

Obiekt ze szczegółowymi informacjami o błędzie.

Nazwa usługi Wartość Opis
code enum(ErrorCode) Kod błędu. Na przykład INVALID_REQUESET lub PERMISSION_DENIED
message string Komunikat o błędzie.
vendorMsg string Szczegółowy opis błędu podany przez dostawcę.
errorId string Identyfikator błędu wewnętrznego.
vendorParams map Dodatkowe pola w parach klucz-wartość określonych przez dostawcę.

ErrorCode

Typowe błędy.

Typ wyliczeniowy Opis
INVALID_PARAM_DEFAULT Nieokreślony nieprawidłowy parametr wejściowy. Więcej informacji znajdziesz w powiadomieniu dostawcy.
INVALID_PAGE_TOKEN Podany token pageToken jest nieprawidłowy.
INVALID_CUSTOMER_ID Podany identyfikator klienta jest nieprawidłowy.
INVALID_DEVICE_IMEI Nieprawidłowy numer IMEI.
INVALID_DEVICE_MEID Nieprawidłowy identyfikator MEID.
INVALID_DEVICE_SERIAL Nieprawidłowy numer seryjny.
INVALID_OPERATION_ID Podany identyfikator operacji jest nieprawidłowy.
INVALID_RESELLER_ID Podany identyfikator sprzedawcy jest nieprawidłowy.
INVALID_MANUFACTURER Podane przez producenta nazwy są nieprawidłowe lub nieobsługiwane.
INVALID_IDENTIFIER_SET Podany zestaw identyfikatorów jest niewystarczający w przypadku tego żądania. Więcej informacji o dozwolonych zestawach identyfikatorów znajdziesz w artykule DeviceIdentifier.
INVALID_MODEL Podany model jest nieprawidłowy lub nieobsługiwany.
INVALID_DEVICE_ID Podany identyfikator urządzenia jest nieprawidłowy.
INVALID_DEVICE Podane urządzenie nie istnieje. Jest to kod błędu typowego dla firmy Samsung.
DUPLICATE_DEVICE Urządzenie zostało wcześniej zgłoszone temu samemu klientowi. Nie są wymagane żadne działania naprawcze.
DEVICE_UPLOAD_COUNT_EXCEEDED Żądanie zawiera więcej urządzeń niż limit (obecnie 100 tys.).
AUTHORIZATION_FAIL Nie masz dostępu do danego zasobu (np. urządzenia lub klienta) lub zasób nie istnieje. Więcej informacji znajdziesz na stronie vendorMsg.
INTERNAL_SERVER_ERROR Nieokreślony wewnętrzny błąd serwera. Więcej informacji znajdziesz w powiadomieniu dostawcy. W zależności od rodzaju błędu serwera żądania te mogą być ponawiane.
NOT_IMPLEMENTED Metoda żądania nie jest obsługiwana przez serwer.