Oggetti

Riferimento società

Identifica in modo univoco un'azienda.

Nome campo Tipo di dati Descrizione
companyId string Solo output. L'ID dell'azienda assegnato dal server.
vendor enum Samsung o Google.

Società

Rappresenta una società.

Nome campo Tipo di dati Descrizione
companyReference object(CompanyReference) Oggetto di riferimento aziendale.
companyName string Il nome dell'azienda. Ad esempio, XYZ Corp. Visualizzato ai dipendenti dell'azienda nel portale della registrazione zero-touch.
vendorParams map Campi aggiuntivi nelle coppie chiave-valore specificate dal fornitore.

Dispositivo

Un dispositivo Android registrato per la registrazione.

Nome campo Tipo di dati Descrizione
deviceId string Solo output. L'ID del dispositivo assegnato dal server.
deviceIdentifier object(DeviceIdentifier) Gli ID hardware che identificano un dispositivo prodotto.
customer object(CompanyReference) Gli ID azienda che identificano la società a cui sono assegnati i dispositivi.
orderNumber string Il numero dell'ordine.
vendorParams map Campi aggiuntivi nelle coppie chiave-valore specificate dal fornitore.

DeviceIdentifier

Incapsula ID del prodotto e hardware per identificare il dispositivo di un produttore.

I dispositivi Samsung richiedono uno dei seguenti campi:

  • IMEI
  • serialNumber
  • meid

Tutti gli altri campi, come model, vengono ignorati.

Per tutti gli altri dispositivi Android:

  • I dispositivi mobili richiedono imei e manufacturer.
  • I dispositivi solo Wi-Fi richiedono serialNumber, manufacturer e model.
Nome campo Tipo di dati Descrizione
imei string Il numero IMEI del dispositivo. Convalidato utilizzando l'input.
serialNumber string Il numero di serie del produttore del dispositivo. Questo valore potrebbe non essere univoco tra modelli di dispositivi diversi.
meid string Il numero MEID del dispositivo.
manufacturer string Il nome del produttore del dispositivo. Corrisponde al valore integrato del dispositivo restituito da android.os.Build.MANUFACTURER I valori consentiti sono elencati nei produttori.
model string Il nome del modello del dispositivo. Corrisponde al valore integrato del dispositivo restituito da android.os.Build.MODEL I valori consentiti sono elencati nei modelli.

Operazione

Questa risorsa contiene lo stato di una chiamata API asincrona. Esistono quattro possibili stati:

  • IN_PROGRESS: l'operazione è in corso.
  • COMPLETE: tutti i dispositivi sono stati elaborati correttamente.
  • COMPLETE_WITH_ERRORS: l'operazione è stata elaborata, ma si sono verificati alcuni errori. Tutti gli errori sono elencati nell'elenco deviceErrors.
  • FAILED: l'operazione non è riuscita e non viene restituito alcun operationId.
Nome campo Tipo di dati Descrizione
operationId string L'ID operazione, preceduto dal prefisso samsung/ o google/. Se vuoto,state è FAILED.
operationType enum(operationType) Il tipo di operazione: CLAIM_DEVICES o UNCLAIM_DEVICES.
state enum(operationState) Lo stato dell'operazione: IN_PROGRESS, COMPLETE, COMPLETE_WITH_ERRORS e FAILED.
deviceErrors Elenco di object(DeviceOperationError) Elenco di errori del funzionamento del dispositivo.
vendorParams map Campi aggiuntivi nelle coppie chiave-valore specificate dal fornitore.

Errore DeviceOperation

Un errore specifico del dispositivo in Operation. Ogni risorsa contiene gli stessi valori deviceId e deviceIdentifier della richiesta che ha avviato l'operazione.

Nome campo Tipo di dati Descrizione
deviceId string Solo output. L'ID del dispositivo assegnato dal server.
deviceIdentifier object(DeviceIdentifier) Gli ID hardware che identificano un dispositivo prodotto.
error object(Error) L'errore di funzionamento del dispositivo.

Eccezione comune

Un'eccezione che può essere generata da tutte le API sincrone.

Nome proprietà Valore Descrizione
error object(Error) Errore di operazione sincrona.

Errore

Un oggetto contenente dettagli su un errore.

Nome proprietà Valore Descrizione
code enum(ErrorCode) Il codice di errore. Ad esempio, INVALID_REQUESET o PERMISSION_DENIED
message string Il messaggio di errore.
vendorMsg string Una spiegazione dettagliata dell'errore presentata dal fornitore.
errorId string L'identificatore dell'errore interno.
vendorParams map Campi aggiuntivi nelle coppie chiave-valore specificate dal fornitore.

ErrorCode

Errori comuni.

Enum Descrizione
INVALID_PARAM_DEFAULT Parametro di input non valido non specificato. Per ulteriori dettagli, consulta il vendorMsg.
INVALID_PAGE_TOKEN Il token della pagina fornito non è valido.
INVALID_CUSTOMER_ID L'ID cliente specificato non è valido.
INVALID_DEVICE_IMEI IMEI non valido.
INVALID_DEVICE_MEID MEID non valido.
INVALID_DEVICE_SERIAL Numero di serie non valido.
INVALID_OPERATION_ID L'ID operazione fornito non è valido.
INVALID_RESELLER_ID L'ID rivenditore fornito non è valido.
INVALID_MANUFACTURER Il produttore indicato non è valido / non è supportato.
INVALID_IDENTIFIER_SET L'insieme di identificatori fornito non è sufficiente per la richiesta. Per ulteriori informazioni sui set di identificatori consentiti, consulta la sezione DeviceIdentifier.
INVALID_MODEL Il modello fornito non è valido / non è supportato.
INVALID_DEVICE_ID L'ID dispositivo fornito non è valido.
INVALID_DEVICE Il dispositivo specificato non esiste. Questo è un codice di errore specifico Samsung.
DUPLICATE_DEVICE Il dispositivo è stato rivendicato in precedenza per lo stesso cliente. Non sono richieste azioni correttive.
DEVICE_UPLOAD_COUNT_EXCEEDED La richiesta contiene più dispositivi di cui il limite (al momento 100.000).
AUTHORIZATION_FAIL Non hai accesso a una determinata risorsa (ad esempio, dispositivo o cliente) oppure la risorsa non esiste. Consulta vendorMsg per ulteriori dettagli.
INTERNAL_SERVER_ERROR Errore interno del server non specificato. Per ulteriori dettagli, consulta vendorMsg. È possibile ritentare queste richieste a seconda della natura dell'errore del server.
NOT_IMPLEMENTED Il metodo di richiesta non è supportato dal server.