Объекты

КомпанияСправочник

Уникально идентифицирует компанию.

Имя поля Тип данных Описание
companyId string Только вывод. Идентификатор компании, присвоенный сервером.
vendor enum Samsung или Google .

Компания

Представляет компанию.

Имя поля Тип данных Описание
companyReference object( CompanyReference ) Справочный объект компании.
companyName string Название компании. Например, корпорация XYZ . Отображается сотрудникам компании на портале автоматической регистрации.
vendorParams map Дополнительные поля в парах ключ-значение, указанных поставщиком.

Устройство

Устройство Android, зарегистрированное для регистрации.

Имя поля Тип данных Описание
deviceId string Только вывод. Идентификатор устройства, назначенный сервером.
deviceIdentifier object( DeviceIdentifier ) Идентификаторы оборудования, идентифицирующие произведенное устройство.
customer object( CompanyReference ) Идентификаторы компании, которые определяют, какой компании присвоены устройства.
orderNumber string Номер заказа.
vendorParams map Дополнительные поля в парах ключ-значение, указанных поставщиком.

Идентификатор устройства

Инкапсулирует идентификаторы оборудования и продуктов для идентификации устройства производителя.

Устройства Samsung требуют заполнения одного из следующих полей:

  • IMEI
  • serialNumber
  • meid

Все остальные поля, такие как model , игнорируются.

Для всех остальных устройств Android:

  • Для мобильных устройств требуется imei и manufacturer .
  • Для устройств, поддерживающих только Wi-Fi, требуются serialNumber , manufacturer и model .
Имя поля Тип данных Описание
imei string Номер IMEI устройства. Проверено при вводе.
serialNumber string Серийный номер производителя устройства. Это значение может не быть уникальным для разных моделей устройств.
meid string MEID-номер устройства.
manufacturer string Название производителя устройства. Соответствует встроенному значению устройства, возвращенному из android.os.Build.MANUFACTURER . Допустимые значения указаны у производителей .
model string Название модели устройства. Соответствует встроенному значению устройства, возвращенному из android.os.Build.MODEL . Допустимые значения указаны в моделях .

Операция

Этот ресурс содержит статус асинхронного вызова API. Возможны четыре статуса:

  • IN_PROGRESS : операция выполняется.
  • COMPLETE : Все устройства успешно обработаны.
  • COMPLETE_WITH_ERRORS : операция была обработана, но возникли ошибки. Все ошибки перечислены в списке deviceErrors .
  • FAILED : операция не удалась, и operationId не возвращается.
Имя поля Тип данных Описание
operationId string Идентификатор операции с префиксом samsung/ или google/ . Если пусто, state FAILED .
operationType enum(operationType) Тип операции: CLAIM_DEVICES или UNCLAIM_DEVICES .
state enum(operationState) Состояние операции: IN_PROGRESS , COMPLETE , COMPLETE_WITH_ERRORS , FAILED .
deviceErrors Список object( DeviceOperationError ) Список ошибок работы устройства.
vendorParams map Дополнительные поля в парах ключ-значение, указанных поставщиком.

Девицеоператионеррор

Ошибка конкретного устройства в Operation . Каждый ресурс содержит те же deviceId и deviceIdentifier , что и запрос, запустивший операцию.

Имя поля Тип данных Описание
deviceId string Только вывод. Идентификатор устройства, назначенный сервером.
deviceIdentifier object( DeviceIdentifier ) Идентификаторы оборудования, идентифицирующие произведенное устройство.
error object( Error ) Ошибка работы устройства.

CommonException

Исключение, которое может быть выдано всеми синхронными API.

Имя свойства Ценить Описание
error object( Error ) Ошибка синхронной операции.

Ошибка

Объект, содержащий сведения об ошибке.

Имя свойства Ценить Описание
code enum( ErrorCode ) Код ошибки. Например, INVALID_REQUESET или PERMISSION_DENIED
message string Сообщение об ошибке.
vendorMsg string Подробное объяснение ошибки от производителя.
errorId string Внутренний идентификатор ошибки.
vendorParams map Дополнительные поля в парах ключ-значение, указанных поставщиком.

