update
Чтобы изменить параметры приложения, используйте метод apps/update.
Этот метод в Wialon Hosting может использовать только пользователь верхнего уровня.
Конечная точка
svc=apps/update¶ms={
"id": <long>,
"name": <text>,
"description": <text>,
"url": <text>,
"flags": <uint>,
"langs": <text>,
"sortOrder": <int>,
"requiredServicesList": <text>,
"billingPlans": <text>
}
Параметры
Запрос должен содержать все следующие параметры. Если параметр не нужен для вашего приложения, укажите для него пустое значение ("" для текстовых параметров и 0 для числовых).
| Параметр | Описание |
|---|---|
| id | ID приложения. Его можно получить с помощью метода apps/list с "manageMode":1. |
| name | Имя приложения. Не может быть пустым. |
| description | Описание приложения. Оно также используется как описание услуги приложения. Можно оставить пустым. |
| url | URL, по которому размещено приложение. Должен начинаться с http://, https:// или //. |
| flags | Флаги приложения (дополнительные параметры URL). Возможные значения см. в разделе Флаги. Укажите 0, если они не нужны. |
| langs | Языки интерфейса, для которых доступно приложение, через запятую, например "en,ru". Если значение пустое, приложение доступно для всех языков. |
| sortOrder | Порядок сортировки приложения в списке. |
| requiredServicesList | Имена услуг, необходимых для приложения, через запятую. Каждая услуга должна быть доступна в вашей учетной записи. Не ставьте запятую в конце списка. Можно оставить пустым. |
| billingPlans | Имена тарифных планов, для которых доступно приложение, через запятую. Каждый тарифный план должен существовать в вашем сервисе. Можно оставить пустым. |
Все параметры заменяются новыми значениями. Чтобы сохранить текущее значение параметра, укажите его в запросе. Текущие значения можно получить с помощью метода apps/list с "manageMode":1.
Если изменить параметр billingPlans, услуга app.<serviceName> (услуга Отображение в меню: <имя приложения> в CMS Manager) добавляется в новые тарифные планы и удаляется из тарифных планов, которые вы исключили из списка.
Ответ
Если запрос выполнен успешно, ответ возвращается в следующем формате:
[
<long>, /* ID приложения */
{
"name": <text>, /* Имя приложения */
"description": <text>, /* Описание приложения */
"url": <text>, /* URL приложения */
"flags": <uint>, /* Флаги приложения */
"sortOrder": <int>, /* Порядок сортировки */
"serviceName": <text>, /* Имя услуги приложения без префикса "app." */
"id": <long>, /* ID приложения */
"langs": <text>, /* Языки интерфейса */
"requiredServicesList": <text>, /* Необходимые услуги */
"billingPlans": <text> /* Тарифные планы */
}
]
Если запрос выполнить не удалось, возвращается код ошибки.
Коды ошибок
| Код ошибки | Описание |
|---|---|
| 4 | Неверные входные параметры, или один из параметров отсутствует. |
| 7 | Нет доступа: пользователь не является пользователем верхнего уровня, или сервис не является Wialon Hosting. Этот код также возвращается, если приложение с указанным ID не найдено, указаны неверные имя или URL, необходимая услуга или тарифный план недоступны, или приложение не удалось обновить. |