SmartFocus Cloud Service APIs

Transcription

1 SmartFcus Clud Service APIs Dcument name Campaign Management REST API Guide Service Campaign management fr managing campaigns Prtcl REST ver HTTP Versin 11.8 Last updated n June 23, 2015

2 Table f Cntents Table f Cntents Table f Cntents 2 Intrductin 7 Abut This Dcument 7 Abut SmartFcus APIs 7 Feedback 7 Supprt Optins 7 Training Optins 7 SmartFcus's Prducts and Services 7 Disclaimer 7 Overview f the Campaign Management API 8 Campaign Management API Use Cases 13 Getting Started with Integratin 15 Prerequisites 15 Quick Start 15 Integratin Using APIs 15 Rules 16 URL Encding Cnsideratins (fr HTTP GET methds nly) 16 Security 17 Cnnectin 18 Recmmended Tken Usage 18 Open Cnnectin 19 Clse Cnnectin 21 Message 22 Hw t Use Tracked URLs in the Message Bdy 22 Hw t Autmatically Track All Links 22 The Message Object 22 Create Message 24 Create SMS Message 26 Create Message (POST) 28 Delete Message 31 Update Message 32 Update Message (POST) 35 Clne Message 38 Get Message 39 Get Last Messages 40 Get Last SMS Messages 41 Get Messages by Field 42 Get SMS Messages by Field 43 Get Messages by Perid

3 Table f Cntents Get Message Preview 45 Get SMS Message Preview 47 Track All Links 48 Untrack All Links 49 Track Link by Psitin 50 Untrack Link by Order 51 Get All Tracked Links 52 Get All Unused Tracked Links 53 Get All Trackable Links 54 Test HTML Validity 55 Test Message n a Grup 56 Test Message n a Member 57 Test SMS Message 58 Get Default Sender 59 Get Validated Alternate Senders 60 Get Unvalidated Senders 61 URL 62 Create Standard URL 62 Create and Add Standard URL 63 Create Unsubscribe URL 64 Create and Add Unsubscribe URL 66 Create Persnalized URL 67 Create and Add Persnalized URL 68 Create Update URL 69 Create and Add Update URL 70 Create Actin URL 71 Create and Add Actin URL 73 Create Mirrr URL 75 Create and Add Mirrr URL 76 Add a Share Link 77 Update URL by Field 79 Delete URL 80 Get URL by Order 81 Segment 82 The Segment Object 82 The Segment Criteria Objects 82 Create Segment 89 Delete Segment 91 Update Segment 93 Add String Demgraphic Criteria t a Segment

4 Table f Cntents Add Numeric Demgraphic Criteria t a Segment 98 Add Date Demgraphic Criteria t a Segment 101 Add Campaign Actin Criteria t a Segment 106 Add Campaign Trackable Link Criteria t a Segment 108 Add Trigger Campaign Actin Criteria t a Segment 111 Add Trigger Campaign Trackable Link Criteria t a Segment 114 Add Scial Criteria t a Segment 117 Add Recency Criteria t a Segment 121 Add DataMart Criteria t a Segment 124 Include r Exclude a Segment frm Anther Segment 126 Get Segment by ID 128 Get Segment List 129 Get Segment Criteria 130 Get DataMart Segment List 131 Delete Segment Criteria 132 Update the String Demgraphic Criteria f a Segment 133 Update the Numeric Demgraphic Criteria f a Segment 136 Update the Date Demgraphic Criteria f a Segment 138 Update the Campaign Actin Criteria f a Segment 143 Update the Campaign Trackable Link Criteria f a Segment 145 Update the Trigger Campaign Actin Criteria f a Segment 148 Update the Trigger Campaign Trackable Link Criteria f a Segment 150 Update the Scial Criteria f a Segment 153 Update the Recency Criteria f a Segment 157 Update the DataMart Criteria f a Segment 160 Update the Included/Excluded Segment Criteria f a Segment 162 Cunt Segment 164 Cunt Distinct Segment Members 165 Campaign 166 The Campaign Object 166 Create Campaign 167 Create Campaign with Analytics 169 Create Campaign (POST) 171 Delete Campaign 173 Update Campaign 174 Update Campaign (POST) 176 Pst Campaign 179 Unpst Campaign 180 Get Campaign 181 Get Campaigns by Field

5 Table f Cntents Get Campaigns By Status 185 Get Campaigns By Perid 186 Get Campaign Status 188 Get Last Campaigns 189 Test Campaign n a Grup 190 Test Campaign n a Member 191 Pause Campaign 192 Unpause Campaign 193 Get Campaign Reprt 194 Get Campaign Snapsht Reprt 196 Get Campaign Summary List 197 Dynamic Cntent 201 The Banner Object 201 Create Dynamic Cntent Blck 202 Create Dynamic Cntent Blck (POST) 204 Delete Dynamic Cntent Blck 206 Update Dynamic Cntent Blck 207 Update Dynamic Cntent Blck POST 209 Clne Dynamic Cntent Blck 211 Get Dynamic Cntent Blck Preview 212 Get Dynamic Cntent Blck 214 Get Dynamic Cntent Blcks by Field 215 Get Dynamic Cntent Blcks by Perid 217 Get Last Dynamic Cntent Blcks 218 Track All Dynamic Cntent Blck Links 219 Untrack All Dynamic Cntent Blck Links 220 Track Dynamic Cntent Blck Link by Psitin 221 Untrack Dynamic Cntent Blck Link by Order 222 Get All Dynamic Cntent Blck Tracked Links 223 Get All Unused Dynamic Cntent Blck Tracked Links 224 Get All Dynamic Cntent Blck Trackable Links 225 Dynamic Cntent Blck Links 226 Create Dynamic Cntent Blck Standard Link 226 Create and Add Dynamic Cntent Blck Standard Link 227 Create Dynamic Cntent Blck Unsubscribe Link 228 Create and Add Dynamic Cntent Blck Unsubscribe Link 230 Create Dynamic Cntent Blck Persnalized Link 231 Create and Add Dynamic Cntent Blck Persnalized Link 232 Create Dynamic Cntent Blck Update Link 233 Create and Add Dynamic Cntent Blck Update Link

6 Table f Cntents Create Dynamic Cntent Blck Actin Link 236 Create and Add Dynamic Cntent Blck Actin Link 238 Create Dynamic Cntent Blck Mirrr Link 239 Create and Add Dynamic Cntent Blck Mirrr Link 240 Update Dynamic Cntent Blck Link by Field 242 Get Dynamic Cntent Blck Link by Order 244 Webfrms 245 The Webfrm Object 245 Create a Webfrm 248 Update a Webfrm 255 Cpy a Webfrm 263 Update a Webfrm's Status 265 Get a Webfrm 267 Get Webfrm Integratin Cde 269 Test Grup 272 The Test Grup Object 272 Create a Test Member 273 Delete a Test Member 274 Create an SMS Test Member 275 Get a Test Member 276 Get Test Members 277 Create a Test Grup 278 Create a Test Grup (POST) 279 Delete a Test Grup 281 Add Test Member t a Test Grup 282 Remve Test Member 283 Update a Test Grup (POST) 284 Get Test Grup 286 Get All Test Grups 287 Reference

7 Intrductin Intrductin Abut This Dcument This dcument is a reference dcument fr using SmartFcus APIs. It des nt explain the purpse r functins f SmartFcus features. Fr infrmatin n these features, please cnsult the SmartFcus Online Help r the SmartFcus User Guide. This dcument is intended fr develpers and prject managers. Abut SmartFcus APIs An Applicatin Prgramming Interface (API) is a surce cde interface that a cmputer system r prgram library prvides in rder t supprt requests fr services made frm anther cmputer prgram. The gal f SmartFcus APIs is t ffer custmers the ability t pilt a cmplete campaign frm their wn system. Feedback The Campaign Management REST API Guide is cnstantly being enhanced t prvide yu with mre and mre infrmatin n using SmartFcus API methds. If yu can't find the infrmatin yu need r want t prvide feedback, simply drp us a line at [email protected]. We lk frward t hearing frm yu! Supprt Optins SmartFcus prvides yu with a dedicated Accunt Manager t accmpany yu thrughut the executin f yur prjects in SmartFcus. Yur Accunt Manager is the gateway t supprt, training, and prfessinal services. Wrking with yur Accunt Manager, yu can rely n SmartFcus s deliverability and technical supprt teams fr cmplex trubleshting and ptimizatin. Training Optins SmartFcus prvides fully cmprehensive training ranging frm basic prduct training thrugh t advanced mdules and bth strategic and tactical marketing curses. The training curses are designed t help yu increase prductivity, develp new methds, and share best practices t ptimize yur , mbile, and scial marketing campaigns. T get mre infrmatin n training, please cntact yur Accunt Manager. SmartFcus's Prducts and Services Fr mre infrmatin n SmartFcus's prducts and services, please see Disclaimer While the infrmatin cntained in this publicatin is believed t be true and accurate, SmartFcus cannt accept any legal respnsibility fr any errrs r missins cntained herein. All infrmatin is subject t change withut ntice. Nne f the material in this publicatin may be reprduced r transmitted in whle r in part withut the express written permissin f SmartFcus. 7

8 Overview f the Campaign Management API Overview f the Campaign Management API The Campaign Management API allws yu t: Create, edit, and delete and SMS Messages Create, edit, and delete Dynamic Cntent Blcks Add, edit, track, and untrack Message and Dynamic Cntent Blck links Create, edit, and delete Segments Retrieve lists f Messages, Dynamic Cntent Blcks, and Campaigns Fr further infrmatin n hw t create, edit, and manage campaigns, please cnsult the SmartFcus User Guide r SmartFcus Online Help. The fllwing methds are available: Cnnectin Methd Open Cnnectin Clse Cnnectin This methd prvides a sessin tken when given valid credentials. This methd terminates the sessin tken. Message Methd Create Message Create SMS Message Create Message (POST) Delete Message Update Message Update Message (POST) Clne Message Get Message Get Last Messages Get Last SMS Messages Get Messages by Field Get SMS Messages by Field Get Messages by Perid Get Message Preview Get SMS Message Preview Track All Links Untrack All Links Track Link by Psitin Untrack Link by Order Get All Tracked Links Get All Unused Tracked Links Get All Trackable Links Test HTML Validity This methd creates an . This methd creates an SMS message. This methd creates an . This methd deletes a message. This methd updates a message field. This methd updates an r SMS message. This methd clnes a message. This methd retrieves a message by its ID. This methd retrieves the list f the last s created. This methd retrieves the last SMS messages created. This methd retrieves a list f s that cntain the given value in the specified field. This methd retrieves a list f SMS messages that cntain the given value in the specified field. This methd retrieves a list f messages frm a given perid. This methd prvides a preview f an . This methd prvides a preview f an SMS message. This methd activates tracking fr all links in an . This methd deactivates link tracking fr all links in an . This methd tracks a link based n its psitin in an . This methd untracks a link based n its rder number. This methd retrieves a list f all the tracked links in an . This methd retrieves the unused tracked links fr an . This methd retrieves all the trackable links in an . This methd verifies the validity f the HTML used in yur

9 Overview f the Campaign Management API Methd Test Message n a Grup Test Message n a Member Test SMS Message Get Default Sender Get Validated Alternate Senders Get Unvalidated Senders This methd sends a test campaign t a grup f recipients. This methd sends a test campaign t a member. This methd sends a test SMS message t a member. This methd retrieves the address f the default sender fr the SmartFcus accunt. This methd retrieves the list f validated alternate senders fr the SmartFcus accunt. This methd retrieves the list f the unvalidated alternate senders fr the SmartFcus accunt. URL Nte: T create r add links in REST, yu must use the HTTP GET Query String (QS) frmat: HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call: Segment Methd Create Segment Delete Segment Update Segment Add String Demgraphic Criteria t a Segment Add Numeric Demgraphic Criteria t a Segment Add Date Demgraphic Criteria t a Segment Add Campaign Actin Criteria t a Segment Add Campaign Trackable Link Criteria t a Segment This methd creates a segment. Nte: It is imperative that yur segment cntains members and that all necessary criteria is defined. If a segment withut criteria is used in a campaign, all members in the database will be selected. This methd deletes a segment. This methd updates a segment. This methd add alphanumeric demgraphic criteria t a segment. This methd adds numeric demgraphic criteria t a segment. This methd adds date demgraphic criteria t a segment. This methd adds campaign actin criteria t a segment. This methd adds campaign tracked link criteria t a segment. 9

10 Overview f the Campaign Management API Methd Add Trigger Campaign Actin Criteria t a Segment Add Trigger Campaign Trackable Link Criteria t a Segment Add Scial Criteria t a Segment Add Recency Criteria t a Segment Add DataMart Criteria t a Segment Include r Exclude a Segment frm Anther Segment Get Segment by ID Get Segment List Get Segment Criteria Get DataMart Segment List Delete Segment Criteria Update the String Demgraphic Criteria f a Segment Update the Numeric Demgraphic Criteria f a Segment Update the Date Demgraphic Criteria f a Segment Update the Campaign Actin Criteria f a Segment Update the Campaign Trackable Link Criteria f a Segment Update the Trigger Campaign Actin Criteria f a Segment Update the Trigger Campaign Trackable Link Criteria f a Segment Update the Scial Criteria f a Segment Update the Recency Criteria f a Segment Update the DataMart Criteria f a Segment Update the Included/Excluded Segment Criteria f a Segment This methd adds Trigger Campaign actin criteria t a segment. This methd adds Trigger Campaign tracked link criteria t a segment. This methd adds scial criteria t a segment. This methd adds quick segment criteria t segment. This methd adds DataMart criteria t a segment. This methd includes r excludes an existing segment in the criteria f a new segment. This methd retrieves a segment by its ID. This methd retrieves a list f segments. This methd retrieves the criteria used in a segment. This methd retrieves a list f DataMart segments. This methd deletes a criteria cell frm a segment. This methd updates alphanumeric demgraphic criteria. This methd updates numeric demgraphic criteria. This methd updates date demgraphic criteria. This methd updates campaign actin criteria. This methd updates campaign tracked link criteria. This methd updates Trigger Campaign actin criteria. This methd updates Trigger Campaign tracked link criteria. This methd updates scial criteria. This methd updates quick segment criteria. This methd updates DataMart criteria. This methd updates a segment's included r excluded segment. 10

11 Overview f the Campaign Management API Methd Cunt Segment Cunt Distinct Segment Members This methd cunts the ttal number f members in a segment (including duplicated members). This methd cunts the ttal number f distinct members in a segment (i.e. duplicate members are remved). Campaign Methd Create Campaign Create Campaign with Analytics Create Campaign (POST) Delete Campaign Update Campaign Update Campaign (POST) Pst Campaign Unpst Campaign Get Campaign Get Campaigns by Field Get Campaigns By Status Get Campaigns By Perid Get Campaign Status Get Last Campaigns This methd creates a campaign. This methd creates a campaign with analytics activated. It uses the analytics settings set up fr the accunt. This methd creates a campaign by bject. This methd deletes a campaign. This methd updates a campaign. This methd updates a campaign. This methd psts a campaign. This methd unpsts a psted campaign. This methd retrieves a campaign. This methd retrieves all campaigns that match a given value in a specified field. This methd retrieves a list f campaigns having a specified status. This methd retrieves a list f campaigns frm a specified perid. This methd retrieves a campaign's status. This methd retrieves the mst recent campaigns. Test Campaign n a Grup This methd sends a test campaign t a grup f members. Test Campaign n a Member Pause Campaign Unpause Campaign Get Campaign Reprt Get Campaign Snapsht Reprt Dynamic Cntent Methd Create Dynamic Cntent Blck Create Dynamic Cntent Blck (POST) Delete Dynamic Cntent Blck Update Dynamic Cntent Blck Update Dynamic Cntent Blck POST Clne Dynamic Cntent Blck This methd sends a test campaign t a member. This methd pauses a running campaign. This methd unpauses a paused campaign. This methd retrieves a campaign's reprt. This methd retrieves a snapsht reprt fr a campaign. This methd creates a Dynamic Cntent Blck. This methd creates a Dynamic Cntent Blck by bject. This methd deletes a Dynamic Cntent Blck. This methd updates a Dynamic Cntent Blck by field and value. This methd updates a Dynamic Cntent Blck by bject. This methd clnes a Dynamic Cntent Blck. Get Dynamic Cntent Blck Preview This methd displays a preview f a Dynamic Cntent Blck. Get Dynamic Cntent Blck This methd retrieves a Dynamic Cntent Blck using its ID. 11

12 Overview f the Campaign Management API Methd Get Dynamic Cntent Blcks by Field Get Dynamic Cntent Blcks by Perid Get Last Dynamic Cntent Blcks Track All Dynamic Cntent Blck Links Untrack All Dynamic Cntent Blck Links Track Link by Psitin Untrack Dynamic Cntent Blck Link by Order Get All Dynamic Cntent Blck Tracked Links Get All Unused Dynamic Cntent Blck Tracked Links Get All Dynamic Cntent Blck Trackable Links Dynamic Cntent Link This methd retrieves a list f Dynamic Cntent Blcks that cntain the same given value in a specific field. This methd retrieves a list f Dynamic Cntent Blcks frm a given perid. This methd retrieves the list f the last Dynamic Cntent Blcks created. This methd activates tracking fr all untracked Dynamic Cntent Blck links and saves the Dynamic Cntent Blck. This methd untracks all the Dynamic Cntent Blck links. This methd tracks the Dynamic Cntent Blck link thrugh its psitin in the Dynamic Cntent Blck. This methd untracks a link in the Dynamic Cntent Blck by its rder. This methd retrieves a list f all the tracked links in a Dynamic Cntent Blck. This methd retrieves a list f all the unused tracked links f the Dynamic Cntent Blck. This methd retrieves a list f all the trackable links in a Dynamic Cntent Blck. Nte: T create r add links in REST, yu must use the HTTP GET Query String (QS) frmat: HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call: Webfrms Methd Create a Webfrm This methd creates a new Webfrm. Update a Webfrm This methd updates a Webfrm. Cpy a Webfrm This methd makes a cpy f an existing Webfrm. Update a Webfrm's Status This methd updates a Webfrm's status. Get a Webfrm This methd retrieves a Webfrm. Get Webfrm Integratin Cde This methd retrieves the Webfrm integratin cde. Test Grup 12

13 Overview f the Campaign Management API Methd Create a Test Member Create an SMS Test Member Delete a Test Member Get a Test Member Get Test Members Create a Test Grup Create a Test Grup (POST) Delete a Test Grup Add Test Member t a Test Grup Remve Test Member Update a Test Grup (POST) Get Test Grup Get All Test Grups This methd creates a test member using an address. This methd creates a test member using their address and mbile telephne number. This methd deletes a test member. This methd retrieves a test member's details. This methd retrieves the test members. This methd creates a test grup f members. This methd creates a test grup. This methd deletes a test grup. This methd adds a member t a test grup. This methd remves a member frm a test grup. This methd updates a test grup. This methd retrieves the list f members in a test grup. This methd retrieves the list f test grups fr yur accunt. Campaign Management API Use Cases Message Use Cases Create an , Add an Unsubscribe Link, and Track All Links T create an , add an unsubscribe link, and track all the links, yu wuld use the fllwing methds in the fllwing sequence: 1. Use the Open Cnnectin methd t pen the cnnectin. 2. Use the Create Message (POST) methd t create yur . Make sure that yur cntent cntains three ampersands (&&&) fr the unsubscribe link. 3. Use the Create and Add Unsubscribe Link methd t create and add an unsubscribe link. 4. Use the Track All Links methd t track all the links in yur Use the Test HTML Validity methd t check whether the HTML in yur is valid. 6. Use the Clse Cnnectin methd t clse the cnnectin. Clne an and Edit the Cpied T clne an in rder t create a new 1. Use the Open Cnnectin methd t pen the cnnectin. 2. Use the Get Messages by Perid methd t retrieve the list f Messages frm which t chse the Message t clne. 3. Use the Clne Message methd t cpy the Message. 4. Use the Update Message (POST) methd t edit the Message. 5. Use the Test HTML Validity methd t check whether the HTML in yur is valid. 6. Use the Clse Cnnectin methd t clse the cnnectin. Campaign Use Cases Create and Pst a Campaign T create and pst a campaign, yu wuld use the fllwing methds in the fllwing sequence: 13

14 Overview f the Campaign Management API 1. Use the Open Cnnectin methd t pen the cnnectin. 2. Use the Get Messages by Perid methd t retrieve the list f Messages frm which t chse the Message fr the campaign. 3. Use the Get Segment List methd t retrieve the list f Segments frm which t chse the Segment fr the campaign. 4. Use the Create Campaign (POST) methd t create the campaign. 5. Use the Pst Campaign methd t pst the campaign. 6. Use the Clse Cnnectin methd t clse the cnnectin. Test Grup Use Cases Create a Test Grup T create a test grup: 1. Use the Open Cnnectin methd t pen the cnnectin. 2. Use the Create a Test Grup (POST) methd t create the test grup with the members. 3. If yu want t add additinal members, use the Add Test Members t Test Grup methd. 4. Use the Clse Cnnectin methd t clse the cnnectin. 14

15 Getting Started with Integratin Getting Started with Integratin Prerequisites T access SmartFcus s APIs and take full advantage f this sftware s ease f integratin with ther systems, yu will need the fllwing: An Internet cnnectin A recent brwser and perating system An active SmartFcus accunt with the API feature enabled Quick Start The prcess fr interfacing yur website, CRM, r any ther internal system with the APIs is quite straightfrward. Step 1: Get yur API key in SmartFcus Nte: Yu must have a dedicated API lgin. This lgin will NOT have access t SmartFcus. Cntact yur Accunt Manager t have a dedicated API lgin. T cnnect thrugh the API, the user must first btain a manager key using the CCMD Web Applicatin. Calling the cnnect methd (with the lgin, passwrd, manager key) will prvide a tken, t be used in all subsequent calls. This tken will expire in the fllwing cases: When a clse cnnectin call is made. When the maximum number f calls per sessin, defined by the manager in SmartFcus, is reached. When the sessin times ut. Step 2: Build yur applicatin Integratin Using APIs The first step in getting started with web services is t cnfigure the range f remte servers that will access this mdule. Webmasters and develpers shuld be able t interface with this new API with any prgramming language that uses standard HTTP calls. List f APIs that are available: RESTful API SOAP API (see the Campaign Management SOAP API Guide) RESTful API : RESTful API is the mst standard way t remtely call a Web Service. REST requests are always sent ver the HTTP prtcl and can vary in frmat and methds f submissin. This API methd is available in tw frmats: HTTP GET Query String (QS) and HTTP GET Path Inf (PI). HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw 15

