WebMoney

Wiki

Interface X17

Interface X17. Operations with arbitration contracts.

This interface is available only to registered clients. To get access to this interface send via internal mail a message to "WMID 941977853154" (Technical support) containing short information about your project, URL of your web-site, IP-address from which requests will be sent, purpose and method the interface will be used. The Keeper signing requests must have Personal (or higher) passport.

This interface allows automatically creating and publishing on the web-site of the arbitration service special text documents - contracts, and also checking whether these contracts were accepted by authorized users.

1 Creating contracts

<contract.request>
    <sign_wmid></sign_wmid>
    <name></name>
    <ctype></ctype>
    <text></text>
    <sign></sign>
        <accesslist>
                <wmid></wmid>
                <wmid></wmid>
            </accesslist>
</contract.request>
  • Request parameters:
name purpose comments
sign_wmid Signer's WMID He/she is the contract author
name Contract name short (not more than 255 characters) contract name
ctype Contract type ctype=1 - contract type with open access, ctype=2 - contract with restricted access
text Text of contract Document text itself
sign Request signature Takes the following parameters: wmid & Len(name) & ctype
accesslist List of users WMIDs authorized to accept the given contract for contracts with restricted access contract.request\ctype=2 it is MANDATORY to specify the list of authorized users. It will be impossible to change this list after the contract is published. For contracts with open access there is no necessity to specify contract.request\accesslist, you can find more information about contract types here
accesslist\wmid WMID WMID of the user who is authorized to accept this contract
  • Response format:
<contract.response>
    <retval></retval>
    <retdesc></retdesc>
    <contractid></contractid>
</contract.response>
  • Response parameters:
name purpose comments
retval Execution code 0 - request successful, other values indicate that error(s) occurred during request
retdesc Description of execution code
contractid Number of the created contract If retval=0 this tag will contain the number of the created contract

2 Information about contract acceptances

<contract.request>
    <wmid></wmid>
    <contractid></contractid>
    <mode>acceptdate</mode>
    <sign></sign>
</contract.request>
  • Request parameters:
name purpose comments
wmid Signer's WMID He/she is the contract author
contractid Contract number
mode Request type To get information about acceptors you must always specify mode=acceptdate
sign Request signature Takes the following parameters: contractid + mode
  • Response format:
<contract.response>
    <retval></retval>
    <retdesc></retdesc>
        <contractinfo>
            <row contractid="" wmid="" acceptdate=""/>
            <row contractid="" wmid="" acceptdate=""/>
        </contractinfo>
</contract.response>
  • Response parameters:
name purpose comments
retval Execution code 0 - request successful, other values mean there were errors during request
retdesc Description of execution code
contractinfo Information about acceptors
contractinfo\row Information about one acceptor
contractinfo\row\@contractid Contract number
contractinfo\row\@wmid Acceptor's WMID
contractinfo\row\@acceptdate Date and time of acceptance for example 2005-11-29T12:00:39.077, if there is no acceptance date, then this user hasn't accepted this contract

See also XML-interfaces