REST basics

Test Program

You can use the RESTClient to test run requests.

HTTP Method

Have a look at the different objects on what methods they support.

Typically they support GET, PUT, sometimes POST and DELETE.

Headers

untermStrich supports the following headers:

ACCEPT

You can change the output format using the ACCEPT header.

Supported are:

• XML (default): application/xml
• JSON: application/json
• PHP serialized application/vnd.php.serialized

Body

Body is only used for PUT and POST.

The request body has to be encoded according to application/x-www-form-urlencoded and the charset has to be UTF-8. Don't forget about the urlencoding for strings.

Further details on how the request body should look like can be found in the explaination of the models.

Authentication

The REST connection asks for an untermStrich username and password using Basic access authentication.

You have to create a special „REST user“ for these actions.

The user has to have the right RESTSERVICES (48) set to MANAGEMENTPLUS (0).

Errors

If untermStrich has to reply with an error, it replies with a HTTP status codes Error (500) instead of OK (200).

The return body is the error message as a plain text.

Encoding

Always use UTF-8.

US-Version

untermStrich from X2 sends the header US-Version, which allows to dedect the untermStrich version running.