16 Getting Started with Integratin API call summary: HTTP GET (Query String) Submissin & sample URL call: HTTP GET PI (Path Inf): The result is identical t the Query String methd. It differs in the way are rganized in the URL. In the PI methd, are rganized like a path. The rder f all is very imprtant. The path is cmpsed f a series f values. The values are each separated by a frward slash sign (/). Belw is an Internet brwser URL lcatin bar shwing a URL with the Path Inf: API call summary: HTTP GET (Path Inf) Submissin URL Parameters & assciated values All parameter names are case-sensitive. When specific values are expected, it shuld be assumed that parameter values are case sensitive. The rder f must be strictly fllwed. Example call Rules Fr a given Object (Message, Campaign, etc.), all create, get, update, delete methds will have the same structure: Get Object will take the ID f the bject as input and return the full bject descriptin. Create Object will take the full bject as input and return the ID f the newly created bject ( r errr if creatin failed). Update Object will take the full bject as input and return true if the update was successful. Delete Object will take the ID f the bject as input and return true if the delete was successful. URL Encding Cnsideratins (fr HTTP GET methds nly) Sme characters cannt be part f a URL - fr example, spaces are nt allwed. Sme characters have a special meaning in a URL fr example, the hash (#) character is used t lcate a specific pint within a page, and the equals (=) character is used t separate a name frm a value. A query string may need t be cnverted t satisfy these cnstraints. This can be dne using a schema knwn as URL encding. In particular, encding the query string uses the fllwing rules: 16

17 Getting Started with Integratin Letters (A-Z and a-z) and numbers (0-9) are nt encded. The perid (.), cmma (,), tilde (~), and underscre (_) characters are nt encded. A space is encded as %20. The frward slash (/) is encded as %2F. All ther characters are encded as %FF hex representatin with any nn-ascii characters first encded as UTF-8 (r ther specified encding). T encde as RFC 1738, use the + sign t replace spaces. Security As web services are accessible ver the Internet and can be interfaced with any system, there is a risk f fraudulent access and usage f the system. T tighten security, SmartFcus APIs can be accessed using the HTTPS prtcl. T use HTTPS, just replace HTTP with HTTPS in all the submissin URLs. 17

18 Cnnectin Cnnectin Prerequisite: T use SmartFcus APIs, yu need t have the API manager lgin prvided by SmartFcus and the assciated passwrd. T cnnect thrugh the API, yu must first retrieve the manager key frm SmartFcus. 1. G t Accunt Administratin and select Lgins. 2. Click the Edit icn next t yur API manager. 3. In the API sectin f the ppup windw, cpy the API key (als knwn as the manager key) and use it t pen a cnnectin t retrieve the tken that will be used in yur calls. Calling the cnnect methd (with the lgin, passwrd, manager key) will prvide a tken, t be used in all subsequent calls. This tken will expire in the fllwing cases: When a clse cnnectin call is made. When the maximum number f calls per sessin, defined by the manager in SmartFcus, is reached. When the sessin times ut. Recmmended Tken Usage An pen cnnectin call generates a tken that shuld be used until it expires. Once the tken expires, an API call will generate a sessin exceptin. At this pint, yu shuld pen a new cnnectin t cntinue yur API calls. Example: An example wrkflw: 1. Open the cnnectin t generate the tken. 2. Use API methd calls as needed. If a call fails due t a prblem with the sessin: a. Send anther pen cnnectin call t renew the tken. b. Resend the call that failed due t the sessin issue. 3. Send a clse cnnectin call nce all API methd calls fr the sessin have been sent successfully. Nte: Fr time cnsuming calls (e.g., uplading a large file), yu may need t use an pen cnnectin call t ensure that the tken will remain valid fr the duratin f the call. 18

19 Open Cnnectin This methd prvides a sessin tken when given valid credentials. Nte: The tken is valid fr 60 minutes. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required lgin The lgin prvided fr API access return pwd The passwrd Nte: API passwrds expire after 365 days. The tken t use in all ther API calls key The manager key cpied frm SmartFcus (see Cnnectin n page 18) Errr messages Yu must fill in the apiname parameter t check rights f client n this API. Yu must fill in the lgin parameter t authentifiate n this API. Yu must fill in the passwrd parameter t authentifiate n this API. Yu must fill in the managerkey parameter t authentifiate n this API. Errr while decding managerkey. Yur lgin is nt valid!! Yur passwrd is nt valid!! N manager retrieved fr thse lgin, passwrd. N available cnnectin fr manager {0}. {0} desn't exist r is nt activated n client accunt. {0} is nt activated fr the client. This manager des nt have authrized access t this API. Errr while parsing validdate n managerkey. Date nt valid n managerkey! The managerkey is n lnger valid. Yur API access is clsed! 19

20 <respnse respnsestatus="success"> <result xsi:type="xs:string"> {tken} </result> </respnse> 20

21 Clse Cnnectin This methd terminates the sessin tken. This is a GET methd. parameter Required parameter tken The cnnectin tken return The cnnectin is clsed if the peratin was successful, therwise an errr cde appears. Errr messages Yu must fill in the tken parameter N available cnnectin fr the specified tken. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:string">cnnectin clsed</result> </respnse> 21

22 Message Message The Messages feature is the crnerstne f yur campaign. It allws yu t create the s and SMS messages that yu will assciate t yur classic and reflex campaigns, split runs, and RSS feeds. This essential and pwerful feature is the medium fr creating attractive s that engage yur readers and track their behavir within and utside f the . A message may cntain links yu wuld like t track r specific links like nline preview, unsubscribe, etc. These links are part f the message and managed in the same bject. Hw t Use Tracked URLs in the Message Bdy T use tracked URLs in the message bdy, yu must change every reference t a tracked URL in the HTML cde t cmply with Ccmd syntax. The href value in the HTML cde must be set t [EMV LINK]1[EMV /LINK] where the crrespnding tracked URL rder number wuld be 1. The tracked URL rder numbers shuld start at 1 and be cntinuus (i.e. 1, 2, 3, 4... and nt 1, 3, 5). Then create a tracked URL (i.e. standard URL, update URL, etc.) using the apprpriate methd and set the rder number fr each tracked URL. Hw t Autmatically Track All Links Anther methd f tracking links cnsists in lading the HTML bdy as it is, withut any tracked URL definitin, and use the trackalllinks methd. If yu use this methd, all links will be cnsidered as standard links. Yu may therefre cnsider managing links individually if yu want t handle specific link types. The Message Object bdy The bdy f the message (HTML must be between the tags <![CDATA[ and ]]> ) createdate descriptin encding frm frm htmailunsubflg htmailunsuburl id isbunceback name The creatin date f the message The descriptin f the message The encding used (e.g. UTF-8) The Frm name. Fr SMS messages, the Frm name cannt exceed 11 characters. The Frm address Set t true t use the unsubscribe feature f Windws Live Mail (this imprves deliverability). The default value is false. The Windws Live Mail unsubscribe URL The ID f the message Set t true if yu want t use this message as a bunce back message (update, unsubscribe). The name f the message. Nte: The name cannt exceed 50 characters. replyt replyt subject The Reply T name The Reply T address The subject f the message. Nte: The subject cannt exceed 2000 characters. 22

23 Message t type The T name The type ( r SMS). The default is SMS. Nte: The making up the bject d nt always need t be present fr methds using the bject. Fr example, when yu create a new banner, campaign, r message, yu d nt need t prvide the id parameter even thugh this is present in the bject. Each methd's sectin lists the that must r can be included fr the methd. On the ther hand, these are all present when the bject appears in a methd's utput. 23

24 Create Message This methd creates an . This is a GET methd. {descriptin}/{subject}/{frm}/{frm }/{t}/{bdy}/{encding}/{replyt}/{replyt }/ {isbunceback}/{htmailunsubflg}/{htmailunsuburl} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The name f the message. name Nte: The name cannt exceed 50 characters. The message ID descriptin subject The descriptin f the message The subject f the message. Nte: The subject cannt exceed 2000 characters. frm The Frm name frm The Frm address t The T name bdy The bdy f the message (HTML must be between the tags <![CDATA[ and ]]> ) encding The encding used (e.g. UTF-8) replyt The Reply T name replyt The Reply T address isbunceback Set t true if yu want t use this message as a bunce back message (update, unsubscribe). Set t true t use the unsubscribe feature f Windws Live Mail (this htmailunsubflg imprves deliverability). The default value is false. htmailunsuburl The Windws Live Mail unsubscribe URL type The type ( r SMS). The default is SMS. 24

25 Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. Yu must fill in the bdy parameter. The cntent must begin with [EMV TEXTPART] OR [EMV HTMLPART]. This sender is nt cnfigured fr yur accunt. Yu must fill in the replyt parameter. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call This%20is%20a%20test%20message/Welcme%20t%20SmartFcus%20test%20sessin/SmartFcus/ @dcumentatin.cc s.net/myclient/%5bemv%20htmlpart%5dhi%20there/utf-8/ Dcumentatin/[email protected]/0/1/ <respnse respnsestatus="success"> <result xsi:type="xs:lng">11490</result> </respnse> 25

26 Create SMS Message This methd creates an SMS message. This is a GET methd. {frm}/{bdy} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The SMS message ID name descriptin The name f the message. Nte: The name cannt exceed 50 characters. The descriptin f the message This parameter is required fr Path Inf, but ptinal fr Query String. The Frm name. The name cannt exceed 11 characters. This parameter is required fr Path Inf, but ptinal fr Query String. Nte: If yu have subscribed t the branded SMS sender ptin, depending n the regin that yu are in, the Frm name can be a fixed r custmizable value. frm Fixed branded sender: Yu must prvide the frm parameter cntaining the branded sender cnfigured fr yur accunt. Custmizable branded sender: Yu must prvide the frm parameter cntaining the sender value that yu want t use fr the SMS campaign using this SMS message. If yu have nt subscribed t the branded SMS sender ptin r if yu are in a regin where the branded SMS sender ptin is nt permitted, the frm parameter shuld nt be included. bdy The bdy f the message Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. Yu must fill in the bdy parameter. 26

27 Errr messages Bdy must cntain [EMV SMSPART]. Bdy must cntain less than 500 characters. This sender is nt cnfigured fr yur accunt. Yu must include the Value parameter t update the Frm field. Yu must include the frm parameter with yur authrised SMS sender, which is: {1}. The Frm parameter must cntain the authrised SMS sender fr yur accunt, which is: {1}. Yu cannt cnfigure the Frm parameter because yu have nt subscribed t the persnalised SMS sender ptin. T activate it, please cntact SmartFcus Supprt. The value fr the Frm parameter cannt cntain mre than 11 characters. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call SMSdescriptin/[email protected]/%5BEMV%20SMSPART%5DHell <respnse respnsestatus="success"> <result xsi:type="xs:lng">11830</result> </respnse> 27

28 Create Message (POST) This methd creates an r SMS message. This is a POST methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return Message Parameters message The message envelpe parameter. The message ID name descriptin type subject The name f the message. Nte: The name cannt exceed 50 characters. The descriptin f the message The type ( r SMS). The default is SMS. The subject f the message.the subject cannt exceed 2000 characters. ( parameter) The Frm name. Fr SMS messages, the Frm name cannt exceed 11 characters. Nte: Fr SMS messages: frm If yu have subscribed t the branded SMS sender ptin, depending n the regin that yu are in, the Frm name can be a fixed r custmizable value. Fixed branded sender: Yu must prvide the frm parameter cntaining the branded sender cnfigured fr yur accunt. Custmizable branded sender: Yu must prvide the frm parameter cntaining the sender value that yu want t use fr the SMS campaign using this SMS message. If yu have nt subscribed t the branded SMS sender ptin r if yu are in a regin where the branded SMS sender ptin is nt permitted, the frm parameter shuld nt be included. frm The Frm address ( parameter) 28

29 Required t bdy encding replyt replyt isbunceback htmailunsubflg The T name ( parameter) The bdy f the message (HTML must be between the tags <![CDATA[ and ]] > ) The encding used (e.g. UTF-8) ( parameter) The Reply T name ( parameter) The Reply T address ( parameter) Set t true if yu want t use this message as a bunce back message (update, unsubscribe). ( parameter) Set t true t use the unsubscribe feature f Windws Live Mail (this imprves deliverability). The default value is false. ( parameter) htmailunsuburl The Windws Live Mail unsubscribe URL ( parameter) Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. Yu must fill in the bdy parameter. The cntent must begin with [EMV TEXTPART] OR [EMV HTMLPART]. Bdy must cntain less than 500 characters. This sender is nt cnfigured fr yur accunt. Yu must include the Value parameter t update the Frm field. Yu must include the frm parameter with yur authrised SMS sender, which is: {1}. The Frm parameter must cntain the authrised SMS sender fr yur accunt, which is: {1}. Yu cannt cnfigure the Frm parameter because yu have nt subscribed t the persnalised SMS sender ptin. T activate it, please cntact SmartFcus Supprt. The value fr the Frm parameter cannt cntain mre than 11 characters. An errr ccured n the server Example URL Cntent-type text/xml; charset=utf-8 Bdy 29

30 <message> <type> </type> <bdy>[emv HTMLPART]test</bdy> <isbunceback>false</isbunceback> <descriptin>desc test</descriptin> <encding>utf8</encding> <name>test name</name> <subject>test subject</subject> <htmailunsubflg>true</htmailunsubflg> <htmailunsuburl> </message> SMS Example URL Cntent-type text/xml; charset=utf-8 Bdy <message> <type>sms</type> <name>test name</name> <descriptin>desc test</descriptin> <bdy>[emv SMSPART] SMS creatin test by API</bdy> <frm>smartfcus</frm> </message> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 30

31 Delete Message This methd deletes a message. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return true if it was successful, false if it was nt successful id The ID f the message t delete Errr messages Yu must fill in the tken parameter This message desn't exist. This message is already used. Please select anther ne. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 31

32 Update Message This methd updates a message field. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return id The ID f the message t update true if it was successful, false if it was nt successful 32

33 parameter Required parameter field The field f the Message bject t update: fields: name descriptin subject encding frm t replyt replyt isbunceback htmailunsubflg htmailunsuburl SMS fields: name descriptin frm Nte: Fr SMS messages: If yu have subscribed t the branded SMS sender ptin, depending n the regin that yu are in, the Frm name can be a fixed r custmizable value. Fixed branded sender: Yu must prvide the frm field cntaining the branded sender cnfigured fr yur accunt. Custmizable branded sender: Yu must prvide the frm field cntaining the sender value that yu want t use fr the SMS campaign using this SMS message. If yu have nt subscribed t the branded SMS sender ptin, the frm field shuld nt be included. value The value t set fr the field Errr messages Yu must fill in the tken parameter This message desn't exist. Yu must fill in the name parameter. Yu must fill in the replyt parameter. Create bunceback message is nt authrized fr manager with id : {0}. Yu cannt cnfigure the Frm field because yu have nt subscribed t the persnalised SMS sender ptin. T activate it, please cntact SmartFcus Supprt. Yu must include the Value parameter t update the Frm field. The value fr the Frm field cannt cntain mre than 11 characters. 33

34 Errr messages The Value parameter must cntain the authrised SMS sender fr yur accunt, which is: {1}. Yu must include the Value parameter with yur authrised SMS sender, which is: {1}. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 34

35 Update Message (POST) This methd updates an r SMS message. This is a POST methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return Message Parameters message id type name descriptin subject frm frm t bdy encding replyt replyt isbunceback htmailunsubflg The message envelpe parameter. The ID f the message The type ( r SMS). The default is SMS. The name f the message.the name cannt exceed 50 characters. The descriptin f the message The subject f the message.the subject cannt exceed 2000 characters. ( parameter) The Frm name. Fr SMS messages, the Frm name cannt exceed 11 characters. The Frm address ( parameter) The T name ( parameter) The bdy f the message (HTML must be between the tags <![CDATA[ and ]] > ) The encding used (e.g. UTF-8) ( parameter) The Reply T name ( parameter) The Reply T address ( parameter) Set t true if yu want t use this message as a bunce back message (update, unsubscribe). ( parameter) Set t true t use the unsubscribe feature f Windws Live Mail (this imprves deliverability). The default value is false. ( parameter) htmailunsuburl The Windws Live Mail unsubscribe URL ( parameter) The message ID 35

36 Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. Yu must fill in the bdy parameter. The cntent must begin with [EMV TEXTPART] OR [EMV HTMLPART]. Bdy must cntain less than 500 characters. This sender is nt cnfigured fr yur accunt. Yu must include the Value parameter t update the Frm field. Yu must include the frm parameter with yur authrised SMS sender, which is: {1}. The Frm parameter must cntain the authrised SMS sender fr yur accunt, which is: {1}. Yu cannt cnfigure the Frm parameter because yu have nt subscribed t the persnalised SMS sender ptin. T activate it, please cntact SmartFcus Supprt. The value fr the Frm parameter cannt cntain mre than 11 characters. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call URL Cntent-type text/xml; charset=utf-8 Bdy <message> <id>2041</id> <type> </type> 36

37 <bdy>[emv SMSPART]Hell</bdy> <descriptin>desc test</descriptin> <encding>utf8</encding> <frm>jhn Smith</frm> <name>test</name> <replyt>jhn Smith</replyT> <subject>test subject</subject> <htmailunsubflg>true</htmailunsubflg> <htmailunsuburl> </message> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 37

38 Clne Message This methd clnes a message. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return The ID f the newly created message id newname The ID f the message t clne The name f the newly created message Errr messages Yu must fill in the tken parameter An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:lng">11828</result> </respnse> 38

39 Get Message This methd retrieves a message by its ID. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return The message id The ID f the message t retrieve Errr messages Yu must fill in the tken parameter This message desn't exist. An errr ccured n the server <respnse respnsestatus="success"> <message> <bdy>[emv HTMLPART]test</bdy> <createdate> t00:00:00+02:00</createdate> <descriptin>desc test</descriptin> <encding>utf8</encding> <frm>[email protected]</frm> <frm > @jhnsmith.emv2.net</frm > <htmailunsubflg>false</htmailunsubflg> <htmailunsuburl> <id>1972</id> <isbunceback>false</isbunceback> <name>test name</name> <replyt>[email protected]</replyt> <replyt >[email protected]</replyt > <subject>test subject</subject> <t>[email protected]</t> <type> </type> </message> </respnse> 39

40 Get Last Messages This methd retrieves the list f the last s created. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return The IDs f the messages limit The maximum number f messages t retrieve Errr messages Yu must fill in the tken parameter An errr ccured n the server <respnse respnsestatus="success"> <entities> <id>11501</id> <id>11500</id> <id>11499</id> </entities> </respnse> 40

41 Get Last SMS Messages This methd retrieves the last SMS messages created. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return The IDs f the messages limit The maximum number f messages t retrieve Errr messages Yu must fill in the tken parameter An errr ccured n the server <respnse respnsestatus="success"> <entities> <id>2041</id> <id>1081</id> </entities> </respnse> 41

42 Get Messages by Field This methd retrieves a list f s that cntain the given value in the specified field. This is a GET methd. {limit} Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return field The field t search (any field f the message bject) The IDs f the messages value limit The value t search fr in the field The maximum number f messages t retrieve Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. Yu must fill in the replyt parameter. The part parameter is nt the same as HTML r TEXT. An errr ccured n the server <respnse respnsestatus="success"> <entities> <id>11123</id> <id>10962</id> </entities> </respnse> 42

43 Get SMS Messages by Field This methd retrieves a list f SMS messages that cntain the given value in the specified field. This is a GET methd. {limit} Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return field The field t search (any field f the message bject) The IDs f the messages value limit The value t search fr in the field The maximum number f messages t retrieve Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. An errr ccured n the server <respnse respnsestatus="success"> <entities> <id>2041</id> <id>2045</id> <id>2047</id> </entities> </respnse> 43

44 Get Messages by Perid This methd retrieves a list f messages frm a given perid. This is a GET methd. {dateend} Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return datebegin The start date f the perid t retrieve (yyyy-mm-dd HH:mm:ss) The IDs f the messages dateend The end date f the perid t retrieve (yyyy-mm-dd HH:mm:ss) Errr messages Yu must fill in the tken parameter Yu must fill in the datebegin parameter. Yu must fill in the dateend parameter. datebegin desn't exist r is malfrmed (gd frmat is : yyyy-mm-dd HH:mm:ss). dateend desn't exist r is malfrmed (gd frmat is : yyyy-mm-dd HH:mm:ss). An errr ccured n the server %2000:00:00/ %2000:00:00 <respnse respnsestatus="success"> <entities> <id>11499</id> <id>11500</id> <id>11501</id> <id>11490</id> </entities> </respnse> 44

45 Get Message Preview This methd prvides a preview f an . This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return id The ID f the message t preview part The part f the message (HTML r TEXT) t preview The preview f the message Errr messages Yu must fill in the tken parameter This message desn't exist. Message type must be . The part parameter is nt the same as HTML r TEXT. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:string"> <html xmlns=" <head> <meta http-equiv="cntent-type" cntent="text/html; charset=is " /> <title>pinnacle</title> </head> <bdy> <table width="100%" brder="0" cellspacing="0" cellpadding="0" bgclr="#dfdfdf" backgrund=" <tr> <td>test HTML</td> 45

46 </tr> </table> </bdy> </html> </result> </respnse> 46

47 Get SMS Message Preview This methd prvides a preview f an SMS message. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return The preview f the SMS message messageid The ID f the message t preview Errr messages Yu must fill in the tken parameter This message desn't exist. Message type must be sms. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:string">hell!</result> </respnse> 47

48 Track All Links This methd activates tracking fr all links in an . This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return The ID f the last tracked URL id The ID f the message f which t track all links Errr messages Yu must fill in the tken parameter This message desn't exist. Message type must be . There is n link t track. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:lng">10</result> </respnse> 48

49 Untrack All Links This methd deactivates link tracking fr all links in an . This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return id The ID f the message fr which t untrack all links true if it was successful, false if it was nt successful Errr messages Yu must fill in the tken parameter This message desn't exist. Message type must be . An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 49

50 Track Link by Psitin This methd tracks a link based n its psitin in an . This is a GET methd. {part} Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return id The ID f the message t update The rder number f the URL psitin part Psitin f the link (URL) t track in the message The part f the message (HTML r TEXT) Errr messages Yu must fill in the tken parameter This message desn't exist. Message type must be . The part parameter is nt the same as HTML r TEXT. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:lng">11</result> </respnse> 50

51 Untrack Link by Order This methd untracks a link based n its rder number. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return true if it was successful, false if it was nt successful id rder The ID f the message t update The rder number f the URL Errr messages Yu must fill in the tken parameter This message desn't exist. Message type must be . An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 51

52 Get All Tracked Links This methd retrieves a list f all the tracked links in an . This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return The list f IDs f the tracked links id The ID f the message fr which t retrieve the tracked links Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. An errr ccured n the server <respnse respnsestatus="success"> <entities> <id>3</id> </entities> </respnse> 52

53 Get All Unused Tracked Links This methd retrieves the unused tracked links fr an . This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return The list f IDs f the unused tracked links id The ID f the message fr which t retrieve the unused tracked links Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. An errr ccured n the server <respnse respnsestatus="success"> <entities> <id>2</id> </entities> </respnse> 53

54 Get All Trackable Links This methd retrieves all the trackable links in an . This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return The list f IDs f the trackable links id The ID f the message fr which t retrieve the trackable links Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. An errr ccured n the server <respnse respnsestatus="success"> <entities> <id>1</id> </entities> </respnse> 54

55 Test HTML Validity This methd verifies the validity f the HTML used in yur . This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return true r an indicatin f the prblem in the HTML id Errr messages Yu must fill in the tken parameter WARNING! Sme lines are t lng. Unable t check HTML syntax n yur message. Yur message may nt have a [EMV HTMLPART]. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 55

56 Test Message n a Grup This methd sends a test campaign t a grup f recipients. This is a GET methd. /{campaignname}/{subject}/{part} Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return true if it was successful, false if it was nt successful id grupid The ID f the message t test The ID f the grup t use fr the test campaignname The name f the test campaign subject part The subject f the message.the subject cannt exceed 2000 characters. fr the test The part f the message t send (HTML, TEXT, MULTIPART) Errr messages Yu must fill in the tken parameter This test grup desn't exist r desn't cntains any test members. An errr ccured n the server TestCampaign/Hell/HTML <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 56

57 Test Message n a Member This methd sends a test campaign t a member. This is a GET methd. {memberid}/{campaignname}/{subject}/{part} Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return true if it was successful, false if it was nt successful id memberid The ID f the message t test The ID f the member t use fr the test campaignname The name f the test campaign subject part The subject f the message.the subject cannt exceed 2000 characters. fr the test Part f the message t send (HTML, TEXT, MULTIPART) Errr messages Yu must fill in the tken parameter An errr ccured n the server 123/TestCampaign/Hell/HTML <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 57

58 Test SMS Message This methd sends a test SMS message t a member. This is a GET methd. {memberid}/{campaignname} Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return true if it was successful, false if it was nt successful id memberid campaignname The ID f the message t test The ID f the member t use fr the test The name f the test campaign Errr messages Yu must fill in the tken parameter An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 58

59 Get Default Sender This methd retrieves the address f the default sender fr the SmartFcus accunt. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return The address f the default sender Errr messages Yu must fill in the tken parameter An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:string"> @dcumentatin.cc s.net</result> </respnse> 59

60 Get Validated Alternate Senders This methd retrieves the list f validated alternate senders fr the SmartFcus accunt. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return The list f addresses f the validated alternate senders Errr messages Yu must fill in the tken parameter An errr ccured n the server <respnse respnsestatus="success"> <entities> < > [email protected]</ > < > [email protected]</ > < > [email protected]</ > </entities> </respnse> 60

61 Get Unvalidated Senders This methd retrieves the list f the unvalidated alternate senders fr the SmartFcus accunt. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return The list f addresses f the nt validated alternate senders Errr messages Yu must fill in the tken parameter An errr ccured n the server <respnse respnsestatus="success"> <entities> < >[email protected]</ > </entities> </respnse> 61

62 URL URL Nte: T create r add links in REST, yu must use the HTTP GET Query String (QS) frmat: HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call: The fllwing types f links can be added t yur Standard link: A standard link is any link that serves the sle purpse f linking t a web page. Unsubscribe link: When recipients click this link, the CCUNJOIN field f the member database is updated t shw them as unsubscribed and they will nt receive any further s. All s must cntain an unsubscribe link t cmply with anti-spam regulatins. Advanced links Persnalized link: A persnalized link is a link that adds a selected value frm yur member database t the end f the URL in rder t redirect the recipient t a specific page based n that value. Fr example, yu culd send male and female recipients t different web pages based n their gender using the TITLE database field. Update link: An update link is a link that, when clicked, will update a field in the member database. Actin link: An actin link is a link that will trigger an actin when clicked, e.g. a frward-t-a-friend link. This type f link needs t be pre-cnfigured by SmartFcus. If yu wish t use actin links, please cntact yur Accunt Manager. Mirrr link: A mirrr link is a link that pints t an autmatically generated mirrr page. Share link: This type f link allws yur recipients t share the n ne r mre scial netwrks. Create Standard URL This methd creates a standard link fr an . Nte: In rder t use the created link, yu need t add [EMV LINK]ORDER[EMV /LINK] t yur message bdy (where ORDER is the rder number returned by the methd). This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. 62

63 URL Required tken The cnnectin tken return messageid The ID f the message t which t add a URL rder - The rder number f the URL name url The name f the URL The URL f the link Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. An errr ccured n the server &messageid=11828&name=standardlink&url= <respnse respnsestatus="success"> <result xsi:type="xs:lng">19</result> </respnse> Create and Add Standard URL This methd scans yur message frm tp t bttm and autmatically replaces the first ccurrence f &&& with [EMV LINK]ORDER[EMV /LINK] (where ORDER is the standard link rder number). This is a GET methd. &messageid={messageid}&name={name}&url={url} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return rder - The rder number f the URL 63

64 URL Required messageid The ID f the message t which t add a URL name The name f the URL url The URL f the link Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:lng">13</result> </respnse> Create Unsubscribe URL This methd creates an unsubscribe link fr an . Nte: In rder t use the created link, yu need t add [EMV LINK]ORDER[EMV /LINK] t yur message bdy (where ORDER is the rder number returned by the methd). This is a GET methd. &messageid={messageid}&name={name}&pageok={pageok}&messageok={messageok} &pageerrr={pageerrr}&messageerrr={messageerrr} Nte: Ask yur Accunt Manager fr yur server name. 64

65 URL Required tken The cnnectin tken return messageid The ID f the messaget which t add a URL rder - The rder number f the URL name pageok messageok pageerrr messageerrr The name f the URL The URL t call if the actin was successful The message t display if the actin was successful The URL t call if the actin was unsuccessful The message t display if the actin was unsuccessful Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call &messageid=11828&name=unsubscribelink&pageok= &pageerrr= 65

66 URL <respnse respnsestatus="success"> <result xsi:type="xs:lng">20</result> </respnse> Create and Add Unsubscribe URL This methd scans yur message frm tp t bttm and autmatically replaces the first ccurrence f &&& with [EMV LINK]ORDER[EMV /LINK] (where ORDER is the unsubscribe link rder number). This is a GET methd. &messageid={messageid}&name={name}&pageok={pageok}&messageok={messageok} &pageerrr={pageerrr}&messageerrr={messageerrr} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return messageid The ID f the message t which t add a URL rder - The rder number f the URL name pageok messageok pageerrr messageerrr The URL f the link The URL t call if the actin was successful The message t display if the actin was successful The URL t call if the actin was unsuccessful The message t display if the actin was unsuccessful Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. 66

67 URL HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call &messageid=11828&name=unsubscribelink&pageok= &pageerrr= <respnse respnsestatus="success"> <result xsi:type="xs:lng">15</result> </respnse> Create Persnalized URL This methd creates a persnalized link fr an . Nte: In rder t use the created link, yu need t add [EMV LINK]ORDER[EMV /LINK] t yur message bdy (where ORDER is the rder number returned by the methd). This is a GET methd. &messageid={messageid}&name={name}&url={url} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return rder - The rder number f the URL 67

68 URL Required messageid The ID f the message t which t add a URL name The name f the persnalized URL url The URL f the link Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. Yu must fill in the url parameter. An errr ccured n the server &messageid=11828&name=persnalizedlink&url= <respnse respnsestatus="success"> <result xsi:type="xs:lng">18</result> </respnse> Create and Add Persnalized URL This methd scans yur message frm tp t bttm and autmatically replaces the first ccurrence f &&& with [EMV LINK]ORDER[EMV /LINK] (where ORDER is the persnalized link rder number). This is a GET methd. &messageid={messageid}&name={name}&url={url} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return rder - The rder number f the URL 68

69 URL Required messageid The ID f the message t which t add a URL name The name f the persnalized URL url The URL f the link Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. Yu must fill in the url parameter. An errr ccured n the server &messageid=11828&name=persnalizedlink&url= <respnse respnsestatus="success"> <result xsi:type="xs:lng">13</result> </respnse> Create Update URL This methd creates an update link fr an . Nte: In rder t use the created link, yu need t add [EMV LINK]ORDER[EMV /LINK] t yur message bdy (where ORDER is the rder number returned by the methd). This is a GET methd. &messageid={messageid}&name={name}&={} &pageok={pageok}&messageok={messageok}&pageerrr={pageerrr} &messageerrr={messageerrr} Nte: Ask yur Accunt Manager fr yur server name. 69

70 URL Required tken The cnnectin tken return messageid The ID f the message t which t add a URL rder - The rder number f the URL name pageok messageok pageerrr messageerrr The name f the URL The update t apply t the member table (fr a particular member) The URL t call if the actin was successful The message t display if the actin was successful The URL t call if the actin was unsuccessful The message t display if the actin was unsuccessful Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. Yu must fill in the field. An errr ccured n the server &messageid=11828&name=updatelink&= &pageok= &pageerrr= <respnse respnsestatus="success"> <result xsi:type="xs:lng">21</result> </respnse> Create and Add Update URL This methd scans yur message frm tp t bttm and autmatically replaces the first ccurrence f &&& with [EMV LINK]ORDER[EMV /LINK] (where ORDER is the update link rder number). This is a GET methd. &messageid={messageid}&name={name}&={} 70

71 URL &pageok={pageok}&messageok={messageok}&pageerrr={pageerrr} &messageerrr={messageerrr} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return messageid The ID f the message t which t add a URL rder - The rder number f the URL name pageok messageok pageerrr messageerrr The name f the URL The update t apply t the member table (fr a particular member) The URL t call if the actin was successful The message t display if the actin was successful The URL t call if the actin was unsuccessful The message t display if the actin was unsuccessful Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. Yu must fill in the field. An errr ccured n the server &messageid=11828&name=updatelink&= &pageok= &pageerrr= <respnse respnsestatus="success"> <result xsi:type="xs:lng">16</result> </respnse> Create Actin URL This methd creates an actin link fr an . Nte: In rder t use the created link, yu need t add [EMV LINK]ORDER[EMV /LINK] t yur message bdy (where ORDER is the rder number returned by the methd). This is a GET methd. 71

72 URL &messageid={messageid}&name={name}&actin={actin}&pageok={pageok} &messageok={messageok}&pageerrr={pageerrr}&messageerrr={messageerrr} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return messageid The ID f the message t which t add a URL rder - The rder number f the URL name actin pageok messageok pageerrr messageerrr The name f the URL The actin t perfrm The URL t call if the actin was successful This parameter is required fr Path Inf, but ptinal fr Query String. The message t display if the actin was successful This parameter is required fr Path Inf, but ptinal fr Query String. The URL t call if the actin was unsuccessful This parameter is required fr Path Inf, but ptinal fr Query String. The message t display if the actin was unsuccessful This parameter is required fr Path Inf, but ptinal fr Query String. Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. Yu must fill in the actin field. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. 72

73 URL HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call &messageid=11828&name=actinlink&actin=actin&pageok= &messageok=395&pageerrr= <respnse respnsestatus="success"> <result xsi:type="xs:lng">10</result> </respnse> Create and Add Actin URL This methd scans yur message frm tp t bttm and autmatically replaces the first ccurrence f &&& with [EMV LINK]ORDER[EMV /LINK] (where ORDER is the actin link rder number). This is a GET methd. &messageid={messageid}&name={name}&actin={actin}&pageok={pageok} &messageok={messageok}&pageerrr={pageerrr}&messageerrr={messageerrr} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return rder - The rder number f the URL 73

74 URL Required messageid The ID f the message t which t add a URL name The name f the URL actin The actin t perfrm The URL t call if the actin was successful pageok This parameter is required fr Path Inf, but ptinal fr Query String. The message t display if the actin was successful messageok This parameter is required fr Path Inf, but ptinal fr Query String. The URL t call if the actin was unsuccessful pageerrr This parameter is required fr Path Inf, but ptinal fr Query String. The message t display if the actin was unsuccessful messageerrr This parameter is required fr Path Inf, but ptinal fr Query String. Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. Yu must fill in the actin field. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call

75 URL &messageid=11828&name=actinlink&actin=actin&pageok= &messageok=395&pageerrr= <respnse respnsestatus="success"> <result xsi:type="xs:lng">11</result> </respnse> Create Mirrr URL This methd creates a mirrr URL fr an . This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return messageid The ID f the message t which t add a Mirrr URL rder - The rder number f the URL name The name f the mirrr URL Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. An errr ccured n the server &messageid=11828&name=mirrrlink 75

76 URL <respnse respnsestatus="success"> <result xsi:type="xs:lng">17</result> </respnse> Create and Add Mirrr URL This methd scans yur message frm tp t bttm and autmatically replaces the first ccurrence f &&& with [EMV LINK]ORDER[EMV /LINK] (where ORDER is the mirrr link rder number). This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return messageid The ID f the message t which t add a mirrr URL rder - The rder number f the URL name The name f the mirrr URL Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. An errr ccured n the server &messageid=11828&name=mirrrlink <respnse respnsestatus="success"> <result xsi:type="xs:lng">12</result> </respnse> 76

77 Add a Share Link This methd scans yur message frm tp t bttm and autmatically replaces the first ccurrence f &&& with [EMV SHARE lang=xx] (where xx is the language identifier). This is a GET methd. &linktype={link type} &buttnurl={url}&language={language} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return true if it was successful, false if it was nt successful messageid linktype buttnurl language The ID f the message t which t add a URL The share link type (true fr link, false fr buttn) The URL f the Share buttn (if nt given the default Share buttn will be used) The language f the share link: 1 = English (US) 2 = English (UK) 3 = French 4 = German 5 = Dutch 6 = Spanish 7 = Russian 8 = Swedish 9 = Italian 10 = Simplified Chinese 11 = Traditinal Chinese 12 = Prtuguese (Prtugal) 13 = Prtuguese (Brazil) 14 = Danish 15 = Japanese 16 = Krean Errr messages Yu must fill in the tken parameter Yu must fill in the buttnurl parameter. 77

78 Errr messages This message desn't exist. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call &buttnurl= <respnse respnsestatus="success"> <result xsi:type="xs:lng">true </result></respnse> 78

79 Update URL by Field This methd updates a URL by field. This is a GET methd. {field}/{value} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return true if it was successful, false if it was nt successful messageid rder field value The ID f the message f which t update an URL The rder number f the URL Field t update in the URL The value t set fr the field Errr messages Yu must fill in the tken parameter This url desn't exist. Url type nt supprted. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 79

80 Delete URL This methd deletes a URL. Yu can nly delete a message's URL, if the message is nt assciated t a campaign. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return true if it was successful, false if it was nt successful messageid rder The ID f the message f which t update an URL The rder number f the URL Errr messages Yu must fill in the tken parameter An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 80

81 Get URL by Order This methd retrieves a URL's based n its rder in the . This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The URL messageid rder The ID f the message f which t update an URL The rder number f the URL Errr messages Yu must fill in the tken parameter This url desn't exist. An errr ccured n the server <respnse respnsestatus="success"> <urllink> <messageid>11828</messageid> <name>url3</name> <rder>3</rder> <type>standard</type> <url> </urllink> </respnse> 81

82 Segment Segment A segment is a set f criteria used t make a selectin f recrds in the user database - the target recipients f the campaign. The Segment Object id descriptin name samplerate sampletype The ID f the segment The descriptin f the segment The name f the segment The percentage r number f members frm the segment. This must be used in cmbinatin with sampletype. The prtin f the segment used (ALL, PERCENT, r FIX) Nte: The making up the bject d nt always need t be present fr methds using the bject. Fr example, when yu create a new banner, campaign, r message, yu d nt need t prvide the id parameter even thugh this is present in the bject. Each methd's sectin lists the that must r can be included fr the methd. On the ther hand, these are all present when the bject appears in a methd's utput. The Segment Criteria Objects Demgraphic Criteria Objects The fllwing tables list the that may appear in a demgraphic criteria bject. Further infrmatin is given in the detailed infrmatin in each methd's sectin. Demgraphic String Criteria Objects grupname The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupnumber grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). id rderfrag The ID f the segment The rder f the criteria in relatin t the ther criteria f the segment clumnname The name f the clumn in the database peratr values The peratr The values t which the peratr will cmpare the data in the database field Nte: The making up the bject d nt always need t be present fr methds using the bject. Fr example, when yu create a new banner, campaign, r message, yu d nt need t prvide the id parameter even thugh this is present in the bject. Each methd's sectin lists the that must r can be included fr the methd. On the ther hand, these are all present when the bject appears in a methd's utput. 82

83 Segment Demgraphic Numeric Criteria Objects grupname The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupnumber grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). id rderfrag The ID f the segment The rder f the criteria in relatin t the ther criteria f the segment clumnname The name f the clumn in the database firstvalue peratr secndvalue The first value n which the peratr acts. Required in all cases except when cmbined with the *_NOT_EMPTY and *_EMPTY peratrs. The peratr The secnd value n which the peratr acts. Required in all cases except when cmbined with the *_NOT_EMPTY and *_EMPTY peratrs. Nte: The making up the bject d nt always need t be present fr methds using the bject. Fr example, when yu create a new banner, campaign, r message, yu d nt need t prvide the id parameter even thugh this is present in the bject. Each methd's sectin lists the that must r can be included fr the methd. On the ther hand, these are all present when the bject appears in a methd's utput. Demgraphic Date Criteria Objects grupname grupnumber id rderfrag abslutedate clumnname firstabslutedate numberdaysbefreorafter peratr The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The ID f the segment The rder f the criteria in relatin t the ther criteria f the segment Defines whether the date criteria cnsists f abslute dates r relative dates (1 = abslute dates, 0 = relative dates) The name f the clumn in the database The start date (YYYY-MM-DDTHH:MM:SS) If the peratr is time sensitive, the date and time need t be indicated using the fllwing frmat (where T serves as a divider between date and time): YYYY-MM- DDTHH:MM:SS If the peratr is nt time sensitive, nly the date needs t be indicated using the fllwing frmat: YYYY-MM-DD The number f days befre r after the selected database field date The peratr 83

