Skip to end of metadata
Go to start of metadata

Generic Request Message

All the REST services use a common XML Request message (payload) to send/request information from individual REST API calls.

This request message is sent as the BODY in HTTP PUT/DELETE operation.

The format of the request (delivered in the BODY) is:

FreeText (Repeats 0..n)

This is an OPTIONAL freetext description of the request intended for displaying to the platform admin. The text is sent always in English, but additional elements in different languages maybe provided if so desired.

 Attribute 'language'
  http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
  Commonly used:

Code

Language

en

English

fi

Finnish

sv

Swedish

Value (Repeats 0..n)

This element contains additional information about the request intended for the client to refine.

 Attribute 'type'
  Defines the role and meaning of the element value.
  Valid types:

?Appendix- LIST Value types

Examples

  • No labels