Получение списка баз

Спецификация для получения списка баз: XML

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

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

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

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

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

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

request

.security

.login

[value]*

String

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

request

.security

.password

[value]*

String

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

request

.security

.token

[value]*

String

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

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

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

<?xml version="1.0" encoding="utf-8" ?>
<response>
     <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 id_base="1235" name_base="База Московского офиса" time_birth="12:48" local_time_birth="yes" day_before="1" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>

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

response

.base

String

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

response

.base

[id_base]

Int

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

response

.base

[name_base]

String

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

response

.base

[time_birth]

Time

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

response

.base

[local_time_birth]

String

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

response

.base

[day_before]

Int

За сколько дней до дня рождения поздравлять

response

.base

[originator_birth]

String

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

response

.base

[on_birth]

String

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

  • yes – включены

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

В случае возникновения ошибки в отправленном 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>
</request>

Last updated