Explain why isds_login() and isds_ping() use _isds_soap() directly
[libisds.git] / doc / web_service_interface
blobf3c5f8313ed5fd9382696e37d1977ad98af5d686
1 Web service interface
2 =====================
4 Source: Webové služby ISDS pro manipulaci s datovými zprávami, version 2.6
5 (2010-01-18) [DataMessage_ws.pdf], Page 5
6 Source: Webové služby ISDS pro vyhledávání datových schránek,
7 version 2 (2009-07-26)
10 Web services for messages are synchronous, web services for boxes are
11 asynchronous.
14 Error Reporting
15 ===============
17 Result code of web service operation is stored in dmStatus/@dmStatusCode.
18 Known values:
20 Code    Meaning
21 -----------------------------------------------------------------------------
22 0000    Means success
23 0002    FindDataBox: No box suits to search request (by name)
24 0003    FindDataBox: To much boxes suit to search request (by name), response
25             truncated
26 3006    Marking messages as delivered takes too long. Try again.
27 5001    FindDataBox: No such box exists (by box ID or registry identifier)
29 NON-NORMATIVE: ISDS on bogus ISDS request but still valid SOAP request
30 responses with SOAP non-Fault 200-HTTP Code message. Example:
32 POST https://www.czebox.cz/DS/dz
33 <?xml version="1.0" encoding="UTF-8"?>
34 <Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
35   <Body>
36     <X-BogusOperation xmlns="http://isds.czechpoint.cz/v20"/>
37   </Body>
38 </Envelope>
40 200
41 <?xml version='1.0' encoding='utf-8'?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><SOAP-ENV:Body><q:X-BogusOperationResponse xmlns:q="http://isds.czechpoint.cz/v20" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><q:dmStatus><q:dmStatusCode>2006</q:dmStatusCode><q:dmStatusMessage>Unknown operation: X-BogusOperation</q:dmStatusMessage></q:dmStatus></q:X-BogusOperationResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>