Objetos

CompanyReference

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 códigos de hardware que identificam um dispositivo fabricado.
customer object(CompanyReference) Os IDs que identificam a que empresa os dispositivos são atribuídos.
orderNumber string O número do pedido.
vendorParams map Campos extras em pares de chave-valor especificados pelo fornecedor.

DeviceIdentifier

Encapsula IDs de hardware e de produtos 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 exigem imei e manufacturer.
  • Dispositivos que só usam 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 entre diferentes modelos de dispositivo.
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 em manufacturers.
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 estão listados na lista deviceErrors.
  • FAILED: a operação falhou e nenhum operationId foi 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 de 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.

DeviceOperationError

Um erro específico do dispositivo em uma Operation. Cada recurso contém a mesma deviceId e deviceIdentifier como a 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 códigos de hardware que identificam um dispositivo fabricado.
error object(Error) O 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 erros internos.
vendorParams map Campos extras em pares de chave-valor especificados pelo fornecedor.

ErrorCode

Erros comuns.

Enumeração Descrição
INVALID_PARAM_DEFAULT Parâmetro de entrada inválido não especificado. Consulte a Mensagem do fornecedor para saber mais detalhes.
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 OperationsId fornecido é inválido.
INVALID_RESELLER_ID O revendedorId informado é inválido.
INVALID_MANUFACTURER O fabricante informado é inválido ou incompatí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 ou incompatível.
INVALID_DEVICE_ID O deviceId informado é inválido.
INVALID_DEVICE O dispositivo fornecido não existe. Este é um código de erro específico da Samsung.
DUPLICATE_DEVICE O dispositivo foi reivindicado anteriormente 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.000).
AUTHORIZATION_FAIL Você não tem acesso a um recurso (por exemplo, dispositivo, cliente) ou o recurso não existe. Consulte vendorMsg para ver mais detalhes.
INTERNAL_SERVER_ERROR Erro interno do servidor não especificado. Consulte o campo "vendorMsg" para saber mais detalhes. Dependendo da natureza do erro do servidor, estas solicitações podem ser repetidas.
NOT_IMPLEMENTED O método de solicitação não é suportado pelo servidor.