Reader
This interface is available only to the registered users.
To register send via internal mail a message to WMID 941977853154 (Technical support) containing short information about the project, web-site URL, IP address, from which requests will be sent, the goal and method how the interface will be used. The Keeper signing the requests must have a personal passport (requests are processed up to three working days).
<w3s.request> <reqn></reqn> <wmid></wmid> <sign></sign> <testwmpurse> <wmid></wmid> <purse></purse> </testwmpurse> </w3s.request>
| name | purpose | comments |
| reqn | request number | an integer without delimiter, max number of digits – 15; the value must always be greater than the number of previous request for means transfer!!! |
| wmid | WMID of the user who signed the request | used only when authorizing WM Keeper Classic keys |
| sign | request signature is formed using the following parameters: testwmpurse\wmid + testwmpurse\purse | used only when authorizing WM Keeper Classic keys |
| testwmpurse | request parameters | depending on search task the user can specify both one and both parameters. possible combinations are given in the table below |
| testwmpurse\wmid | WM-identifier | 12 digits |
| testwmpurse\purse | Purse | the first character is one from: Z,R,E,U,C,D and then 12 digits |
<w3s.response> <reqn></reqn> <retval></retval> <retdesc></retdesc> <testwmpurse> <wmid></wmid> <purse></purse> </testwmpurse> </w3s.response>
| name | purpose | comments |
| reqn | request number | |
| retval | request (search) execution code | 1 – search successful, 0 – no entries found |
| retdesc | description of request execution code | |
| testwmpurse | response parameters | possible values of the returned parameters are specified in the table below |
| testwmpurse\wmid | WM-identifier searched for | if search successful (WM-identifier exists) – WM-identifier searched for, if unsuccessful – empty value |
| testwmpurse\purse | the Purse searched for | if search successful (Purse exists or belongs to the specified WM-identifier) – the specified Purse |
| search task | passed parameters | search result/ retval value |
returned parameters |
| search by identifier | wmid | found/1 | wmid |
| not found/0 | |||
| search by purse | purse | found/1 | wmid purse |
| not found/0 | purse | ||
| does the purse belong to the identifier | wmid purse |
the purse belongs to the identifier/1 | wmid purse | the purse does not belong to the identifier/1 | wmid |
| identifier is not registed/0 |
See also XML-interfaces, How to check whether the specified WMID exists
Category: XML-Interfaces
This article in other languages: Русский