Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

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:

Code Block
xml
xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Request version="1.0">
     <FreeText language="ISO639-1 Languagecode"></FreeText>
     <Content>
        <Group>
           <Value type="ValueType"></Value>
        </Group>
     </Content>
</Request>

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

Code Block
xml
xml
PUT http://test-api.apix.fi/pricing?uid=8043a060-ee47-430a-9f65-a6d8a630cb60&t=20100601130021&d=SHA-256:5e308ea8479f348fdc9e586137ff07d4c27bd713e26fbe4885b00c3823c9bd12

Date: Fri, 11 Jun 2010 23:59:59 GMT
Content-Type: text/xml
Content-Length: 516

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Request version="1.0">
     <Content>
        <Group>
		<Value type="Sender">2332748-7</Value>
		<Value type="Receiver">0838105-5</Value>
		<Value type="MessageType">invoic</Value>
		<Value type="LetterPages">4</Value>
	 </Group>
	 <Group>
		<Value type="Sender">2332748-7</Value>
		<Value type="Receiver">0835996-6</Value>
		<Value type="MessageType">invoic</Value>
		<Value type="LetterPages">12</Value>
	 </Group>
     </Content>
</Request>