User Manual

Chapter 1: Using the REST API 24
Legacy REST GetSearchResults Input
Version 3.7
&TrackingProvider=MyTrackingProvider&TrackingId=MyTrackingId&CJSID=MyCJSID&Schema=1&Compati
bilityLevel=491
All applications must be migrated from legacy input parameters to unified schema input parameters.
Please see the following section of this guide for the unified schema GetSearchResults input
parameters: “GetSearchResults Input Parameters” on page 10. The following table describes the
legacy GetSearchResults affiliate parameters.
Legacy Input Parameters for GetSearchResults
All applications must be migrated from legacy input parameters to unified schema input parameters.
Please see the following section of this guide for the unified schema GetSearchResults input
parameters: “GetSearchResults Input Parameters” on page 10. Formerly, REST input parameters for
GetSearchResults were similar to the Legacy XML API input parameters for GetSearchResults. Now,
you can specify unified schema parameters for GetSearchResults. The unified schema is
standardized and uses objects for data exchange.
Until you migrate all REST applications from legacy input parameters to unified schema input
parameters, this section of the REST API Guide may be applicable to GetSearchResults calls because
this section contains information about legacy GetSearchResults input.
Table 1-4 Legacy GetSearchResults Parameters for Affiliate Tracking
Parameter Required? Data Type Purpose
TrackingProvider N Integer Specifies the third party, e.g. Commission Junction, who is your
tracking partner (tracking provider).
Depending on your tracking partner, specify one of the
following values. Not all partners are valid for all sites.
1 = Commission Junction
2 = Be Free
3 = Affilinet
4 = TradeDoubler
5 = Mediaplex
6 = DoubleClick
7 = Allyes
8 = BJMT
TrackingId N String Specifies an ID to identify you to your tracking partner
(tracking provider).
The value you specify is obtained from your tracking partner.
For example, in the case of Commission Junction, this
parameter is the PID given to you by Commission Junction.
CJSID N String Optional value that specifies the Commission Junction Shopper
ID (SID). This parameter is applicable if you used 1
(Commission Junction) for the TrackingProvider
parameter.
CJSID is a user-defined ID number for identifying specific
search-result placement of Commission Junction affiliates. You
can specify up to 30 characters (plus HTML-encoded spaces,
commas, periods, and the “@” character), but you cannot
specify zero or non-alpha-numeric characters.