Синхронизация списка регионов
Consenta.API / Регистрация агента по внешнему запросу / Синхронизация списка регионов
Ответ на запрос получения регионов в формате XML
Ответ возвращается в формате XML. Рассмотрим XML-ответ сервиса на запрос https://consenta.ru/CommonAPI/GetRegions?login=test@mail.ru&password=12345&id=171. В ответ сервис вернёт все регионы доступные регионалу в виде XML-документа.Если не задать id, то в ответ сервис вернёт все регионы доступные регионалу Consenta. Если не указан логин или пароль аккаунта Consenta.ru с доступом к API функциям или аккаунт с такими логин и пароль не существует, то в ответ придет соответсвующее сообщение. Если задан id несуществующего регионала, то в ответ придёт сообщение, что такой регионал не найден.
Примерный ответ при удачном запросе:
<consenta_regions date="2015-04-14 15:26">
<regional Title="Консента" id="171">
<regions>
<region Title="Абакан" id="223"/>
<region Title="Агинское" id="224"/>
<region Title="Анапа" id="117"/>
<region Title="Армавир" id="122"/>
<region Title="Архангельск" id="201"/>
<region Title="Астрахань " id="202"/>
<region Title="Чудово" id="179"/>
<region Title="Шуя" id="189"/>
<region Title="Щелково" id="193"/>
<region Title="Энгельс" id="247"/>
<region Title="Южно-Сахалинск" id="253"/>
<region Title="Якутск" id="222"/>
<region Title="Ярославль" id="197"/>
</regions>
</regional>
</consenta_regions>
Примерный ответ при неудачном запросе:
<consenta_regions date="2015-04-14 15:26">
<regional Title="Не найден пользователь - неверный логин или пароль для доступа" id="0">
<regions/>
</regional>
</consenta_regions>
<regional Title="Регионал не найден" id="1111">
<regions/>
</regional>
</consenta_regions>
Аттрибут date элеимента consenta_regions содержит дату и время ответа. Элемент regional содержит информацию о регионале, для которого был сформирован список регионов:
· аттрибут Title содержит название регионала;
· аттрибут id содержит идентификатор регионала.
Ответы на запросы получения заявок со статусом " Пройдена модерация" или "Оспорено" в формате XML.
1. Удачный запрос вернёт
<?xml version="1.0" encoding="utf-8" ?>
<sales request_date="2018-11-07 15:46">
<sale Id="16969" EntityId="8460" Agent="Мурат" Manager="" CreationDate="2018-10-19 16:40" ApprovedDate="19.10.2018 16:43:21" SoldDate="19.10.2018 16:43:21" Name="ТЕСТ" Phone="+7(499)757-87-87" Email="" Product="Бухгалтерское и юридическое обслуживание бизнеса" ForItself="False" State="оспорено" SumAgent="0" SumRegional="0" SumSupplier="0" ChallengeComment="ТЕСТ" ChallengeFile="" Urgent="False" CustomerName="Ольга" Comment="" SaleSum="" SubscriberFee="False" CustomerPassed="False" Notifications="0" LastNotificationDate="" NotificationSuccess="" CallLaterDate="" ChargeDate="" OperatorComment="" ManagerTitle="" Quantity="1" NBNReqId="" ConsentaReward="20000" ConsentaRewardPercent="0" ConsentaSumFromPercent="0" AgentReward="10000" AgentRewardPercent="0" AgentSumFromPercent="0" AdditionalFields="Название компании, сфера деятельности, ИНН" Moderator="" ModeratorTitle="" ModeratorComments="" OperatorComments="" CommentsForAgent="" HasUnreadComment="False" ChallengeDate="19.10.2018 16:44:53" ExternalId="" IncomingChannel="" TochkaAPIState="" approved_date="" challenged_date="2018-10-19 16:44" id="16969" />
</sales>
2. Запрос без логина или пароля вернёт
<?xml version="1.0" encoding="utf-8" ?>
<error date="2018-11-07 15:53" message="Нет доступа. Требуется указать логин и пароль" />
Больше о параметрах запросов прочитайте в пункте "Параметры HTTP-запросов"
Ответы на запрос изменения статуса заявки поставщиком.
1. Удачный запрос вернёт
<?xml version="1.0" encoding="utf-8" ?>
<consenta_changeSaleState date="2019-01-23 16:43">
<changeSaleState Result="успешно" Value="заявка saleId = 1234 статус saleStateId = 105" />
</consenta_changeSaleState>
2. Запрос с ошибками будет иметь следующий формат
<?xml version="1.0" encoding="utf-8" ?>
<consenta_changeSaleState date="2019-01-23 16:59">
<changeSaleState Result="неудачно" Value="ПРИЧИНА />
</consenta_changeSaleState>
Больше о параметрах запросов прочитайте в пункте "Параметры HTTP-запросов"