84 Segment The database field name cntaining the base date value fr relative dates relativeclumnnamebefreorafter Yu can cmbine multiple cmbinatins f numberdaysbefreorafter and secndabslutedate relativeclumnnamebefreorafter criteria. The end date (YYYY-MM-DDTHH:MM:SS) Required if the peratr is *_BETWEEN r *_NOT_BETWEEN. If the peratr is time sensitive, the date and time need t be indicated using the fllwing frmat (where T serves as a divider between date and time): YYYY-MM- DDTHH:MM:SS If the peratr is nt time sensitive, nly the date needs t be indicated using the fllwing frmat: YYYY-MM-DD Yu can cmbine multiple cmbinatins f firstabslutedate and secndabslutedate criteria. Nte: The making up the bject d nt always need t be present fr methds using the bject. Fr example, when yu create a new banner, campaign, r message, yu d nt need t prvide the id parameter even thugh this is present in the bject. Each methd's sectin lists the that must r can be included fr the methd. On the ther hand, these are all present when the bject appears in a methd's utput. Behaviral Criteria Objects The fllwing tables list the that may appear in a behaviral criteria bject. Further infrmatin is given in the detailed infrmatin in each methd's sectin. Actin Criteria Objects grupname grupnumber id rderfrag campaignid The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The ID f the segment The rder f the criteria in relatin t the ther criteria f the segment Standard Campaign criteria The ID f the campaign messageorder The rder f the message in the Trigger Campaign peratr serieid The peratr Trigger Campaign criteria The ID f the series f the Trigger Campaign Nte: The making up the bject d nt always need t be present fr methds using the bject. Fr example, when yu create a new banner, campaign, r message, yu d nt need t prvide the id parameter even thugh this is present in the bject. Each methd's sectin lists the that must r can be included fr the methd. On the ther hand, these are all present when the bject appears in a methd's utput. 84

85 Segment Trackable Link Criteria Objects grupname grupnumber id rderfrag campaignid linkorder messageorder peratr The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The ID f the segment The rder f the criteria in relatin t the ther criteria f the segment Standard Campaign criteria The ID f the campaign The rder number f the link. Required if the criteria is based n a specific tracked link. Optinal if the criteria is based n any link. Trigger Campaign criteria The rder f the message in the Trigger Campaign The peratr The tracking start day periddaybegin Required if yu want t limit link tracking t a specific perid. Optinal if yu use ne f the *NOTIME peratrs. periddayend serieid The tracking end day Required if yu want t limit link tracking t a specific perid. Optinal if yu use ne f the *NOTIME peratrs. Trigger Campaign criteria The ID f the series f the Trigger Campaign Nte: The making up the bject d nt always need t be present fr methds using the bject. Fr example, when yu create a new banner, campaign, r message, yu d nt need t prvide the id parameter even thugh this is present in the bject. Each methd's sectin lists the that must r can be included fr the methd. On the ther hand, these are all present when the bject appears in a methd's utput. Quick Segments Criteria Object The fllwing table lists the that may appear in a quick segment criteria bject. Further infrmatin is given in the detailed infrmatin in each methd's sectin. grupname grupnumber id rderfrag The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The ID f the segment The rder f the criteria in relatin t the ther criteria f the segment 85

86 Segment clumnname firststaticvalue peratr periddaybeginlist periddayendlist secndstaticvalue The name f the clumn in the database The start date (YYYY-MM-DD). Required fr static dates. It shuld nt be included fr relative dates r when cmbined with the *NOT_EMPTY and *EMPTY peratrs. The peratr The start date (number f days befre r after tday). Required fr relative dates. It shuld nt be included fr static dates r when cmbined with the *NOT_EMPTY and *EMPTY peratrs. The end date (number f days befre r after tday). Required fr relative dates. It shuld nt be included fr static dates r when cmbined with the *NOT_EMPTY and *EMPTY peratrs. Yu can cmbine multiple cmbinatins f periddaybeginlist and periddayendlist criteria. The end date (YYYY-MM-DD). Required fr static dates cmbined with the *BETWEEN and *NOTBETWEEN peratrs. It shuld nt be included fr relative dates r when cmbined with the *NOT_EMPTY and *EMPTY peratrs. Yu can cmbine multiple cmbinatins f firststaticvalue and secndstaticvalue criteria. Nte: The making up the bject d nt always need t be present fr methds using the bject. Fr example, when yu create a new banner, campaign, r message, yu d nt need t prvide the id parameter even thugh this is present in the bject. Each methd's sectin lists the that must r can be included fr the methd. On the ther hand, these are all present when the bject appears in a methd's utput. Scial Netwrk Criteria Objects The fllwing table lists the that may appear in a scial netwrk criteria bject. Further infrmatin is given in the detailed infrmatin in each methd's sectin. grupname grupnumber id rderfrag campaignid clumnname The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The ID f the segment The rder f the criteria in relatin t the ther criteria f the segment Standard Campaign criteria The ID f the campaign The name f the clumn in the database Trigger Campaign criteria messageorder The rder f the message in the Trigger Campaign peratr serieid The peratr Trigger Campaign criteria The ID f the series f the Trigger Campaign 86

87 Segment snids value1 value 2 The ID f the scial netwrk 1: Delicius 2: Digg 3: Facebk 4: LinkedIn 5: YahBuzzUp 6: Twitter 7: GgleBkmarks 8: MySpace 9: Netvibes 10: Viade 11: Hyves 12: Netlg 13: Mister Wng 14: MailRu 15: Iwiw 16: Orkut The first value n which the peratr acts. Required in all cases except when cmbined with the *_NOT_EMPTY and *_EMPTY peratrs. The secnd value n which the peratr acts. Required in all cases except when cmbined with the *_NOT_EMPTY and *_EMPTY peratrs. Nte: The making up the bject d nt always need t be present fr methds using the bject. Fr example, when yu create a new banner, campaign, r message, yu d nt need t prvide the id parameter even thugh this is present in the bject. Each methd's sectin lists the that must r can be included fr the methd. On the ther hand, these are all present when the bject appears in a methd's utput. Datamart Criteria Object The fllwing table lists the that may appear in a Datamart criteria bject. Further infrmatin is given in the detailed infrmatin in each methd's sectin. grupname grupnumber id rderfrag apipersfragcriteria The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The ID f the segment The rder f the criteria in relatin t the ther criteria f the segment The Datamart envelpe cntaining: persfragid: The ID f the Datamart criteria persname: The name f the Datamart criteria. persdesc: The descriptin f the Datamart criteria. Nte: The making up the bject d nt always need t be present fr methds using the bject. Fr example, when yu create a new banner, campaign, r message, yu d nt need t prvide the id parameter even thugh this is 87

88 Segment present in the bject. Each methd's sectin lists the that must r can be included fr the methd. On the ther hand, these are all present when the bject appears in a methd's utput. Include/Exclude Segment Criteria Object The fllwing table lists the that may appear in a include/exclude segment criteria bject. Further infrmatin is given in the detailed infrmatin in each methd's sectin. grupname The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupnumber grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). id rderfrag difflistid peratr The ID f the segment The rder f the criteria in relatin t the ther criteria f the segment The segment id t be included r excluded. The peratr Nte: The making up the bject d nt always need t be present fr methds using the bject. Fr example, when yu create a new banner, campaign, r message, yu d nt need t prvide the id parameter even thugh this is present in the bject. Each methd's sectin lists the that must r can be included fr the methd. On the ther hand, these are all present when the bject appears in a methd's utput. 88

89 Create Segment This methd creates a segment. Nte: It is imperative that yur segment cntains members and that all necessary criteria is defined. If a segment withut criteria is used in a campaign, all members in the database will be selected. This is a PUT methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return Segment Parameters segmentatin The segment envelpe parameter. name The name f the segment desc The descriptin f the segment The ID f the created segment sampletype samplerate The prtin f the segment used (ALL, PERCENT, r FIX) The percentage r number f members frm the segment. This must be used in cmbinatin with sampletype. Errr messages Yu must fill in the tken parameter An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). 89

90 Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call URL Cntent-type text/xml; charset=utf-8 Bdy <segmentatin> <descriptin>segment descriptin</descriptin> <name>segment name</name> <sampletype>all</sampletype> </segmentatin> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:lng" xmlns:xs=" xmlns: xsi=" </respnse> 90

91 Delete Segment This methd deletes a segment. This is a DELETE methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The ID f the created segment id The ID f the segment Segment Parameters segmentatin The segment envelpe parameter. name The name f the segment desc The descriptin f the segment sampletype samplerate The prtin f the segment used (ALL, PERCENT, r FIX) The percentage r number f members frm the segment. This must be used in cmbinatin with sampletype. Errr messages Yu must fill in the tken parameter An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw 91

92 API call summary: HTTP GET (Query String) Submissin & sample URL call <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 92

93 Update Segment This methd updates a segment. This is a POST methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The ID f the created segment id The ID f the segment Segment Parameters segmentatin The segment envelpe parameter. name The name f the segment desc The descriptin f the segment sampletype samplerate The prtin f the segment used (ALL, PERCENT, r FIX) The percentage r number f members frm the segment. This must be used in cmbinatin with sampletype. Errr messages Yu must fill in the tken parameter An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw 93

94 API call summary: HTTP GET (Query String) Submissin & sample URL call URL Cntent-type text/xml; charset=utf-8 Bdy <segmentatin> <descriptin>segment descriptin</descriptin> <name>segment new name</name> <sampletype>all</sampletype> </segmentatin> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 94

95 Add String Demgraphic Criteria t a Segment This methd add alphanumeric demgraphic criteria t a segment. This is a PUT methd. addstringdemgraphic Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the segment String Demgraphic Criteria Parameters stringdemgraphiccriteria The string demgraphic criteria envelpe parameter. true if it was successful, false if it was nt successful grupname grupnumber rderfrag clumnname The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The rder f the criteria in relatin t the ther criteria f the segment The name f the clumn in the database 95

96 Required peratr values The peratr Case-insensitive peratrs EQUALS CONTAINS DOES_NOT_CONTAINS BEGINS_WITH ENDS_WITH IS_EMPTY IS_NOT_EMPTY Case-sensitive peratrs EQUALS_CASE_SENSITIVE CONTAINS_CASE_SENSITIVE DOES_NOT_CONTAINS_CASE_SENSITIVE BEGINS_WITH_CASE_SENSITIVE ENDS_WITH_CASE_SENSITIVE The values t which the peratr will cmpare the data in the database field Errr messages Yu must fill in the tken parameter The clumn name is nt a String Demgraphic r desn't exist. Yu must fill in the segmentid parameter. The grupname passed in API Criteria bject must cntain less than 20 characters. The peratr passed in API bject desn't exist fr criteria. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call

97 URL addstringdemgraphic Cntent-type text/xml; charset=utf-8 Bdy <stringdemgraphiccriteria> <grupname>group 4</grupName> <grupnumber>4</grupnumber> <clumnname> </clumnname> <peratr>contains</peratr> <values>htmail</values> </stringdemgraphiccriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 97

98 Add Numeric Demgraphic Criteria t a Segment This methd adds numeric demgraphic criteria t a segment. This is a PUT methd. addnumericdempgraphic Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the segment Numeric Demgraphic Criteria Parameters numericdemgraphiccriteria The numeric demgraphic criteria envelpe parameter. grupname grupnumber rderfrag clumnname peratr The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The rder f the criteria in relatin t the ther criteria f the segment The name f the clumn in the database The peratr EQUALS NOT_EQUALS IS_EMPTY IS_NOT_EMPTY SUPERIOR SUPERIOR_OR_EQUAL INFERIOR INFERIOR_OR_EQUAL IS_BETWEEN IS_NOT_BETWEEN true if it was successful, false if it was nt successful 98

99 Required firstvalue secndvalue The first value n which the peratr acts. Required in all cases except when cmbined with the *_ NOT_EMPTY and *_EMPTY peratrs. The secnd value n which the peratr acts. Required in all cases except when cmbined with the *_ NOT_EMPTY and *_EMPTY peratrs. Errr messages Yu must fill in the tken parameter Yu must fill in the segmentid parameter. The clumn name is nt a Numeric Demgraphic r desn't exist. The peratr passed in API bject desn't exist fr criteria. The grupname passed in API Criteria bject must cntain less than 20 characters. This criteria desn't exist fr the segment. The secnd value is missing. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call URL addnumericdempgraphic Cntent-type 99

100 text/xml; charset=utf-8 Bdy <numericdemgraphiccriteria> <grupname>group 1</grupName> <grupnumber>1</grupnumber> <id>12345</id> <rderfrag>0</rderfrag> <clumnname>code</clumnname> <firstvalue>0</firstvalue> <peratr>is_between</peratr> <secndvalue>5</secndvalue> </numericdemgraphiccriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 100

101 Add Date Demgraphic Criteria t a Segment This methd adds date demgraphic criteria t a segment. This is a PUT methd. adddatedemgraphic Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the segment Date Demgraphic Criteria Parameters datedemgraphiccriteria The date demgraphic criteria envelpe parameter. true if it was successful, false if it was nt successful grupname grupnumber rderfrag clumnname abslutedate The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The rder f the criteria in relatin t the ther criteria f the segment The name f the clumn in the database Defines whether the date criteria cnsists f abslute dates r relative dates (1 = abslute dates, 0 = relative dates) 101

102 Required peratr firstabslutedate The peratr Generic peratrs IS_EMPTY IS_NOT_EMPTY Time-sensitive peratrs ABSOLUTE_AFTER_TIME_SENSITIVE ABSOLUTE_AFTER_OR_ON_TIME_SENSITIVE ABSOLUTE_BEFORE_TIME_SENSITIVE ABSOLUTE_BEFORE_OR_ON_TIME_SENSITIVE ABSOLUTE_IS_BETWEEN_TIME_SENSITIVE ABSOLUTE_IS_NOT_BETWEEN_TIME_SENSITIVE ABSOLUTE_NOT_ON_TIME_SENSITIVE ABSOLUTE_ON_TIME_SENSITIVE Nn-time-sensitive peratrs ABSOLUTE_AFTER ABSOLUTE_AFTER_OR_ON ABSOLUTE_BEFORE ABSOLUTE_BEFORE_OR_ON ABSOLUTE_IS_BETWEEN ABSOLUTE_IS_NOT_BETWEEN ABSOLUTE_NOT_ON ABSOLUTE_ON Relative date peratrs RELATIVE_AFTER_AFTER RELATIVE_AFTER_BEFORE RELATIVE_AFTER_OR_ON_AFTER RELATIVE_AFTER_OR_ON_BEFORE RELATIVE_BEFORE_AFTER RELATIVE_BEFORE_BEFORE RELATIVE_BEFORE_OR_ON_AFTER RELATIVE_BEFORE_OR_ON_BEFORE RELATIVE_NOT_ON_AFTER RELATIVE_NOT_ON_BEFORE RELATIVE_ON_AFTER RELATIVE_ON_BEFORE The start date (YYYY-MM-DDTHH:MM:SS) If the peratr is time sensitive, the date and time need t be indicated using the fllwing frmat (where T serves as a divider between date and time): YYYY-MM-DDTHH:MM:SS If the peratr is nt time sensitive, nly the date needs t be indicated using the fllwing frmat: YYYY-MM-DD 102

103 Required secndabslutedate numberdaysbefreor After relativeclumnname BefreOrAfter values The end date (YYYY-MM-DDTHH:MM:SS) Required if the peratr is *_BETWEEN r *_NOT_BETWEEN. If the peratr is time sensitive, the date and time need t be indicated using the fllwing frmat (where T serves as a divider between date and time): YYYY-MM-DDTHH:MM:SS If the peratr is nt time sensitive, nly the date needs t be indicated using the fllwing frmat: YYYY-MM-DD Yu can cmbine multiple cmbinatins f firstabslutedate and secndabslutedate criteria (see the example belw). The number f days befre r after the selected database field date The database field name cntaining the base date value fr relative dates Yu can cmbine multiple cmbinatins f numberdaysbefreorafter and relativeclumnnamebefreorafter criteria (see the example belw). The values t which the peratr will cmpare the data in the database field 103

104 Errr messages Yu must fill in the tken parameter The clumn name is nt a Date Demgraphic r desn't exist. Yu must fill in the segmentid parameter. The grupname passed in API Criteria bject must cntain less than 20 characters. The peratr passed in API bject desn't exist fr criteria. The secnd value is missing. Wrng value f befre_after clumn. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call URL adddatedemgraphic Cntent-type text/xml; charset=utf-8 Bdy <datedemgraphiccriteria> <grupname>group 1</grupName> <grupnumber>1</grupnumber> <id>2</id> <clumnname>dateofbirth</clumnname> <abslutedate>1</abslutedate> <peratr>absolute_is_not_between_time_sensitive</peratr> <firstabslutedate> t00:00:00</firstabslutedate> <secndabslutedate> t00:00:00</secndabslutedate> <firstabslutedate> t00:00:00</firstabslutedate> <secndabslutedate> t00:00:00</secndabslutedate> 104

105 OR <abslutedate>0</abslutedate> <peratr>operator_relative_before_before_id</peratr> <numberdaysbefreorafter>90</numberdaysbefreorafter> <relativeclumnnamebefreorafter>sysdate</relativeclumnnamebefreorafter> </datedemgraphiccriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 105

106 Add Campaign Actin Criteria t a Segment This methd adds campaign actin criteria t a segment. This is a PUT methd. addcampaignactin Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the segment Actin Criteria Parameters actincriteria The actin criteria envelpe parameter. grupname grupnumber rderfrag campaignid peratr The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The rder f the criteria in relatin t the ther criteria f the segment The ID f the campaign The peratr SENT_CAMP WERENOTSENT_CAMP RECEIVEDMESSAGE_CAMP DIDNOTRECEIVEDMESSAGE_CAMP CLICKED_CAMP DIDNOTCLICKED_CAMP OPENEDMESSAGE_CAMP DIDNOTOPENEDMESSAGE_CAMP SOFTBOUNCE_CAMP true if it was successful, false if it was nt successful Errr messages Yu must fill in the tken parameter Nt fund Campaign, please specify the campaign id

107 Errr messages Yu must fill in the segmentid parameter. The peratr passed in API bject desn't exist fr criteria. The grupname passed in API Criteria bject must cntain less than 20 characters. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call URL addcampaignactin Cntent-type text/xml; charset=utf-8 Bdy <trackablelinkcriteria> <grupname>group 1</grupName> <grupnumber>1</grupnumber> <campaignid>3867</campaignid> <peratr>classic_anylink_clicked_notime</peratr> <linkorder>13</linkorder> <periddaybegin>10</periddaybegin> <periddayend>20</periddayend> </trackablelinkcriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 107

