Error Handling

While integrating your game using the Devlounge-APIs, please be aware that our systems are standards-compliant and expect the correct usage of fault-constructs in the event of an error.

JSON-RPC as well as XML-RPC both defined the way in which errors are reported back to the calling endpoint. While some frameworks and implementations of these specifications may contain an automatic handling and reporting of errors, others might not.

If you need information on how these constructs are created, feel free to take a look at the examples in this wiki-page.

XML-RPC Error Messages

If you need to format XML-RPC fault structs for yourself, please stay true to the way it has been put into the specification:

<?xml version="1.0"?>
<methodResponse>
    <fault>
        <value>
            <struct>
                <member>
                    <name>faultCode</name>
                    <value><int>-1</int></value>
                </member>
                <member>
                    <name>faultString</name>
                    <value><string>INVALID_XML</string></value>
                </member>
            </struct>
        </value>
    </fault>
</methodResponse>

You can send back an error code in the field “faultCode” and a more verbose error message as the “faultString”. Faults are automatically recognized by the Devlounge's systems and are tied into the API tests in the technical integration of your game.

The more verbose your error messages and/or error codes are, the easier it might be to debug problems occurring during the integration.

JSON-RPC Error Messages

If you need to create JSON-RPC error constructs for yourself, please stay true to the specifications:

{"jsonrpc": "2.0", "error": {"code": -32600, "message": "Invalid Request."}, "id": null}

As outlined in the specifications, errors generated by the developer should keep their corresponding error codes in the range between -32099 and -32000. More common errors and their codes are already available and can be found in the JSON-RPC documentation.

en/apis/error_handling.txt · Last modified: 2012/08/31 10:08 (external edit)
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0