The following section describes the low-level communication protocol between the CMS and Selligent. The protocol is a light weight XML based information exchange over http(s). Client helper objects are available in most commonly used programming languages that let you communicate with Selligent very easily.
NOTE: In-depth knowledge of the underlying communication is often not required by implementers and is only added for completeness.
Request Package
The site will create an XML package containing all parameters that have been posted. This package will be sent to the Selligent WebAgent for processing.
<REQUESTID="8q828w_C888_">
<DATA>
<FIELDNAME="@PARAM1">Value
1</FIELD>
<FIELDNAME="@PARAM2">Value
2</FIELD>
<FIELDNAME="@PARAM3">Value
3</FIELD>
<FIELDNAME="@PARAM4">Value
4</FIELD>
</DATA>
</REQUEST>
The ID attribute contains the hashcode that was received on the URL. The DATA section contains one node for every parameter (GET or POST) that has been received by the CMS. All request parameters are prefixed with an @.
Response Package
The response package contains an XML document with values for a list of returned variables
<RESPONSE>
<TYPE>PAGE</TYPE>
<HTML>This
is an example webpage</HTML>
<BODYATTR>leftmargin=0</BODYATTR>
<HEAD></HEAD>
</REQUEST>
The table below contains an overview of all possible values for the TYPE variable.
|
Value |
Description |
|
Page |
The XML document contains the different parts of a web page. To provide easy integration in existing sites the HTML document is returned in different fragments: HTML (the part between the BODY tags), BODYATTR, HEAD, DOCTYPE |
|
Redirect |
The execution of the last request resulted in a redirect towards a new URL. The calling CMS should redirect the user to the value of the field 'url' |
|
Error |
An error occurred during the processing of this request |
|
SurveyPage |
A SurveyPage returns the same structure as a page |