108 Add Campaign Trackable Link Criteria t a Segment This methd adds campaign tracked link criteria t a segment. This is a PUT methd. addcampaigntrackablelink Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the segment Trackable Link Criteria Parameters trackablelinkcriteria The trackable link criteria envelpe parameter. true if it was successful, false if it was nt successful grupname grupnumber rderfrag campaignid clicked peratr The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The rder f the criteria in relatin t the ther criteria f the segment The ID f the campaign The number f times the link was clicked The peratr CLASSIC_ANYLINK_CLICKED_NOTIME CLASSIC_ANYLINK_UNCLICKED_NOTIME CLASSIC_LINK_CLICKED_NOTIME CLASSIC_LINK_UNCLICKED_NOTIME CLASSIC_LINK_CLICKED_TIME CLASSIC_LINK_UNCLICKED_TIME CLASSIC_ANYLINK_CLICKED_TIME CLASSIC_ANYLINK_UNCLICKED_TIME 108

109 Required linkorder periddaybegin periddayend The rder number f the link. Required if the criteria is based n a specific tracked link. Optinal if the criteria is based n any link. The tracking start day Required if yu want t limit link tracking t a specific perid. Optinal if yu use ne f the *NOTIME peratrs. The tracking end day Required if yu want t limit link tracking t a specific perid. Optinal if yu use ne f the *NOTIME peratrs. Errr messages Yu must fill in the tken parameter Nt fund Campaign, please specify the campaign id. The grupname passed in API Criteria bject must cntain less than 20 characters. The peratr passed in API bject desn't exist fr criteria. Yu are nt authrized t manipulate this campaign. This campaign desn't exist. The perid day begin r perid day end passed in API Criteria must be less than 121. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call

110 URL addcampaigntrackablelink Cntent-type text/xml; charset=utf-8 Bdy <actincriteria> <grupname>group 1</grupName> <grupnumber>1</grupnumber> <campaignid>3867</campaignid> <peratr>sent_camp</peratr> </actincriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 110

111 Add Trigger Campaign Actin Criteria t a Segment This methd adds Trigger Campaign actin criteria t a segment. This is a PUT methd. addserieactin Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the segment Actin Criteria Parameters actincriteria The actin criteria envelpe parameter. grupname grupnumber rderfrag The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The rder f the criteria in relatin t the ther criteria f the segment messageorder The rder f the message in the Trigger Campaign serieid peratr The ID f the series f the Trigger Campaign The peratr SENT_SERIE WERENOTSENT_SERIE RECEIVEDMESSAGE_SERIE DIDNOTRECEIVEDMESSAGE_SERIE CLICKED_SERIE DIDNOTCLICKED_SERIE OPENEDMESSAGE_SERIE DIDNOTOPENEDMESSAGE_SERIE SOFTBOUNCE_SERIE true if it was successful, false if it was nt successful 111

112 Errr messages Yu must fill in the tken parameter Nt fund Reflex, please specify the serie id. Nt fund message fr Reflex, please specify the message rder. The peratr passed in API bject desn't exist fr criteria. The grupname passed in API Criteria bject must cntain less than 20 characters. The serieid passed in API Criteria bject desn't exist. Nt fund message fr Reflex, please specify the message rder. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call URL addserieactin Cntent-type text/xml; charset=utf-8 Bdy <actincriteria> <grupname>group 1</grupName> <grupnumber>1</grupnumber> <messageorder>3</messageorder> <serieid>122</serieid> <peratr>sent_serie</peratr> </actincriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> 112

113 <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 113

114 Add Trigger Campaign Trackable Link Criteria t a Segment This methd adds Trigger Campaign tracked link criteria t a segment. This is a PUT methd. addserietrackablelink Nte: Ask yur Accunt Manager fr yur server name. Required true if it was tken The cnnectin tken return id The ID f the message Trackable Link Criteria Parameters successful, false if it was nt successful trackablelinkcriteria The trackable link criteria envelpe parameter. The name f the grup (less than 20 characters). Only necessary if grupname yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grupnumber rderfrag campaignid clicked peratr grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The rder f the criteria in relatin t the ther criteria f the segment The ID f the campaign The number f times the link was clicked The peratr REFLEX_ANYLINK_CLICKED_NOTIME REFLEX_ANYLINK_UNCLICKED_NOTIME REFLEX_LINK_CLICKED_NOTIME REFLEX_LINK_UNCLICKED_NOTIME REFLEX_LINK_CLICKED_TIME REFLEX_LINK_UNCLICKED_TIME REFLEX_ANYLINK_CLICKED_TIME REFLEX_ANYLINK_UNCLICKED_TIME 114

115 Required linkorder messageorder periddaybegin periddayend serieid The rder number f the link. Required if the criteria is based n a specific tracked link. Optinal if the criteria is based n any link. The rder f the message in the Trigger Campaign The tracking start day Required if yu want t limit link tracking t a specific perid. Optinal if yu use ne f the *NOTIME peratrs. The tracking end day Required if yu want t limit link tracking t a specific perid. Optinal if yu use ne f the *NOTIME peratrs. The ID number f the series f the reflex campaign Errr messages Yu must fill in the tken parameter The peratr passed in API bject desn't exist fr criteria. Nt fund Reflex, please specify the serie id. Nt fund message fr Reflex, please specify the message rder. The grupname passed in API Criteria bject must cntain less than 20 characters. The serieid passed in API Criteria bject desn't exist. Yu must fill in the segmentid parameter. The messageorder passed in API Criteria bject desn't exist. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call

116 URL addserietrackablelink Cntent-type text/xml; charset=utf-8 Bdy <trackablelinkcriteria> <grupname>group 2</grupName> <grupnumber>2</grupnumber> <peratr>reflex_link_clicked_time</peratr> <linkorder>2</linkorder> <messageorder>3</messageorder> <periddaybegin>10</periddaybegin> <periddayend>20</periddayend> <serieid>122</serieid> </trackablelinkcriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 116

117 Add Scial Criteria t a Segment This methd adds scial criteria t a segment. This is a PUT methd. addscialnetwrk Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the segment Scial Criteria Parameters scialnetwrkcriteria The scial criteria envelpe parameter. true if it was successful, false if it was nt successful grupname grupnumber rderfrag campaignid serieid clumnname messageorder The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The rder f the criteria in relatin t the ther criteria f the segment The ID f the campaign Required if the criteria is based n a classic campaign. The ID f the series f the Trigger Campaign Required if the criteria is based n a reflex campaign The name f the clumn in the database SOCIAL_SHARERS EXTRA_OPENS The rder f the message in the Trigger Campaign 117

118 Required peratr The peratr Generic ANY_EQUALS ANY_NOT_EQUALS ANY_EMPTY ANY_NOT_EMPTY ANY_SUPERIOR ANY_SUPERIOR_OR_EQUALS ANY_INFERIOR ANY_INFERIOR_OR_EQUALS ANY_BETWEEN ANY_NOT_BETWEEN Specific campaign CAMPAIGN_EQUALS CAMPAIGN_NOT_EQUALS CAMPAIGN_EMPTY CAMPAIGN_NOT_EMPTY CAMPAIGN_SUPERIOR CAMPAIGN_SUPERIOR_OR_EQUALS CAMPAIGN_INFERIOR CAMPAIGN_INFERIOR_OR_EQUALS CAMPAIGN_BETWEEN CAMPAIGN_NOT_BETWEEN Any campaign ANY_CAMPAIGN_EQUALS ANY_CAMPAIGN_NOT_EQUALS ANY_CAMPAIGN_EMPTY ANY_CAMPAIGN_NOT_EMPTY ANY_CAMPAIGN_SUPERIOR ANY_CAMPAIGN_SUPERIOR_OR_EQUALS ANY_CAMPAIGN_INFERIOR ANY_CAMPAIGN_INFERIOR_OR_EQUALS ANY_CAMPAIGN_BETWEEN ANY_CAMPAIGN_NOT_BETWEEN Specific reflex campaign SERIE_EQUALS SERIE_NOT_EQUALS SERIE_EMPTY SERIE_NOT_EMPTY SERIE_SUPERIOR SERIE_SUPERIOR_OR_EQUALS SERIE_INFERIOR SERIE_INFERIOR_OR_EQUALS SERIE_BETWEEN SERIE_NOT_BETWEEN Any reflex campaign ANY_SERIE_EQUALS ANY_SERIE_NOT_EQUALS ANY_SERIE_EMPTY 118

119 Required snids value1 value 2 ANY_SERIE_NOT_EMPTY ANY_SERIE_SUPERIOR ANY_SERIE_SUPERIOR_OR_EQUALS ANY_SERIE_INFERIOR ANY_SERIE_INFERIOR_OR_EQUALS ANY_SERIE_BETWEEN ANY_SERIE_NOT_BETWEEN The ID f the scial netwrk 1: Delicius 2: Digg 3: Facebk 4: LinkedIn 5: YahBuzzUp 6: Twitter 7: GgleBkmarks 8: MySpace 9: Netvibes 10: Viade 11: Hyves 12: Netlg 13: Mister Wng 14: MailRu 15: Iwiw 16: Orkut The first value n which the peratr acts. Required in all cases except when cmbined with the *_NOT_ EMPTY and *_EMPTY peratrs. The secnd value n which the peratr acts. Required in all cases except when cmbined with the *_NOT_ EMPTY and *_EMPTY peratrs. Errr messages Yu must fill in the tken parameter Yu must fill in the id in the api criteria bject. Yu must fill in the clumn name in the api criteria bject. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&)

120 Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call URL addscialnetwrk Cntent-type text/xml; charset=utf-8 Bdy <scialnetwrkcriteria> <id>7374</id> <rderfrag>2</rderfrag> <campaignid>3867</campaignid> <clumnname>extra_opens</clumnname> <peratr>campaign_not_empty</peratr> <snids>1</snids> </scialnetwrkcriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 120

121 Add Recency Criteria t a Segment This methd adds quick segment criteria t segment. This is a PUT methd. addrecency Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the segment Recency Criteria Parameters recencycriteria The recency criteria envelpe parameter. true if it was successful, false if it was nt successful grupname grupnumber rderfrag clumnname firststaticvalue The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The rder f the criteria in relatin t the ther criteria f the segment The name f the clumn in the database LAST_DATE_PURCHASE LAST_DATE_CLICK LAST_DATE_OPEN The start date (YYYY-MM-DD). Required fr static dates. It shuld nt be included fr relative dates r when cmbined with the *NOT_EMPTY and *EMPTY peratrs

122 Required secndstaticvalue peratr periddaybeginlist periddayendlist The end date (YYYY-MM-DD). Required fr static dates cmbined with the *BETWEEN and *NOTBETWEEN peratrs. It shuld nt be included fr relative dates r when cmbined with the *NOT_EMPTY and *EMPTY peratrs. Yu can cmbine multiple cmbinatins f firststaticvalue and secndstaticvalue criteria. The peratr Generic peratrs EMPTY NOT_EMPTY Relative date peratrs ISBETWEEN_RELATIVE ISNOTBETWEEN_RELATIVE ON_RELATIVE NOTON_RELATIVE Static date peratrs ISBETWEEN_STATIC ISNOTBETWEEN_STATIC ON_STATIC NOTON_STATIC BEFORE_STATIC BEFOREORON_STATIC AFTER_STATIC AFTERORON_STATIC The start date (number f days befre r after tday). Required fr relative dates. It shuld nt be included fr static dates r when cmbined with the *NOT_EMPTY and *EMPTY peratrs. The end date (number f days befre r after tday). Required fr relative dates. It shuld nt be included fr static dates r when cmbined with the *NOT_EMPTY and *EMPTY peratrs. Yu can cmbine multiple cmbinatins f periddaybeginlist and periddayendlist criteria. Errr messages Yu must fill in the tken parameter Yu must fill in the segmentid parameter. The peratr passed in API bject desn't exist fr criteria. The firststaticvalue in API Criteria must be specified. The periddaybeginlist in API Criteria must be specified. An errr ccured n the server 122

123 Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call URL addrecency Cntent-type text/xml; charset=utf-8 Bdy <recencycriteria> <clumnname>last_date_purchase</clumnname> <periddaybeginlist>100</periddaybeginlist> <periddayendlist>50</periddayendlist> <peratr>isbetween_relative</peratr> </recencycriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 123

124 Add DataMart Criteria t a Segment This methd adds DataMart criteria t a segment. This is a PUT methd. adddatamart Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the segment DataMart Criteria Parameters datamartcriteria The DataMart criteria parameter envelpe. The name f the grup (less than 20 characters). Only necessary if grupname yu want t add the criteria t a grup and yu want t name the grup. true if it was successful, false if it was nt successful grupnumber rderfrag The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). PersFrag Criteria Parameters The rder f the criteria in relatin t the ther criteria f the segment apipersfragcriteria The PersFrag criteria parameter envelpe. persfragid The ID f the Datamart criteria Errr messages Yu must fill in the tken parameter The grupname passed in API Criteria bject must cntain less than 20 characters. An errr ccured n the server 124

125 Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call URL adddatamart Cntent-type text/xml; charset=utf-8 Bdy <datamartcriteria> <grupname>group 3</grupName> <grupnumber>3</grupnumber> <apipersfragcriteria> <persfragid>1222</persfragid> </apipersfragcriteria> </datamartcriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 125

126 Include r Exclude a Segment frm Anther Segment This methd includes r excludes an existing segment in the criteria f a new segment. This is a PUT methd. addinclusinexclusinsegment Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return Inclusin/Exclusin Criteria Parameters inclusinexclusincriteria rderfrag id difflistid The inclusin/exclusin criteria envelpe parameter. The rder f the criteria in relatin t the ther criteria f the segment The ID f the segment t create The ID f the segment that shuld be included/excluded true if it was successful, false if it was nt successful peratr The peratr SEGMENT_INCLUSION SEGMENT_EXCLUSION Errr messages Yu must fill in the tken parameter The peratr passed in API bject desn't exist fr criteria. Yu can't retrieve this type f segment. This criteria desn't exist fr the segment. {0} is nt activated fr the client. Yu must fill in the segmentid parameter. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat

127 HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call URL addinclusinexclusinsegment Cntent-type text/xml; charset=utf-8 Bdy <inclusinexclusincriteria> <id>7400</id> <difflistid>7308</difflistid> <peratr>segment_inclusion</peratr> </inclusinexclusincriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 127

128 Get Segment by ID This methd retrieves a segment by its ID. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return An ApiSegmentatin bject difflistid The ID f the segment Errr messages Yu must fill in the tken parameter An errr ccured n the server <respnse respnsestatus="success"> <segmentatin> <datecreate> t11:41:23+01:00</datecreate> <datemdif> t11:41:23+01:00</datemdif> <id>7374</id> <name>segment Name</name> <samplerate>0.0</samplerate> <sampletype>all</sampletype> </segmentatin> </respnse> 128

129 Get Segment List This methd retrieves a list f segments. This is a GET methd. {nbitemsperpage} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return A list f ApiSegmentatin bjects page nbitemsperpage The current page The number f items per page Errr messages Yu must fill in the tken parameter An errr ccured n the server <respnse respnsestatus="success"> <entities> <id>7374</id> <id>7308</id> <id>2621</id> </entities> </respnse> 129

130 Get Segment Criteria This methd retrieves the criteria used in a segment. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return An ApiSegmentatin bject difflistid The ID f the segment Errr messages Yu must fill in the tken parameter Yu must fill in the difflistid parameter. An errr ccured n the server <respnse respnsestatus="success"> <apisegmentcriterias> <datedemgraphiccriteria> <grupnumber>-1</grupnumber> <id>7308</id> <rderfrag>0</rderfrag> <abslutedate>true</abslutedate> <clumnname>dateofbirth</clumnname> <firstabslutedate> t00:00:00+01:00</firstabslutedate> <peratr>absolute_after</peratr> </datedemgraphiccriteria> </apisegmentcriterias> </respnse> 130

131 Get DataMart Segment List This methd retrieves a list f DataMart segments. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return A list f ApiPersFragCriteria bjects pagenumber nbitemperpage The current page The number f items per page Errr messages Yu must fill in the tken parameter An errr ccured n the server <respnse respnsestatus="success"> <ApiPersFragCriteria> <persfragid>2</persfragid> <persdesc>first per frag sql</persdesc> <persname>pers frag name</persname> </ApiPersFragCriteria> 131

132 Delete Segment Criteria This methd deletes a criteria cell frm a segment. This is a DELETE methd. list Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return true if it was successful, false if it was nt successful difflistid rdercriteria The ID f the segment The rder f the criteria in the segment Errr messages Yu must fill in the tken parameter Yu must fill in the difflistid parameter. This segment desn't exist. This criteria desn't exist fr the segment. Yu can't delete a criteria in a ne criteria segment. Please delete the segment instead. An errr ccured n the server <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 132

133 Update the String Demgraphic Criteria f a Segment This methd updates alphanumeric demgraphic criteria. Nte: In rder t update a segment, yu must first use the Get Segment Criteria methd t retrieve all its. This is a POST methd. {rder}/updatestringdemgraphic Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return rder String Demgraphic Criteria Parameters The rder f the criteria in relatin t the ther criteria f the segment stringdemgraphiccriteria The string demgraphic criteria envelpe parameter. true if it was successful, false if it was nt successful grupname grupnumber id clumnname The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The ID f the segment The name f the clumn in the database 133

134 Required peratr values The peratr Case-insensitive peratrs EQUALS CONTAINS DOES_NOT_CONTAINS BEGINS_WITH ENDS_WITH IS_EMPTY IS_NOT_EMPTY Case-sensitive peratrs EQUALS_CASE_SENSITIVE CONTAINS_CASE_SENSITIVE DOES_NOT_CONTAINS_CASE_SENSITIVE BEGINS_WITH_CASE_SENSITIVE ENDS_WITH_CASE_SENSITIVE The values t which the peratr will cmpare the data in the database field Errr messages Yu must fill in the tken parameter The clumn name is nt a String Demgraphic r desn't exist. Yu must fill in the segmentid parameter. The grupname passed in API Criteria bject must cntain less than 20 characters. The peratr passed in API bject desn't exist fr criteria. This criteria desn't exist fr the segment. An errr ccured n the server URL updatestringdemgraphic Cntent-type text/xml; charset=utf-8 Bdy <stringdemgraphiccriteria> <grupname>group 4</grupName> <grupnumber>4</grupnumber> <clumnname>firstname</clumnname> <peratr>ends_with</peratr> <values>cm</values> </stringdemgraphiccriteria> 134

135 <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xsi=" xmlns: xsi=" </respnse> 135

136 Update the Numeric Demgraphic Criteria f a Segment This methd updates numeric demgraphic criteria. Nte: In rder t update a segment, yu must first use the Get Segment Criteria methd t retrieve all its. This is a POST methd. {rder}/updatenumericdemgraphic Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return rder Numeric Demgraphic Criteria Parameters The rder f the criteria in relatin t the ther criteria f the segment numericdemgraphiccriteria The numeric demgraphic criteria envelpe parameter. grupname grupnumber id clumnname peratr The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The ID f the segment The name f the clumn in the database The peratr EQUALS NOT_EQUALS IS_EMPTY IS_NOT_EMPTY SUPERIOR SUPERIOR_OR_EQUAL INFERIOR INFERIOR_OR_EQUAL IS_BETWEEN IS_NOT_BETWEEN true if it was successful, false if it was nt successful 136

137 Required firstvalue secndvalue The first value n which the peratr acts. Required in all cases except when cmbined with the *_ NOT_EMPTY and *_EMPTY peratrs. The secnd value n which the peratr acts. Required in all cases except when cmbined with the *_ NOT_EMPTY and *_EMPTY peratrs. Errr messages Yu must fill in the tken parameter Yu must fill in the segmentid parameter. The clumn name is nt a Numeric Demgraphic r desn't exist. The peratr passed in API bject desn't exist fr criteria. This criteria desn't exist fr the segment. The secnd value is missing. An errr ccured n the server URL 2/updateNumericDemgraphic Cntent-type text/xml; charset=utf-8 Bdy <numericdemgraphiccriteria> <grupname>group 1</grupName> <grupnumber>1</grupnumber> <clumnname>code</clumnname> <peratr>is_between</peratr> <firstvalue>0</firstvalue> <secndvalue>3</secndvalue> </numericdemgraphiccriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xsi=" xmlns: xsi=" </respnse> 137

138 Update the Date Demgraphic Criteria f a Segment This methd updates date demgraphic criteria. Nte: In rder t update a segment, yu must first use the Get Segment Criteria methd t retrieve all its. This is a POST methd. {rder}/updatedatedemgraphic Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return rder Date Demgraphic Criteria Parameters datedemgraphiccriteria The rder f the criteria in relatin t the ther criteria f the segment The date demgraphic criteria envelpe parameter. true if it was successful, false if it was nt successful grupname grupnumber id clumnname abslutedate The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The ID f the segment The name f the clumn in the database Defines whether the date criteria cnsists f abslute dates r relative dates (1 = abslute dates, 0 = relative dates) 138

139 Required peratr firstabslutedate The peratr Generic peratrs IS_EMPTY IS_NOT_EMPTY Time-sensitive peratrs ABSOLUTE_AFTER_TIME_SENSITIVE ABSOLUTE_AFTER_OR_ON_TIME_SENSITIVE ABSOLUTE_BEFORE_TIME_SENSITIVE ABSOLUTE_BEFORE_OR_ON_TIME_SENSITIVE ABSOLUTE_IS_BETWEEN_TIME_SENSITIVE ABSOLUTE_IS_NOT_BETWEEN_TIME_SENSITIVE ABSOLUTE_NOT_ON_TIME_SENSITIVE ABSOLUTE_ON_TIME_SENSITIVE Nn-time-sensitive peratrs ABSOLUTE_AFTER ABSOLUTE_AFTER_OR_ON ABSOLUTE_BEFORE ABSOLUTE_BEFORE_OR_ON ABSOLUTE_IS_BETWEEN ABSOLUTE_IS_NOT_BETWEEN ABSOLUTE_NOT_ON ABSOLUTE_ON Relative date peratrs RELATIVE_AFTER_AFTER RELATIVE_AFTER_BEFORE RELATIVE_AFTER_OR_ON_AFTER RELATIVE_AFTER_OR_ON_BEFORE RELATIVE_BEFORE_AFTER RELATIVE_BEFORE_BEFORE RELATIVE_BEFORE_OR_ON_AFTER RELATIVE_BEFORE_OR_ON_BEFORE RELATIVE_NOT_ON_AFTER RELATIVE_NOT_ON_BEFORE RELATIVE_ON_AFTER RELATIVE_ON_BEFORE The start date (YYYY-MM-DDTHH:MM:SS) If the peratr is time sensitive, the date and time need t be indicated using the fllwing frmat (where T serves as a divider between date and time): YYYY-MM-DDTHH:MM:SS If the peratr is nt time sensitive, nly the date needs t be indicated using the fllwing frmat: YYYY-MM-DD 139

140 Required secndabslutedate numberdaysbefreorafter The end date (YYYY-MM-DDTHH:MM:SS) Required if the peratr is *_BETWEEN r *_NOT_BETWEEN. If the peratr is time sensitive, the date and time need t be indicated using the fllwing frmat (where T serves as a divider between date and time): YYYY-MM-DDTHH:MM:SS If the peratr is nt time sensitive, nly the date needs t be indicated using the fllwing frmat: YYYY-MM-DD Yu can cmbine multiple cmbinatins f firstabslutedate and secndabslutedate criteria. The number f days befre r after the selected database field date relativeclumnnamebefre OrAfter The database field name cntaining the base date value fr relative dates Yu can cmbine multiple cmbinatins f numberdaysbefreorafter and relativeclumnnamebefreorafter criteria. values The values t which the peratr will cmpare the data in the database field 140

141 Errr messages Yu must fill in the tken parameter The clumn name is nt a Date Demgraphic r desn't exist. Yu must fill in the segmentid parameter. The grupname passed in API Criteria bject must cntain less than 20 characters. The peratr passed in API bject desn't exist fr criteria. This criteria desn't exist fr the segment. The secnd value is missing. Wrng value f befre_after clumn. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call URL 2/updateDateDemgraphic Cntent-type text/xml; charset=utf-8 Bdy <datedemgraphiccriteria> <grupname>group 1</grupName> <grupnumber>1</grupnumber> <abslutedate>1</abslutedate> <clumnname>dateofbirth</clumnname> <peratr>absolute_is_not_between_time_sensitive</peratr> <firstabslutedate> t00:00:00</firstabslutedate> <secndabslutedate> t00:00:00</secndabslutedate> </datedemgraphiccriteria> 141

142 <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xsi=" xmlns: xsi=" </respnse> 142

143 Update the Campaign Actin Criteria f a Segment This methd updates campaign actin criteria. Nte: In rder t update a segment, yu must first use the Get Segment Criteria methd t retrieve all its. This is a POST methd. {rder}/updatecampaignactin Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id rder The ID f the segment Actin Criteria Parameters The rder f the criteria in relatin t the ther criteria f the segment actincriteria The actin criteria envelpe parameter. grupname The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber grupnumber takes pririty ver grupname (i.e. if grupnumber campaignid peratr cntradicts grupname, grupname will be ignred). The ID f the campaign The peratr SENT_CAMP WERENOTSENT_CAMP RECEIVEDMESSAGE_CAMP DIDNOTRECEIVEDMESSAGE_CAMP CLICKED_CAMP DIDNOTCLICKED_CAMP OPENEDMESSAGE_CAMP DIDNOTOPENEDMESSAGE_CAMP SOFTBOUNCE_CAMP true if it was successful, false if it was nt successful 143

144 Errr messages Yu must fill in the tken parameter Nt fund Campaign, please specify the campaign id. The peratr passed in API bject desn't exist fr criteria. The grupname passed in API Criteria bject must cntain less than 20 characters. This criteria desn't exist fr the segment. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call URL /1/updateCampaignActin Cntent-type text/xml; charset=utf-8 Bdy <actincriteria> <grupname>group 1</grupName> <grupnumber>1</grupnumber> <campaignid>3867</campaignid> <peratr>sent_camp</peratr> </actincriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 144

145 Update the Campaign Trackable Link Criteria f a Segment This methd updates campaign tracked link criteria. Nte: In rder t update a segment, yu must first use the Get Segment Criteria methd t retrieve all its. This is a POST methd. {rder}/updatecampaigntrackablelink Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return rder Trackable Link Criteria Parameters The rder f the criteria in relatin t the ther criteria f the segment This parameter must be present. Hwever it can be left undefined. trackablelinkcriteria The trackable link criteria envelpe parameter. grupname grupnumber id campaignid The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The ID f the segment The ID f the campaign true if it was successful, false if it was nt successful 145

146 Required peratr linkorder periddaybegin periddayend serieid The peratr CLASSIC_ANYLINK_CLICKED_NOTIME CLASSIC_ANYLINK_UNCLICKED_NOTIME CLASSIC_LINK_CLICKED_NOTIME CLASSIC_LINK_UNCLICKED_NOTIME CLASSIC_LINK_CLICKED_TIME CLASSIC_LINK_UNCLICKED_TIME CLASSIC_ANYLINK_CLICKED_TIME CLASSIC_ANYLINK_UNCLICKED_TIME The rder number f the link. Required if the criteria is based n a specific tracked link. Optinal if the criteria is based n any link. The tracking start day Required if yu want t limit link tracking t a specific perid. Optinal if yu use ne f the *NOTIME peratrs. The tracking end day Required if yu want t limit link tracking t a specific perid. Optinal if yu use ne f the *NOTIME peratrs. The ID f the series f the Trigger Campaign Errr messages Yu must fill in the tken parameter Nt fund Campaign, please specify the campaign id. Yu must fill in the segmentid parameter. This criteria desn't exist fr the segment. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: 146

