Oggetti

CompanyReference

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 un'azienda.

Nome campo Tipo di dati Descrizione
companyReference object(CompanyReference) Oggetto riferimento società.
companyName string Il nome dell'azienda. Ad esempio XYZ Corp. Mostrato ai dipendenti dell'azienda nel portale della registrazione zero-touch.
vendorParams map Campi aggiuntivi in 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 l'azienda a cui sono assegnati i dispositivi.
orderNumber string Il numero dell'ordine.
vendorParams map Campi aggiuntivi in coppie chiave-valore specificate dal fornitore.

DeviceIdentifier

Incapsula l'hardware e gli ID prodotto 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 che utilizzano solo il Wi-Fi richiedono serialNumber, manufacturer e model.
Nome campo Tipo di dati Descrizione
imei string Il numero IMEI del dispositivo. Convalidato al momento dell'input.
serialNumber string Il numero di serie del produttore del dispositivo. Questo valore potrebbe non essere univoco per diversi modelli di dispositivi.
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 produttore.
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: 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,il valore di state corrisponde a FAILED.
operationType enum(operationType) Il tipo di operazione: CLAIM_DEVICES o UNCLAIM_DEVICES.
state enum(operationState) Stato dell'operazione: IN_PROGRESS, COMPLETE, COMPLETE_WITH_ERRORS, FAILED.
deviceErrors Elenco di object(DeviceOperationError) Elenco degli errori relativi al funzionamento dei dispositivi.
vendorParams map Campi aggiuntivi in coppie chiave-valore specificate dal fornitore.

DeviceOperationError

Un errore specifico del dispositivo in un Operation. Ogni risorsa contiene lo stesso deviceId e deviceIdentifier come 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 operativo del dispositivo.

CommonException

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

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

Errore

Un oggetto che contiene 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 da parte del fornitore.
errorId string L'identificatore dell'errore interno.
vendorParams map Campi aggiuntivi in coppie chiave-valore specificate dal fornitore.

ErrorCode

Errori comuni.

Enum Descrizione
INVALID_PARAM_DEFAULT Parametro di input non specificato non valido. Per ulteriori dettagli, consulta il file VendorMsg.
INVALID_PAGE_TOKEN Il valore pageToken fornito non è valido.
INVALID_CUSTOMER_ID L'ID cliente fornito 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 fornito non è valido / non è supportato.
INVALID_IDENTIFIER_SET L'insieme di identificatori fornito non è sufficiente per la richiesta. Per saperne di più sugli insiemi di identificatori consentiti, consulta DeviceIdentifier.
INVALID_MODEL Il modello fornito non è valido o non è supportato.
INVALID_DEVICE_ID L'ID dispositivo fornito non è valido.
INVALID_DEVICE Il dispositivo fornito non esiste. Questo è un codice di errore specifico di Samsung.
DUPLICATE_DEVICE Il dispositivo è stato precedentemente rivendicato allo stesso cliente. Non è richiesta alcuna azione correttiva.
DEVICE_UPLOAD_COUNT_EXCEEDED La richiesta contiene più dispositivi rispetto al limite (attualmente 100.000).
AUTHORIZATION_FAIL Non hai accesso a una determinata risorsa (ad es. dispositivo, cliente) oppure la risorsa non esiste. Per ulteriori dettagli, consulta la pagina vendorMsg.
INTERNAL_SERVER_ERROR Errore interno del server non specificato. Per ulteriori dettagli, consulta il file VendorMsg. È possibile ritentare queste richieste a seconda della natura dell'errore del server.
NOT_IMPLEMENTED Il metodo di richiesta non è supportato dal server.