Global parameters

Some Query Parameters (&param=...) and HTTP headers are handled by most or all services.

Charset

  • Default: UTF-8
  • Query Parameter: charset=
  • HTTP Header: Accept-Charset

The character encoding that should be used for the response. On POST requests, this also describes the encoding of the pushed data.

Example:

Use german date format on all date fields:

https://rds.rasch.de/....&dateFormat=dd.MM.YYYY

Date Format

  • Default: ISO 8601 (yyyy-MM-dd)
  • Query parameter: dateFormat=
  • HTTP Header: none

Provide a custom date format string that should be applied to date fields. Alternative, you may supply 'datetime' as value, which will be translated to a full ISO 8601 datetime string with milliseconds (if available) and timezone.

Line Wrapping

  • Method: GET
  • Default: empty (all fields)
  • Query Parameter: linewrap=
  • HTTP Header: X-RDS-Linewrap

Normaly, linewraps within text fields will be represented by a newline characters (NL, 0x10). If you need an alternative representation, e.g. "\n" (for Microsoft Excel's CSV variant) or "<br>" (for HTML pages), you can use this parameter to define your own newline character instead. Please note that there is no escaping when this value occurs within the regular field's value.

Fields

  • Method: GET
  • Default: empty (all fields)
  • Query Parameter: fields=
  • HTTP Header: X-RDS-Fields

If not empty this parameter defines the fields or columns that should be included within the response. When using the CSV output format this parameter also defines the column order.

Multiple fields can either be defined by using a comma-separated list, or by repeating the parameter or header fields multiple times. The following examples are equivalent:

https://....&fields=name,zipcode,city

https://....&fields=name&fields=zipcode&fields=city

X-RDS-Fields: name,zipcode,city

X-RDS-Fields: name
X-RDS-Fields: zipcode
X-RDS-Fields: city

Additionally, it's possible to rename fields (using ' as NEWNAME' behind the fieldname, remember that spaces must be replaced with %20 in URLs) and to supply a default value (by separating both using a doublecolon):

$ curl -s -o- -u :KEY https://rds.rasch.de/v2/articles/stock?fields=id,stock,date
[ {
  "id" : "498301",
  "stock" : 347,
  "date" : null
} ]


$ curl -s -o- -u :KEY https://rds.rasch.de/v2/articles/stock?fields=id%20AS%20article%20number,stock%20AS%quantity,date
[ {
  "article number" : "498301",
  "quantity" : 347,
  "date" : null
} ]

$ curl -s -o- -u :KEY https://rds.rasch.de/v2/articles/stock?fields=id,stock,date:unknown
[ {
  "id" : "498301",
  "stock" : 347,
  "date" : "unknown"
} ]

# Doing both
$ curl -s -o- -u :KEY https://rds.rasch.de/v2/articles/stock?fields=id,stock,date%20as%20availability:unknown
[ {
  "id" : "498301",
  "stock" : 347,
  "availability" : "unknown"
} ]

A special value for this parameter is a single asterix (fields=*) which means that all fields will be included in a random order. This value might be relevant when using the CSV output format where the fields parameter is mandatory.

Limit

  • Method: GET
  • Default: empty (all entries)
  • Query Parameter: limit=
  • HTTP Header: X-RDS-Limit

For requests that may return multiple entries this parameter defines that maximum number of results that should be printed.

Offset

  • Method: GET
  • Default: 0
  • Query Parameter: offset=
  • HTTP Header: X-RDS-Offset

For services that may return multiple entries this parameter defines the position from where the output should start (starting with 0).

Language

  • Method: GET
  • Default: de
  • Query Parameter: lang=
  • HTTP Header: Accept-Language

For services that supports multiple languages (like /articles/items) this parameter defines the preferred language as ISO 639-1 Code

Trial Upload

  • Method: POST
  • Default: not set
  • Query Parameter: dryrun=

If set, the transaction of a POST request is always rolled back. This means you can do a full test if the uploaded data would have been accepted.

Silent mode

  • Method: POST
  • Default: false
  • Query Parameter: quiet=

Normally, a service will either respond with SUCCESS or DRYRUN after successfully processing uploaded data. You can suppress this message by adding quiet=false to the URL. This might be required when using a WebDAV client for file upload that doesn't expect any response body.