147 HTTP GET (Query String) Submissin & sample URL call URL updatecampaigntrackablelink Cntent-type text/xml; charset=utf-8 Bdy <trackablelinkcriteria> <grupname>group 1</grupName> <grupnumber>1</grupnumber> <campaignid>3867</campaignid> <peratr>classic_anylink_clicked_notime</peratr> <linkorder>2</linkorder> <periddaybegin>10</periddaybegin> <periddayend>20</periddayend> </trackablelinkcriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xsi=" xmlns: xsi=" </respnse> 147

148 Update the Trigger Campaign Actin Criteria f a Segment This methd updates Trigger Campaign actin criteria. Nte: In rder t update a segment, yu must first use the Get Segment Criteria methd t retrieve all its. This is a POST methd. {rder}/updateserieactin Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return rder Actin Criteria Parameters The rder f the criteria in relatin t the ther criteria f the segment actincriteria The actin criteria envelpe parameter. grupname grupnumber id The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The ID f the segment messageorder The rder f the message in the Trigger Campaign serieid peratr The ID f the series f the Trigger Campaign The peratr SENT_SERIE WERENOTSENT_SERIE RECEIVEDMESSAGE_SERIE DIDNOTRECEIVEDMESSAGE_SERIE CLICKED_SERIE DIDNOTCLICKED_SERIE OPENEDMESSAGE_SERIE DIDNOTOPENEDMESSAGE_SERIE SOFTBOUNCE_SERIE true if it was successful, false if it was nt successful 148

149 Errr messages Yu must fill in the tken parameter Nt fund Reflex, please specify the serie id. Nt fund message fr Reflex, please specify the message rder. The peratr passed in API bject desn't exist fr criteria. The grupname passed in API Criteria bject must cntain less than 20 characters. This criteria desn't exist fr the segment. The serieid passed in API Criteria bject desn't exist. Nt fund message fr Reflex, please specify the message rder. An errr ccured n the server URL 2/updateSerieActin Cntent-type text/xml; charset=utf-8 Bdy <actincriteria> <grupname>group 1</grupName> <grupnumber>1</grupnumber> <messageorder>3</messageorder> <serieid>14</serieid> <peratr>sent_serie</peratr> </actincriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xsi=" xmlns: xsi=" </respnse> 149

150 Update the Trigger Campaign Trackable Link Criteria f a Segment This methd updates Trigger Campaign tracked link criteria. Nte: In rder t update a segment, yu must first use the Get Segment Criteria methd t retrieve all its. This is a POST methd. {rder}/updateserietrackablelink Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return rder Trackable Link Criteria Parameters The rder f the criteria in relatin t the ther criteria f the segment trackablelinkcriteria The trackable link criteria envelpe parameter. true if it was successful, false if it was nt successful grupname grupnumber id campaignid clicked The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The ID f the segment The ID f the campaign The number f times the link was clicked 150

151 Required peratr linkorder messageorder periddaybegin periddayend serieid The peratr REFLEX_ANYLINK_CLICKED_NOTIME REFLEX_ANYLINK_UNCLICKED_NOTIME REFLEX_LINK_CLICKED_NOTIME REFLEX_LINK_UNCLICKED_NOTIME REFLEX_LINK_CLICKED_TIME REFLEX_LINK_UNCLICKED_TIME REFLEX_ANYLINK_CLICKED_TIME REFLEX_ANYLINK_UNCLICKED_TIME The rder number f the link. Required if the criteria is based n a specific tracked link. Optinal if the criteria is based n any link. The rder f the message in the Trigger Campaign The tracking start day Required if yu want t limit link tracking t a specific perid. Optinal if yu use ne f the *NOTIME peratrs. The tracking end day Required if yu want t limit link tracking t a specific perid. Optinal if yu use ne f the *NOTIME peratrs. The ID f the series f the Trigger Campaign Errr messages Yu must fill in the tken parameter Nt fund Reflex, please specify the serie id. Nt fund message fr Reflex, please specify the message rder. Yu must fill in the segmentid parameter. This criteria desn't exist fr the segment. The serieid passed in API Criteria bject desn't exist. The messageorder passed in API Criteria bject desn't exist. An errr ccured n the server URL 2/updateSerieTrackableLink Cntent-type text/xml; charset=utf-8 Bdy 151

152 <trackablelinkcriteria> <grupname>group 2</grupName> <grupnumber>2</grupnumber> <peratr>reflex_link_clicked_time</peratr> <linkorder>2</linkorder> <messageorder>3</messageorder> <periddaybegin>10</periddaybegin> <periddayend>20</periddayend> <serieid>7891</serieid> </trackablelinkcriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xsi=" xmlns: xsi=" </respnse> 152

153 Update the Scial Criteria f a Segment This methd updates scial criteria. Nte: In rder t update a segment, yu must first use the Get Segment Criteria methd t retrieve all its. This is a POST methd. {rder}/updatescialnetwrk Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return rder Scial Criteria Parameters The rder f the criteria in relatin t the ther criteria f the segment scialnetwrkcriteria The scial criteria envelpe parameter. true if it was successful, false if it was nt successful grupname grupnumber id campaignid serieid clumnname The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The ID f the segment The ID f the campaign The ID f the series f the Trigger Campaign The name f the clumn in the database 153

154 Required peratr The peratr Generic ANY_EQUALS ANY_NOT_EQUALS ANY_EMPTY ANY_NOT_EMPTY ANY_SUPERIOR ANY_SUPERIOR_OR_EQUALS ANY_INFERIOR ANY_INFERIOR_OR_EQUALS ANY_BETWEEN ANY_NOT_BETWEEN Specific campaign CAMPAIGN_EQUALS CAMPAIGN_NOT_EQUALS CAMPAIGN_EMPTY CAMPAIGN_NOT_EMPTY CAMPAIGN_SUPERIOR CAMPAIGN_SUPERIOR_OR_EQUALS CAMPAIGN_INFERIOR CAMPAIGN_INFERIOR_OR_EQUALS CAMPAIGN_BETWEEN CAMPAIGN_NOT_BETWEEN Any campaign ANY_CAMPAIGN_EQUALS ANY_CAMPAIGN_NOT_EQUALS ANY_CAMPAIGN_EMPTY ANY_CAMPAIGN_NOT_EMPTY ANY_CAMPAIGN_SUPERIOR ANY_CAMPAIGN_SUPERIOR_OR_EQUALS ANY_CAMPAIGN_INFERIOR ANY_CAMPAIGN_INFERIOR_OR_EQUALS ANY_CAMPAIGN_BETWEEN ANY_CAMPAIGN_NOT_BETWEEN Specific reflex campaign SERIE_EQUALS SERIE_NOT_EQUALS SERIE_EMPTY SERIE_NOT_EMPTY SERIE_SUPERIOR SERIE_SUPERIOR_OR_EQUALS SERIE_INFERIOR SERIE_INFERIOR_OR_EQUALS SERIE_BETWEEN SERIE_NOT_BETWEEN Any reflex campaign ANY_SERIE_EQUALS ANY_SERIE_NOT_EQUALS ANY_SERIE_EMPTY 154

155 Required snids value1 value 2 ANY_SERIE_NOT_EMPTY ANY_SERIE_SUPERIOR ANY_SERIE_SUPERIOR_OR_EQUALS ANY_SERIE_INFERIOR ANY_SERIE_INFERIOR_OR_EQUALS ANY_SERIE_BETWEEN ANY_SERIE_NOT_BETWEEN The ID f the scial netwrk 1: Delicius 2: Digg 3: Facebk 4: LinkedIn 5: YahBuzzUp 6: Twitter 7: GgleBkmarks 8: MySpace 9: Netvibes 10: Viade 11: Hyves 12: Netlg 13: Mister Wng 14: MailRu 15: Iwiw 16: Orkut The secnd value n which the peratr acts. Required in all cases except when cmbined with the *_NOT_ EMPTY and *_EMPTY peratrs. The first value n which the peratr acts. Required in all cases except when cmbined with the *_NOT_ EMPTY and *_EMPTY peratrs

156 Errr messages Yu must fill in the tken parameter Yu must fill in the id in the api criteria bject. Yu must fill in the clumn name in the api criteria bject. This criteria desn't exist fr the segment. An errr ccured n the server URL 2/updateScialNetwrk Cntent-type text/xml; charset=utf-8 Bdy <scialnetwrkcriteria> <campaignid> </campaignid> <clumnname>nb_sn_opened</clumnname> <peratr>campaign_not_empty</peratr> <snids>1</snids> </scialnetwrkcriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xsi=" xmlns: xsi=" </respnse> 156

157 Update the Recency Criteria f a Segment This methd updates quick segment criteria. Nte: In rder t update a segment, yu must first use the Get Segment Criteria methd t retrieve all its. This is a POST methd. {rder}/updaterecency Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return rder Recency Criteria Parameters recencycriteria The rder f the criteria in relatin t the ther criteria f the segment The recency criteria envelpe parameter. true if it was successful, false if it was nt successful grupname grupnumber id clumnname firststaticvalue The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber cntradicts grupname, grupname will be ignred). The ID f the segment The name f the clumn in the database LAST_DATE_PURCHASE LAST_DATE_CLICK LAST_DATE_OPEN The start date (YYYY-MM-DD). Required fr static dates. It shuld nt be included fr relative dates r when cmbined with the *NOT_EMPTY and *EMPTY peratrs

158 Required secndstaticvalue peratr periddaybeginlist periddayendlist The end date (YYYY-MM-DD). Required fr static dates cmbined with the *BETWEEN and *NOTBETWEEN peratrs. It shuld nt be included fr relative dates r when cmbined with the *NOT_EMPTY and *EMPTY peratrs. Yu can cmbine multiple cmbinatins f firststaticvalue and secndstaticvalue criteria. The peratr Generic peratrs EMPTY NOT_EMPTY Relative date peratrs ISBETWEEN_RELATIVE ISNOTBETWEEN_RELATIVE ON_RELATIVE NOTON_RELATIVE Static date peratrs ISBETWEEN_STATIC ISNOTBETWEEN_STATIC ON_STATIC NOTON_STATIC BEFORE_STATIC BEFOREORON_STATIC AFTER_STATIC AFTERORON_STATIC The start date (number f days befre r after tday). Required fr relative dates. It shuld nt be included fr static dates r when cmbined with the *NOT_EMPTY and *EMPTY peratrs. The end date (number f days befre r after tday). Required fr relative dates. It shuld nt be included fr static dates r when cmbined with the *NOT_EMPTY and *EMPTY peratrs. Yu can cmbine multiple cmbinatins f periddaybeginlist and periddayendlist criteria. Errr messages Yu must fill in the tken parameter Yu must fill in the segmentid parameter. The peratr passed in API bject desn't exist fr criteria. The grupname passed in API Criteria bject must cntain less than 20 characters. This criteria desn't exist fr the segment. The firststaticvalue in API Criteria must be specified. The periddaybeginlist in API Criteria must be specified. An errr ccured n the server 158

159 URL updaterecency Cntent-type text/xml; charset=utf-8 Bdy <recencycriteria> <grupname>group 1</grupName> <grupnumber>1</grupnumber> <clumnname>datejoin</clumnname> <firststaticvalue> </firststaticvalue> <secndstaticvalue> </secndstaticvalue> <peratr>isbetween_static</peratr> </recencycriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xsi=" xmlns: xsi=" </respnse> 159

160 Update the DataMart Criteria f a Segment This methd updates DataMart criteria. Nte: In rder t update a segment, yu must first use the Get Segment Criteria methd t retrieve all its. This is a POST methd. {rder}/updatedatamart Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return rder DataMart Criteria Parameters datamartcriteria grupname The rder f the criteria in relatin t the ther criteria f the segment The DataMart criteria parameter envelpe. The name f the grup (less than 20 characters). Only necessary if yu want t add the criteria t a grup and yu want t name the grup. true if it was successful, false if it was nt successful The ID f the grup. Required if yu want t add the criteria t a grup. grupnumber takes pririty ver grupname (i.e. if grupnumber grupnumber cntradicts grupname, grupname will be ignred). id The ID f the segment PersFrag Criteria Parameters apipersfragcriteria The PersFrag criteria parameter envelpe. persfragid The ID f the Datamart criteria Errr messages Yu must fill in the tken parameter Yu must fill in the segmentid parameter. The grupname passed in API Criteria bject must cntain less than 20 characters. An errr ccured n the server 160

161 Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call URL updatedatamart Cntent-type text/xml; charset=utf-8 Bdy <datamartcriteria> <grupname>group 3</grupName> <grupnumber>3</grupnumber> <apipersfragcriteria> <persfragid>1222</persfragid> </apipersfragcriteria> </datamartcriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xsi=" xmlns: xsi=" </respnse> 161

162 Update the Included/Excluded Segment Criteria f a Segment This methd updates a segment's included r excluded segment. Nte: In rder t update a segment, yu must first use the Get Segment Criteria methd t retrieve all its. This is a POST methd. {rder}/updateinclusinexclusinsegment Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return rder Inclusin/Exclusin Criteria Parameters inclusinexclusincriteria id difflistid The rder f the criteria in relatin t the ther criteria f the segment The inclusin/exclusin criteria envelpe parameter. The ID f the segment t update The ID f the segment that shuld be included/excluded true if it was successful, false if it was nt successful peratr The peratr SEGMENT_INCLUSION SEGMENT_EXCLUSION Errr messages Yu must fill in the tken parameter The peratr passed in API bject desn't exist fr criteria. Yu can't retrieve this type f segment. This criteria desn't exist fr the segment. {0} is nt activated fr the client. Yu must fill in the segmentid parameter. An errr ccured n the server URL 162

163 2/updateInclusinExclusinSegment Cntent-type text/xml; charset=utf-8 Bdy <inclusinexclusincriteria> <difflistid> </difflistid> <peratr>segment_inclusion</peratr> </inclusinexclusincriteria> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xsi=" xmlns: xsi=" </respnse> 163

164 Cunt Segment This methd cunts the ttal number f members in a segment (including duplicated members). This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The number f members id The ID f the segment Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:int">27901</result> </respnse> 164

165 Cunt Distinct Segment Members This methd cunts the ttal number f distinct members in a segment (i.e. duplicate members are remved). This is a GET methd. distinctcunt Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The number f members id The ID f the segment Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:int">26511</result> </respnse> 165

166 Campaign Campaign The campaign is the assembly f what will be sent: the message, t recipients, the segment, and sme extra infrmatin like delivery speed, etc. When the campaign is cnfigured yu can test it and pst it t start the prcessing. The Campaign Object analytics deliveryspeed descriptin dedupflg frmat id lifestatus mailinglistid messageid name ntificatin Set t true t activate analytics The maximum number f messages sent per hur fr this campaign The descriptin f the campaign Set t true t deduplicate the members f the segment The frmat f the campaign (TXT,HTML,AOL,MULTIPART,SMS,OTHER) (default OTHER) The ID f the campaign This is an bslete parameter and shuld nt be used. This is an bslete parameter and shuld nt be used. When it des appear, it is the equivalent f segmentid. The ID f the message t send The name f the campaign Set t true t be ntified f the prgress f the campaign by pstclicktracking Set t true t use pst click tracking segmentids senddate status strategy target urlendcampaign urlhst valid The ID f the segment t which the campaign will be sent. The date fr when t schedule the campaign (YYYY-MM-DDTHH:mm:SS) The status f the campaign (EDITABLE, QUEUED, RUNNING, PAUSED, COMPLETED, FAILED, KILLED). (ACQUISITION,RETENTION,OTHER) (default OTHER) (C2C,B2C,B2B,OTHER) (default OTHER) The end-f-tracking URL. An campaign is tracked fr 45 days by default. After that, tracked links will be redirected t this URL.(default null) The branded trackable URL This is an bslete parameter and shuld nt be used. Nte: The making up the bject d nt always need t be present fr methds using the bject. Fr example, when yu create a new banner, campaign, r message, yu d nt need t prvide the id parameter even thugh this is present in the bject. Each methd's sectin lists the that must r can be included fr the methd. On the ther hand, these are all present when the bject appears in a methd's utput

167 Create Campaign This methd creates a campaign. This is a GET methd. {senddate}/{messageid}/{segmentids}/{ntifprgress}/{pstclicktracking}/{ dedupflg} Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return The ID f the campaign name desc senddate messageid mailinglistid ntifprgress pstclicktracking dedupflg Name f the campaign The descriptin f the campaign The date fr when t schedule the campaign (YYYY-MM-DD HH:mm:SS) The ID f the message t send The ID f the segment t which t send the campaign Set t true t be ntified f the prgress f the campaign by Set t true t use pst click tracking Set t true t deduplicate the duplicate members in the segment Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. This message desn't exist. This message is already used. Please select anther ne. Yu must fill in the messageid parameter. senddate must be in the future. senddate desn't exist r is malfrmed (gd frmat is : yyyy-mm-dd HH:mm:ss). Yu must fill in the cntenttype parameter. An errr ccured n the server 167

168 Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call %2010:00:00/11490/7374/true/true/true <respnse respnsestatus="success"> <result xsi:type="xs:lng">3866</result> </respnse> 168

169 Create Campaign with Analytics This methd creates a campaign with analytics activated. It uses the analytics settings set up fr the accunt. This is a GET methd. {senddate}/{messageid}/{segmentids}/{ntifprgress}/{pstclicktracking}/{ dedupflg} Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return The ID f the campaign name desc senddate messageid mailinglistid ntifprgress pstclicktracking dedupflg Name f the campaign The descriptin f the campaign The date fr when t schedule the campaign (YYYY-MM-DD HH:mm:SS) The ID f the message t send The ID f the segment t which t send the campaign Set t true t be ntified f the prgress f the campaign by Set t true t use pst click tracking Set t true t deduplicate the duplicate members in the segment Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. This message desn't exist. This message is already used. Please select anther ne. Yu must fill in the messageid parameter. senddate must be in the future. senddate desn't exist r is malfrmed (gd frmat is : yyyy-mm-dd HH:mm:ss). Yu must fill in the cntenttype parameter. Analytics functinality is nt activated. An errr ccured n the server 169

170 Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call AnalyticsCampaign// %2010:00:00/11123/7374/true/true/true <respnse respnsestatus="success"> <result xsi:type="xs:lng">3867</result> </respnse> 170

171 Create Campaign (POST) This methd creates a campaign. This is a POST methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return Campaign Parameters campaign name descriptin dedupflg frmat id segmentids messageid deliveryspeed ntificatin The campaign envelpe parameter. The name f the campaign The descriptin f the campaign Set t true t deduplicate the members f the segment The frmat f the campaign (TXT,HTML,AOL,MULTIPART,SMS,OTHER) (default OTHER) This attribute must be present and cntain a number value, which will be ignred. The ID f the segment t which the campaign will be sent. Multiple segments can be added. The ID f the message t send The maximum number f messages sent per hur fr this campaign Set t true t be ntified f the prgress f the campaign by pstclicktracking Set t true t use pst click tracking senddate strategy target urlendcampaign urlhst analytics The date fr when t schedule the campaign (YYYY-MM-DDTHH:mm:SS) (ACQUISITION,RETENTION,OTHER) (default OTHER) (C2C,B2C,B2B,OTHER) (default OTHER) The end-f-tracking URL. An campaign is tracked fr 45 days by default. After that, tracked links will be redirected t this URL.(default null) The branded trackable URL Set t true t activate analytics The ID f the campaign 171

172 Errr messages Yu must fill in the tken parameter This mailinglist desn't exist. Yu must fill in the name parameter. This message desn't exist. This message is already used. Please select anther ne. Yu must fill in the messageid parameter. senddate must be in the future. Yu must fill in the cntenttype parameter. An errr ccured n the server URL Cntent-type text/xml; charset=utf-8 Bdy <campaign> <deliveryspeed>0</deliveryspeed> <descriptin>this is great</descriptin> < dedupflg>true</ dedupflg> <frmat>other</frmat> <lifestatus>tracking</lifestatus> <segmentids>123</segmentids> <segmentids>124</segmentids> <segmentids>125</segmentids> <messageid>1944</messageid> <name>campaign</name> <ntificatin>true</ntificatin> <pstclicktracking>true</pstclicktracking> <senddate> t00:00:00+02:00</senddate> <status>editable</status> <strategy>other</strategy> <target>other</target> <valid>editable</valid> </campaign> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 172

173 Delete Campaign This methd deletes a campaign. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return true if it was successful, false if it was nt successful id The ID f the campaign t delete Errr messages Yu must fill in the tken parameter This campaign desn't exist. Yu are nt authrized t manipulate this campaign. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:lng">true</result> </respnse> 173

174 Update Campaign This methd updates a campaign. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return true if it was successful, false if it was nt successful id field value The ID f the campaign t update The field t update: name descriptin senddate ntificatin pstclicktracking mailinglistid messageid dedupflg analytics The value t set fr the field Errr messages Yu must fill in the tken parameter This campaign desn't exist. Yu must fill in the field parameter. Yu are nt authrized t manipulate this campaign. Yu can't update a campaign that is nt EDITABLE. This mailinglist desn't exist. This message desn't exist. This message is already used. Please select anther ne. Analytics functinality is nt activated. Yu must fill in the senddate parameter An errr ccured n the server 174

175 <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 175

176 Update Campaign (POST) This methd updates a campaign. This is a POST methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return Campaign Parameters campaign The campaign envelpe parameter. id The ID f the campaign name The name f the campaign descriptin The descriptin f the campaign dedupflg Set t true t deduplicate the members f the segment frmat The frmat f the campaign (TXT,HTML,AOL,MULTIPART,SMS,OTHER) (default OTHER) segmentids The ID f the segment t which the campaign will be sent. messageid The ID f the message t send deliveryspeed The maximum number f messages sent per hur fr this campaign ntificatin Set t true t be ntified f the prgress f the campaign by pstclicktracking Set t true t use pst click tracking senddate The date fr when t schedule the campaign (YYYY-MM-DDTHH:mm:SS) strategy (ACQUISITION,RETENTION,OTHER) (default OTHER) target (C2C,B2C,B2B,OTHER) (default OTHER) The end-f-tracking URL. An campaign is tracked fr 45 days by urlendcampaign default. After that, tracked links will be redirected t this URL.(default null) urlhst The branded trackable URL analytics Set t true t activate analytics The ID f the campaign 176

177 Errr messages Yu must fill in the tken parameter This campaign desn't exist. Yu are nt authrized t manipulate this campaign. Yu can't update a campaign that is nt EDITABLE. This mailinglist desn't exist. Yu must fill in the name parameter. This message desn't exist. This message is already used. Please select anther ne. Yu must fill in the messageid parameter. senddate must be in the future. Analytics functinality is nt activated. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call URL Cntent-type text/xml; charset=utf-8 Bdy <campaign> <deliveryspeed>0</deliveryspeed> <descriptin>this is great</descriptin> <id>1543</id> < dedupflg>true</ dedupflg> 177

178 <frmat>other</frmat> <lifestatus>tracking</lifestatus> <segmentids>123</segmentids> <segmentids>124</segmentids> <segmentids>125</segmentids> <messageid>1944</messageid> <name>campaign</name> <ntificatin>true</ntificatin> <pstclicktracking>true</pstclicktracking> <senddate> t00:00:00+02:00</senddate> <status>editable</status> <strategy>other</strategy> <target>other</target> <valid>editable</valid> </campaign> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 178

179 Pst Campaign This methd psts a campaign. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the campaign t pst true if it was successful, false if it was nt successful Errr messages Yu must fill in the tken parameter This campaign desn't exist. Yu are nt authrized t manipulate this campaign. Only EDITABLE campaign can be sent. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 179

180 Unpst Campaign This methd unpsts a psted campaign. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return true if it was successful, false if it was nt successful id The ID f the campaign t unpst Errr messages Yu must fill in the tken parameter This campaign desn't exist. Yu are nt authrized t manipulate this campaign. The status f the campaign desn't allw yu t unpst it. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 180

181 Get Campaign This methd retrieves a campaign. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The campaign id The ID f the campaign t retrieve Errr messages Yu must fill in the tken parameter Yu must fill in the field parameter. Yu must fill in the value parameter. This methd shuld nt be used with the parameter senddate. Please use the Methd getcampaignsbyperid(datebegin, dateend). An errr ccured n the server <respnse respnsestatus="success"> <campaign> <analytics>true</analytics> <deliveryspeed>0</deliveryspeed> <descriptin></descriptin> < dedupflg>true</ dedupflg> <frmat>other</frmat> <id>3867</id> <lifestatus>tracking</lifestatus> <mailinglistid>7374</mailinglistid> <messageid>11123</messageid> <name>analyticscampaign</name> <ntificatin>true</ntificatin> <pstclicktracking>true</pstclicktracking> <senddate> t10:00:00+01:00</senddate> <status>editable</status> <strategy>other</strategy> <target>other</target> 181

182 <valid>editable</valid> </campaign> </respnse> 182

183 Get Campaigns by Field This methd retrieves all campaigns that match a given value in a specified field. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The list f campaign IDs with the matching value in the specified field field value limit The field t search fr the value that shuld be matched name descriptin senddate ntificatin pstclicktracking mailinglistid segmentid messageid dedupflg analytics The value t search fr in the field The maximum number f campaigns t retrieve Errr messages Yu must fill in the tken parameter Yu must fill in the field parameter. Yu must fill in the value parameter. This methd shuld nt be used with the parameter senddate. Please use the Methd getcampaignsbyperid(datebegin, dateend). An errr ccured n the server 183

184 <respnse respnsestatus="success"> <entities> <id>3867</id> <id>3866</id> <id>3487</id> </entities> </respnse> 184

185 Get Campaigns By Status This methd retrieves a list f campaigns having a specified status. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The list f campaign IDs matching the status status Status t match EDITABLE QUEUED RUNNING PAUSED COMPLETED FAILED KILLED Errr messages Yu must fill in the tken parameter Yu must fill in the status parameter. An errr ccured n the server <respnse respnsestatus="success"> <entities> <id>664</id> <id>3867</id> <id>675</id> <id>3866</id> <id>674</id> <id>673</id> </entities> </respnse> 185

186 Get Campaigns By Perid This methd retrieves a list f campaigns frm a specified perid. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return datebegin The start date f the perid t retrieve (yyyy-mmdd HH:mm:ss) The list f campaign IDs frm that perid dateend The end date f the perid t retrieve (yyyy-mmdd HH:mm:ss) Errr messages Yu must fill in the tken parameter Yu must fill in the datebegin parameter. Yu must fill in the dateend parameter. datebegin desn't exist r is malfrmed (gd frmat is : yyyy-mm-dd HH:mm:ss). dateend desn't exist r is malfrmed (gd frmat is : yyyy-mm-dd HH:mm:ss). An errr ccured n the server %2000:00:00/ %2000:00:00 <respnse respnsestatus="success"> <entities> <id>3466</id> <id>1442</id> <id>2855</id> <id>749</id> <id>3465</id> <id>3464</id> 186

187 <id>3467</id> <id>1445</id> <id>1463</id> <id>3487</id> </entities> </respnse> 187

188 Get Campaign Status This methd retrieves a campaign's status. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The status f the campaign id The ID f the campaign fr which t get the status Errr messages Yu must fill in the tken parameter This campaign desn't exist. Yu are nt authrized t manipulate this campaign. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:string">editable</result> </respnse> 188

