Изменение параметров, добавление/удаление баз

Спецификация для изменения параметров, добавления/удаления баз: XML

Метод отправки POST

Кодировка XML-документов: UTF-8

Обязательный заголовок: Content-type: text/xml; charset=utf-8;

Адрес для запроса: https://my3.webcom.mobi/xml/bases.php

Параметры запроса на отправку сообщения

Параметр
Тип
Описание

request

.security

.login

[value]*

String

Ваш логин в системе

request

.security

.password

[value]*

String

Ваш пароль в системе

request

.security

.token

[value]*

String

Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру

request

.bases

.base*

String

Текст поздравления

request

.bases

.base

[id_base]

Int

Уникальный номер базы в системе.

Если не указан произойдет добавление базы. При этом нужно указать параметр number_base

request

.bases

.base

[number_base]

Int

Номер базы в XMLзапросе. Указывается только при создании новой базы. Используется для сопоставления ID добавленных баз (если их было несколько в запросе)

request

.bases

.base

[name_base]

Int

Название базы

request

.bases

.base

[time_birth]

Time

Время поздравления

request

.bases

.base

[local_time_birth]

String

Считать время поздравления относительно местного времени абонента (yes) или относительно времени системы (no)

request

.bases

.base

[originator_birth]

String

Отправитель поздравления

request

.bases

.base

[on_birth]

Int

Включены ли поздравления:

  • yes – включены

  • no - выключены

request

.delete_bases

.base

[id_base]

Int

Уникальный номер базы в системе, который необходимо удалить

*- обязательный параметр

В случае получения правильного XML-документа

<?xml version="1.0" encoding="utf-8" ?>
<response>
     <base id_base=”1234”>edit</base>
     <base number_base=”1” id_base=”1235”>insert</base>
     <base number_base=”2” id_base=”1236”>edit</base>
     <base id_base=”1235”>delete</base>
     <base id_base=”1235”>not_found</base>

</response>
Параметр
Тип
Описание

response

.base

Sting

Действие

response

.base

[id_base]

Int

Уникальный номер базы в системе.

response

.base

[number_base]

Int

Номер базы в XML запросе. Указывается только при создании новой базы. Используется для сопоставления ID добавленных баз (если их было не сколько в запросе)

В случае возникновения ошибки в отправленном XML-документе

<?xml version="1.0" encoding="utf-8"?>
<response>
     <error>текст ошибки</error>
</response>
Параметр
Тип
Описание

response

.error

String

Текст ошибки может принимать следующие значения:

  • Неправильный формат XML документа

  • Ваш аккаунт заблокирован

  • Неправильный логин или пароль

  • POST данные отсутствуют

Пример XML запроса

<?xml  version="1.0" encoding="utf-8" ?>
<request>
     <security>
          <login value="логин" />
          <password value="пароль" />
     </security>
     <bases>
          <base id_base="1234" name_base="База главного офиса" time_birth="12:48" local_time_birth="yes" day_before="1" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
          <base number_base="1" name_base="База Московского офиса" time_birth="12:48" local_time_birth="yes" day_before="1" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
     </bases>
     <delete_bases>
          <base id_base="1235" />
          <base id_base="1236" />

     </delete_bases>
</request>

Last updated