Интерфейс X17

Интерфейс X17. Операции с арбитражными контрактами.

Этот интерфейс доступен только зарегистрированным участникам. Для получения доступа к данному интерфейсу пришлите по внутренней почте на "WMID 941977853154" (Техническая поддержка) краткую информацию о проекте, URL сайта, IP-адрес с которого будут отсылаться запросы, цель и способ использования интерфейса. Кипер, подписывающий запросы должен иметь персональный аттестат (и выше) аттестат.

Интерфейс позволяет автоматически создавать и публиковать на сайте арбитражного сервиса специальные текстовые документы - контракты, а также проверять факт акцепта этих контрактов допущенных к нему участников системы.

1 Создание контрактов

<contract.request>
    <sign_wmid></sign_wmid>
    <name></name>
    <ctype></ctype>
    <text></text>
    <sign></sign>
        <accesslist>
                <wmid></wmid>
                <wmid></wmid>
            </accesslist>
</contract.request>
  • параметры запроса:
название назначение примечание
sign_wmid WMID, подписавший запрос он же автор контракта
name Название контракта краткое (не более 255 символов) название контракта
ctype Тип контракта ctype=1 - контракт с открытым доступом, ctype=2 - контракт с ограниченным доступом
text Текст контракта собственно текст документа. Для разделения строк в тексте документа используйте: \r\n
sign Подпись запроса формируется из параметров: sign_wmid + Len(name) + ctype
accesslist Список WMID участников, которым разрешается акцептовывать данный контракт для контрактов с ограниченным доступом contract.request\ctype=2 указывать список допущенных к нему участников ОБЯЗАТЕЛЬНО, после публикации контракта изменить это список нельзя, для контрактов открытым доступом указывать contract.request\accesslist не нужно, подробнее о типах контрактов читайте здесь
accesslist\wmid WMID WMID участника, которому разрешено акцептовать данный контракт
  • формат ответа:
<contract.response>
    <retval></retval>
    <retdesc></retdesc>
    <contractid></contractid>
</contract.response>
  • параметры ответа:
название назначение примечание
retval код выполнения 0 - запрос выполнен успешно, другие значения означают, что при запросе произошла ошибка
retdesc расшифровка кода выполнения
contractid номер созданного контракта при retval=0 в данный тэг записывается номер созданного контракта
2 Информация об акцептантах
<contract.request>
    <wmid></wmid>
    <contractid></contractid>
    <mode>acceptdate</mode>
    <sign></sign>
</contract.request>
  • параметры запроса:
название назначение примечание
wmid WMID, подписавший запрос он же автор контракта
contractid Номер контракта
mode Тип запроса для получения информации об акцептантах всегда указывать mode=acceptdate
sign подпись запроса формируется из параметров: contractid + mode
  • формат ответа:
<contract.response>
    <retval></retval>
    <retdesc></retdesc>
        <contractinfo>
            <row contractid="" wmid="" acceptdate=""/>
            <row contractid="" wmid="" acceptdate=""/>
        </contractinfo>
</contract.response>
  • параметры ответа:
название назначение примечание
retval код выполнения 0 - запрос выполнен успешно, другие значения означают, что при запросе произошла ошибка
retdesc расшифровка кода выполнения
contractinfo информация об акцептантах
contractinfo\row информация об одном акцептанте
contractinfo\row\@contractid номер контракта
contractinfo\row\@wmid WMID акцептанта
contractinfo\row\@acceptdate дата и время акцепта например 2005-11-29T12:00:39.077, если даты акцепта нет, значит данный участник не акцептовал данное соглашение

см. также XML-интерфейсы