189 Get Last Campaigns This methd retrieves the mst recent campaigns. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return limit The maximum number f campaigns t retrieve The list f the mst recent campaign IDs Errr messages Yu must fill in the tken parameter An errr ccured n the server <respnse respnsestatus="success"> <entities> <id>3867</id> <id>3866</id> <id>3487</id> </entities> </respnse> 189

190 Test Campaign n a Grup This methd sends a test campaign t a grup f members. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return true if it was successful, false if it was nt successful id grupid The ID f the campaign t test The grup ID t whm t send the test Errr messages Yu must fill in the tken parameter This test grup desn't exist r desn't cntains any test members. This campaign desn't exist. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 190

191 Test Campaign n a Member This methd sends a test campaign t a member (see Test Campaign by Grup t create a test grup). This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return true if it was successful, false if it was nt successful id memberid The ID f the campaign t test The ID f the member t whm the test will be sent Errr messages Yu must fill in the tken parameter This campaign desn't exist. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 191

192 Pause Campaign This methd pauses a running campaign. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the campaign t pause true if it was successful, false if it was nt successful Errr messages Yu must fill in the tken parameter This campaign desn't exist. Yu are nt authrized t manipulate this campaign. Only RUNNING campaign can be paused. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 192

193 Unpause Campaign This methd unpauses a paused campaign. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return true if it was successful, false if it was nt successful id The ID f the campaign t unpause Errr messages Yu must fill in the tken parameter This campaign desn't exist. Yu are nt authrized t manipulate this campaign. The status f the campaign desn't allw yu t unpause it. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 193

194 Get Campaign Reprt This methd retrieves a campaign's reprt. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The campaign reprt data campaignid The ID f the campaign Errr messages Yu must fill in the tken parameter There is nt reprt created fr this campaign. There is n such campaign n this client accunt. An errr ccured n the server <respnse respnsestatus="success"> <campaignreprt> <begindate> t11:50:00+02:00</begindate> <campaignid>3487</campaignid> <enddate> t11:50:00+02:00</enddate> <initduratin>132</initduratin> <messageid>10961</messageid> <nbbad >0</nbbad > <nbcnversin>0</nbcnversin> <nberrr>0</nberrr> <nbjin>0</nbjin> <nbmessage>0</nbmessage> <nbmultiple>0</nbmultiple> <nbopen>0</nbopen> <nbopened>0</nbopened> <nbrespnse>0</nbrespnse> <nbselected>0</nbselected> <nbsingle>0</nbsingle> <nbskipped>0</nbskipped> <nbsfterrr>0</nbsfterrr> 194

195 <nbttalclick>0</nbttalclick> <nbuniqueclick>0</nbuniqueclick> <nbunjined>0</nbunjined> <passthruflg>false</passthruflg> </campaignreprt> </respnse> Details f the campaign reprt: Reprt Fields begindate campaignid enddate initduratin messageid nbbad The start date f the campaign The ID f the campaign The end date f the campaign N/A The ID f the message used in the campaign N/A nbcnversin The ttal number f recipients wh clicked thrugh the t a cnversin page nberrr nbjin nbmessage nbmultiple nbopen nbopened nbrespnse nbselected nbsingle nbskipped The ttal number f s that culd nt be delivered fr a permanent reasn such as an invalid r expired address. N/A The ttal number f s sent. Ttal number f net sent = Selected - Filtered N/A N/A The ttal number f recipients wh pened an . The ttal number f recipients wh clicked thrugh an t a landing page. The ttal number f members selected as recipients f the campaign. N/A The ttal number f s that were nt sent due t settings such as Dedupe n send OR Mailing Frequency Cntrl. The ttal number f s that culd nt be delivered fr a temprary reasn such as the recipient's nbsfterrr mailbx being full, the size and/r attachments being t large, r a temprary netwrk prblem during the transmissin prcess. nbttalclick nbuniqueclick N/A The ttal number f clicks generated by an campaign (excluding Unsubscribe and Share clicks). nbunjined passthruflg The ttal number f unsubscribes N/A 195

196 Get Campaign Snapsht Reprt This methd retrieves a snapsht reprt fr a campaign. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The campaign snapsht reprt data campaignid The ID f the campaign Errr messages Yu must fill in the tken parameter There is nt reprt created fr this campaign. There is n such campaign n this client accunt. An errr ccured n the server <respnse respnsestatus="success"> <campaignsnapsht> <begindate> t11:50:00+02:00</begindate> <campaignid>3487</campaignid> <enddate> t11:50:00+02:00</enddate> <nbbunce>0</nbbunce> <nbcmplaint>0</nbcmplaint> <nbcnversin>0</nbcnversin> <nbdelivered>0</nbdelivered> <nbfiltered>0</nbfiltered> <nbhardbunce>0</nbhardbunce> <nbselected>0</nbselected> <nbsftbunce>0</nbsftbunce> <nbuniqueclick>0</nbuniqueclick> <nbuniqueopen>0</nbuniqueopen> <nbunsubscribe>0</nbunsubscribe> </campaignsnapsht> </respnse> 196

197 Details f the snapsht reprt: Reprt Fields begindate The start date f the campaign campaignid enddate nbbunce nbcmplaint nbcnversin nbdelivered nbfiltered nbhardbunce nbselected The ID f the campaign The end date f the campaign The ttal number f hardbunces and sftbunces The ttal number f recipients wh reprted the as spam. The ttal number f recipients wh clicked thrugh the t a cnversin page The ttal number f s delivered, regardless f whether they end up in the inbx, spam, r junk flders (i.e. net sent minus the hard and sft bunces). The ttal number f s that were nt sent due t settings such as Dedupe n send OR Mailing Frequency Cntrl. The ttal number f s that culd nt be delivered fr a permanent reasn such as an invalid r expired address. The ttal number f members selected as recipients f the campaign. The ttal number f s that culd nt be delivered fr a temprary reasn such as the recipient's nbsftbunce mailbx being full, the size and/r attachments being t large, r a temprary netwrk prblem during the transmissin prcess. nbuniqueclick The ttal number f recipients wh clicked thrugh an t a landing page. nbuniqueopen The ttal number f recipients wh pened an . nbunsubscribe The ttal number f recipients wh clicked an 's unsubscribe link. Get Campaign Summary List This methd retrieves a list f campaigns and their details. This is a GET methd. Examples {pagesize}?searchcriteria={searchclumn}:{searchvalue}&srtorder={srtclumn}:{srtorder} Nte: Ask yur Accunt Manager fr yur server name. parameter Required parameter tken The cnnectin tken return The campaigns and their details 197

198 parameter Required List Optins Parameters page The page t return pagesize The number f elements t return per page (default: 1000) Search Parameters searchcriteria campaignid name status The search envelpe cntaining the values used fr the search when the request is made. The ID f the campaign Name f the campaign The status f the campaign: EDITABLE QUEUED RUNNING PAUSED COMPLETED FAILED parameter Nte: The status value must be in uppercase. The date range fr the search. When entering the date range fr the search, the end date must prceed the start date fr the range in the fllwing frmat: <{enddate}>{begindate} (e.g., < T00%3A00%3A00Z> T00%3A00%3A00Z) The date frmat fllws the ISO 8601 rules where date and time values are rdered frm the mst t the least significant. senddate Example: : T10:20: T10:20:58+02:00 messageid Srt Optins Parameters srtoptins srtoptin clumn Nte: It is highly recmmended t always include the time zne. If the time zne is mitted, the SmartFcus server time zne will be used. Nte: Yu must encde the date in URL frmat. The ID f the message The envelpe cntaining the srtoptin envelpe(s) The srtoptin envelpe that specifies which clumn shuld be used fr the srt and in which rder the srt shuld be applied The clumn that shuld be used fr the srt 198

199 parameter Required rder The rder f the srt (i.e., ascending r descending): ASC DESC parameter Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call Errr Status Errr messages Parameter 'search' is invalid: {0}. Expected syntax: "criterium:value" Search criterium '{0}' is unknwn. Expected criteria: {1} Search criterium '{0}' has a bad value: {1}. An integer is expected 005 Parameter '{0}' has an invalid value: {1}. Expected values: {2} Srt criterium '{0}' is unknwn. Expected criteria: {1} Parameter '{0}' is invalid: {1} REST QS {tken}/getcam- paignsummarylist/1/10?searchcriteria=senddate:< t00%3a00%3a00z> T00%3A00%3A00Z&srtOrder=name:asc <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <apicampaignsummarylist> 199

200 <campaignsummarylist> <campaignsummary> <campaignid>10822</campaignid> <name>campaign Name 1</name> <manager>jhn Smith</manager> <status>completed</status> <senddate> t15:25:41+02:00</senddate> <messageid>49398</messageid> <segmentids> <segmentid>675</segmentid> <segmentid>1337</segmentid> </segmentids> </campaignsummary> <campaignsummary> <campaignid>5254</campaignid> <name>campaign Name 2</name> <manager>jhn Smith</manager> <status>completed</status> <senddate> t17:49:00+01:00</senddate> <messageid>11501</messageid> <segmentids> <segmentid>9016</segmentid> </segmentids> </campaignsummary> <campaignsummary> <campaignid>7701</campaignid> <name>campaign Name 3</name> <manager>jhn Smith</manager> <status>editable</status> <senddate> t08:30:00+02:00</senddate> <messageid>11924</messageid> <segmentids> <segmentid>9015</segmentid> </segmentids> </campaignsummary> </campaignsummarylist> <pagesize>10</pagesize> <nbttalitems>3</nbttalitems> <page>1</page> <nextpage>false</nextpage> <previuspage>false</previuspage> </apicampaignsummarylist> </respnse> 200

201 Dynamic Cntent Dynamic Cntent A Dynamic Cntent Blck (ften referred t as a Banner) is a rectangular strip f HTML/text that typically appears at the tp f an fr prmtinal purpses. SmartFcusffers a Dynamic Cntent feature allwing yu t create and manage the Dynamic Cntent Blcks used in yur Messages. The Banner Object cntent The cntent f the Dynamic Cntent Blck (must be between the tags <![CDATA[ and ]]> ) cntenttype creatindate descriptin id mdifdate name The cntent type f the Dynamic Cntent Blck (TEXT r HTML) The date when the Dynamic Cntent Blck was created. The descriptin f the Dynamic Cntent Blck The ID f the Dynamic Cntent Blck The date when the Dynamic Cntent Blck was last mdified. The name f the Dynamic Cntent Blck Nte: The making up the bject d nt always need t be present fr methds using the bject. Fr example, when yu create a new banner, campaign, r message, yu d nt need t prvide the id parameter even thugh this is present in the bject. Each methd's sectin lists the that must r can be included fr the methd. On the ther hand, these are all present when the bject appears in a methd's utput

202 Create Dynamic Cntent Blck This methd creates a Dynamic Cntent Blck. This is a GET methd. {cntenttype} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return name descriptin cntenttype The name f the Dynamic Cntent Blck The descriptin f the Dynamic Cntent Blck The cntent type f the Dynamic Cntent Blck (TEXT r HTML) bannerid - The ID f the Dynamic Cntent Blck Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. Yu must fill in the cntenttype parameter. Yu can't retrieve this type f banner. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: 202

203 HTTP GET (Query String) Submissin & sample URL call <respnse respnsestatus="success"> <result xsi:type="xs:lng">769 </result></respnse> 203

204 Create Dynamic Cntent Blck (POST) This methd creates a Dynamic Cntent Blck. This is a POST methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return Banner Parameters banner name descriptin cntent cntenttype The Dynamic Cntent Blck envelpe parameter. The name f the Dynamic Cntent Blck The descriptin f the Dynamic Cntent Blck The cntent f the Dynamic Cntent Blck (must be between the tags <![CDATA[ and ]]> ) The cntent type f the Dynamic Cntent Blck (TEXT r HTML) bannerid - The ID f the Dynamic Cntent Blck Errr messages Yu must fill in the tken parameter Yu must fill in the name parameter. Yu must fill in the cntenttype parameter. Yu can't retrieve this type f banner. An errr ccured n the server URL Cntent-type text/xml; charset=utf-8 Bdy 204

205 <banner> <cntent> <![CDATA[ <table> <tr> <td>just smething here</td> </tr> </table>]]></cntent> <cntenttype>html</cntenttype> <descriptin>first API banner</descriptin> <name>first API banner</name> </banner> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 205

206 Delete Dynamic Cntent Blck This methd deletes a Dynamic Cntent Blck. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the Dynamic Cntent Blck true if it was successful, false if it was nt successful Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. N banner fund!! An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 206

207 Update Dynamic Cntent Blck This methd updates a Dynamic Cntent Blck by field and value. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id field value The ID f the Dynamic Cntent Blck The field f the Dynamic Cntent Blck: name descriptin cntenttype The value f the field Required fr: the name field the cntenttype field (0=TEXT, 1=HTML) Optinal fr: the descriptin field true if it was successful, false if it was nt successful Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. Yu must fill in the field parameter. The field parameter desn't exist. Yu must fill in the name parameter. Yu must fill in the cntenttype parameter. Yu can't retrieve this type f banner. N banner fund!! An errr ccured n the server 207

208 <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 208

209 Update Dynamic Cntent Blck POST This methd updates a Dynamic Cntent Blck. This is a POST methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return Campaign Parameters banner id name descriptin cntent cntenttype The Dynamic Cntent Blck envelpe parameter. The ID f the Dynamic Cntent Blck The name f the Dynamic Cntent Blck The descriptin f the Dynamic Cntent Blck The cntent f the Dynamic Cntent Blck (must be between the tags <![CDATA[ and ]]> ) The cntent type f the Dynamic Cntent Blck (TEXT r HTML) true if it was successful, false if it was nt successful Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. Yu must fill in the name parameter. Yu must fill in the cntenttype parameter. N banner fund!! Yu can't retrieve this type f banner. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat

210 HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call URL Cntent-type text/xml; charset=utf-8 Bdy <banner> <cntent> <![CDATA[ <table> <tr> <td>just smething here</td> </tr> </table>]]></cntent> <cntenttype>html</cntenttype> <descriptin>first API banner</descriptin> <name>first API banner</name> <id>456</id> </banner> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:blean" xmlns:xs=" xmlns: xsi=" </respnse> 210

211 Clne Dynamic Cntent Blck This methd clnes a Dynamic Cntent Blck. This is a GET methd. Required tken The cnnectin tken return id newname The ID f the Dynamic Cntent Blck The new name f the new Dynamic Cntent Blck clnebannerid -The ID f the new Dynamic Cntent Blck Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. Yu must fill in the name parameter. N banner fund!! An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:lng">750</result> </respnse> 211

212 Get Dynamic Cntent Blck Preview This methd displays a preview f a Dynamic Cntent Blck. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the Dynamic Cntent Blck frmattedbanner - The frmatted preview f the Dynamic Cntent Blck Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. The cntent must begin with [EMV TEXTPART] OR [EMV HTMLPART]. N banner fund!! The part parameter is nt the same as HTML r TEXT. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:string"> <html> <head> </head> <bdy> <table width="606" cellspacing="0" cellpadding="0" brder="0"> <tr> <td width="31"> <img alt="" width="31" height="1" brder="0" srcc=" /> </td> <td width="532" style="fnt-size:11px; clr:#333333;">available in all stres 212

213 <br> <br> <span style="fnt-family:arial, Helvetica, sans-serif; fnt-size:15px; clr:#000000;"> <b>3 gifts fr yu t chse frm</b> </span> </td> <td width="43"> <img alt="" width="30" height="1" brder="0" srcc=" /> </td> </tr> </table> <img alt="" width="1" height="8" brder="0" srcc=" /> <br> <table width="606" cellspacing="0" cellpadding="0" brder="0"> <tr> <td width="26"> <img alt="" width="26" height="1" brder="0" srcc=" /> </td> <td width="166" style="fnt-family:arial, Helvetica, sans-serif; fnt-size:10px; clr:#666666;"> <img alt="5 % reductin" width="166" height="130" brder="0" srcc=" /> <br> <img alt="" width="1" height="8" brder="0" srcc=" /> <br>half price n the item f yur chice.</td> <td width="20"> <img alt="" width="20" height="1" brder="0" srcc=" /> </td> <td width="166" style="fnt-family:arial, Helvetica, sans-serif; fnt-size:10px; clr:#666666;"> <img alt="tasty treat" width="166" height="130" brder="0" srcc=" /> <br> <img alt="" width="1" height="8" brder="0" srcc=" /> <br>enjy the simplicity. </td> <td width="20"> <img alt="" width="20" height="1" brder="0" srcc=" /> </td> <td width="166" style="fnt-family:arial, Helvetica, sans-serif; fnt-size:10px; clr:#666666;"> <img alt="50% ff headphnes" width="166" height="130" brder="0" srcc=" /> <br> <img alt="" width="1" height="8" brder="0" srcc=" /> <br>50% ff headphnes f all brands. </td> <td width="42"> <img alt="" width="42" height="1" brder="0" srcc=" /> </td> </tr> </table> </bdy> </html> <result> </respnse> 213

214 Get Dynamic Cntent Blck This methd retrieves a Dynamic Cntent Blck using its ID. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the Dynamic Cntent Blck APIBanner - The Dynamic Cntent Blck Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. N banner fund!! Yu can't retrieve this type f banner. An errr ccured n the server <respnse respnsestatus="success"> <apibanner> <cntent>banner cntent</cntent> <cntenttype>text</cntenttype> <descriptin>headerbanner</descriptin> <id>769</id> <name>newbanner</name> </apibanner> </respnse> 214

215 Get Dynamic Cntent Blcks by Field This methd retrieves a list f Dynamic Cntent Blcks that cntain the same given value in a specific field. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return field value limit The field f the Dynamic Cntent Blck: name descriptin cntenttype The value f the field Required fr: the name field the cntenttype field (0=TEXT, 1=HTML) Optinal fr: the descriptin field The size f the list (between 1 and 1000) listids - The list f Dynamic Cntent Blck IDs Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. Yu must fill in the limit parameter. Yu must fill in the name parameter. Yu must fill in the cntenttype parameter. An errr ccured n the server

216 <respnse respnsestatus="success"> <entities> <id>339</id> <id>324</id> </entities> </respnse> 216

217 Get Dynamic Cntent Blcks by Perid This methd retrieves a list f Dynamic Cntent Blcks frm a given perid. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return datebegin dateend The start date f the perid t retrieve (yyyy- MM-dd HH:mm:ss) The end date f the perid t retrieve (yyyy-mmdd HH:mm:ss) listids - The list f Dynamic Cntent Blck IDs Errr messages Yu must fill in the tken parameter Yu must fill in the datebegin parameter. Yu must fill in the dateend parameter. datebegin desn't exist r is malfrmed (gd frmat is : yyyy-mm-dd HH:mm:ss). dateend desn't exist r is malfrmed (gd frmat is : yyyy-mm-dd HH:mm:ss). An errr ccured n the server %2000:00:00 <respnse respnsestatus="success"> <entities> <id>750</id> </entities> </respnse> 217

218 Get Last Dynamic Cntent Blcks This methd retrieves the list f the last Dynamic Cntent Blcks created. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return limit The size f the list (between 1 and 1000) listids - The list f Dynamic Cntent Blck IDs Errr messages Yu must fill in the tken parameter Yu must fill in the limit parameter. An errr ccured n the server <respnse respnsestatus="success"> <entities> <id>769</id> <id>750</id> <id>657</id> </entities> </respnse> 218

219 Track All Dynamic Cntent Blck Links This methd activates tracking fr all untracked Dynamic Cntent Blck links and saves the Dynamic Cntent Blck. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the Dynamic Cntent Blck lastorder - The last tracked link's rder number Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. N banner fund!! There is n link t track. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:lng">5</result> </respnse> 219

220 Untrack All Dynamic Cntent Blck Links This methd untracks all the Dynamic Cntent Blck links. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the Dynamic Cntent Blck true if it was successful, false if it was nt successful Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. N banner fund!! An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 220

221 Track Dynamic Cntent Blck Link by Psitin This methd tracks the Dynamic Cntent Blck link thrugh its psitin in the Dynamic Cntent Blck. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id psitin The ID f the Dynamic Cntent Blck The psitin f the link in the Dynamic Cntent Blck rder - The rder number f the URL Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. Yu must fill in the psitin parameter. N banner fund!! An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:lng">6</result> </respnse> 221

222 Untrack Dynamic Cntent Blck Link by Order This methd untracks a link in the Dynamic Cntent Blck by its rder. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id rder The ID f the Dynamic Cntent Blck The rder number f the URL true if it was successful, false if it was nt successful Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. Yu must fill in the rder parameter. N banner fund!! An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 222

223 Get All Dynamic Cntent Blck Tracked Links This methd retrieves a list f all the tracked links in a Dynamic Cntent Blck. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the Dynamic Cntent Blck listorders - The list f all the tracked links in the banner Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. N banner fund!! There aren't tracked links. An errr ccured n the server <respnse respnsestatus="success"> <entities> <id>1</id> <id>2</id> <id>3</id> <id>4</id> </entities> </respnse> 223

224 Get All Unused Dynamic Cntent Blck Tracked Links This methd retrieves a list f all the unused tracked links f the Dynamic Cntent Blck. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the Dynamic Cntent Blck listorders - The list f all the unused tracked links in the Dynamic Cntent Blck Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. N banner fund!! There aren't unused tracked links. An errr ccured n the server <respnse respnsestatus="success"> <entities> <id>1</id> <id>2</id> <id>3</id> <id>4</id> </entities> </respnse> 224

225 Get All Dynamic Cntent Blck Trackable Links This methd retrieves a list f all the trackable links in a Dynamic Cntent Blck. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return id The ID f the Dynamic Cntent Blck listorders - The list f all the trackable links in the Dynamic Cntent Blck Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. N banner fund!! There aren't trackable links. An errr ccured n the server <respnse respnsestatus="success"> <entities> <id>1</id> <id>2</id> <id>3</id> <id>4</id> </entities> </respnse> 225

226 Dynamic Cntent Blck Links Dynamic Cntent Blck Links Nte: T create r add links in REST, yu must use the HTTP GET Query String (QS) frmat: HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call: The fllwing types f links can be added t yur Dynamic Cntent Blck: Standard link: A standard link is any link that serves the sle purpse f linking t a web page. Unsubscribe link: When recipients click this link, the CCUNJOIN field f the member database is updated t shw them as unsubscribed and they will nt receive any further s. All s must cntain an unsubscribe link t cmply with anti-spam regulatins. Advanced links Persnalized link: A persnalized link is a link that adds a selected value frm yur member database t the end f the URL in rder t redirect the recipient t a specific page based n that value. Fr example, yu culd send male and female recipients t different web pages based n their gender using the TITLE database field. Update link: An update link is a link that, when clicked, will update a field in the member database. Actin link: An actin link is a link that will trigger an actin when clicked, e.g. a frward-t-a-friend link. This type f link needs t be pre-cnfigured by SmartFcus. If yu wish t use actin links, please cntact yur Accunt Manager. Mirrr link: A mirrr link is a link that pints t an autmatically generated mirrr page. Create Dynamic Cntent Blck Standard Link This methd creates a standard link fr the Dynamic Cntent Blck. This is a GET methd. &bannerid={bannerid}&name={name}&url={url} Nte: Ask yur Accunt Manager fr yur server name

227 Dynamic Cntent Blck Links Required tken The cnnectin tken return bannerid name url The ID f the Dynamic Cntent Blck The name f the Dynamic Cntent Blck link The URL f the link rder - The rder number f the URL Errr messages Yu must fill in the tken parameter Yu must fill in the bannerid parameter. Yu must fill in the name parameter. Yu must fill in the url parameter. N banner fund!! An errr ccured n the server &bannerid=769&name=standardlink&url= <respnse respnsestatus="success"> <result xsi:type="xs:lng">11</result> </respnse> Create and Add Dynamic Cntent Blck Standard Link This methd creates and adds a standard link t the Dynamic Cntent Blck. This is a GET methd. &bannerid={bannerid}&name={name}&url={url} Nte: Ask yur Accunt Manager fr yur server name

228 Dynamic Cntent Blck Links Required tken The cnnectin tken return rder - The rder number f the URL bannerid name url The ID f the Dynamic Cntent Blck The name f the banner link The URL f the link Errr messages Yu must fill in the tken parameter Yu must fill in the bannerid parameter. Yu must fill in the name parameter. Yu must fill in the url parameter. N banner fund!! An errr ccured n the server &bannerid=750&name=standardlink&url= <respnse respnsestatus="success"> <result xsi:type="xs:lng">4</result> </respnse> Create Dynamic Cntent Blck Unsubscribe Link This methd creates an unsubscribe link fr the Dynamic Cntent Blck. This is a GET methd. &bannerid={bannerid}&name={name}&pageok={pageok}&messageok={messageok} &pageerrr={pageerrr}&messageerrr={messageerrr} Nte: Ask yur Accunt Manager fr yur server name

229 Dynamic Cntent Blck Links Required tken The cnnectin tken return bannerid name pageok messageok pageerrr messageerrr The ID f the Dynamic Cntent Blck The name f the Dynamic Cntent Blck link The URL t call if the actin was successful The message t display if the actin was successful The URL t call if the actin was unsuccessful The message t display if the actin was unsuccessful rder - The rder number f the URL Errr messages Yu must fill in the tken parameter Yu must fill in the bannerid parameter. Yu must fill in the name parameter. Yu must fill in the url parameter. N banner fund!! An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call

230 Dynamic Cntent Blck Links &bannerid=750&name=unsubscribe&pageok= &pageerrr= <respnse respnsestatus="success"> <result xsi:type="xs:lng">12</result> </respnse> Create and Add Dynamic Cntent Blck Unsubscribe Link This methd creates and adds an unsubscribe link t the Dynamic Cntent Blck. This is a GET methd. &bannerid={bannerid}&name={name}&pageok={pageok}&messageok={messageok} &pageerrr={pageerrr}&messageerrr={messageerrr} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return bannerid name pageok messageok pageerrr messageerrr The ID f the Dynamic Cntent Blck The name f the Dynamic Cntent Blck link The URL t call if the actin was successful The message t display if the actin was successful The URL t call if the actin was unsuccessful The message t display if the actin was unsuccessful rder - The rder number f the URL Errr messages Yu must fill in the tken parameter Yu must fill in the bannerid parameter. Yu must fill in the name parameter. Yu must fill in the url parameter. N banner fund!! An errr ccured n the server 230

231 Dynamic Cntent Blck Links Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call &bannerid=750&name=unsubscribe&pageok= &pageerrr= <respnse respnsestatus="success"> <result xsi:type="xs:lng">2</result> </respnse> Create Dynamic Cntent Blck Persnalized Link This methd creates a persnalized link fr the Dynamic Cntent Blck. This is a GET methd. &bannerid={bannerid}&name={name}&url={url} Nte: Ask yur Accunt Manager fr yur server name

232 Dynamic Cntent Blck Links Required tken The cnnectin tken return bannerid name url The ID f the Dynamic Cntent Blck The name f the Dynamic Cntent Blck link The URL f the link rder - The rder number f the URL Errr messages Yu must fill in the tken parameter Yu must fill in the bannerid parameter. Yu must fill in the name parameter. Yu must fill in the url parameter. N banner fund!! An errr ccured n the server &bannerid=769&name=persnalizedlink&url= <respnse respnsestatus="success"> <result xsi:type="xs:lng">9</result> </respnse> Create and Add Dynamic Cntent Blck Persnalized Link This methd creates and adds a persnalized link t the Dynamic Cntent Blck. This is a GET methd. &bannerid={bannerid}&name={name}&url={url} Nte: Ask yur Accunt Manager fr yur server name