Код ошибки

Распространенные ошибки.

Перечисление Описание
INVALID_PARAM_DEFAULT Неопределенный неверный входной параметр. Посмотрите наvendorMsg, чтобы получить более подробную информацию.
INVALID_PAGE_TOKEN Предоставленный pageToken недействителен.
INVALID_CUSTOMER_ID Указанный идентификатор клиента недействителен.
INVALID_DEVICE_IMEI Неверный IMEI.
INVALID_DEVICE_MEID Неверный MEID.
INVALID_DEVICE_SERIAL Неправильный серийный номер.
INVALID_OPERATION_ID Указанный идентификатор операции недействителен.
INVALID_RESELLER_ID Указанный идентификатор реселлера недействителен.
INVALID_MANUFACTURER Указанный производитель недействителен/не поддерживается.
INVALID_IDENTIFIER_SET Предоставленного набора идентификаторов недостаточно для запроса. См. DeviceIdentifier для получения дополнительной информации о разрешенных наборах идентификаторов.
INVALID_MODEL Предоставленная модель недействительна/не поддерживается.
INVALID_DEVICE_ID Указанный идентификатор устройства недействителен.
INVALID_DEVICE Указанное устройство не существует. Это специфический код ошибки Samsung.
DUPLICATE_DEVICE Устройство ранее было заявлено тому же покупателю. Никаких корректирующих действий не требуется.
DEVICE_UPLOAD_COUNT_EXCEEDED Запрос содержит больше устройств, чем установлено ограничением (в настоящее время 100 000).
AUTHORIZATION_FAIL У вас нет доступа к данному ресурсу (например, устройству, клиенту) или ресурс не существует. vendorMsg чтобы получить более подробную информацию.
INTERNAL_SERVER_ERROR Неизвестная внутренняя ошибка сервера. ПосмотритеvendorMsg, чтобы получить более подробную информацию. Эти запросы могут быть повторены в зависимости от характера ошибки сервера.
NOT_IMPLEMENTED Метод запроса не поддерживается сервером.
,

КомпанияСправочник

Уникально идентифицирует компанию.

Имя поля Тип данных Описание
companyId string Только вывод. Идентификатор компании, присвоенный сервером.
vendor enum Samsung или Google .

Компания

Представляет компанию.

Имя поля Тип данных Описание
companyReference object( CompanyReference ) Справочный объект компании.
companyName string Название компании. Например, корпорация XYZ . Отображается сотрудникам компании на портале автоматической регистрации.
vendorParams map Дополнительные поля в парах ключ-значение, указанных поставщиком.

Устройство

Устройство Android, зарегистрированное для регистрации.

Имя поля Тип данных Описание
deviceId string Только вывод. Идентификатор устройства, назначенный сервером.
deviceIdentifier object( DeviceIdentifier ) Идентификаторы оборудования, идентифицирующие произведенное устройство.
customer object( CompanyReference ) Идентификаторы компании, которые определяют, какой компании присвоены устройства.
orderNumber string Номер заказа.
vendorParams map Дополнительные поля в парах ключ-значение, указанных поставщиком.

Идентификатор устройства

Инкапсулирует идентификаторы оборудования и продуктов для идентификации устройства производителя.

Устройства Samsung требуют заполнения одного из следующих полей:

  • IMEI
  • serialNumber
  • meid

Все остальные поля, такие как model , игнорируются.

Для всех остальных устройств Android:

  • Для мобильных устройств требуется imei и manufacturer .
  • Устройствам, поддерживающим только Wi-Fi, требуются serialNumber , manufacturer и model .
Имя поля Тип данных Описание
imei string Номер IMEI устройства. Проверено при вводе.
serialNumber string Серийный номер производителя устройства. Это значение может не быть уникальным для разных моделей устройств.
meid string MEID-номер устройства.
manufacturer string Название производителя устройства. Соответствует встроенному значению устройства, возвращенному из android.os.Build.MANUFACTURER . Допустимые значения указаны у производителей .
model string Название модели устройства. Соответствует встроенному значению устройства, возвращенному из android.os.Build.MODEL . Допустимые значения указаны в моделях .

