Odyssee Mobile

API User Guide

As stated in the previous section, you can choose whether you want to work with either xml or json, just specifiy the content type in the request headers.

Xml: Content-Type: application/xml; charset=utf-8
Json: Content-Type: application/json; charset=utf-8

When you pass entities in xml or json you need to adhere to some standards for passing values of certain data types.

XML Data Types

All rules for the xml datatypes are available on http://www.w3.org/TR/xmlschema-1/ or: http://www.w3schools.com/schema/

DateTime

The dateTime data type is used to specify a date and a time.

The dateTime is specified in the following form "YYYY-MM-DDThh:mm:ss.fff" where:

  • YYYY indicates the year;
  • MM indicates the month (with a leading zero);
  • DD indicates the day (with a leading zero);
  • T indicates the start of the required time section;
  • hh indicates the hour (with a leading zero);
  • mm indicates the minute (with a leading zero);
  • ss indicates the second (with a leading zero);
  • fff indicates the millisecond (with 2 leading zeros);

Note: All components are required!

E.g. The value for 2 may 2013 at 15:30:59.123 would be: 2013-05-02T15:30:59.123

Note: The UTC dateTime is specified in the following form "YYYY-MM-DDThh:mm:ss.fffZ"


Decimals

The decimal data type is used to specify a numeric value.

  • Decimal separator: ‘.’
  • Thousand separator: prohibited;

E.g. for 123 456,78 is 123456.78

Note: The maximum number of decimal digits you can specify is 18!


Booleans

Pass true or false.

Json Datatypes


DateTime

The dateTime data type is used to specify a date and a time.

The dateTime is specified in the following form "YYYY-MM-DDThh:mm:ss.fff" where:

  • YYYY indicates the year;
  • MM indicates the month (with a leading zero);
  • DD indicates the day (with a leading zero);
  • T indicates the start of the required time section;
  • hh indicates the hour (with a leading zero);
  • mm indicates the minute (with a leading zero);
  • ss indicates the second (with a leading zero);
  • fff indicates the millisecond (with 2 leading zeros);

Note: All components are required!

E.g. The value for 2 may 2013 at 15:30:59.123 would be: 2013-05-02T15:30:59.123

Note: The UTC dateTime is specified in the following form "YYYY-MM-DDThh:mm:ss.fffZ"


Decimals

Use the double precision floating-point format of JavaScript.


Booleans

Pass true or false.