233 Dynamic Cntent Blck Links Required tken The cnnectin tken return bannerid name url The ID f the Dynamic Cntent Blck The name f the Dynamic Cntent Blck link The URL f the link rder - The rder number f the URL Errr messages Yu must fill in the tken parameter Yu must fill in the bannerid parameter. Yu must fill in the name parameter. Yu must fill in the url parameter. N banner fund!! An errr ccured n the server &bannerid=750&name=persnalizedlink&url= <respnse respnsestatus="success"> <result xsi:type="xs:lng">3</result> </respnse> Create Dynamic Cntent Blck Update Link This methd creates an update link fr the Dynamic Cntent Blck. This is a GET methd. &bannerid={bannerid}&name={name}&={} &pageok={pageok}&messageok={messageok}&pageerrr={pageerrr} &messageerrr={messageerrr} Nte: Ask yur Accunt Manager fr yur server name

234 Dynamic Cntent Blck Links Required tken The cnnectin tken return bannerid name pageok messageok pageerrr messageerrr The ID f the Dynamic Cntent Blck The name f the Dynamic Cntent Blck link The update t apply t the member table (fr a particular member) The URL t call if the actin was successful The message t display if the actin was successful The URL t call if the actin was unsuccessful The message t display if the actin was unsuccessful rder - The rder number f the URL Errr messages Yu must fill in the tken parameter Yu must fill in the bannerid parameter. Yu must fill in the name parameter. Yu must fill in the field. N banner fund!! An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call

235 Dynamic Cntent Blck Links &bannerid=750&name=updatelink&=&pageok= &messageok=395&pageerrr= <respnse respnsestatus="success"> <result xsi:type="xs:lng">12</result> </respnse> Create and Add Dynamic Cntent Blck Update Link This methd creates and adds an update link t the Dynamic Cntent Blck. This is a GET methd. &bannerid={bannerid}&name={name}&={}&pageok={pageok} &messageok={messageok}&pageerrr={pageerrr}&messageerrr={messageerrr} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return bannerid name pageok messageok pageerrr messageerrr The ID f the Dynamic Cntent Blck The name f the Dynamic Cntent Blck link The update t apply t the member table (fr a particular member) The URL t call if the actin was successful The message t display if the actin was successful The URL t call if the actin was unsuccessful The message t display if the actin was unsuccessful rder - The rder number f the URL Errr messages Yu must fill in the tken parameter Yu must fill in the bannerid parameter. Yu must fill in the name parameter. Yu must fill in the field

236 Dynamic Cntent Blck Links Errr messages N banner fund!! An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call &bannerid=750&name=updatelink&=&pageok= &messageok=395&pageerrr= <respnse respnsestatus="success"> <result xsi:type="xs:lng">2</result> </respnse> Create Dynamic Cntent Blck Actin Link This methd creates an actin link fr a Dynamic Cntent Blck. This is a GET methd. &bannerid={bannerid}&name={name}&actin={actin}&pageok={pageok} &messageok={messageok}&pageerrr={pageerrr}&messageerrr={messageerrr} Nte: Ask yur Accunt Manager fr yur server name

237 Dynamic Cntent Blck Links Required tken The cnnectin tken return bannerid name actin pageok messageok pageerrr messageerrr The ID f the Dynamic Cntent Blck The name f the Dynamic Cntent Blck link The actin t perfrm The URL t call if the actin was successful The message t display if the actin was successful The URL t call if the actin was unsuccessful The message t display if the actin was unsuccessful rder - The rder number f the URL Errr messages Yu must fill in the tken parameter Yu must fill in the bannerid parameter. Yu must fill in the name parameter. Yu must fill in the actin field. N banner fund!! An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call

238 Dynamic Cntent Blck Links &bannerid=750&name=actinlink&actin=actin&pageok= &messageok=395&pageerrr= <respnse respnsestatus="success"> <result xsi:type="xs:lng">1</result> </respnse> Create and Add Dynamic Cntent Blck Actin Link This methd creates and adds an actin link t the Dynamic Cntent Blck. This is a GET methd. &bannerid={bannerid}&name={name}&actin={actin}&pageok={pageok} &messageok={messageok}&pageerrr={pageerrr}&messageerrr={messageerrr} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return bannerid name actin pageok messageok pageerrr messageerrr The ID f the Dynamic Cntent Blck The name f the Dynamic Cntent Blck link The actin t perfrm The URL t call if the actin was successful The message t display if the actin was successful The URL t call if the actin was unsuccessful The message t display if the actin was unsuccessful rder - The rder number f the URL Errr messages Yu must fill in the tken parameter Yu must fill in the bannerid parameter. Yu must fill in the name parameter. Yu must fill in the actin field. An errr ccured n the server 238

239 Dynamic Cntent Blck Links Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call &bannerid=750&name=actinlink&actin=actin&pageok= &messageok=395&pageerrr= <respnse respnsestatus="success"> <result xsi:type="xs:lng">2</result> </respnse> Create Dynamic Cntent Blck Mirrr Link This methd creates a mirrr link in the Dynamic Cntent Blck. This is a GET methd. &bannerid={bannerid}&name={name} Nte: Ask yur Accunt Manager fr yur server name

240 Dynamic Cntent Blck Links Required tken The cnnectin tken return bannerid name The ID f the Dynamic Cntent Blck The name f the Dynamic Cntent Blck link rder - The rder number f the URL Errr messages Yu must fill in the tken parameter Yu must fill in the bannerid parameter. Yu must fill in the name parameter. N banner fund!! An errr ccured n the server &bannerid=750&name=mirrrlink <respnse respnsestatus="success"> <result xsi:type="xs:lng">1</result> </respnse> Create and Add Dynamic Cntent Blck Mirrr Link This methd creates and adds a mirrr link t the Dynamic Cntent Blck. This is a GET methd. &bannerid={bannerid}&name={name} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return rder - The rder number f the URL 240

241 Dynamic Cntent Blck Links Required bannerid The ID f the Dynamic Cntent Blck name The name f the Dynamic Cntent Blck link Errr messages Yu must fill in the tken parameter Yu must fill in the bannerid parameter. Yu must fill in the name parameter. N banner fund!! An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call &bannerid=750&name=mirrrlink <respnse respnsestatus="success"> <result xsi:type="xs:lng">3</result> </respnse> 241

242 Update Dynamic Cntent Blck Link by Field This methd updates a Dynamic Cntent Blck link by field. This is a GET methd. {field}/{value} Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return bannerid rder field value The ID f the Dynamic Cntent Blck The rder number f the URL The field f the Dynamic Cntent Blck: name descriptin cntenttype The value f the field Required fr: the name field the cntenttype field (0=TEXT, 1=HTML) Optinal fr: the descriptin field true if it was successful, false if it was nt successful Errr messages Yu must fill in the tken parameter Yu must fill in the id parameter. Yu must fill in the rder parameter. Yu must fill in the field parameter. This link desn't exist fr the banner. Yu must fill in the name parameter. Yu must fill in the url parameter. Yu must fill in the field. Yu must fill in the actin field

243 Errr messages Banner link type nt supprted. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 243

244 Get Dynamic Cntent Blck Link by Order This methd retrieves a Dynamic Cntent Blck link by its rder number. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return bannerid rder The ID f the Dynamic Cntent Blck The rder number f the URL APIBannerLink - The Dynamic Cntent Blck link Errr messages Yu must fill in the tken parameter Yu must fill in the bannerid parameter. Yu must fill in the rder parameter. This link desn't exist fr the banner. An errr ccured n the server <respnse respnsestatus="success"> <apibannerlink> <actin>actin</actin> <bannerid>750</bannerid> <clientid>10</clientid> <id>4452</id> <name>linkname</name> <rder>2</rder> <type>action</type> </apibannerlink> </respnse> 244

245 Webfrms Webfrms A Webfrm is a frm that yu can place n yur website t attract new subscribers, capture new data n members, and update member subscriptin preferences. It is ne f the easiest ways t attract new subscribers t yur member database. The Webfrm Object tken webfrmid name descriptin type cntrlwarninglanguage status The cnnectin tken The ID f the Webfrm The name f the Webfrm The descriptin f the Webfrm The type f Webfrm: SUBSCRIBE: This type f Webfrm adds new members t the member table and des nt allw duplicate entries. This type f Webfrm wuld be used, fr example, fr a cmpetitin that nly allws ne entry per address. SUBSCRIBE_WITH_DUPLICATE_ S: This type f Webfrm adds new members t the member table even if they already exist in the member table. This type f frm wuld be used, fr example, fr a cmpetitin that allws peple t participate multiple times. UPDATE: This type f Webfrm allws members t update their prfile infrmatin. The member's address is used fr identificatin. UPDATE_WITH_MULTIPLE_KEYS: This type f Webfrm updates all prfiles in the member table using ne r mre fields t identify the member. Fr all ther Webfrm types the address is used. SUBSCRIBE_OR_UPDATE: This type f Webfrm searches the member table fr the address and, if the address exists, updates the prfile infrmatin f the member r, if the address des nt exist, creates a new member. UNSUBSCRIBE: This type f Webfrm allws members t unsubscribe. It enters the date that the frm is filled ut in the DATEUNJOIN field f the member in the member table. The language t use t autmatically spell-check the text entered in the Webfrm. ENGLISH DUTCH FRENCH GERMAN ITALIAN SPANISH DANISH SWEDISH JAPAN CHINESE_SIMPLIFIED CHINESE_TRADITIONAL PORTUGUESE_BRAZIL PORTUGUESE_PORTUGAL RUSSIAN KOREAN The status f the Webfrm: ENABLE DISABLE 245

246 Webfrms expiratindate usedefaultexpiratinlandingpage custmexpiratinlandingpageurl cnfirmatinlandingpageurl standarderrrlandingpageurl duplicate errrlandingpageurl fields field fieldname required displayname inputtype validatintype The expiratin date and time f the Webfrm. When this date is exceeded, data will n lnger be captured frm the Webfrm and anyne wh fills ut the Webfrm will be redirected t the default r custm expiratin page. The date must respect the fllwing frmat: yyyy-mm-ddthh:mm:ss Whether t use (true) r nt (false) the default expiratin landing page. The URL f the custm expiratin landing page. This parameter is required if yu set the usedefaultexpiratinlandingpage t false. The URL f the landing page that shuld appear if the Webfrm is successfully cmpleted. The URL f the landing page that shuld appear if an errr ccurs when the Webfrm is cmpleted. The landing page that will be displayed if an already subscribed persn attempts t fill ut the frm. This parameter is required if the type is set t SUBSCRIBE. The fields envelpe The field envelpe. The field is required fr all types except fr the type UPDATE_WITH_MULTIPLE_KEYS. The name f the field in the member table where the infrmatin will be inserted r updated. Whether the field must be filled in (true) r nt (false). The default value is false. The label t accmpany the Webfrm element (field, drp-dwn menu, radi buttn, r checkbx). This parameter is required fr all inputtype values except fr HIDDEN. The Webfrm element: TEXT: A field SELECT: A drp-dwn menu RADIO: Radi buttns CHECKBOX: Checkbxes HIDDEN: A hidden field The type f data that can be entered int the field. If a different type f data is entered, an errr message will appear. NONE: Any type f data can be entered. DATE: Only dates can be entered. INTEGER: Only numbers can be entered. Only addresses can be entered. textlength custmkey listofvalues value defaultvalue This parameter is required if inputtype is set t TEXT. The maximum number f characters that can be entered int the field. This parameter is required if inputtype is set t TEXT. Whether the field shuld be used t identify the member (true) r nt (false). At least ne field's custmkey value must be set t true if the type is UPDATE_WITH_ MULTIPLE_KEYS. The list f values fr drp-dwn menus, checkbxes, r radi buttns. This parameter is required if inputtype is set t SELECT, CHECKBOX, r RADIO. The value The value t appear by default befre the field is filled in. Fr hidden fields, the default value is the value that will be inserted int the member table

247 Webfrms buncebacktype custmerserviceaddresses custmerserviceaddress replyt verrideunsubscribedusersstatus allwmessageoverriding buncebackmessageid managerbuncebackmessageid The recipient(s) f the cnfirmatin . NO_CONFIRMATION: N Cnfirmatin Message will be sent. USER: A Message will be sent t the subscriber wh cmpletes the frm. CUSTOMER_SERVICE: A Message will be sent t the specified address (es). USER_AND_CUSTOMER_SERVICE: A Message will be sent t the subscriber wh cmpletes the frm and the specified address. Different Messages can be used fr the user (subscriber) and the cmpany custmer service. The custmer service addresses envelpe. This parameter is required if buncebacktype is set t CUSTOMER_SERVICE r USER_AND_CUSTOMER_SERVICE. The custmer service address The address that shuld serve as the 's reply-t address. This parameter is required if buncebacktype is set t USER, CUSTOMER_SERVICE, r USER_AND_ CUSTOMER_SERVICE. Whether t send the (true) r nt (false) t unsubscribed members. This parameter can be set if buncebacktype is set t USER r USER_AND_CUSTOMER_ SERVICE. Whether (true) r nt (false) t make it pssible t cnfigure a different cnfirmatin message t the ne selected thrugh a parameter in the integratin cde. By default, it is set t false. This parameter can be set if buncebacktype is set t USER, CUSTOMER_SERVICE, r USER_AND_CUSTOMER_SERVICE. The ID f the Message t send t the subscriber. This parameter is required if buncebacktype is set t USER r USER_AND_CUSTOMER_SERVICE. The ID f the Message t send t the custmer service address(es). This parameter is required if buncebacktype is set t CUSTOMER_SERVICE r USER_ AND_CUSTOMER_SERVICE

248 Create a Webfrm This methd creates a new Webfrm. This is a POST methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return name descriptin type The name f the Webfrm The descriptin f the Webfrm The type f Webfrm: SUBSCRIBE: This type f Webfrm adds new members t the member table and des nt allw duplicate entries. This type f Webfrm wuld be used, fr example, fr a cmpetitin that nly allws ne entry per address. SUBSCRIBE_WITH_DUPLICATE_ S: This type f Webfrm adds new members t the member table even if they already exist in the member table. This type f frm wuld be used, fr example, fr a cmpetitin that allws peple t participate multiple times. UPDATE: This type f Webfrm allws members t update their prfile infrmatin. The member's address is used fr identificatin. UPDATE_WITH_MULTIPLE_KEYS: This type f Webfrm updates all prfiles in the member table using ne r mre fields t identify the member. Fr all ther Webfrm types the address is used. SUBSCRIBE_OR_UPDATE: This type f Webfrm searches the member table fr the address and, if the address exists, updates the prfile infrmatin f the member r, if the address des nt exist, creates a new member. UNSUBSCRIBE: This type f Webfrm allws members t unsubscribe. It enters the date that the frm is filled ut in the DATEUNJOIN field f the member in the member table. The ID f the Webfrm 248

249 Required cntrlwarninglanguage expiratindate usedefaultexpiratinlandingpage custmexpiratinlandingpageurl cnfirmatinlandingpageurl standarderrrlandingpageurl duplicate errrlandingpageurl fields field fieldname required The language t use t autmatically spell-check the text entered in the Webfrm. ENGLISH DUTCH FRENCH GERMAN ITALIAN SPANISH DANISH SWEDISH JAPAN CHINESE_SIMPLIFIED CHINESE_TRADITIONAL PORTUGUESE_BRAZIL PORTUGUESE_PORTUGAL RUSSIAN KOREAN The expiratin date and time f the Webfrm. When this date is exceeded, data will n lnger be captured frm the Webfrm and anyne wh fills ut the Webfrm will be redirected t the default r custm expiratin page. The date must respect the fllwing frmat: yyyy-mm-ddthh:mm:ss Whether t use (true) r nt (false) the default expiratin landing page. The URL f the custm expiratin landing page. This parameter is required if yu set the usedefaultexpiratinlandingpage t false. The URL f the landing page that shuld appear if the Webfrm is successfully cmpleted. The URL f the landing page that shuld appear if an errr ccurs when the Webfrm is cmpleted. The landing page that will be displayed if an already subscribed persn attempts t fill ut the frm. This parameter is required if the type is set t SUBSCRIBE. The fields envelpe The field envelpe. The field is required fr all types except fr the type UPDATE_WITH_MULTIPLE_ KEYS. The name f the field in the member table where the infrmatin will be inserted r updated. Whether the field must be filled in (true) r nt (false). The default value is false

250 Required displayname inputtype validatintype textlength custmkey listofvalues value defaultvalue buncebacktype The label t accmpany the Webfrm element (field, drp-dwn menu, radi buttn, r checkbx). This parameter is required fr all inputtype values except fr HIDDEN. The Webfrm element: TEXT: A field SELECT: A drp-dwn menu RADIO: Radi buttns CHECKBOX: Checkbxes HIDDEN: A hidden field The type f data that can be entered int the field. If a different type f data is entered, an errr message will appear. NONE: Any type f data can be entered. DATE: Only dates can be entered. INTEGER: Only numbers can be entered. Only addresses can be entered. This parameter is required if inputtype is set t TEXT. The maximum number f characters that can be entered int the field. This parameter is required if inputtype is set t TEXT. Whether the field shuld be used t identify the member (true) r nt (false). At least ne field's custmkey value must be set t true if the type is UPDATE_WITH_MULTIPLE_KEYS. The list f values fr drp-dwn menus, checkbxes, r radi buttns. This parameter is required if inputtype is set t SELECT, CHECKBOX, r RADIO. The value The value t appear by default befre the field is filled in. Fr hidden fields, the default value is the value that will be inserted int the member table. The recipient(s) f the cnfirmatin . NO_CONFIRMATION: N Cnfirmatin Message will be sent. USER: A Message will be sent t the subscriber wh cmpletes the frm. CUSTOMER_SERVICE: A Message will be sent t the specified address(es). USER_AND_CUSTOMER_SERVICE: A Message will be sent t the subscriber wh cmpletes the frm and the specified address. Different Messages can be used fr the user (subscriber) and the cmpany custmer service

251 Required custmerserviceaddresses custmerserviceaddress replyt verrideunsubscribedusersstatus allwmessageoverriding buncebackmessageid managerbuncebackmessageid The custmer service addresses envelpe. This parameter is required if buncebacktype is set t CUSTOMER_SERVICE r USER_AND_CUSTOMER_ SERVICE. The custmer service address The address that shuld serve as the 's replyt address. This parameter is required if buncebacktype is set t USER, CUSTOMER_SERVICE, r USER_AND_CUSTOMER_SERVICE. Whether t send the (true) r nt (false) t unsubscribed members. This parameter can be set if buncebacktype is set t USER r USER_AND_ CUSTOMER_SERVICE. Whether (true) r nt (false) t make it pssible t cnfigure a different cnfirmatin message t the ne selected thrugh a parameter in the integratin cde. By default, it is set t false. This parameter can be set if buncebacktype is set t USER, CUSTOMER_SERVICE, r USER_AND_CUSTOMER_SERVICE. The ID f the Message t send t the subscriber. This parameter is required if buncebacktype is set t USER r USER_AND_CUSTOMER_SERVICE. The ID f the Message t send t the custmer service address(es). This parameter is required if buncebacktype is set t CUSTOMER_SERVICE r USER_AND_CUSTOMER_SERVICE. Errr Statuses FILL_TOKEN_PARAMETER CREATE_WEBFORM_FAILED WEBFORM_INVALID_PARAMETER WEBFORM_MANDATORY_PARAMETER WEBFORM_DATE_IN_PAST WEBFORM_FORBIDDEN_PARAMETER WEBFORM_INVALID_URL MESSAGE_BOUNCEBACK_NOT_FOUND WEBFORM_MANDATORY_PARAMETER_FIELD WEBFORM_FORBIDDEN_PARAMETER_FIELD WEBFORM_INVALID_PARAMETER_FIELD WEBFORM_MANDATORY_PARAMETER_FIELD_CUSTOM_KEY WEBFORM_MANDATORY_PARAMETER_FIELD_NOT_UNIQUE WEBFORM_MANDATORY_PARAMETER_FIELD_ _REQUIRED WEBFORM_MANDATORY_PARAMETER_FIELD_ WEBFORM_INVALID_ 251

252 Errr Statuses WEBFORM_INVALID_ _ALIAS_CHARACTERS WEBFORM_INVALID_ _DOMAIN_CHARACTERS WEBFORM_INVALID_ _SYNTAX WEBFORM_INVALID_ _ALIAS WEBFORM_INVALID_ _DOMAIN WEBFORM_INVALID_ _DOMAIN_SUFFIX SERVER_ERROR Errr s Yu must fill in the tken parameter Access webfrm is nt authrized fr manager with id : {0}. The parameter {0} is invalid : date in the past. Yu must specify at least ne field. Yu must fill in the {0} parameter. Yu must fill in the {0} parameter f the field at the psitin {1}. The parameter custmkey is required with the type {0} in at least ne field. The field is required. The parameter REQUIRED fr the field is required. The fieldname {0} must be unique. The f the parameter {0} is invalid: {1}. The syntax f the f the parameter {0} is invalid: {1}. The alias f the f the parameter {0} is invalid: {1}. The alias f the f the parameter {0} cntains invalid characters: {1}. The dmain f the f the parameter {0} is invalid: {1}. The dmain f the f the parameter {0} cntains invalid characters: {1}. The dmain suffix f the f the parameter {0} is invalid: {1}. The url f the parameter {0} is invalid: {1}. The parameter {0} is invalid: {1}. The parameter {0} f the field at the psitin {1} is invalid: {2}. The parameter {0} is frbidden. The parameter {0} f the field at the psitin {1} is frbidden. The fieldname {0} at the psitin {1} is frbidden. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw 252

253 API call summary: HTTP GET (Query String) Submissin & sample URL call URL HTTP Methd POST Header cntent-type applicatin/xml accept applicatin/xml Bdy <webfrm> <name>rest webfrm</name> <descriptin>rest descriptin</descriptin> <type>subscribe</type> <cntrlwarninglanguage>english</cntrlwarninglanguage> <expiratindate> t07:15:00</expiratindate> <usedefaultexpiratinlandingpage>true</usedefaultexpiratinlandingpage> <cnfirmatinlandingpageurl> <standarderrrlandingpageurl> <fields> <field> <fieldname> </fieldname> <required>true</required> <displayname>mail</displayname> <inputtype>text</inputtype> <validatintype> </validatintype> <textlength>100</textlength> </field> <field> <fieldname>title</fieldname> <displayname>title</displayname> <inputtype>select</inputtype> <listofvalues> <value>ms.</value> <value>mrs.</value> <value>mr.</value> </listofvalues> <defaultvalue>mr.</defaultvalue> </field> <field> <fieldname>lastname</fieldname> <required>true</required> 253

254 <displayname>last Name</displayName> <inputtype>text</inputtype> <defaultvalue>enter yur last name</defaultvalue> <validatintype>none</validatintype> <textlength>65</textlength> </field> <field> <fieldname>firstname</fieldname> <displayname>first Name</displayName> <inputtype>text</inputtype> <validatintype>none</validatintype> <textlength>600</textlength> </field> </fields> <buncebacktype>user_and_customer_service</buncebacktype> <custmerserviceaddresses> <custmerserviceaddress> <custmerserviceaddress> </custmerserviceaddresses> <buncebackmessageid>525</buncebackmessageid> <managerbuncebackmessageid>526</managerbuncebackmessageid> </webfrm> <respnse respnsestatus="success"> <result xsi:type="xs:lng">141</result> </respnse> 254

255 Update a Webfrm This methd updates a Webfrm. This is a POST methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return webfrmid The ID f the Webfrm name The name f the Webfrm descriptin The descriptin f the Webfrm true if it was successful, false if it was nt successful 255

256 Required type cntrlwarninglanguage The type f Webfrm: SUBSCRIBE: This type f Webfrm adds new members t the member table and des nt allw duplicate entries. This type f Webfrm wuld be used, fr example, fr a cmpetitin that nly allws ne entry per address. SUBSCRIBE_WITH_DUPLICATE_ S: This type f Webfrm adds new members t the member table even if they already exist in the member table. This type f frm wuld be used, fr example, fr a cmpetitin that allws peple t participate multiple times. UPDATE: This type f Webfrm allws members t update their prfile infrmatin. The member's address is used fr identificatin. UPDATE_WITH_MULTIPLE_KEYS: This type f Webfrm updates all prfiles in the member table using ne r mre fields t identify the member. Fr all ther Webfrm types the address is used. SUBSCRIBE_OR_UPDATE: This type f Webfrm searches the member table fr the address and, if the address exists, updates the prfile infrmatin f the member r, if the address des nt exist, creates a new member. UNSUBSCRIBE: This type f Webfrm allws members t unsubscribe. It enters the date that the frm is filled ut in the DATEUNJOIN field f the member in the member table. The language t use t autmatically spell-check the text entered in the Webfrm. ENGLISH DUTCH FRENCH GERMAN ITALIAN SPANISH DANISH SWEDISH JAPAN CHINESE_SIMPLIFIED CHINESE_TRADITIONAL PORTUGUESE_BRAZIL PORTUGUESE_PORTUGAL RUSSIAN KOREAN 256

257 Required expiratindate usedefaultexpiratinlandingpage custmexpiratinlandingpageurl cnfirmatinlandingpageurl standarderrrlandingpageurl duplicate errrlandingpageurl fields field fieldname required displayname inputtype validatintype The expiratin date and time f the Webfrm. When this date is exceeded, data will n lnger be captured frm the Webfrm and anyne wh fills ut the Webfrm will be redirected t the default r custm expiratin page. The date must respect the fllwing frmat: yyyy-mm-ddthh:mm:ss Whether t use (true) r nt (false) the default expiratin landing page. The URL f the custm expiratin landing page. This parameter is required if yu set the usedefaultexpiratinlandingpage t false. The URL f the landing page that shuld appear if the Webfrm is successfully cmpleted. The URL f the landing page that shuld appear if an errr ccurs when the Webfrm is cmpleted. The landing page that will be displayed if an already subscribed persn attempts t fill ut the frm. This parameter is required if the type is set t SUBSCRIBE. The fields envelpe The field envelpe. The field is required fr all types except fr the type UPDATE_WITH_MULTIPLE_ KEYS. The name f the field in the member table where the infrmatin will be inserted r updated. Whether the field must be filled in (true) r nt (false). The default value is false. The label t accmpany the Webfrm element (field, drp-dwn menu, radi buttn, r checkbx). This parameter is required fr all inputtype values except fr HIDDEN. The Webfrm element: TEXT: A field SELECT: A drp-dwn menu RADIO: Radi buttns CHECKBOX: Checkbxes HIDDEN: A hidden field The type f data that can be entered int the field. If a different type f data is entered, an errr message will appear. NONE: Any type f data can be entered. DATE: Only dates can be entered. INTEGER: Only numbers can be entered. Only addresses can be entered. This parameter is required if inputtype is set t TEXT

