.. _calling_conventions:

XML core basic calling conventions
==================================

https://[your-id].tsd-aff.com/cgi-bin/xml_core.exe


- Data must be provided in a POST request 
- Suggested content type header is **text/xml**. 

- Any call can contain the "lang" element for language. It should not change during a particular session.

Fail codes
----------

- If a request fails then the returned element will contain the elements
  "fail\_code" and "fail\_desc". 
- The fail code is a numeric value indicating the problem

There are also eight generic errors. If a generic error occurs then
the returned element will always be "script\_error" and will contain the
elements "error\_code" and "error\_desc". 

The eight error codes and their meanings are as follows:

1. A bad username has been provided in the "user\_id" element.

2. User authorisation has failed. Either your password or crypto\_block
   are invalid for the given user\_id.

3. A connection could not be established to the backend ticketing
   system.

4. Your IP address is on a network forbidden from using the core.

5. A connection could not be established to the main database.

6. Membership authentication has failed. This should never happen as
   membership schemes are not being used with the XML core.

7. Bad data has been supplied to the script.


It is possible to access the error information in different formats, supplying the necessary type required in the "mime\_text\_type" element: "plain", "html", "xml" or "vnd.wap.wml"