Referencia de empresa
Identifica una empresa de forma exclusiva.
Nombre del campo | Tipo de datos | Descripción |
---|---|---|
companyId |
string |
Solo salida. El ID de la empresa, asignado por el servidor. |
vendor |
enum |
Samsung o Google . |
Empresa
Representa a una empresa.
Nombre del campo | Tipo de datos | Descripción |
---|---|---|
companyReference |
object( CompanyReference ) |
Objeto de referencia de la empresa. |
companyName |
string |
El nombre de la empresa. Por ejemplo, XYZ Corp. Se muestra a los empleados de la empresa en el portal de inscripción automática. |
vendorParams |
map |
Campos adicionales en pares clave-valor especificados por el proveedor. |
Dispositivo
Un dispositivo Android registrado para la inscripción
Nombre del campo | Tipo de datos | Descripción |
---|---|---|
deviceId |
string |
Solo salida. El ID del dispositivo, asignado por el servidor. |
deviceIdentifier |
object( DeviceIdentifier ) |
Los ID de hardware que identifican un dispositivo fabricado. |
customer |
object( CompanyReference ) |
Los ID de empresa que identifican a qué empresa están asignados los dispositivos. |
orderNumber |
string |
El número de pedido. |
vendorParams |
map |
Campos adicionales en pares clave-valor especificados por el proveedor. |
Identificador de dispositivo
Encapsula ID de hardware y de productos para identificar el dispositivo del fabricante.
Los dispositivos Samsung requieren uno de los siguientes campos:
IMEI
serialNumber
meid
Se ignoran todos los demás campos, como model
.
Para todos los demás dispositivos Android:
- Los dispositivos móviles requieren
imei
ymanufacturer
. - Los dispositivos que solo tienen Wi-Fi requieren
serialNumber
,manufacturer
ymodel
.
Nombre del campo | Tipo de datos | Descripción |
---|---|---|
imei |
string |
El número IMEI del dispositivo. Validado en la entrada. |
serialNumber |
string |
Es el número de serie del fabricante del dispositivo. Es posible que este valor no sea único en los distintos modelos de dispositivos. |
meid |
string |
El número MEID del dispositivo. |
manufacturer |
string |
Es el nombre del fabricante del dispositivo. Coincide con el valor integrado del dispositivo que muestra android.os.Build.MANUFACTURER . Los valores permitidos se detallan en fabricantes. |
model |
string |
El nombre del modelo del dispositivo. Coincide con el valor integrado del dispositivo que muestra android.os.Build.MODEL . Los valores permitidos se enumeran en modelos. |
Operación
Este recurso contiene el estado de una llamada a la API asíncrona. Hay cuatro estados posibles:
IN_PROGRESS
: La operación está en curso.COMPLETE
: Todos los dispositivos se procesaron correctamente.COMPLETE_WITH_ERRORS
: La operación se procesó, pero se produjeron algunos errores. Todos los errores se muestran en la listadeviceErrors
.FAILED
: La operación falló y no se muestra ningúnoperationId
.
Nombre del campo | Tipo de datos | Descripción |
---|---|---|
operationId |
string |
El ID de la operación, con el prefijo samsung/ o google/ . Si está vacío, state es FAILED . |
operationType |
enum(operationType) |
El tipo de operación: CLAIM_DEVICES o UNCLAIM_DEVICES . |
state |
enum(operationState) |
El estado de la operación: IN_PROGRESS , COMPLETE , COMPLETE_WITH_ERRORS , FAILED . |
deviceErrors |
Lista de object( DeviceOperationError ) |
Lista de errores de funcionamiento del dispositivo. |
vendorParams |
map |
Campos adicionales en pares clave-valor especificados por el proveedor. |
Error en la operación del dispositivo
Es un error específico del dispositivo en una Operation
. Cada recurso contiene los mismos deviceId
y deviceIdentifier
que la solicitud que inició la operación.
Nombre del campo | Tipo de datos | Descripción |
---|---|---|
deviceId |
string |
Solo salida. El ID del dispositivo, asignado por el servidor. |
deviceIdentifier |
object( DeviceIdentifier ) |
Los ID de hardware que identifican un dispositivo fabricado. |
error |
object( Error ) |
Se produjo un error en el funcionamiento del dispositivo. |
Excepción común
Una excepción que pueden arrojar todas las API síncronas.
Nombre de la propiedad | Valor | Descripción |
---|---|---|
error |
object( Error ) |
Error de operación síncrono |
Error
Un objeto que contiene detalles sobre un error.
Nombre de la propiedad | Valor | Descripción |
---|---|---|
code |
enum( ErrorCode ) |
Es el código de error. Por ejemplo, INVALID_REQUESET o PERMISSION_DENIED . |
message |
string |
Mensaje de error. |
vendorMsg |
string |
Una explicación detallada del error del proveedor. |
errorId |
string |
Es el identificador de error interno. |
vendorParams |
map |
Campos adicionales en pares clave-valor especificados por el proveedor. |
ErrorCode
Errores comunes
Enum | Descripción |
---|---|
INVALID_PARAM_DEFAULT |
Parámetro de entrada no válido no especificado. Para obtener más información, consulta el proveedor de servicios. |
INVALID_PAGE_TOKEN |
El pageToken que se proporcionó no es válido. |
INVALID_CUSTOMER_ID |
El ID del cliente proporcionado no es válido. |
INVALID_DEVICE_IMEI |
El IMEI no es válido. |
INVALID_DEVICE_MEID |
El MEID no es válido. |
INVALID_DEVICE_SERIAL |
Número de serie no válido |
INVALID_OPERATION_ID |
El ID de operación proporcionado no es válido. |
INVALID_RESELLER_ID |
El ID del distribuidor proporcionado no es válido. |
INVALID_MANUFACTURER |
El fabricante proporcionado no es válido o no es compatible. |
INVALID_IDENTIFIER_SET |
El conjunto de identificadores proporcionados no es suficiente para la solicitud. Consulta DeviceIdentifier para obtener más información sobre los conjuntos de identificadores permitidos. |
INVALID_MODEL |
El modelo proporcionado no es válido o no es compatible. |
INVALID_DEVICE_ID |
El deviceId proporcionado no es válido. |
INVALID_DEVICE |
El dispositivo proporcionado no existe. Este es un código de error específico de Samsung. |
DUPLICATE_DEVICE |
Ya se reclamó el dispositivo al mismo cliente. No se requiere ninguna acción correctiva. |
DEVICE_UPLOAD_COUNT_EXCEEDED |
La solicitud contiene más dispositivos que el límite (actualmente, 100,000). |
AUTHORIZATION_FAIL |
No tienes acceso a un recurso determinado (p.ej., un dispositivo o cliente), o el recurso no existe. Consulta vendorMsg para obtener más detalles. |
INTERNAL_SERVER_ERROR |
Error de servidor interno no especificado Para ver más detalles, consulta providerMsg. Se pueden reintentar estas solicitudes según la naturaleza del error del servidor. |
NOT_IMPLEMENTED |
El servidor no admite el método de solicitud. |