258 Required textlength custmkey listofvalues value defaultvalue buncebacktype custmerserviceaddresses custmerserviceaddress replyt verrideunsubscribedusersstatus allwmessageoverriding The maximum number f characters that can be entered int the field. This parameter is required if inputtype is set t TEXT. Whether the field shuld be used t identify the member (true) r nt (false). At least ne field's custmkey value must be set t true if the type is UPDATE_WITH_MULTIPLE_KEYS. The list f values fr drp-dwn menus, checkbxes, r radi buttns. This parameter is required if inputtype is set t SELECT, CHECKBOX, r RADIO. The value The value t appear by default befre the field is filled in. Fr hidden fields, the default value is the value that will be inserted int the member table. The recipient(s) f the cnfirmatin . NO_CONFIRMATION: N Cnfirmatin Message will be sent. USER: A Message will be sent t the subscriber wh cmpletes the frm. CUSTOMER_SERVICE: A Message will be sent t the specified address(es). USER_AND_CUSTOMER_SERVICE: A Message will be sent t the subscriber wh cmpletes the frm and the specified address. Different Messages can be used fr the user (subscriber) and the cmpany custmer service. The custmer service addresses envelpe. This parameter is required if buncebacktype is set t CUSTOMER_SERVICE r USER_AND_CUSTOMER_ SERVICE. The custmer service address The address that shuld serve as the 's replyt address. This parameter is required if buncebacktype is set t USER, CUSTOMER_SERVICE, r USER_AND_CUSTOMER_SERVICE. Whether t send the (true) r nt (false) t unsubscribed members. This parameter can be set if buncebacktype is set t USER r USER_AND_ CUSTOMER_SERVICE. Whether (true) r nt (false) t make it pssible t cnfigure a different cnfirmatin message t the ne selected thrugh a parameter in the integratin cde. By default, it is set t false. This parameter can be set if buncebacktype is set t USER, CUSTOMER_SERVICE, r USER_AND_CUSTOMER_SERVICE

259 Required buncebackmessageid managerbuncebackmessageid The ID f the Message t send t the subscriber. This parameter is required if buncebacktype is set t USER r USER_AND_CUSTOMER_SERVICE. The ID f the Message t send t the custmer service address(es). This parameter is required if buncebacktype is set t CUSTOMER_SERVICE r USER_AND_CUSTOMER_SERVICE. Errr Statuses FILL_TOKEN_PARAMETER WEBFORM_NOT_FOUND UPDATE_WEBFORM_FAILED WEBFORM_INVALID_PARAMETER WEBFORM_MANDATORY_PARAMETER WEBFORM_DATE_IN_PAST WEBFORM_FORBIDDEN_PARAMETER WEBFORM_INVALID_URL MESSAGE_BOUNCEBACK_NOT_FOUND WEBFORM_MANDATORY_PARAMETER_FIELD WEBFORM_FORBIDDEN_PARAMETER_FIELD WEBFORM_INVALID_PARAMETER_FIELD WEBFORM_MANDATORY_PARAMETER_FIELD_CUSTOM_KEY WEBFORM_MANDATORY_PARAMETER_FIELD_NOT_UNIQUE WEBFORM_MANDATORY_PARAMETER_FIELD_ _REQUIRED WEBFORM_MANDATORY_PARAMETER_FIELD_ WEBFORM_INVALID_ WEBFORM_INVALID_ _ALIAS_CHARACTERS WEBFORM_INVALID_ _DOMAIN_CHARACTERS WEBFORM_INVALID_ _SYNTAX WEBFORM_INVALID_ _ALIAS WEBFORM_INVALID_ _DOMAIN WEBFORM_INVALID_ _DOMAIN_SUFFIX SERVER_ERROR Errr s Yu must fill in the tken parameter The webfrm desn't exist. Access webfrm is nt authrized fr manager with id : {0}. The parameter {0} is invalid : date in the past. Yu must specify at least ne field. Yu must fill in the {0} parameter. Yu must fill in the {0} parameter f the field at the psitin {1}. The parameter custmkey is required with the type {0} in at least ne field

260 Errr s The field is required. The parameter REQUIRED fr the field is required. The fieldname {0} must be unique. The f the parameter {0} is invalid: {1}. The syntax f the f the parameter {0} is invalid: {1}. The alias f the f the parameter {0} is invalid: {1}. The alias f the f the parameter {0} cntains invalid characters: {1}. The dmain f the f the parameter {0} is invalid: {1}. The dmain f the f the parameter {0} cntains invalid characters: {1}. The dmain suffix f the f the parameter {0} is invalid: {1}. The url f the parameter {0} is invalid: {1}. The parameter {0} is invalid: {1}. The parameter {0} f the field at the psitin {1} is invalid: {2}. The parameter {0} is frbidden. The parameter {0} f the field at the psitin {1} is frbidden. The fieldname {0} at the psitin {1} is frbidden. The webfrm {0} is expired. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call URL HTTP Methd POST Header 260

261 cntent-type applicatin/xml accept applicatin/xml Bdy <webfrm> <webfrmid>141</webfrmid> <name>rest webfrm</name> <descriptin>rest descriptin</descriptin> <type>subscribe</type> <cntrlwarninglanguage>english</cntrlwarninglanguage> <expiratindate> t07:15:00</expiratindate> <usedefaultexpiratinlandingpage>true</usedefaultexpiratinlandingpage> <cnfirmatinlandingpageurl> <standarderrrlandingpageurl> <fields> <field> <fieldname> </fieldname> <required>true</required> <displayname>mail</displayname> <inputtype>text</inputtype> <validatintype> </validatintype> <textlength>100</textlength> </field> <field> <fieldname>title</fieldname> <displayname>title</displayname> <inputtype>select</inputtype> <listofvalues> <value>ms.</value> <value>mrs.</value> <value>mr.</value> </listofvalues> <defaultvalue>mr.</defaultvalue> </field> <field> <fieldname>lastname</fieldname> <required>true</required> <displayname>last Name</displayName> <inputtype>text</inputtype> <defaultvalue>enter yur last name</defaultvalue> <validatintype>none</validatintype> <textlength>65</textlength> </field> <field> <fieldname>firstname</fieldname> <displayname>first Name</displayName> <inputtype>text</inputtype> <validatintype>none</validatintype> <textlength>600</textlength> </field> </fields> <buncebacktype>user_and_customer_service</buncebacktype> <custmerserviceaddresses> </custmerserviceaddresses> <buncebackmessageid>525</buncebackmessageid> <managerbuncebackmessageid>525</managerbuncebackmessageid> </webfrm> 261

262 <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 262

263 Cpy a Webfrm This methd makes a cpy f an existing Webfrm. This is a GET methd. Required tken The cnnectin tken return The Webfrm webfrmid The ID f the Webfrm Errr Statuses FILL_TOKEN_PARAMETER WEBFORM_NOT_FOUND COPY_WEBFORM_FAILED WEBFORM_INVALID_PARAMETER WEBFORM_MANDATORY_PARAMETER SERVER_ERROR Errr s Yu must fill in the tken parameter The webfrm desn't exist. Access webfrm is nt authrized fr manager with id : {0}. The webfrm {0} is expired. An errr ccured n the server <respnse respnsestatus="success"> <webfrm> <webfrmid>142</webfrmid> <name>cpy Of REST webfrm</name> <descriptin>rest descriptin</descriptin> <type>subscribe</type> <cntrlwarninglanguage>english</cntrlwarninglanguage> <status>enable</status> <creatindate> t10:07:27+01:00</creatindate> <expiratindate> t07:15:00+02:00</expiratindate> <usedefaultexpiratinlandingpage>true</usedefaultexpiratinlandingpage> 263

264 <cnfirmatinlandingpageurl> <standarderrrlandingpageurl> <fields> <field> <fieldname> </fieldname> <required>true</required> <displayname>mail</displayname> <inputtype>text</inputtype> <listofvalues/> <validatintype> </validatintype> <textlength>100</textlength> </field> <field> <fieldname>title</fieldname> <required>false</required> <displayname>title</displayname> <inputtype>select</inputtype> <listofvalues> <value>ms.</value> <value>mrs.</value> <value>mr.</value> </listofvalues> <defaultvalue>mr.</defaultvalue> <validatintype>none</validatintype> <textlength>0</textlength> </field> <field> <fieldname>lastname</fieldname> <required>true</required> <displayname>last Name</displayName> <inputtype>text</inputtype> <listofvalues/> <defaultvalue>enter yur last name</defaultvalue> <validatintype>none</validatintype> <textlength>65</textlength> </field> <field> <fieldname>firstname</fieldname> <required>false</required> <displayname>first Name</displayName> <inputtype>text</inputtype> <listofvalues/> <validatintype>none</validatintype> <textlength>600</textlength> </field> </fields> <buncebacktype>user_and_customer_service</buncebacktype> <custmerserviceaddresses> <custmerserviceaddress> <custmerserviceaddress> </custmerserviceaddresses> <verrideunsubscribedusersstatus>false</verrideunsubscribedusersstatus> <allwmessageoverriding>false</allwmessageoverriding> <buncebackmessageid>525</buncebackmessageid> <managerbuncebackmessageid>525</managerbuncebackmessageid> </webfrm> </respnse> 264

265 Update a Webfrm's Status This methd updates a Webfrm's status. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return webfrmid status The ID f the Webfrm The status f the Webfrm: ENABLE DISABLE true if it was successful, false if it was nt successful Errr Statuses FILL_TOKEN_PARAMETER WEBFORM_NOT_FOUND UPDATE_WEBFORM_STATUS_FAILED WEBFORM_INVALID_PARAMETER WEBFORM_MANDATORY_PARAMETER WEBFORM_EXPIRED SERVER_ERROR Errr s Yu must fill in the tken parameter The webfrm desn't exist. Access webfrm is nt authrized fr manager with id : {0}. Yu must fill in the {0} parameter. The parameter {0} is invalid: {1}. The webfrm {0} is expired. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat

266 HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: HTTP GET (Query String) Submissin & sample URL call <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 266

267 Get a Webfrm This methd retrieves a Webfrm. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The Webfrm webfrmid The ID f the Webfrm Errr Statuses FILL_TOKEN_PARAMETER WEBFORM_NOT_FOUND GET_WEBFORM_FAILED WEBFORM_INVALID_PARAMETER WEBFORM_MANDATORY_PARAMETER SERVER_ERROR Errr s Yu must fill in the tken parameter Access webfrm is nt authrized fr manager with id : {0}. The webfrm desn't exist. The parameter {0} is invalid: {1}. Yu must fill in the {0} parameter. An errr ccured n the server <respnse respnsestatus="success"> <webfrm> <webfrmid>142</webfrmid> <name>cpy Of REST webfrm</name> <descriptin>rest descriptin</descriptin> <type>subscribe</type> <cntrlwarninglanguage>english</cntrlwarninglanguage> 267

268 <status>enable</status> <creatindate> t10:07:27+01:00</creatindate> <expiratindate> t07:15:00+02:00</expiratindate> <usedefaultexpiratinlandingpage>true</usedefaultexpiratinlandingpage> <cnfirmatinlandingpageurl> <standarderrrlandingpageurl> <fields> <field> <fieldname> </fieldname> <required>true</required> <displayname>mail</displayname> <inputtype>text</inputtype> <listofvalues/> <validatintype> </validatintype> <textlength>100</textlength> </field> <field> <fieldname>title</fieldname> <required>false</required> <displayname>title</displayname> <inputtype>select</inputtype> <listofvalues> <value>ms.</value> <value>mrs.</value> <value>mr.</value> </listofvalues> <defaultvalue>mr.</defaultvalue> <validatintype>none</validatintype> <textlength>0</textlength> </field> <field> <fieldname>lastname</fieldname> <required>true</required> <displayname>last Name</displayName> <inputtype>text</inputtype> <listofvalues/> <defaultvalue>enter yur last name</defaultvalue> <validatintype>none</validatintype> <textlength>65</textlength> </field> <field> <fieldname>firstname</fieldname> <required>false</required> <displayname>first Name</displayName> <inputtype>text</inputtype> <listofvalues/> <validatintype>none</validatintype> <textlength>600</textlength> </field> </fields> <buncebacktype>user_and_customer_service</buncebacktype> <custmerserviceaddresses> <custmerserviceaddress> <custmerserviceaddress> </custmerserviceaddresses> <verrideunsubscribedusersstatus>false</verrideunsubscribedusersstatus> <allwmessageoverriding>false</allwmessageoverriding> <buncebackmessageid>525</buncebackmessageid> <managerbuncebackmessageid>525</managerbuncebackmessageid> </webfrm> </respnse> 268

269 Get Webfrm Integratin Cde This methd retrieves the Webfrm integratin cde. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The Webfrm integratin cde webfrmid The ID f the Webfrm Errr Statuses FILL_TOKEN_PARAMETER GET_WEBFORM_INTEGRATION_FAILED WEBFORM_INVALID_PARAMETER WEBFORM_MANDATORY_PARAMETER WEBFORM_EXPIRED SERVER_ERROR Errr s Yu must fill in the tken parameter The webfrm desn't exist. Access webfrm is nt authrized fr manager with id : {0}. The webfrm {0} is expired. An errr ccured n the server <respnse respnsestatus="success"> <webfrmintegratin> <surcecde> <html> <head> <title>webfrm</title> <meta http-equiv="cntent-type" cntent="text/html;charset=utf-8"> <script language="javascript">functin is ( address){ addressvalue= address.value.tlwercase(); var cuntrytlds=/^ 269

270 (ac ad ae af ag ai al am an a aq ar as at au aw ax az ba bb bd be bf bg bh bi bj bm bn b br bs bt bv bw by bz ca cat cc cd cf cg ch ci ck cl cm cn c cr cu cv cx cy cz de dj dk dm d dz ec ee eg eh er es et eu fi fj fk fm f fr ga gd ge gf gg gh gi gl gm gn gp gq gr gs gt gu gw gy hk hm hn hr ht hu id ie il im in i iq ir is it je jm j jp ke kg kh ki km kn kp kr kw ky kz la lb lc li lk lr ls lt lu lv ly ma mc md me mg mh mk ml mm mn m mp mq mr ms mt mu mv mw mx my mz na nc ne nf ng ni nl n np nr nu nz m pa pe pf pg ph pk pl pm pn pr ps pt pw py qa re r rs ru rw sa sb sc sd se sg sh si sj sk sl sm sn s sr st sv sy sz tc td tf tg th tj tk tm tn t tp tr tt tv tw tz ua ug uk um us uy uz va vc ve vg vi vn vu wf ws ye yt yu za zm zw)$/; var gtlds=/^(aer asia biz cat cm cp edu ge gv inf int jbs mil mbi museum name net rg pst pr tel travel)$/; var basicaddress=/^(.+)@(.+)$/; var specialchars='\\(\\)> <@,;:\\\\\\\"\\.\\[\\]'; var validchars='\[^\\s'+specialchars+'\]'; var validcharset='abcdefghijklmnopqrstuvwxyzabcdefghijklmnpqrstuvwxyzöå \'-_.+'; var quteduser='(\"[^\"]*\")'; var atm=validchars+'+'; var wrd='('+atm+' '+quteduser+')'; var validuser=new RegExp('^'+wrd+'(\.'+wrd+')*$'); var symdmain=new RegExp('^'+atm+'(\.'+atm+') *$'); var matcharray= addressvalue.match(basicaddress); if( address.value=='' address==null){ return true; } if(matcharray==null){ alert('the address desn\'t seem t be crrect,\nplease check syntax.'); address.fcus(); return false; }else{ var user=matcharray[1]; var dmain= matcharray[2]; fr(i=0;i <user.length;i++){ if(validcharset.indexof(user.charat(i))==-1){ alert('the address cntains invalid characters,\nplease check the username.'); address.fcus(); return false; } } fr(i=0;i <dmain.length;i++){ if(validcharset.indexof(dmain.charat(i))==-1){ alert('the address cntains invalid characters,\nplease check the dmain.'); address.fcus(); return false; } } if(user.match(validuser)==null){ alert('the address desn\'t seem t be crrect,\nplease check the username.'); address.fcus(); return false; } var atmpat=new RegExp('^'+atm+'$'); var dmarr=dmain.split('.'); var len=dmarr.length; fr(i=0;i <len;i++){ if(dmarr[i].search(atmpat)==-1){ alert('the address desn\'t seem t be crrect,\nplease check the dmain name.'); address.fcus(); return false; } } if((dmarr[dmarr.length-1].length==2)&&(dmarr[dmarr.length-1].search(cuntrytlds) ==-1)){ alert('the address desn\'t seem t be crrect,\nplease check dmain suffix.'); address.fcus(); return false; } if((dmarr[dmarr.length-1].length>2)&&(dmarr[dmarr. length-1].search(gtlds)==-1)){ alert('the address desn\'t seem t be crrect,\nplease check dmain suffix.'); address.fcus(); return false; } if((dmarr[dmarr.length-1].length <2) (dmarr[dmarr.length-1].length>6)){ alert('the address desn\'t seem t be crrect,\nplease check dmain suffix.'); address.fcus(); return false; } if(len <2){ alert('the address desn\'t seem t be crrect,\nplease check missing hstname.'); address.fcus(); return false; } } return true; } String.prttype.trim = functin() { return this.replace(/^\s*(\b.*\b )\s*$/, "$1"); } functin mandatrytext(input,fieldname){ if(input.value.trim()=='' input==null){ alert('please enter yur '+fieldname+'.'); input.fcus(); return false; } else { return true; } } functin validfrm(){ if (!mandatrytext(dcument.getelementbyid(' _field'), 'mail')) return; if(! is (dcument.getelementbyid(' _field'))) return; if(!mandatrytext(dcument.getelementbyid('lastname_field'), 'Last Name')) return; dcument.getelementbyid('emvfrm').submit(); } </script> </head> <bdy> <frm name="emvfrm" id="emvfrm" actin=" methd="post" target="_tp"> <input type="hidden" name="emv_tag" value=" cb8b" /> <input type="hidden" name="emv_ref" value="edx7cqkmjtfh8sa9mkjp1g_ fl0r6hq3d-jnefq5fksirkui" /> <table> <tr> <td>mail</td> <td> <input type="text" id=" _field" name=" _field" value="" size="30" maxlength="100"> </td> </tr> 270

271 <tr> <td>title</td> <td> <select id="title_field" name="title_field"> <ptin value=""> </ptin> <ptin value="ms.">ms.</ptin> <ptin value="mrs.">mrs.</ptin> <ptin selected value="mr.">mr.</ptin> </select> </td> </tr> <tr> <td>last Name</td> <td> <input type="text" id="lastname_field" name= "LASTNAME_FIELD" value="enter yur last name" size="30" maxlength="65"> </td> </tr> <tr> <td>first Name</td> <td> <input type="text" id="firstname_field" name="firstname_ FIELD" value="" size="30" maxlength="600"> </td> </tr> <tr> <td clspan="2" align="center"> <input type="buttn" value="submit Frm" nclickk="javascript:validfrm();"> </td> </tr> </table> </frm> </bdy> </html> </surcecde> <httpcallmethd> g= cb8b&emv_ref=edx7cqkmjtfh8sa9mkjp1g_fl0r6hq3d-jnefq5fksirkui& _field- D=XXXXXX&TITLE_FIELD=XXXXXX&LASTNAME_FIELD=XXXXXX& FIRSTNAME_FIELD=XXXXXX</httpCallMethd> <emvtag> cb8b</emvtag> <emvref>edx7cqkmjtfh8sa9mkjp1g_fl0r6hq3d-jnefq5fksi rkui</emvref> </webfrmintegratin> </respnse> 271

272 Test Grup Test Grup The Test Grup Object A test grup is a list f member IDs. This grup can be used t test a message r a campaign. id name testmembers memberid The ID f the test grup The name f the test grup. The test members parameter envelpe. The ID f the member Nte: The making up the bject d nt always need t be present fr methds using the bject. Fr example, when yu create a new banner, campaign, r message, yu d nt need t prvide the id parameter even thugh this is present in the bject. Each methd's sectin lists the that must r can be included fr the methd. On the ther hand, these are all present when the bject appears in a methd's utput

273 Create a Test Member This methd creates a test member using an address. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The test member details The address f the member Errr messages Yu must fill in the tken parameter An errr ccured n the server <?xml versin="1.0" encding="utf-8"?> <respnse respnsestatus="success"> <member> <clientid>4282</clientid> <datejin> t17:55:02+02:00</datejin> < >[email protected]</ > <id> </id> </member> </respnse> 273

274 Delete a Test Member This methd deletes a test member. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken memberid The cnnectin tken return The ID f the member true if it was successful, false if it was nt successful Errr messages Yu must fill in the tken parameter An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:lng">true</result> </respnse> 274

275 Create an SMS Test Member This methd creates a test member using their address and mbile telephne number. This is a GET methd Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The ID f the test member cellphne The address f the member The cellphne number f the member Errr messages Yu must fill in the tken parameter An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:lng">10</result> </respnse> 275

276 Get a Test Member This methd retrieves a test member's details. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The details f the test member memberid The ID f the member Errr messages Yu must fill in the tken parameter An errr ccured n the server <?xml versin="1.0"?> <respnse respnsestatus="success"> <member> <clientid>10</clientid> <datejin> t10:02:55+01:00</datejin> < >[email protected]</ > <emvcellphne> </emvcellphne> <id> </id> </member> </respnse> 276

277 Get Test Members This methd retrieves the test members. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The list f test member IDs Errr messages Yu must fill in the tken parameter An errr ccured n the server <?xml versin="1.0"?> <respnse respnsestatus="success"> <testmembers> <memberid> </memberid> <memberid> </memberid> <memberid> </memberid> </testmembers> </respnse> 277

278 Create a Test Grup This methd creates a test grup f members. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The ID f the newly created test grup Name The name f the test grup Errr messages Yu must fill in the tken parameter An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:lng">286</result> </respnse> 278

279 Create a Test Grup (POST) This methd creates a test grup. This is a POST methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The ID f the created test grup Test Grup Parameters testgrup The test grup parameter envelpe. name The name f the test grup. Test Members Parameters testmembers The test members parameter envelpe. memberid The ID f the member Errr messages Yu must fill in the tken parameter An errr ccured n the server URL Cntent-type text/xml; charset=utf-8 Bdy <testgrup> <name>test grup 2</name> <testmembers> <memberid>673272</memberid> <memberid>673271</memberid> <memberid>673266</memberid> </testmembers> </testgrup> 279

280 <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:lng" xmlns:xs=" xmlns: xsi=" </respnse> 280

281 Delete a Test Grup This methd deletes a test grup. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return true if it was successful, false if it was nt successful grupid The ID f the grup t delete Errr messages Yu must fill in the tken parameter This testgrup desn't exist. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 281

282 Add Test Member t a Test Grup This methd adds a member t a test grup. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return true if it was successful, false if it was nt successful memberid grupid The ID f the member t add The ID f the grup t which t add the member Errr messages Yu must fill in the tken parameter Yu must fill in the buttnurl parameter. This testgrup desn't exist. This member desn't exist. An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 282

283 Remve Test Member This methd remves a member frm a test grup. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return memberid grupid The ID f the member The ID f the grup frm which t remve the member true if it was successful, false if it was nt successful Errr messages Yu must fill in the tken parameter An errr ccured n the server <respnse respnsestatus="success"> <result xsi:type="xs:blean">true</result> </respnse> 283

284 Update a Test Grup (POST) This methd updates a test grup. This is a POST methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The ID f the created test grup Test Grup Parameters testgrup The test grup parameter envelpe. id The ID f the test grup name The name f the test grup. Test Members Parameters testmembers The test members parameter envelpe. memberid The ID f the member Errr messages Yu must fill in the tken parameter This test grup desn't exist r desn't cntains any test members. An errr ccured n the server Nte: Whenever yu d nt use all required and ptinal input fr a given methd, yu must use the HTTP GET QS (Query String) frmat. HTTP GET QS (Query String): The query string is cmpsed f a series f field-value pairs. The field-value pairs are each separated by an equals sign (=). The series f pairs is separated by the ampersand (&). Belw is an Internet brwser URL lcatin bar shwing a URL where the Query String is: title=main_ page&actin=raw API call summary: 284

285 HTTP GET (Query String) Submissin & sample URL call URL Cntent-type text/xml; charset=utf-8 Bdy <testgrup> <name>test grup 3</name> <id>294</id> <testmembers> <memberid>673272</memberid> <memberid>673271</memberid> <memberid>673266</memberid> </testmembers> </testgrup> <?xml versin="1.0" encding="utf-8" standalne="yes"?> <respnse respnsestatus="success"> <result xsi:type="xs:lng" xmlns:xs=" xmlns: xsi=" </respnse> 285

286 Get Test Grup This methd retrieves the list f members in a test grup. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The list f member IDs in that grup grupid The ID f the grup Errr messages Yu must fill in the tken parameter This testgrup desn't exist. An errr ccured n the server <respnse respnsestatus="success"> <testgrup> <id>287</id> <name>newtestgrup</name> <testmembers> <memberid>321566</memberid> <memberid>321567</memberid> </testmembers> </testgrup> </respnse> 286

287 Get All Test Grups This methd retrieves the list f test grups fr yur accunt. This is a GET methd. Nte: Ask yur Accunt Manager fr yur server name. Required tken The cnnectin tken return The list f grup IDs fr yur accunt Errr messages Yu must fill in the tken parameter This testgrup desn't exist. An errr ccured n the server <respnse respnsestatus="success"> <entities> <id>253</id> <id>254</id> <id>255</id> <id>256</id> <id>257</id> <id>258</id> <id>287</id> </entities> </respnse> 287

288 Reference Reference WADL The Web Applicatin Language (WADL) is a machine-readable XML-based language that prvides a mdel fr describing HTTP-based web applicatins (such as REST web services). Web Services The W3C defines a Web service as a sftware system designed t supprt interperable Machine t Machine interactin ver a netwrk. Web services are frequently just Web APIs that can be accessed ver a netwrk, such as the Internet, and executed n a remte system hsting the requested services. The W3C Web service definitin encmpasses many different systems, but in cmmn usage the term refers t clients and servers that cmmunicate XML messages that fllw the SOAP-standard. Cmmn in bth the field and the terminlgy is the assumptin that there is als a machine readable descriptin f the peratins supprted by the server, a descriptin in the WSDL. The latter is nt a requirement f SOAP endpint, but it is a prerequisite fr autmated client-side cde generatin in the mainstream Java and.net SOAP framewrks. Sme industry rganizatins, such as the WS-I, mandate bth SOAP and WSDL in their definitin f a Web service. WSDL The Web Services Language (WSDL, prnunced 'wiz-dull' r spelled ut, 'W-S-D-L') is an XML-based language that prvides a mdel fr describing Web services. Versin 2.1 has nt been endrsed by the Wrld Wide Web Cnsrtium (W3C). Versin 2.0, fr which several drafts have been released, is expected t becme a W3C recmmendatin. WSDL is an XMLbased service descriptin n hw t cmmunicate using web services. The WSDL defines services as cllectins f netwrk endpints, r prts. WSDL specificatin prvides an XML frmat fr dcuments fr this purpse. WSDL is ften used in cmbinatin with SOAP and XML Schema t prvide web services ver the Internet. A client prgram cnnecting t a web service can read the WSDL t determine what functins are available n the server. Any special datatypes used are embedded in the WSDL file in the frm f XML Schema. The client can then use SOAP t actually call ne f the functins listed in the WSDL. XML The Extensible Markup Language (XML) is a W3C-recmmended general-purpse markup language. The XML recmmendatin specifies bth the structure f XML, and the requirements fr XML prcessrs. XML is cnsidered "general-purpse" because it enables anyne t riginate and use a markup language fr many types f applicatins and prblem dmains. Numerus frmally defined markup languages are based n XML, such as RSS, MathML, GraphML, XHTML, Scalable Vectr Graphics, MusicXML, and thusands f thers. XML's primary purpse is t facilitate the sharing f data acrss different infrmatin systems, particularly systems cnnected via the Internet. It is a simplified subset f Standard Generalized Markup Language (SGML), and is designed t be relatively human-legible