CMS Query

CMS Queries are set up based on CMS objects set up in the CMS Query section of iVector, which returns a set of XML back through the iVectorconnect API.

There is a module within iVector called "CMS Queries". This module is used to set up queries based on the CMS setup in your system with the aim of exposing the content to iVectorConnect. Upon accessing the CMS Query form within iVector you will find a screen resembling this:

Once you click on one of these queries the fields within this query will display:

You can give the Query a name that it will be referred to as through connect, also the fields that are to be added to the query - either from the CMS fields available from that CMS object, or from the base iVector table the CMS object is linked to. The 'Preview' tab will give you a dry run of the data that will be output to connect when the query is called.

A CMS query is called using the same iVectorConnect URL with the following syntax.

Request

XML Structure

The structure of this XML will be:

Response

The response returned will contain the fields selected in the CMS Query to be returned in the request

XML Structure

Examples

Request

This will request a CMS Query called "Country".

<CMSQueryRequest>

<LoginDetails>

<Login>test</Login>

<Password>test</Password>

</LoginDetails>

<QueryName>Country</QueryName>

</CMSQueryRequest>

Response

<CMSQueryResponse>

<ReturnStatus>

<Success>true</Success>

<Exceptions/>

<ThirdPartyErrors/>

</ReturnStatus>

<CustomXML>

<CMSQuery>

<Country>

<Code>SPN</Code>

<Country>Spain</Country>

<InBrief>...</InBrief>

<InDetail>...</InDetail>

<PageTitle></PageTitle>

<MetaKeywords></MetaKeywords>

<MetaDescription></MetaDescription>

<MyTestTextBox></MyTestTextBox>

<DescriptionAUsite></DescriptionAUsite>

<Code>SPN</Code>

<Name>Spain</Name>

<Country_Imagess>

<Country_Images>

<Images>DataObjects/Country/Image/image_1_1_v1.jpg</Images>

<Images_ImageTitle/>

<Images_AdditionalInfo/>

</Country_Images>

<Country_Images>

<Images>DataObjects/Country/Image/image_1_2_v1.jpg</Images>

<Images_ImageTitle/>

<Images_AdditionalInfo/>

</Country_Images>

<Country_Images>

<Images>DataObjects/Country/Image/image_1_3_v1.jpg</Images>

<Images_ImageTitle/>

<Images_AdditionalInfo/>

</Country_Images>

<Country_Images>

<Images>DataObjects/Country/Image/image_1_4_v1.jpg</Images>

<Images_ImageTitle/>

<Images_AdditionalInfo/>

</Country_Images>

<Country_Images>

<Images>DataObjects/Country/Image/image_1_5_v1.jpg</Images>

<Images_ImageTitle/>

<Images_AdditionalInfo/>

</Country_Images>

<Country_Images>

<Images>DataObjects/Country/Image/image_1_6_v1.jpg</Images>

<Images_ImageTitle/>

<Images_AdditionalInfo/>

</Country_Images>

<Country_Images>

<Images>DataObjects/Country/Image/image_1_7_v1.jpg</Images>

<Images_ImageTitle/>

<Images_AdditionalInfo/>

</Country_Images>

<Country_Images>

<Images>DataObjects/Country/Image/image_1_8_v1.jpg</Images>

<Images_ImageTitle/>

<Images_AdditionalInfo/>

</Country_Images>

<Country_Images>

<Images>DataObjects/Country/Image/image_1_9_v1.jpg</Images>

<Images_ImageTitle/>

<Images_AdditionalInfo/>

</Country_Images>

</Country_Imagess>

</Country>

</CMSQuery>

</CustomXML>

</CMSQueryResponse>