API help
Data types
Here is a reference documentation for data types this API supports.
string
Any character in quotes. Range of allowed values can be limited by enumerating correct values in the parameter description. In that case, the parameter can contain only specified values and everything else is an error.
int
Any number in range from -9223372036854775808 to 9223372036854775807.
float
Floating point number.
bool
Boolean value: true/false.
struct
Complex structure of items. Each item has it's identifier and value. Identifier is anything that begins with letter from range [a-zA-Z] and contains only letters a-z A-Z, numbers 0-9 and underscore (_) and hyphen (-). Value is any valid data type specified by method description.
array
Homogenous array of values of single type. Array can have any number of items of type defined by method description.
date
Day (year, month, day) in format specified by ISO8601. That means, that the date must be in format YYYY-MM-DD where YYYY means year with exactly four digits, MM means month with exactly two digits (January is 01) and DD means day in the month with exactly two digits (01 is first day in month).
For example, January 2nd 2015 will be written as 2015-01-02.
Another valid representation is omitting the hyphens and specifying the date as YYYYMMDD with same meaning as described above.
time
Time (hour, minute, second) in format specified by ISO8601. That means, that the time must be in format HH:MM:SS where HH is hour in 24 houd format in exactly two digits. MM is minutes (00-59) with exactly two digits and SS is seconds (00-59) with exactly two digits.
For example, two minutes and three seconds after 1pm will be written as 13:02:03.
You can optionally omit the colons and write the time as HHMMSS, for example 130203.
You can also omit the rightmost fields, which will be substituted by zeroes. So you can write 13:02 or 1302, both representing the same time as 13:02:00. Also, you can write only 13, which represents same time as writing 13:00:00.
datetime
Datetime (year, month, day, hour, minute, second) in format specified by ISO8601. That means format of <date>T<time>.
The <date> is any date as described above in the date data type.
The <time> is any time as described above in the time data type.
The T separator of date and time parts is mandatory.
optional
Any parameter can be marked as optional. That means, that you can safely ommit it without receiving error message.
null
Any parameter also can be marked as nullable. That means, that instead of required value, you can pass the NULL.
default
If the parameter has default value, that value will be used when parameter is ommited.
requires
If parameter has any required parameters specified using the requires annotation, it means that if you want to pass this parameter, you must also pass parameters specified in the required annotation.
excludes
If parameter has any excluded parameters, that means that if you want to use this parameter, you cannot use any of parametere specified in the excluded annotation.