obiektu

Dokumentacja firmy

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świetlany 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 na potrzeby 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ą wygenerowane urządzenie.
customer object(CompanyReference) Identyfikatory firmy, do których firmy są przypisane urządzenia.
orderNumber string Numer zamówienia.
vendorParams map Dodatkowe pola w parach klucz-wartość określonych przez dostawcę.

DeviceIdentifier (identyfikator urządzenia)

Zawiera identyfikatory sprzętu i produktu, aby zidentyfikować urządzenie producenta.

Urządzenia Samsung wymagają 1 z tych pól:

  • IMEI
  • serialNumber
  • meid

Pozostałe pola, takie jak 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ą serialNumber, manufacturer i model.
Nazwa pola Typ danych Opis
imei string Numer IMEI urządzenia. Zweryfikowana przy wprowadzaniu.
serialNumber string Numer seryjny producenta urządzenia. Wartość może nie być unikalna w zależności od modelu urządzenia.
meid string Numer MEID urządzenia.
manufacturer string Nazwa producenta urządzenia. Odpowiada wbudowanej wartości urządzenia zwróconej przez android.os.Build.MANUFACTURER. Dozwolone wartości są wymienione na stronie producentów.
model string Nazwa modelu urządzenia. Odpowiada wbudowanej wartości urządzenia zwróconej przez android.os.Build.MODEL. Dozwolone wartości są wymienione w modelach.

Operacja

Ten zasób zawiera stan asynchronicznego wywołania interfejsu API. Możliwe są 4 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 się nie udała i operationId nie jest zwracana.
Nazwa pola Typ danych Opis
operationId string Identyfikator operacji poprzedzony ciągiem samsung/ lub google/. Jeśli wartość jest pusta,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 operacji na urządzeniu.
vendorParams map Dodatkowe pola w parach klucz-wartość określonych przez dostawcę.

Błąd operacji urządzenia

Błąd dotyczący konkretnego urządzenia w: Operation. Każdy zasób zawiera te same deviceId i deviceIdentifier co żądanie, które uruchomił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ą wygenerowane urządzenie.
error object(Error) Błąd operacji urządzenia.

Wyjątek

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

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

Błąd

Obiekt zawierający szczegółowe informacje 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ółowe objaśnienie błędu od dostawcy.
errorId string Identyfikator błędu wewnętrznego.
vendorParams map Dodatkowe pola w parach klucz-wartość określonych przez dostawcę.

ErrorCode

Typowe błędy.

Enum Opis
INVALID_PARAM_DEFAULT Nieokreślony nieprawidłowy parametr wejściowy. Więcej informacji znajdziesz na stronie providerMsg.
INVALID_PAGE_TOKEN Podany token pagepage jest nieprawidłowy.
INVALID_CUSTOMER_ID Podany identyfikator klienta jest nieprawidłowy.
INVALID_DEVICE_IMEI Nieprawidłowy numer EMEI.
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 Podany producent jest nieprawidłowy lub nieobsługiwany.
INVALID_IDENTIFIER_SET Zestaw identyfikatorów nie jest wystarczający dla żądania. Więcej informacji o dozwolonych zestawach identyfikatorów znajdziesz na stronie DeviceIdentifier.
INVALID_MODEL Podany model jest nieprawidłowy lub nieobsługiwany.
INVALID_DEVICE_ID Podana wartość deviceId jest nieprawidłowa.
INVALID_DEVICE Podane urządzenie nie istnieje. To jest kod błędu specyficzny dla Samsunga.
DUPLICATE_DEVICE Właściciel tego urządzenia miał wcześniej prawa do tego urządzenia. Nie musisz niczego robić.
DEVICE_UPLOAD_COUNT_EXCEEDED Prośba obejmuje więcej urządzeń (obecnie 100 tys.).
AUTHORIZATION_FAIL Nie masz dostępu do danego zasobu (np. urządzenia, klienta) lub nie istnieje. Więcej informacji znajdziesz tutaj: vendorMsg.
INTERNAL_SERVER_ERROR Nieokreślony wewnętrzny błąd serwera. Więcej informacji znajdziesz na providerMsg. Żądania te można ponowić w zależności od rodzaju błędu serwera.
NOT_IMPLEMENTED Serwer nie obsługuje tej metody żądania.