Операция

Этот ресурс содержит статус асинхронного вызова API. Возможны четыре статуса:

  • IN_PROGRESS : операция выполняется.
  • COMPLETE : Все устройства успешно обработаны.
  • COMPLETE_WITH_ERRORS : операция была обработана, но возникли ошибки. Все ошибки перечислены в списке deviceErrors .
  • FAILED : операция не удалась, и operationId не возвращается.
Имя поля Тип данных Описание
operationId string Идентификатор операции с префиксом samsung/ или google/ . Если пусто, state FAILED .
operationType enum(operationType) Тип операции: CLAIM_DEVICES или UNCLAIM_DEVICES .
state enum(operationState) Состояние операции: IN_PROGRESS , COMPLETE , COMPLETE_WITH_ERRORS , FAILED .
deviceErrors Список object( DeviceOperationError ) Список ошибок работы устройства.
vendorParams map Дополнительные поля в парах ключ-значение, указанных поставщиком.

Девицеоператионеррор

Ошибка конкретного устройства в Operation . Каждый ресурс содержит те же deviceId и deviceIdentifier , что и запрос, запустивший операцию.

Имя поля Тип данных Описание
deviceId string Только вывод. Идентификатор устройства, назначенный сервером.
deviceIdentifier object( DeviceIdentifier ) Идентификаторы оборудования, идентифицирующие произведенное устройство.
error object( Error ) Ошибка работы устройства.

CommonException

Исключение, которое может быть выдано всеми синхронными API.

Имя свойства Ценить Описание
error object( Error ) Ошибка синхронной операции.

Ошибка

Объект, содержащий сведения об ошибке.

Имя свойства Ценить Описание
code enum( ErrorCode ) Код ошибки. Например, INVALID_REQUESET или PERMISSION_DENIED
message string Сообщение об ошибке.
vendorMsg string Подробное объяснение ошибки от производителя.
errorId string Внутренний идентификатор ошибки.
vendorParams map Дополнительные поля в парах ключ-значение, указанных поставщиком.

Код ошибки

Распространенные ошибки.

Перечисление Описание
INVALID_PARAM_DEFAULT Неопределенный неверный входной параметр. Посмотрите наvendorMsg, чтобы получить более подробную информацию.
INVALID_PAGE_TOKEN Предоставленный pageToken недействителен.
INVALID_CUSTOMER_ID Указанный идентификатор клиента недействителен.
INVALID_DEVICE_IMEI Неверный IMEI.
INVALID_DEVICE_MEID Неверный MEID.
INVALID_DEVICE_SERIAL Неправильный серийный номер.
INVALID_OPERATION_ID Указанный идентификатор операции недействителен.
INVALID_RESELLER_ID Указанный идентификатор реселлера недействителен.
INVALID_MANUFACTURER Указанный производитель недействителен/не поддерживается.
INVALID_IDENTIFIER_SET Предоставленного набора идентификаторов недостаточно для запроса. См. DeviceIdentifier для получения дополнительной информации о разрешенных наборах идентификаторов.
INVALID_MODEL Предоставленная модель недействительна/не поддерживается.
INVALID_DEVICE_ID Указанный идентификатор устройства недействителен.
INVALID_DEVICE Указанное устройство не существует. Это специфический код ошибки Samsung.
DUPLICATE_DEVICE Устройство ранее было заявлено тому же покупателю. Никаких корректирующих действий не требуется.
DEVICE_UPLOAD_COUNT_EXCEEDED Запрос содержит больше устройств, чем установлено ограничением (в настоящее время 100 000).
AUTHORIZATION_FAIL У вас нет доступа к данному ресурсу (например, устройству, клиенту) или ресурс не существует. vendorMsg чтобы получить более подробную информацию.
INTERNAL_SERVER_ERROR Неизвестная внутренняя ошибка сервера. ПосмотритеvendorMsg, чтобы получить более подробную информацию. Эти запросы могут быть повторены в зависимости от характера ошибки сервера.
NOT_IMPLEMENTED Метод запроса не поддерживается сервером.