Objetos

Referência da empresa

Identifica uma empresa de forma exclusiva.

Nome do campo Tipo de dado Descrição
companyId string Apenas saída. O ID da empresa, atribuído pelo servidor.
vendor enum Samsung ou Google.

Empresa

Representa uma empresa.

Nome do campo Tipo de dado Descrição
companyReference object(CompanyReference) Objeto de referência da empresa.
companyName string O nome da empresa. Por exemplo, XYZ Corp. Exibida aos funcionários da empresa no portal de registro sem toque.
vendorParams map Campos extras em pares de chave-valor especificados pelo fornecedor.

Dispositivo

Um dispositivo Android registrado para registro.

Nome do campo Tipo de dado Descrição
deviceId string Apenas saída. O ID do dispositivo, atribuído pelo servidor.
deviceIdentifier object(DeviceIdentifier) Os IDs de hardware que identificam um dispositivo fabricado.
customer object(CompanyReference) Os IDs das empresas que recebem os dispositivos atribuídos.
orderNumber string O número do pedido.
vendorParams map Campos extras em pares de chave-valor especificados pelo fornecedor.

DeviceIdentifier

Encapsula os IDs de hardware e produto para identificar o dispositivo de um fabricante.

Os dispositivos Samsung exigem um dos seguintes campos:

  • IMEI
  • serialNumber
  • meid

Todos os outros campos, como model, são ignorados.

Para todos os outros dispositivos Android:

  • Os dispositivos móveis precisam de imei e manufacturer.
  • Dispositivos somente Wi-Fi exigem serialNumber, manufacturer e model.
Nome do campo Tipo de dado Descrição
imei string O número IMEI do dispositivo. Validado na entrada.
serialNumber string É o número de série do fabricante do dispositivo. Esse valor pode não ser exclusivo em diferentes modelos de dispositivos.
meid string O número MEID do dispositivo.
manufacturer string O nome do fabricante do dispositivo. Corresponde ao valor integrado do dispositivo retornado de android.os.Build.MANUFACTURER. Os valores permitidos estão listados nos fabricantes.
model string É o nome do modelo do dispositivo. Corresponde ao valor integrado do dispositivo retornado de android.os.Build.MODEL. Os valores permitidos estão listados em modelos.

Operação

Esse recurso contém o status de uma chamada de API assíncrona. Há quatro status possíveis:

  • IN_PROGRESS: a operação está em andamento.
  • COMPLETE: todos os dispositivos foram processados.
  • COMPLETE_WITH_ERRORS: a operação foi processada, mas ocorreram alguns erros. Todos os erros são listados na lista deviceErrors.
  • FAILED: a operação falhou e nenhum operationId é retornado.
Nome do campo Tipo de dado Descrição
operationId string O ID da operação, com o prefixo samsung/ ou google/. Se estiver vazio,state será FAILED.
operationType enum(operationType) O tipo de operação: CLAIM_DEVICES ou UNCLAIM_DEVICES.
state enum(operationState) O estado da operação: IN_PROGRESS, COMPLETE, COMPLETE_WITH_ERRORS, FAILED.
deviceErrors Lista de object(DeviceOperationError) Lista de erros de operação do dispositivo.
vendorParams map Campos extras em pares de chave-valor especificados pelo fornecedor.

ErroDeOperaçãoDeDispositivo

Um erro específico do dispositivo em um Operation. Cada recurso contém os mesmos deviceId e deviceIdentifier da solicitação que iniciou a operação.

Nome do campo Tipo de dado Descrição
deviceId string Apenas saída. O ID do dispositivo, atribuído pelo servidor.
deviceIdentifier object(DeviceIdentifier) Os IDs de hardware que identificam um dispositivo fabricado.
error object(Error) Erro de operação do dispositivo.

CommonException

Uma exceção que pode ser gerada por todas as APIs síncronas.

Nome da propriedade Valor Descrição
error object(Error) Erro de operação síncrona.

Erro

Um objeto que contém detalhes sobre um erro.

Nome da propriedade Valor Descrição
code enum(ErrorCode) O código do erro. Por exemplo, INVALID_REQUESET ou PERMISSION_DENIED
message string A mensagem de erro.
vendorMsg string Uma explicação detalhada do erro do fornecedor.
errorId string O identificador de erro interno.
vendorParams map Campos extras em pares de chave-valor especificados pelo fornecedor.

ErrorCode

Erros comuns.

Tipo enumerado Descrição
INVALID_PARAM_DEFAULT Parâmetro de entrada inválido não especificado. Consulte o providerMsg para saber mais.
INVALID_PAGE_TOKEN O pageToken fornecido é inválido.
INVALID_CUSTOMER_ID O customerId fornecido é inválido.
INVALID_DEVICE_IMEI IMEI inválido.
INVALID_DEVICE_MEID MEID inválido.
INVALID_DEVICE_SERIAL Número de série inválido.
INVALID_OPERATION_ID O originId fornecido é inválido.
INVALID_RESELLER_ID O revendedorId fornecido é inválido.
INVALID_MANUFACTURER O fabricante fornecido é inválido / não compatível.
INVALID_IDENTIFIER_SET O conjunto de identificadores fornecido não é suficiente para a solicitação. Consulte DeviceIdentifier para mais informações sobre os conjuntos de identificadores permitidos.
INVALID_MODEL O modelo fornecido é inválido / incompatível.
INVALID_DEVICE_ID O ID do dispositivo fornecido é inválido.
INVALID_DEVICE O dispositivo fornecido não existe. Este é um código de erro específico da Samsung.
DUPLICATE_DEVICE O dispositivo já foi reivindicado para o mesmo cliente. Nenhuma ação corretiva é necessária.
DEVICE_UPLOAD_COUNT_EXCEEDED A solicitação contém mais dispositivos do que o limite (atualmente 100 mil).
AUTHORIZATION_FAIL Você não tem acesso a um determinado recurso (por exemplo, dispositivo ou cliente) ou o recurso não existe. Consulte vendorMsg para ver mais detalhes.
INTERNAL_SERVER_ERROR Erro de servidor interno não especificado. Consulte fornecedorMsg para saber mais. Essas solicitações podem ser repetidas dependendo da natureza do erro de servidor.
NOT_IMPLEMENTED O servidor não oferece suporte ao método de solicitação.