Search Services

General

This page offers additional information for using Search Services.

To return to the main index, please click here.

Further technical details on Search Services are available at:

Available Operations

GetBrands

Retrieve a list of Brands when passed a piece of text to search upon. Each Brand contains a Product entity. The BrandRefs or ProductRefs returned can be passed to RunItemSearch to allow a more specific brand search.

Parameters:

Response:

GetCountries

Retrieve a list of all countries which can be searched upon.

Parameters:

Response:

GetCategories

Retrieve all categories which can be searched upon.

Parameters:

Response:

GetRegions

Retrieve a list of all regions which can be searched upon.

Parameters:

Response:

RunItemSearch

Runs a search to return an array of Item. These items will hold details for each item, such as Brand, Title, Transmission Date etc. Each item will include a link to the items thumbnail (a 115x92 JPEG image), and whenever available a link to a preview file and source file. Currently preview and source files will only be available for Portfolio results, and preview files are only ever available for TV and Radio items.

Parameters:

Response:

RetrieveItemPage

Retrieve a page of items from a search already run.

Parameters:

Response:

RunScheduleSearch

Access to this service is not granted by default. Please speak to Xtreme if you require access.

Runs a search to return an array of events. These events hold minimal information, just the ItemRef, Region, Transmission Date and Cost.

Parameters:

Response:

RetrieveSchedulePage

Access to this service is not granted by default. Please speak to Xtreme if you require access.

Retrieve a page of events from an event search already run.

Parameters:

Response:

GetAdvertiser

Access to this service is not granted by default. Please speak to Xtreme if you require access.

Access Advertiser Ref and Name.

Parameters:

Response:


Definitions

Item


It consists of an Advertiser, an ItemRef, an array of Brand expressed in the Item with the name "Brands", an array of Category expressed with the name "Categories", a Country, a Region, a Media, a TransmissionDate, a Version, a Duration, a Title string, a StoryLine string, a Description string, a Thumbnail, a PreviewLink, a SourceFiles, an OriginalFiles, a Translation



Thumbnail

Format: WSFile

Description: ***Thumbnail Description***



Brand

It consists of a BrandRef int, a BrandText string and a Product



Category

It consists of a CategoryRef int, a Level int, a Name string and a ChildCategories that consist of an array of Category



Country

It consists of a ISO3166Code string, example "", a CountryText string, a CountryRef int and a Name string.



Region

It consists of a RegionRef int, a RegionText string, a Media, a ISO3166Code string and a RegionType



Media

It consists of a SourceType enum



       TransmissionDate

       String format. Example: "05-01-2007", "05/01/2007","DD-MM-YYYY or DD/MM/YYYY"

 

Version

It consists of a VersionRef int and a Name string format



Duration

It consists of a DurationRef int and a Name string



WSFile

It consists of a Name string, a Type with the format FileType, and a Url string



PreviewLink

Format: WSFile

Description: ***PreviewLink Description***



SourceFiles

Format: WSFile

Description: ***SourceFiles Description***



Translation

It consists of a Type with the format TranslationType, a CreatedDate DateTime format, a HeadLine string, Support string and Payoff string



Product

It consists of a ProductText string and a ProductRef int



FileType

It is an enumeration type



TranslationType

It is an enumeration type



SourceType

It is an enumeration type



OriginalFiles

Format: Array of string

Description:



Advertiser

It consists of an AdvertiserRef int and a Name string





































Further technical details:


Search Web Service Version 1.0

Search Service Web Service Version 2.0