Success and Error Messages

If the request is successful, HTTP calls to RESTful Web Service SDK methods return a message of the following format:

<success>
    <message>A successful message</message>
    <id>An identifier</id>
</success>

Where the <id> element contains the identifier of the object concerned, such as a query, document, variable, or style. In some rare cases, <id> is not present.

If the request was unsuccessful, the call returns a message of the following format:

<error>
    <error_code>An error code</error_code>
    <message>An error message</message>
</error>
The following table shows the possible Web Intelligence RESTful Web Service SDK error codes. Each of these codes corresponds to a category of error messages.
Error Code Description
WSR 00001 The user does not provide session token. The session is not found.
WSR 00002 The session token is invalid.
WSR 00100 A rule is not respected.
WSR 00101 An argument is not correct.
WSR 00102 The request body is malformed.
WSR 00400 The user tries to get a resource that does not exist.
WSR 00401 The user tries to create a resource that already exist.
WSR 00402 The user fails to access a resource.
WSR 00501 The user tries to perform an action that is not supported.
WSR 00999 This is an internal error.

The BI Semantic Layer RESTful Web Service SDK error codes are more specific. Each of these codes corresponds to a particular error message and to a specific error. See the Error Messages Explained guide for a detailed description of the error messages.

Note The API reference chapters do not describe the XML outputs returned by the methods if an error occurs.

Example

400 Error Code
Content-Type: application/xml
HTTP Response Code: 404 
<?xml version="1.0" encoding="UTF-8"?>
<error>
    <error_code>400</error_code>
    <message>The expression '[DUMMY]' can not be found in the document dictionary.</message>
</error>

Example

401 Error Code
Content-Type: application/xml
HTTP Response Code: 400 
<?xml version="1.0" encoding="UTF-8"?>
<error>
    <error_code>401</error_code>
    <message>The resource of type 'Report' with identifier '154769'
        already has an inner resource of type 'Data filter'.</message>
</error>