Soap Web Services API Guide

8/15/2019 Soap Web Services API Guide

1/107

!"" $%&''( )*&+ ,-% ./00' 1 234 5'6407 $) !8"99 1 9,"+:8,+;:"" 1


2/107

Table of Contents

Interact API Guide Page 2 of 107 Responsys Confidential

TTaabbllee oof f CCoonntteennttss

INTERACT WEB SERVICES API 8

Interact API Functionality 9

What’s New in the Interact API for Interact Campaign 5.16 (January 2011) 10

What’s New in the Interact API for Interact Campaign 5.14 (June 2010) 10

What’s New in the Interact API for Interact Campaign 5.13 (January 2010) 10

What’s New in the Interact API for Interact Campaign 5.12 (September 2009) 11

What’s New in the Interact API for Interact Campaign 5.11 (July 2009) 12

What’s New in the Interact API for Interact Campaign 5.10 (April 2009) 13

What’s New in the Interact API for Interact Campaign 5.9 (February 2009) 14

What’s New in the Interact API for Interact Campaign 5.8 (October 2008) 15

What’s New in the Interact API for Interact Campaign 5.7.1 (September 2008) 16

Interact API URLs 18

Security Considerations 18

Web Service Standards Compliance 19

Development Environments 19

Interact Platform Maintenance and Downtime 19

Backward Compatibility 19

INTERACT PLATFORM AND DATA MODEL OVERVIEW 20

INTERACT OBJECT AND DATA MODEL 20

Campaigns 21

Forms 21

Data Sources 21

Documents 22


3/107

Table of Contents


INTERACT API – GETTING STARTED 23

General Steps 23

For Java Applications 23

For C# Applications 28

INTERACT API CALLS 30

SESSION MANAGEMENT API CALLS 30

Login 30

Logout 32

GetServerTimestamp 34

FOLDER MANAGEMENT API CALLS 35

CreateFolder 35

DeleteFolder 37

ListFolders 39

ListFolderContents 41

ListFolderObjects 43

ImportFolder 46

ExportFolder 48

DATA MANAGEMENT API CALLS 50

CreateDataSource 50

UpdateDataSource 52

UpdateDataSourceUsingMultipleColumns 53

AppendDataSource 54

CopyDataSource 55

CopyDataSourceToTable 56

CreateSQLDataSource 57


4/107

Table of Contents


DeleteDataSource 58

TruncateTable 59

DownloadDataSourceByTimestamp 60

DownloadDataSource 61

PurgeDataSourceByTimestamp 62

PurgeDataSource 63

ScrubDataSource 64

CheckResult 65

Cancel 66

AddIndex 67

DeleteIndex 68

ListIndexes 69

GetDataSourceSchema 70

GetDataSourceRecordCount 71

CONTENT MANAGEMENT API CALLS 72

UploadDocument 72

RemoveDocument 73

CopyDocument 74

ShowDocument 75

CAMPAIGN MANAGEMENT API CALLS 76

CreateCampaign 76

CopyCampaign 77

DeleteCampaign 78

GetCampaignProperties 79

SetCampaignProperties 80


5/107

Table of Contents


LaunchCampaign 81

UnScheduleCampaign 82

GetCampaignStatus 82

StopCampaign 83

TriggerFormRules 84

GetLiveReportMetrics 85

GetReportOptions 86

GetCampaignsInDatamart 87

GetLaunchesInDatamart 89

RunLaunchReport 91

RunTriggeredMessageReport 92

INTERACT API TYPE DEFINITIONS 93

PRIMITIVE TYPE DEFINITIONS 93

boolean 93

string 93

int and long 93

dateTime 93

INTERACT API TYPE DEFINITIONS 94

CampaignInfo 94

CampaignLaunchType 94

CampaignProperties 94

CampaignPurpose 96

CampaignState 96

CampaignType 96

CampaignVariable 96


6/107

Table of Contents


CharacterEncoding 97

ClickThru 97

ClickthroughCount 97

DataSourceProperties 97

Document 98

DocumentFile 98

DocumentType 98

EmailFormat 99

Field 99

FieldMap 99

FilterObjectType 99

FolderContentType 99

FolderImport 99

FolderObject 100

FormData 100

HtmlData 100

Index 100

InteractObject 100

InteractObjectType 101

IntermediateResult 101

LaunchInfo 101

LiveReportMetrics 102

LiveReportPeriod 102

Log Table 102

LogTableType 103

LoginResult 103


7/107

Table of Contents


OptOut 103

OptOutMode 103

PurgeDataSourceProperties 104

RecipientLocale 104

RecordCount 105

Report 106

ReportOptions 106

ReportResult 106

ResponsePeriod 107

ScrubProperties 107

ScheduleFrequency 107


8/107

Interact API Functionality


Interact Web Services API

A%& B4-&'3?- C&D 2&'*E?&= )>>/E?3-E04 F'0G'3@@E4G B4-&'H3?& IB4-&'3?- )FBJ GE*&= (06' K&*&/0>&'= =-34K3'K=L D3=&K 3??&== -0 @34( 0H -%& K3-37 ?04-&4-7 34K ?3@>3EG4 @343G&@&4- H&3-6'&= 0H M&=>04=(= B4-&'3?-N $3@>3EG4+

CE-% -%& B4-&'3?- )FB7 (06 ?34 D6E/K (06' 0>/E?3-E04= -%3- 4&&K -0 E4-&'H3?& /E?3-& K3-3 D&-0'- @&-'E?= 34K K3-3 K0-63/ KE3G'3@ 0H -%& 6=& 0H -%& B4-&'3?- )FB E= =%0@&4- -00/= -0 G3E4 >'0G'3@@3-E? 3??&== -0 (06'

0'G34EO3-E04V= M&=>04=(= B4-&'3?- 3??064-+ A%& B4-&'3?- )FB &43D/&= &3=( E4-&G'3-E04 0H (06' &4-&'>'E=& =(=-&@=

3EG4= 34K K3-3 =-0'&K E4 (06' M&=>04=(= B4-&'3?- 3??064-7 &43D/E4G G'&3-&' 36-0@3-E04 0H @3'R&-E4G-3=R= 34K >'0?&==&=+


9/107




A%& B4-&'3?- )FB =6>>0'-= 3 =6D=&- 0H -%& H64?-E043/E-( 0H -%& B4-&'3?- 6=&' E4-&'H3?& 3= 06-/E4&K D&/0/3-H0'@ -E@&=-3@> H0' K3-3 =(4?%'04EO3-E04 /0GE?

Folder and Interact Object Management

$'&3-& 0' K&/&-E4G H0/K&'=

B@>0'- 0' &Y>0'- B4-&'3?- H0/K&' 3'?%E*& HE/&=

M&-'E&*& H0/K&' 34K H0/K&' 0DZ&?- E4H0'@3-E04

List and Data Management

$'&3-&7 3>>&4K7 6>K3-& 0' K&/&-& '&?0'K= E4 -3D/& K3-3 =06'?& D( 6>/03KE4G K&/E@E-&K -&Y- HE/&=

T&/&-& '&?0'K= D3=&K 04 -E@&=-3@> ?0@>3'E=04=

$'&3-& 2[U *E&< 0DZ&?-= T06'G& K3-3

$0>(7 =?'6D7 K&/&-&7 0' -'64?3-& 3 K3-3 =06'?&

SD-3E4 K3-3 0DZ&?- =?%&@3 E4H0'@3-E04

)KK7 K&/&-&7 0' /E=- E4K&Y&= 04 3 -3D/&

Content Management

\>/03K 3 @&==3G& K0?6@&4- 34K E@3G& HE/&=

$0>( 0' K&/&-& 3 K0?6@&4-

Campaign Management

$'&3-& 3 ?3@>3EG47 0' ?%34G& E-= >'0>&'-E&=

$0>( 0' K&/&-& 3 ?3@>3EG4

U364?%7 =-0> 3 /364?%7 0' 64=?%&K6/& 3 ?3@>3EG4

X&- ?3@>3EG4 /364?% =-3-6=

X&- '&>0'- @&-'E?= H0' 3 ?3@>3EG4

Form Management

A'EGG&' H0'@ '6/&= -0 E4=&'-W6>K3-& 3 '&?0'K E4 34 &YE=-E4G -3D/& 34KW0' -'EGG&' 3 @&==3G& H'0@ 3 ?3@>3EG4+


10/107

What’s New in the Interact API for Interact Campaign 5.16 (January 2011)


What’s New in the Interact API for Interact Campaign 5.16 (January 2011)

A%& ,+;9 B4-&'3?- $3@>3EG4 '&/&3=& E4-'0K6?&= -%& H0//00E4- E4-'0K6?&K E4 -%& ,+: '&/&3=& 0H B4-&'3?- $3@>3EG4+

What’s New in the Interact API for Interact Campaign 5.14 (June 2010)

A%& ,+;8 B4-&'3?- $3@>3EG4 '&/&3=& E4-'0K6?&= -%& H0//0


11/107

What’s New in the Interact API for Interact Campaign 5.12 (September 2009)


NoteQ )KKE-E04= -0 -%& B4-&'3?- )FB H0' -%E= '&/&3=& KEK 40- 4&?&==E-3-& 3 *&'=E04E4G 0H -%& C2TU+ A%&'&H0'&7 (06'

?/E&4- 3>>/E?3-E04= K0 40- %3*& -0 D& @EG'3-&K -0 4&< 0E4- E4-'0K6?&K E4 -%& ,+: '&/&3=& 0H B4-&'3?- $3@>3EG4+

What’s New in the Interact API for Interact Campaign 5.12 (September 2009)

]0 ?%34G&= 3EG4 '&/&3=&+


12/107

What’s New in the Interact API for Interact Campaign 5.11 (July 2009)


What’s New in the Interact API for Interact Campaign 5.11 (July 2009)

A%& ,+;; B4-&'3?- $3@>3EG4 '&/&3=& E4-'0K6?&= 04& 4&< )FB ?3// 34K 3 46@D&' 0H D6G HEY&=+

;+ ) 4&< B4-&'3?- )FB ?3// %3= D&&4 3KK&K -0 3//0< H0' K&/&-E4G '&?0'K= E4 D6/R H'0@ 3 K3-3 =06'?&Q >6'G&T3-3206'?&IJ

_+ ) 46@D&' 0H D6G= %3*& D&&4 HEY&KQ

3+ 6>K3-&T3-3206'?&IJ ?3// KEK 40- =6>>0'- >E>& K&/E@E-&K OE> HE/& I9_,dJ+

D+ 3>>&4KT3-3206'?&IJ ?3// '0>&'/( %34K/E4G HE&/K @3>>E4G= >&4K&K '&?0'K=EH -%& -3'G&- -3D/& ?04-3E4&K 34( HE&/K & I9_89J+

K+ 6>K3-&T3-3206'?&IJ


13/107

What’s New in the Interact API for Interact Campaign 5.10 (April 2009)


What’s New in the Interact API for Interact Campaign 5.10 (April 2009)

A%& ,+;" B4-&'3?- $3@>3EG4 '&/&3=& E4-'0K6?&= =&*&'3/ 4&< )FB ?3//=7 34K 3 46@D&' 0H D6G HEY&=+

;+ ]&< ?3//= %3*& D&&4 3KK&K -0 -%& B4-&'3?- )FB+

3+ M&>0'-E4G )FB=

E+ G&-M&>0'-S>-E04=IJ

EE+ G&-$3@>3EG4=B4T3-3@3'-IJ

EEE+ G&-U364?%&=B4T3-3@3'-IJ

E*+ '64U364?%M&>0'-IJ

*+ '64A'EGG&'&Ka&==3G&M&>0'-IJ

D+ T3-3 @&'G& )FB H0' @6/-E?0/6@4 @3-?% '6/&=Q =&& 6>K3-&T3-3206'?&\=E4Ga6/-E>/&$0/6@4=IJ

_+ 5&%3*E0' ?%34G&=Q $3@>3EG4 /364?% /E@E-=Q 3 ?3@>3EG4 ?34 40 /04G&' D& /364?%&K >/E?3-E04=7 M&=>04=(= M&3/LAE@&

a&==3GE4G 0' .0'@LD3=&K -'EGG&'E4G =%06/K D& ?04=EK&'&K+ $04-3?- (06' 3??064- @343G&' 0' M&=>04=(=

26>>0'- H0' @0'& E4H0'@3-E04 3D06- -%&=& -'EGG&'E4G 0>-E04=+

`+ 56G HEY&= 34K >&'H0'@34?& &4%34?&@&4-=

3+ A%& >&'H0'@34?& 34K =-3DE/E-( 0H @&'G& 0>&'3-E04= K3-&T3-3206'?& ?3// %3= D&&4E@>'0*&K I`!``7 ,:,87 ,d!"J+

D+ $'&3-E04 0H 2[U 0DZ&?-= E= 40< HEY&K H0' &KG& ?3=&= 0E4- E4-'0K6?&K E4 -%& ,+: '&/&3=& 0H B4-&'3?- $3@>3EG4+


14/107

What’s New in the Interact API for Interact Campaign 5.9 (February 2009)


What’s New in the Interact API for Interact Campaign 5.9 (February 2009)

A%& ,+! B4-&'3?- $3@>3EG4 '&/&3=& E4-'0K6?&= =&*&'3/ 4&< )FB ?3//=7 34K 3 46@D&' 0H D6G HEY&=+

;+ ]&< ?3//= %3*& D&&4 3KK&K -0 -%& B4-&'3?- )FBQ

3+ /E=-.0/K&'SDZ&?-=

D+ -'EGG&'.0'@M6/&=

?+ G&-UE*&M&>0'-a&-'E?=

_+ ]&< '&=-'E?-E04= g a3YE@6@ ?04?6''&4- B4-&'3?- )FB /0GE4=Q 3 /E@E- 04 -%& 46@D&' 0H ?04?6''&4- /0GE4=%3= D&&4 E@>/&@&4-&K -0 D&--&' >'0-&?- -%& B4-&'3?- >/3-H0'@ H'0@ E43K*&'-34- 3D6=& D( ?/E&4- 3>>/E?3-E04=-%3- &'H0'@34?& K&G'3K3-E04 H0' 3// ?/E&4- 3>>/E?3-E04=+ A%E= /E@E- E= =&- -0 ;" D( K&H36/-+ BH(06' E4-&G'3-E04 >'0Z&?-= '&c6E'& 3 %EG%&' /E@E-7 ?04-3?- M&=>04=(= 26>>0'- -0 KE=?6== E4?'&3=E4G -%E= /E@E-H0' (06' 3??064-+

`+ 56G HEY&=Q

3+ T3-3 E= 40- 3>>&4K&K 0' 6>K3-&K EH -%& E4?0@E4G HE&/K 43@& K0&= 40- @3-?% -%& -3'G&- HE&/K 43@&I,`:`J+

D+ ABae2A)aFf HE&/K *3/6&= 3'& 40- G&4&'3-&K E4 =0@& ?3=&= H0' 3>>&4K 34K 6>K3-& 0>&'3-E04=I,;,:J+

NoteQ )KKE-E04= -0 -%& B4-&'3?- )FB H0' -%E= '&/&3=& KEK 40- 4&?&==E-3-& 3 *&'=E04E4G 0H -%& C2TU+ A%&'&H0'&7 (06'

?/E&4- 3>>/E?3-E04= K0 40- %3*& -0 D& @EG'3-&K -0 4&< 0E4- E4-'0K6?&K E4 -%& ,+: '&/&3=& 0H B4-&'3?- $3@>3EG4+


15/107

What’s New in the Interact API for Interact Campaign 5.8 (October 2008)


What’s New in the Interact API for Interact Campaign 5.8 (October 2008)

A%& ,+d B4-&'3?- $3@>3EG4 '&/&3=& E4-'0K6?&= =&*&'3/ 4&< )FB ?3//=7 34K 3 46@D&' 0H D6G HEY&=+

;+ ]&< ?3//= %3*& D&&4 3KK&K -0 -%& B4-&'3?- )FBQ

3+ G&-2&'*&'AE@&=-3@>

D+ -'64?3-&A3D/&

?+ 3KKB4K&Y

K+ K&/&-&B4K&Y&+ /E=-B4K&Y&=

_+ 56G HEY&=Q

3+ C%&4 ?0>(T3-3206'?& E= ?3//&K7 K3-3 &Y-'3?-E04 R&(= 3'& 40< ?0>E&K -0 -%& 4&< K3-3 =06'?&+

D+ .'0@ )KK'&== H0' 3 ?3@>3EG4 ?34 40< D& ?%34G&K 3EG4F'0>&'-E&= ?3//+ Note: A%& .'0@ )KK'&== @6=- 3/'&3K( D& K&HE4&K H0' 6=& E4 (06' B4-&'3?- $3@>3EG4 3??064-+

NoteQ )KKE-E04= -0 -%& B4-&'3?- )FB H0' -%E= '&/&3=& KEK 40- 4&?&==E-3-& 3 *&'=E04E4G 0H -%& C2TU+ A%&'&H0'&7 (06'?/E&4- 3>>/E?3-E04= K0 40- %3*& -0 D& @EG'3-&K -0 4&< 0E4- E4-'0K6?&K E4 -%& ,+: '&/&3=& 0H B4-&'3?- $3@>3EG4+


16/107

What’s New in the Interact API for Interact Campaign 5.7.1 (September 2008)



A%& M&=>04=(= B4-&'3?-N ,+:+; '&/&3=& E4-'0K6?&= 3 =&'E&= 0H &4%34?&@&4-= 34K D6G HEY&= H0' -%& B4-&'3?- B4-&'3?-

)FB+

;+ ]&< C&D 2&'*E?& e4K>0E4- \MU= 34K C2TU= %3*& D&&4 E4-'0K6?&K -0 =6>>0'- -%E= 4&< B4-&'3?- )FB*&'=E04+ A%& C&D 2&'*E?& e4K>0E4- \MU= H0' -%& >'&*E06= B4-&'3?- )FB *&'=E04 >0'-&K 34K (06' &YE=-E4G ?/E&4- 3>>/E?3-E04= =%06/K 40- D& E@>3?-&K+ P06 =%06/K @3R& >/34= -0 @EG'3-&-0 -%& 4&< B4-&'3?- )FB *&'=E04 -0 -3R& 3K*34-3G& 0H '&?&4- &4%34?&@&4-=+

_+ T3-3 )FB= -%3- E4*0/*& HE/& %34K/E4G 3'& 40< D3=&K 04 C`$ 2S)F a&==3G& A'34=H&' S>-E@EO3-E04

a&?%34=E=@ IaASaJ 3= 0>>0=&K -0 >'&*E06= *&'=E04= 0H -%&=& )FB= -E04= %3= D&&4 '&@0*&K+ ]&< T3-3 )FB ?3//= 3'& 40< D3=&K 04 343=(4?%'0406= 3>>'03?% /&-E04 0H -%3- 6>/03K E= ?%&?R&K /3?&K E4 -%& 2S)F %&3K&' 0H 3//

=6D=&c6&4- )FB ?3//= -0 36-%&4-E?3-& -%& ?/E&4- 3>>/E?3-E04 '&c6&=-+,+ $3@>3EG4F'0>&'-E&= 0DZ&?- %3= D&&4 &Y-&4K&K -0 E4?/6K& 4&< >'0>&'-( 3??&==Q

3+ B- 40< =6>>0'-= '&-'E&*E4G -%& B4-&'3?- $3@>3EG4 EK&4-EHE&' 3= 3EG4F'0>&'-E&= 40< E4?/6K&= ?3@>3EG4F6'>0=& >'0>&'-( 3?&= %3*& D&&4 '&@0*&K H'0@ -%& 2S)F '&=>04=&= 0H )FB ?3//= -0 @3R& -%& haU

@0'& '&3K3D/& 34K ?0@>3?-+

:+ ) 46@D&' 0H 4&< 0D&?-= %3*& D&&4 E4-'0K6?&K -0 3//0< ?/&34&' )FB ?3//=Q B4-&'3?-SDZ&?-+ .0' &Y3@>/&7 >'&*E06=/( =&>3'3-& 0DZ&?- -(>&= E4?/6K&K )?R4004=&T57 2&&KUE=-7 26>>/&@&4-3/T3-3206'?&7 34K

26>>'&==E04T3-3206'?&+ 2E4?& -%&=& 3'& @&'&/( B4-&'3?- 0D&?-= &'-(7 3 @0'&

G&4&'E? 0D&?-7 ?3//&K -%& B4-&'3?-SDZ&?- E= 40< 6=&K H0' -%&=& H0'@&' 0DZ&?-=+

d+ C& %3*& 3KK&K -%& H0//03EG4A(>& I2A)]T)MT7 .SMa7 Me)UABaeJ 6=&K E4 ?'&3-&$3@>3EG4+

D+ 2?%&K6/&.'&c6&4?( IS]$e7 T)BUP7 CeeiUP7 aS]AjUPJ 6=&K E4 /364?%$3@>3EG4+

?+ U0GA3D/&A(>& I2e]A7 .)BUeTJ 6=&K E4 -%& U0GA3D/& &/&@&4-+

K+ T0?6@&4-A(>& I)SU7 jAaU7 AehAJ 6=&K E4 -%& T0?6@&4- &/&@&4-+

&+ S>-S6-a0K& I]S]e7 S]ef2AeF7 ACSf2AeF7 \2eMf\MUJ 6=&K E4 -%& S>-S6- &/&@&4-+

H+ .E&/KA(>& I2AM_,7 2AM,"7 2AM_,,7 2AM;"""7 aeaS7 ]\a5eM7 B]AeXeM7 ABae2A)aFJ76=&K E4 .E&/K &/&@&4-+

G+ .0/K&'$04-&4-A(>& IT)A)7 $)aF)BX]7 TS$\ae]A7 MeFSMA7 M\Ue7 )UUfAPFe2J 6=&KE4=-&3K 0H -%& ?04-&4-A(>& =-'E4G+

http://www.w3.org/TR/soap12-mtom/http://www.w3.org/TR/soap12-mtom/http://www.w3.org/TR/soap12-mtom/http://www.w3.org/TR/soap12-mtom/


17/107



%+ .0/K&'$04-&4-A(>& IT)A)7 $)aF)BX]7 TS$\ae]A7 MeFSMA7 M\Ue7 )UUfAPFe2 6=&KE4=-&3K 0H -%& ?04-&4-A(>& =-'E4G E4 /E=-.0/K&'$04-&4-= )FB+

E+ M&?E>E&4-U0?3/& I3// =6>>0'-&K /0?3/& =-'E4G=J

!+ )KK&K -%& H0//0& &46@7 6=&K E4 -%&T3-3206'?&F'0>&'-E&=+

?+ ]&< /0?3/& &/&@&4- E4 T0?6@&4-.E/& ?0@>/&YA(>&+

;"+ 56G HEY&=Q

3+ C%&4 3 ?3@>3EG4 E= /364?%&K *E3 34 )FB ?3//7 -%& ?04*&'=E04 -'3?RE4G >'0>&'-( E= 40 /04G&' =&- -0H3/=& I8"_,J+

D+ C%&4 3 ?3@>3EG4 E= ?'&3-&K H'0@ ?3@>3EG4 -&@>/3-& -%3- E4?/6K&= /E4R -'3?RE4G 34K E-= K0?6@&4-E= ?%34G&K7 /E4R -'3?RE4G E= 40 /04G&' KE=3D/&K I8",:J+

?+ \=& 0H =&-$3@>3EG4F'0>&'-E&= -0 =&- 3 UE4R A3D/& -%3- 0==ED/& I8;;,J+

;;+ ^3*3 =3@>/& ?0K& %3= D&&4 '&*E=&K D3=&K 04 -%& 6=& 0H )>3?%& )YE=_ ;+8 -0 G&4&'3-& ^3*3 =-6D ?/3==&=I>'&*E06= =3@>/&=


18/107

Interact API URLs


Interact API URLs

C%&4 (06' 3??064- E= &43D/&K H0' 3??&== -0 -%& B4-&'3?- )FB7 -%& M&=>04=(= 26>>0'- -&3@ '0*EK& (06 '0Z&?-=+ B4-&'3?- )FB \MU= H0' =&*&'3/ 3*3E/3D/& M&=>04=(=

B4-&'3?- E4=-34?&= 3'& >'0*EK&K D&/0< H0' >'&/E@E43'( '&H&'&4?& 04/(+

Responsys Interact Pod Web Service API URLs

B4-&'3?- ; F0K

IE4-&'3?-;+'&=>04=(=+4&-J

%-->=QWW04=(=+4&-W04=(=C2,:l04=(=+4&-W04=(=C2,:

%-->=QWW04=(=+4&-J

%-->=QWW04=(=+4&-W04=(=C2,:lQWW>/E?3-E04 34K -%& B4-&'3?- $3@>3EG4 B4-&'3?- )FB ?34 D& =&?6'&K D( 6=E4G

-%& 2&?6'& 20?R&-= U3(&' I22UJ >'0-0?0/ H0' jAAF '&c6&=-= 34K '&=>04=&=+ A%E= E= 3 =-34K3'K 3>>'03?% H0'=&?6'E4G E4-&'4&-LD3=&K ?0@@64E?3-E04= 34K '&*&4- &3*&=K'0>>E4G7 -3@>&'E4G7 34K @&==3G&

H0'G&'(+ B- =&?6'&= ?0@@64E?3-E04= 0*&' -%& E4-&'4&- D( ?'(>-0G'3>%E? @&-%0K= D3=&K 04 3 ;_dLDE- &4?'(>-E04 34K

E= 3 =-34K3'K 3>>'03?% H0' =&?6'E4G 2S)FLD3=&K C&D =&'*E?& -'34=3?-E04=+

https://ws1.responsys.net/webservices57/services/ResponsysWS57https://ws1.responsys.net/webservices57/services/ResponsysWS57?wsdlhttps://ws3.responsys.net/webservices57/services/ResponsysWS57https://ws3.responsys.net/webservices57/services/ResponsysWS57?wsdlhttps://ws4.responsys.net/webservices57/services/ResponsysWS57https://ws4.responsys.net/webservices57/services/ResponsysWS57?wsdlhttps://ws.ruk1.net/webservices57/services/ResponsysWS57http://ws.ruk1.net/webservices57/services/ResponsysWS57?wsdlhttp://ws.ruk1.net/webservices57/services/ResponsysWS57?wsdlhttps://ws.ruk1.net/webservices57/services/ResponsysWS57https://ws4.responsys.net/webservices57/services/ResponsysWS57?wsdlhttps://ws4.responsys.net/webservices57/services/ResponsysWS57https://ws3.responsys.net/webservices57/services/ResponsysWS57?wsdlhttps://ws3.responsys.net/webservices57/services/ResponsysWS57https://ws1.responsys.net/webservices57/services/ResponsysWS57?wsdlhttps://ws1.responsys.net/webservices57/services/ResponsysWS57


19/107

Web Service Standards Compliance


Web Service Standards Compliance

A%& B4-&'3?- )FB /&@&4-&K E4 ?0@>/E34?& /& SDZ&?- )??&== F'0-0?0/ I2S)FJ ;+;%-->QWW3?%& )YE=+ T&*&/0>@&4- >/3-H0'@= *3'( E4 -%&E' 2S)F E@>/&@&4-3-E04=+B@>/&@&4-3-E04 KEHH&'&4?&= E4 ?&'-3E4 K&*&/0>@&4- >/3-H0'@= @EG%- >'&*&4- 3??&== -0 =0@& 0' 3// 0H -%& H&3-6'&= E4

-%& )FB+ BH (06 3'& 6=E4G mE=63/ 2-6KE0 H0' +]eA K&*&/0>@&4-7 /3-H0'@ 3EG4 /0GE4 =&==E04= -= -0 ?'&3-& 3 /0GE4 =&==E04

'E3-& 3?-E047 0E4- \MU

E= *&'=E04&K =0 -%3- KEHH&'&4- B4-&'3?- )FB *&'=E04= %3*& KEHH&'&4- &4K>0E4- \MU=+ P06' 3>>/E?3-E04= '&*E06= '&/&3=&= 34K (06 %3*& -%& 0>>0'-64E-( -0 @EG'3-& (06'?/E&4- 3>>/E?3-E04= -0 -%& 4&>/E?3-E04 '&=&4-3-E04= 3'& 0H-&4 '&c6E'&K 3= 04=(= '&?3-E04+

http://www.w3.org/TR/2000/NOTE-SOAP-20000508/http://www.w3.org/TR/2001/NOTE-wsdl-20010315http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.htmlhttp://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.htmlhttp://www.w3.org/TR/2001/NOTE-wsdl-20010315http://www.w3.org/TR/2000/NOTE-SOAP-20000508/


20/107

Backward Compatibility


Interact Platform and Data Model Overview

2E4?& ;!!d7 M&=>04=(= %3= D&&4 3 -&?%40/0G( /&3K&' 34K E440*3-0' E4 -%& @3'R&-E4G E4K6=-'(7 K&/E*&'E4G %EG%Lc63/E-( ?3@>3EG4 @343G&@&4- =0H-'&%&4=E*& 04LK&@34K @3'R&-E4G >/3-H0'@ >/E?3-E04= g 3// D6E/- H'0@ -%& G'064K 6> 04 3 =E4G/&LE4=-34?&7 @6/-EL-&434-3'?%E-&?-6'&+

Interact Object and Data Model

B4 -%& B4-&'3?- $3@>3EG4 6=&' E4-&'H3?&7 (06 ?'&3-& 34K @343G& 3 *3'E&-( 0H 3>>/E?3-E04 0DZ&?-= -%3- 3'& 4&&K&K -0

&Y&?6-& (06' @3'R&-E4G >'0G'3@=+ A%& B4-&'3?- $3@>3EG4 0DZ&?- @0K&/ ?04=E=-= 0H -%& H0//0&= 0H 0DZ&?-=+

$3@>3EG4= g )//0< 6=&'= -0 &Y&?6-& E4KE*EK63/ &@3E/ ?3@>3EG4= E4 D3-?% 0' -'EGG&'&K @0K&=

.0'@= g )//0< 6=&'= -0 ?0//&?- K3-3 *E3 6'>0=&=

TE=-'ED6-E04 /E=-= -3D/&= g 2-0'& '&?E>E&4- 36KE&4?& '&?0'K=

$3@>3EG4 26>>/&@&4-3/ K3-3 =06'?&= g 2-0'& @E=?&//34&06= K3-3 -%3- ?34 D& 6=&K H0' 3 @6/-EL-3D/&'&/3-E043/ =?%&@3 E4 3 ?3@>3EG4 H0' @&==3G& ?04-&4- >&'=043/EO3-E04 34K E4KE*EK63/EO3-E04+

UE4R -3D/&= g 2-0'& /E4R -'3?RE4G E4H0'@3-E04+

$3@>3EG4 &*&4- -'3?RE4G /0G -3D/&= g 2-0'& '&?E>E&4-L/&*&/ K3-3 04 %0< '&?E>E&4-= '&=>04K -0 GE*&4?3@>3EG4=+

2[U 0DZ&?-= g M&>'&=&4- 3 2[U *E&< 04 3 D3=& -3D/&+

T0?6@&4-= g $04=E=- 0H '&L6=3D/& ?'&3-E*& ?04-&4- E4 -%& H0'@ 0H jAaU 34K A&Y- K0?6@&4- 0DZ&?-= -%3-3'& 3*3E/3D/& H0' 6=& E4 34( $3@>3EG4 0' .0'@+

.0/K&' g )//0< 6=&'= -0 @343G& -%&E' *3'E06= @3'R&-E4G >'0Z&?-= D( >/3?E4G 3>>/E?3-E04 0DZ&?-= E4 3 =&'E&=0H 6=&'LK&HE4&K H0/K&'=

A%& B4-&'3?- )FB >'0*EK&= >'0G'3@@3-E? ?04-'0/ 0*&' @34( 0H -%&=& 0DZ&?-=7 3//0>/E?3-E04 K&*&/0>&'=-0 ?'&3-&7 ?%34G&7 0' '&@0*& -%&=& 0DZ&?-= -0 3??0@>/E=% 34( GE*&4 @3'R&-E4G 36-0@3-E04 G03/+ ) D'E&H KE=?6==E04

0H -%&=& 0DZ&?-= E= >'0*EK&K D&/03EG4 E=

3*3E/3D/& *E3 -%& B4-&'3?- $3@>3EG4 K0?6@&4-3-E04 34K -'3E4E4G @3-&'E3/=+

http://www.responsys.com/solutions/index.phphttp://www.responsys.com/solutions/index.php


21/107

Campaigns


Campaigns

$3@>3EG4 0DZ&?-= K&HE4& -%& D3=E? D&%3*E0' 0H 34 &@3E/ ?3@>3EG4 E4 -&'@= 0H 36KE&4?&7 @&==3G&7 34K =&--E4G=+ )

?3@>3EG4 ?34 D& /364?%&K E4 D6/R E@@&KE3-&/( 0' =?%&K6/&K H0' /364?%+ A%& $3@>3EG4 0DZ&?- %3= >'0>&'-E&= =6?%

3=Q

X&4&'3/ >'0>&'-E&= g 43@&7 K&=?'E>-E047 ?3-&G0'EO3-E047 &-?+

)6KE&4?& g KE=-'ED6-E04 /E=- 34K =6>>'&==E04 /E=-=

a&==3G& g H'0@ %&3K&'7 '&>/(L-0 %&3K&'7 =6DZ&?- %&3K&'7 jAaUWA&Y- @&==3G& K0?6@&4-=

2&--E4G= g -'3?RE4G 0>-E04=7 36-0L?/0=& D&%3*E0'7 K&H36/- *3'E3D/&=7 ?3@>3EG4 &*&4- /0G -3D/&7 &-?+

Forms

.0'@ 0DZ&?-= >'0*EK& H64?-E043/E-( H0' %0=-E4G 6'>0=& =6'*&(=+ T3-3 ?0//&?-&K H'0@ .0'@= ?34 D& @&'G&K E4-0 34( -3D/&+ .0'@

'&=>04=&= ?34 3/=0 -'EGG&' H0//0 &@3E/= -0 '&=>04K&'=+

Data Sources

T3-3 =06'?& 0DZ&?-= ?0@& E4 -%& H0'@ 0H -3D/&=7 HE/-&'=7 0' 2[U *E&6'>0=&= E4

B4-&'3?- $3@>3EG47 E4?/6KE4GQ

Distribution Lists g $04-3E4 '&?E>E&4- '&?0'K= 34K ?34 D& 6=&K -0 K&HE4& -%& 36KE&4?& 0H 3 ?3@>3EG4+

Supplemental Data g $04-3E4 K3-3 -%3- ?34 D& Z0E4&K 3EG4 @&==3G&+

Campaign Event Tracking “Log” Data g $04-3E4 '&?E>E&4- &*&4- K3-3 =6?% 3= 2&4-7 S>&4&K7 $/E?R&K7&-?+ -%3- 3'& G&4&'3-&K D( -%& B4-&'3?- $3@>3EG4 >/3-H0'@ 3= '&?E>E&4-= 3'& E4*0/*&K E4 34K '&=>04K -0

*3'E06= ?3@>3EG4 @&==3G&=+

Link Tracking Data or “Link Tables” g $04-3E4 K3-3 4&&K&K -0 -'3?R /E4R= E4 3 ?3@>3EG4 @&==3G&+ )- 3@E4E@6@7 ?0/6@4= H0' 3 /E4R 43@& 34K 3 /E4R K&=-E43-E04 \MU 3'& '&c6E'&K H0' 6=& 0H 3 /E4R -3D/& E4 3?3@>3EG4+

)4 3??064- ?34 %3*& 34( 46@D&' 0H K3-3 =06'?&=7 D6- E- E= '&?0@@&4K&K -%3- 3 ?&4-'3/ ?04-3?- /E=- D& ?'&3-&K H0' 3

GE*&4 @3'R&-E4G 0DZ&?-E*&+ BK&3//(7 3 ?&4-'3/ /E=- E= ?'&3-&K 34K 6>K3-&K 6=E4G '&GE=-'3-E04 34K >'&H&'&4?& ?&4-&'3EG4+ A%E= ?&4-'3/ /E=- -3D/& ?34 -%&4 D& HE/-&'&K 0' c6&'E&K -0 G&4&'3-& ?3@>3EG4 KE=-'ED6-E04 /E=- =&G@&4-=

-%3- K'E*& E4KE*EK63/ ?3@>3EG4 36KE&4?& -3'G&-E4G+

26>>/&@&4-3/ K3-3 =06'?&= 3'& 0H-&4 6=&K -0 =-0'& K3-3 -%3- E= 40- 0'E&4-&K 3'064K -%& K&HE4E-E04 0H 3 /E=- '&?E>E&4-

EK&4-E-(7 D6- 6=&K E4=-&3K H0' =6>>/&@&4-E4G 3 /E=- &'=043/EO3-E04 -0 =-0'E4G ?3@>3EG4 '&?E>E&4- /&*&/ ?3@>3EG4 &*&4- '&?0'K=+


22/107

Documents


C%&4 =&*&'3/ -3D/&= 3'& 6=&K -0 '&>'&=&4- 3 @6/-EL-3D/& '&/3-E043/ @3'R&-E4G K3-3D3=& &' E4K&Y&= -0 >'&*&4- 64&'H0'@34?&

E@>3?-= 3==0?E3-&K 3EG4= 34K .0'@=+ A%&'& 3'& -&=0H K0?6@&4- 0DZ&?-Q jAaU 34K A&Y-+ ExampleQ )4 &@3E/ ?3@>3EG4 6=63//( ?04=E=-= 0H 34 jAaU 34K A&Y-

K0?6@&4- '&H&'&4?&+ A%& ?3@>3EG4 3?R3GE4G 0H jAaUL04/(7 A&Y-L04/(7 0' a6/-EL>3'- &@3E/=

36-0@3-E?3//( D3=&K 04 -%& '&?E>E&4- >'0HE/&+ T0?6@&4-= ?34 D& '&L6=&K 3?'0== @6/-E>/& ?3@>3EG4= 34K H0'@= 3=E&K7 &KE-&K7 34K K&/&-&K *E3 -%& B4-&'3?- $3@>3EG4 6=&' E4-&'H3?&+


23/107

General Steps


Interact API – Getting Started

A0 6=& -%E= G6EK&7 (06 =%06/K %3*& 3 D3=E? H3@E/E3'E-( '0*EK&K E4 -%E= =&?-E04+

General Steps

B4 G&4&'3/7 34( B4-&'3?- )FB ?/E&4- 3>>/E?3-E04 >'0Z&?- '0*EK& =6>>0'- H0' 3??0@>/E=%E4G -%E= =-&>+

_+ \=& -%& U0GE4 ?3// -0 &=-3D/E=% 3 =&==E04 /3?&K E4 -%& 2S)F %&3K&' 0H 3// =6D=&c6&4- B4-&'3?- )FB ?3//=+

`+ \=& -%& 3*3E/3D/& B4-&'3?- )FB ?3//= -0 3??0@>/E=% 3 K&=E'&K E4-&G'3-E04 0DZ&?-E*&+ BH (06' ?/E&4- 3>>/E?3-E04E= E43?-E*& H0' /04G&' -%34 -3?%& )YE=_ C2TU_^3*3 6-E/E-(7 3= K&=?'ED&K 04 -%& )>3?%& )YE=_ 3?%& )YE=_ 2-34K3'K TE=-'ED6-E04J

○ AXIS2_LIB = %AXIS2_HOME%\lib

○ AXIS2CLASSPATH =%AXIS2_LIB%\axis.jar;%AXIS2_LIB%\jaxrpc.jar;%AXIS2_LIB%\saaj.jar;%AXIS2_LIB%\commons-logging.jar;%AXIS2_LIB%\commons-discovery.jar;%AXIS2_LIB%\wsdl4j.jar

`+ B4 (06' ^3*3 3>>/E?3-E047 @3R& =6'& -%3- -%& G&4&'3-&K B4-&'3?- )FB =-6D ?/3==&= 3'& 3*3E/3D/& -0 (06' >'0Z&?- D6E/K >3-%+

http://ws.apache.org/axis2/1_3/userguide-creatingclients.htmlhttp://ws.apache.org/axis2/1_3/userguide-creatingclients.html


24/107

For Java Applications


8+ B@>0'- -%& H0//0&?EHE? ?/3==&= 4&&K&K H0' (06' ?/E&4-3>>/E?3-E04 ?3//=Q

import responsys.ws57.*;import responsys.ws57.client.*;import responsys.ws57.fault.*;

,+ B4=-34-E3-& 3 C&D =&'*E?& =-6D 0DZ&?-Q

ResponsysWS57Stub stub;stub = new ResponsysWS57Stub(endPointURL);

9+ a3E4-3E4 =&==E04 D&->'0>'E3-& =-3HH 34K -3R& H0//0 3?-E04 3= 4&&K&K+

;_+ U0G06- 0H -%& =&==E04 >/E?3-E04 -3=R= 3'& ?0@>/&-&+

;`+ 2?%&K6/& -%& ?/E&4- 3>>/E?3-E04 -0 '64 04 3 GE*&4 H'&c6&4?(+


25/107



ackage client.test;

import java.io.File;import java.rmi.RemoteException;

import org.apache.axis2.Constants;import javax.activation.DataHandler;import javax.activation.FileDataSource;import responsys.ws57.*;import responsys.ws57.client.*;

ublic class APITest {ResponsysWS57Stub service;SessionHeader sessionHeader; public static void main(String[] args) {

APITest runTest = new APITest();runTest.sampleCode();

} private void sampleCode() {

try {service = new ResponsysWS57Stub("...WS URL...");Login login = new Login();login.setUsername("XXXXX");login.setPassword("YYYYY");LoginResponse response = service.login(login);String sessionId = response.getResult().getSessionId();System.out.println("Login session token: " + sessionId);if (sessionId != null) {

sessionHeader = new SessionHeader();sessionHeader.setSessionId(sessionId);

// Set timeout that is appropriate for the maximum expected duration of APIcalls (2 minutes)

service._getServiceClient().getOptions().setManageSession( true);service._getServiceClient().getOptions().setTimeOutInMilliSeconds(

1000 * 60 * 2);// MTOM code to support SOAP calls involving delimited text file uploads

service._getServiceClient().getOptions().setProperty(Constants.Configuration. ENABLE_MTOM ,Constants.VALUE_TRUE );

service._getServiceClient().getOptions().setProperty(Constants.Configuration. CACHE_ATTACHMENTS ,Constants.VALUE_TRUE );

service._getServiceClient().getOptions().setProperty(Constants.Configuration. FILE_SIZE_THRESHOLD ,"4000");

// List folders exampleListFolders listFolders = new ListFolders();ListFoldersResponse listFoldersResponse = service.listFolders(listFolders,

sessionHeader);String[] folders = listFoldersResponse.getResult();if (folders != null) {

for (String folder : folders) {System.out.println("Folder Name = " + folder);

}}

// Update table example


26/107



FieldMap[] fieldMap = new FieldMap[3];fieldMap[0] = new FieldMap();fieldMap[0].setColumnNameInFile("CUSTOMER_ID");fieldMap[0].setColumnNameInTable("CUSTOMER_ID");

fieldMap[0].setOverrideIfNull(true);fieldMap[1] = new FieldMap();fieldMap[1].setColumnNameInFile("EMAIL_ADDRESS");fieldMap[1].setColumnNameInTable("EMAIL_ADDRESS");fieldMap[1].setOverrideIfNull(true);fieldMap[2] = new FieldMap();fieldMap[2].setColumnNameInFile("FIRSTNAME");fieldMap[2].setColumnNameInTable("FIRSTNAME");fieldMap[2].setOverrideIfNull(true);Field[] fields = new Field[3];fields[0] = new Field();fields[0].setFieldName("CUSTOMER_ID");fields[0].setFieldType(FieldType.INTEGER);fields[1] = new Field();fields[1].setFieldName("EMAIL_ADDRESS");fields[1].setFieldType(FieldType.STR255);fields[2] = new Field();fields[2].setFieldName("FIRSTNAME");fields[2].setFieldType(FieldType.STR50);DataSourceProperties properties = new DataSourceProperties();properties.setFields(fields);properties.setDelimitedBy("COMMA");properties.setEnclosedBy("DOUBLE_QUOTE");properties.setCharacterEncoding(CharacterEncoding. ISO_8859_1);properties.setFolderName("Whats_New_In_5-10");

properties.setTableName("Customer_List");properties.setCsvFileName("C:\\API_TEST\\data\\retail_list.csv");File fileObj = new File("C:\\API_Test\\data\\retail_list.csv");FileDataSource fds = new FileDataSource(fileObj);DataHandler dataHandler = new DataHandler(fds);properties.setCsvFileData(dataHandler);UpdateDataSource updateDataSource = new UpdateDataSource();updateDataSource.setProperties(properties);updateDataSource.setMapping(fieldMap);updateDataSource.setMatchColumnName("CUSTOMER_ID");System.out.println("Starting table update");UpdateDataSourceResponse updateDataSourceResponse =

service.updateDataSource(updateDataSource, sessionHeader);

RecordCount dataSrcResult = null;IntermediateResult irws = null;CheckResult checkResult = new CheckResult(); while (true) {

dataSrcResult = updateDataSourceResponse.getResult();checkResult.setIntermediateResultKey(dataSrcResult.getKey());irws = service.checkResult(checkResult, sessionHeader).getResult();if (irws.getFinished()) {

if (irws.getComplete()) {System.out.println("Record Count: " + ((RecordCount) irws).getCount());

break;}

}// wait for 10 minutes before next check System.out.println("Sleep for bit ...");

Thread.sleep(10*60000);}

System.out.println("Completed table update");


27/107


28/107

For C# Applications


For C# Applications

;+ T0>/E?3-E04 ?0K&7 G&- 3 %34K/& H0' -%& C&D 2&'*E?&7 34K &4=6'& -%& 6=&' =&==E04 /& &Y3@>/& E= >'0*EK&K D&/0E/&' -0 ?'&3-& 34 &Y&?6-3D/& 43@&K HE/&]3@&+&Y&7


29/107

For C# Applications


namespace WSCSharpClient {

using System;using System.Net;using System.IO;

using System.Xml;using System.Web.Services.Protocols;

class TestResponsysWS {ResponsysWSService stub;bool loggedIn = false;

SessionHeader sessionHeader;try {

string url = "... WS Endpoint URL ...";string username = "user";string password = "password";

stub = new ResponsysWSService();stub.CookieContainer = new CookieContainer();

stub.Url = url;// Call the login methodLoginResult loginResult = stub.login(username, password);string sessionId = loginResult.sessionId;if (sessionId != null) {

// Create the sessionHeader object and set it to the stub.

// The sessionHeader is passed to every other API call after the login. sessionHeader = new SessionHeader();sessionHeader.sessionId = sessionId;

stub.SessionHeaderValue = sessionHeader;// Caution: It is important to set a sessionHeader object to the stub as it is used in all the subsequent

calls.

stub.Timeout = 1000 * 60 * 2;// Caution: It is important to set a timeout that is appropriate for the maximum expected duration of API

calls. loggedIn = true;

}} catch (System.Web.Services.Protocols.SoapException e) {

Console.WriteLine("SoapException in login : " + e.Message);Console.WriteLine("SoapException in login : " + e.Detail.InnerText);

} catch (Exception e) {

Console.WriteLine("Exception in login : " + e.Message);}

}

}


30/107

Login


Interact API Calls

Session Management API Calls

Login

Syntax

D00/&34 q =&'*E?&+/0GE4I=-'E4G 6=&'43@&7 =-'E4G >3== H0' 34( ?/E&4- 3>>/E?3-E04 E= -0 &=-3D/E=% 3 /0GE4 =&==E04+ A%E= ?34 D& 3?%E&*&K 6=E4G -%& login ?3//+

C%&4 3 ?/E&4- 3>>/E?3-E04 E4*0R&= -%& login ?3//7 E- >3==&= 3 6=&'43@& 34K >3==>/E?3-E04 /0GE4 '&c6&=-7 -%& B4-&'3?- )FB 36-%&4-E?3-&= -%&=& ?'&K&4-E3/=7 34K '&-6'4= 3

LoginResult 0DZ&?-+ A%E= 0DZ&?- ?34 D& E4=>&?-&K -0 '&-'E&*& 3 =&==E04 -0R&4 -%3- E= '&c6E'&K H0' 6=& E4 3//=6D=&c6&4- )FB ?3//=+ )H-&' =6??&==H6//( ?0@>/&-E4G -%& login ?3// 34K '&-'E&*E4G -%& =&==E04 -0R&47 3 ?/E&4-

3>>/E?3-E04 4&&K= -0 =&- -%E= =&==E04 -0R&4 E4 -%& 2S)F %&3K&' H0' =6D=&c6&4- ?3//= 3= 3 @&34= 0H 36-%&4-E?3-E04+

2&==E04 -0R&4= &Y>E'& 36-0@3-E?3//( 3H-&' -/E?E- /0G06- ?3//= -0 prevent the accumulation of unnecessary open sessions+ ) /E@E- E=

>/3?&K 04 -%& 46@D&' 0H ?04?6''&4- )FB =&==E04= -%3- 34 3??064- ?34 E4E-E3-&+ B- E= E@>0'-34- -0 >'0>&'/( @343G&

)FB =&==E04= -0 3*0EK &Y?&&KE4G -%E= /E@E-+ BH -%& /E@E- E= '&3?%&K7 34 &''0' @&==3G& 04=& H'0@ -%& /0GE4 ?3//+ A%E=?00RE& @6=- D& >&'=E=-&K H0' 6=& E4 =6D=&c6&4- )FB ?3//= E4 -%& =&==E04+

Important

BH (06 3'& 6=E4G &E-%&' )YE=_7 $b 0' 34( 0-%&' +]&- /34G63G&7 -%& ^2e22BS]BT E= 36-0@3-E?3//( ?3>-6'&K 34K =&4-

E4 =6D=&c6&4- '&c6&=-=+ j0-6'& -%& ^2e22BS]BT

34K F3-% H'0@ -%& /0GE4 '&=>04=& jAAF j&3K&'= 34K =&- -%&@ E4 3 ?00RE& E4 -%& jAAF %&3K&'= 0H 3// =6D=&c6&4-'&c6&=-= 64-E/ (06 /0G 06-+ A%E= '&*&4- &''0'=+

Example:

HTTP/1.1 200 OK

Date: Tue, 16 Nov 2010 14:52:14 GMT

Set-Cookie: JSESSIONID=C1DC1654EE6BBEEBE94043EE4D006F59.tmws2; Path=/tmws

Content-Type: text/xml;charset=UTF-8

Connection: close


31/107

Login


Transfer-Encoding: chunked

Request Arguments

Name Type Description

6=&'43@& =-'E4G \=&' 43@& H0' -%& M&=>04=(= B4-&'3?- 3??064-+

>3==&'-(Q


'&=6/- =-'E4G 2&==E04 BT 3==0?E3-&K


32/107

Logout


Logout

Syntax

D00/&34 q =&'*E?&+/0G06-IJ

Usage

\=& -%& logout ?3// -0 &4K 34 )FB =&==E04+ A%& /3=- =-&> H0' 34( ?/E&4- 3>>/E?3-E04 E= -0 &4K 3 =&==E04 D( /0GGE4G 06-+

]0-& -%3- =&==E04=


33/107

Logout


Example SOAP Request

-220b6206:11be22bbe11:-7ff3

Example SOAP Response

true


34/107

GetServerTimestamp


GetServerTimestamp

Syntax

K3-&AE@& q =&'*E?&+G&-2&'*&'AE@&=-3@> IJ

Usage

\=& -%& getServerTimestamp ?3// -0 '&-6'4 -%& ?6''&4- -E@&=-3@> H'0@ -%& B4-&'3?- >/3-H0'@+ A%E= ?34 D& 6=&K H0'

?/E&4- 3>>/E?3-E04= -%3- @343G& =(4?%'04EO3-E04 0H K3-3+ M3-%&' -%34 3 -0-3/ '&>/E?3-E04 0H K3-37 -%& -E@&=-3@> ?34 D& 6=&K E4 -34K&@ = H0' K3-3 '&?0'K= -0 04/( >'0?&== '&?0'K= -%3- %3*& ?%34G& =E4?&

-%& /3=- =(4?%'04EO3-E04 '64+

Request Arguments

]04&

Response


'&=6/- K3-&-E@& $6''&4- K3-& 34K -E@& 0H -%& B4-&'3?- >/3-H0'@+

CreateFolder


35/107

CreateFolder


Folder Management API Calls

CreateFolder

Syntax

D00/&34 q =&'*E?&+?'&3-&.0/K&'I=-'E4G H0/K&']3@&J

Usage

\=& -%& createFolder ?3// -0 ?'&3-& 3 4&< &@>-( H0/K&' E4 34 B4-&'3?- 3??064-+ A%E= ?3// '&-6'4= 3 D00/&34 *3/6& -%3-E4KE?3-&= -%& =6??&== 0H -%& H0/K&' ?'&3-E04 '&c6&=-+

Request Arguments


H0/K&']3@& =-'E4G ]&< H0/K&' 43@& -0 D& ?'&3-&K+

Response


'&=6/- D00/&34 26??&== H/3G H0' ?'&3-E04 0H H0/K&'+

CreateFolder


36/107

CreateFolder



-220b6206:11be22bbe11:-7f83

test folder


true

DeleteFolder


37/107

DeleteFolder


DeleteFolder

Syntax

D00/&34 q =&'*E?&+K&/&-&.0/K&'I=-'E4G H0/K&']3@&J

Usage

\=& -%& deleteFolder ?3// -0 K&/&-& 3 H0/K&' 34K E-= ?04-&4-= H'0@ 34 B4-&'3?- 3??064-+

Request Arguments


H0/K&']3@& =-'E4G ]3@& 0H H0/K&' -0 K&/&-&+

Response


'&=6/- D00/&34 26??&== H/3G H0' K&/&-E04 0H H0/K&'+

DeleteFolder


38/107



-220b6206:11be22bbe11:-7f83

test folder


true

ListFolders


39/107


ListFolders

Syntax

2-'E4Grs q =&'*E?&+/E=-.0/K&'=IJ

Usage

\=& -%& listFolders ?3// -0 '&-'E&*& 3 /E=-E4G 0H 3// 0H -%& H0/K&'= E4 34 3??064-+

Request Arguments

]04&

Response


'&=6/- =-'E4Grs .0/K&' 43@&= E4 3??064-+

ListFolders


40/107



-220b6206:11be22bbe11:-7f83


Demo_DynamicContentExample CampaignsMarguerite FolderNew_Built-in_Tests

ProfileDataProfileFormsReporting ExamplesTemplate ContentTriggered_Message_Campaigns~System

ListFolderContents


41/107


ListFolderContents

Syntax

2-'E4Grs q =&'*E?&+/E=-.0/K&'$04-&4-=I=-'E4G H0/K&']3@&7 .0/K&'$04-&4-A(>& ?04-&4-A(>&J

Usage

A%& listFolderContents ?3// '&-6'4= 3 =-'E4G 3''3( ?04-3E4E4G -%& 43@&= 0H 0DZ&?-= ?04-3E4&K E4 3 =>&?EHE&K B4-&'3?-

H0/K&'+

Request Arguments


H0/K&']3@& =-'E4G ]3@& 0H H0/K&'+ ]0-& -%3- H0/K&' 43@&= 3'& ?3=& =&4=E-E*&+

?04-&4-A(>& .0/K&'$04-&4-A(>& $04-&4- -(>& '&=-'E?-E04Q T)A)7 $)aF)BX]7 TS$\ae]A7MeFSMA7 M\Ue7 )UUfAPFe2

Response


'&=6/- =-'E4Grs ]3@&= 0H 0DZ&?-= E4 =>&?EHE&K H0/K&'+

ListFolderContents


42/107



-220b6206:11be22bbe11:-7f83

ProfileDataDATA


Customer_ListMaster_Seed_ListMaster_Test_ListMen Purchased 4x or moreNo Purchases Last 90 DaysPurchase Segment Example with SQLSupplementalExample

ListFolderObjects


43/107


ListFolderObjects

Syntax

.0/K&'SDZ&?-rs q =&'*E?&+/E=-.0/K&'SDZ&?-=I=-'E4G H0/K&']3@&7 .E/-&'SDZ&?-A(>& -(>&J

Usage

A%& listFolderObjects ?3// '&-6'4= E4H0'@3-E04 3D06- 0DZ&?-= ?04-3E4&K E4 3 =>&?EHE&K B4-&'3?- H0/K&'+ B4 ?04-'3=- -0-%& listFolderContents ?3//7 -%E= ?3// >'0*EK&= -(>& E4H0'@3-E04 3D06- &3?% 0DZ&?- E4 3 H0/K&'+

Request Arguments


H0/K&']3@& 2-'E4G ]3@& 0H H0/K&'+ ]0-& -%3- H0/K&' 43@&= 3'& ?3=& =&4=E-E*&+

-(>& .E/-&'SDZ&?-A(>& $04-&4- -(>& '&=-'E?-E04Q

)UUfAPFe2 7 $)aF)BX] 7 .SMa 7 TS$\ae]A 7 T)A) 7

2eXae]A 7 TP])aB$f$S]Ae]A 7 )AA)$jae]A 7

M\Ue2 7 MeFSMA

Response


'&=6/- .0/K&'SDZ&?-rs )''3( 0H 0DZ&?-= ?04-3E4E4G >'0>&'-E&= H0' -%& 43@& 34K -(>& 0H &*&'(0DZ&?- E4 -%& H0/K&'+

ListFolderObjects

E l SOAP R t


44/107



-5d14b63f:11f213c33b2:-7fdf

Reporting ExamplesALL_TYPES

ListFolderObjects



45/107



Summer Styles-DynamicPROMOTIONAL_CAMPAIGN

Summer Styles-Generic ContentPROMOTIONAL_CAMPAIGN

Summer Styles-UntargetedPROMOTIONAL_CAMPAIGN

testtriggerTRANSACTIONAL_REAL_TIME_CAMPAIGN

Summer Styles-Dynamic_Message.htmHTML_DOCUMENT

Summer Styles-Generic Content_Message.htmHTML_DOCUMENT

Summer Styles-Untargeted_Message.htm

HTML_DOCUMENT

Summer Styles-Dynamic_LinkTableDATA_TABLE

Summer Styles-Generic Content_LinkTableDATA_TABLE

Summer Styles-Untargeted_LinkTableDATA_TABLE

Gender-Purchase_SegmentationSEGMENT_GROUP

ImportFolder


46/107


ImportFolder

Syntax

.0/K&'B@>0'- q =&'*E?&+E@>0'-.0/K&'I=-'E4G OE>.E/&]3@&7 D3=&985E43'( OE>5E43'(T3-3J

Usage

A%& importFolder ?3// E@>0'-= 3 >'&*E06=/( &Y>0'-&K B4-&'3?- $3@>3EG4 H0/K&' 3'?%E*& HE/& E4-0 34 3??064-+ A%&

importFolder ?3// E= 34 3=(4?%'0406= ?3// -%3- E4E-E3-&= 3 H0/K&' E@>0'-+ T&>&4KE4G 04 -%& =EO& 0H -%& H0/K&' D&E4GE@>0'-&K7 -%& ?3// @3( 40- D& HE4E=%&K H0' -%& '&=>04=& -0 -%& E4E-E3/ '&c6&=-+ BH -%E= E= -%& ?3=&7 -%& =-3-6= 0H -%&

H0/K&' E@>0'- ?34 D& ?%&?R&K D( 6=E4G -%& checkReult ?3// 34K -%& R&( -%3- E= '&-6'4&K .E/&]3@& =-'E4G F3-% 34K 43@& 0H H0/K&' 3'?%E*& HE/& -0 D& E@>0'-&K+

OE>5E43'(T3-3 D3=&985E43'( 5E43'( '&>'&=&4-3-E04 0H H0/K&' 3'?%E*& HE/& -0 D& E@>0'-&K+

Response

A%E= ?3// '&-6'4= 3 .0/K&'B@>0'- 0DZ&?-7 &'3-E04 D( 6=E4G -%& checkResult B4-&'3?- )FB ?3//+

?0@>/&-& D00/&34 ./3G E4KE?3-E4G &'3-E04 /&-&K =6??&==H6//(

0' 40-+ A%E= H/3G =%06/K 04/( D& ?%&?R&K 04?& -%& .E4E=%&K H/3G E= -'6&+

?34?&//&K D00/&34 ./3G E4KE?3-E4G &'3-E04 &'3-E04 E= HE4E=%&K '644E4G+

@&==3G& =-'E4G a&==3G& -%3- ?34 D& 6=&K -0 -'06D/&=%00- &Y?&>-E04= -%3- @3( 0??6'+

H0/K&']3@& =-'E4G ]3@& 0H -%& H0/K&' ?'&3-&K E4 -%& B4-&'3?- 3??064-+

ImportFolder


47/107



ExampleFolderExport.zipUEsDBBQAC... (truncated)

Note that the zipBinaryData input has been truncated for presentation purposes.


truefalsetrueirkey1128Example Folder Import

ExportFolder


48/107


ExportFolder

Syntax

D3=&985E43'( q =&'*E?&+&Y>0'-.0/K&'I=-'E4G H0/K&']3@&7 =-'E4G OE>.E/&]3@&J

Usage

A%& exportFolder ?3// '&-6'4= -%& ?04-&4-= 0H 3 HE/& E4 34 3'?%E*& HE/& H0'@3-+

Request Arguments


H0/K&']3@& =-'E4G ]3@& 0H B4-&'3?- $3@>3EG4 H0/K&' -0 &Y>0'-+

OE>.E/&]3@& =-'E4G F3-% 34K 43@& H0' -%& H0/K&' 3'?%E*& HE/& D&E4G &Y>0'-&K+

Response


'&=6/- D3=&985E43'( .0/K&' 3'?%E*& HE/&

ExportFolder


49/107



Triggered Message TestsC:\ExampleFolderExport.zip


UEsDBBQ...

Note that the exportFolderReturn has been truncated for presentation purposes.

CreateDataSource


50/107


Data Management API Calls

CreateDataSource

Syntax

M&?0'K$064- q =&'*E?&+?'&3-&T3-3206'?&IT3-3206'?&F'0>&'-E&= >'0>&'-E&=J

Usage

A%& createDataSource ?3// E= 6=&K -0 ?'&3-& 3 -3D/& E4 34 B4-&'3?- $3@>3EG4 3??064- D( 6>/03KE4G K3-3 H'0@ 3 /0?3/K&/E@E-&K -&Y- HE/&+ A%& createDataSource ?3// E= 34 3=(4?%'0406= ?3// -%3- E4E-E3-&= -%& -3D/& ?'&3-E04 34K E= /ER&/(

-0 40- D& HE4E=%&K H0' -%& '&=>04=& -0 -%& E4E-E3/ ?'&3-& '&c6&=-+ )= 3 '&=6/-7 -%& =-3-6= 0H -%& 0>&'3-E04 ?34 D&

?%&?R&K D( 6=E4G -%& checkReult ?3// 34K -%& R&( -%3- E= '&-6'4&K /&-E04 0H -%& 0>&'3-E04 =%06/K D& K04& 04 -%& 0'K&' 0H &*&'( ,L;" @E46-&=+ For best peformance, it ishighly recommended that data files be compressed (Zip compression) prior to upload with this API call.

B4?0@E4G -E@&=-3@> K3-3 =%06/K D& E4 -%& H0'@3- 0H PPPPWaaWTT jj_8QaBQ22 0' PPPPLaaLTT

jj_8QaBQ22 -E043/+

Request Arguments

A%& E4>6- -0 -%E= ?3// E= 3 T3-3206'?&F'0>&'-E&= 0DZ&?-7 -E043/ *3/6& H0' 3 ?6=-0@ HE&/K K&/E@E-&'+

&4?/0=&K5( =-'E4G A(>& 0H &4?/0=E4G ?%3'3?-&' H0' 3 HE&/K E4 3 HE/& '0&'-E&=Q%-@/.E&/K]3@&7 %-@/m3/6& 7 34K -&Y-m3/6&+

K3-3eY-'3?-E04i&( =-'E4G T&HE4&= K3-3 &Y-'3?-E04 R&( H0' -%& 4&< -3D/&+ ) ?0@>0=E-& K3-3

&Y-'3?-E04 R&( =%06/K D& K&/E@E-&K /03K&K+

?=*.E/&]3@& =-'E4G ]3@& 0H -%& /0?3/ K&/E@E-&K -&Y- HE/& -0 D& 6>/03K&K+

H0/K&']3@& =-'E4G ]3@& 0H -%& H0/K&'


51/107


A%E= ?3// '&-6'4= 3 M&?0'K$064- 0DZ&?-7 &'3-E04 D( 6=E4G -%& checkResult B4-&'3?- )FB ?3//+

?0@>/&-& D00/&34 ./3G E4KE?3-E4G &'3-E04 /&-&K=6??&==H6//( 0' 40-+ A%E= H/3G =%06/K 04/( D& ?%&?R&K 04?& -%& .E4E=%&K

H/3G E= -'6&+

?34?&//&K D00/&34 ./3G E4KE?3-E4G &'3-E04 -E04= -%3- @3( 0??6'+

?064- E4- S4?& -%& -3D/& ?'&3-E04 E= ?0@>/&-&K =6??&==H6//(7 3 *3/EK ?064-


52/107


p

Syntax

M&?0'K$064- q =&'*E?&+6>K3-&T3-3206'?&IT3-3206'?&F'0>&'-E&= >'0>&'-E&=7 .E&/Ka3>rs @3>>E4G7 =-'E4G

@3-?%$0/6@4]3@&J

Usage

A%& updateDataSource ?3// E= 6=&K -0 @&'G& K3-3 IE4=&'-W6>K3-& '&?0'K=J E4 34 &YE=-E4G -3D/& D( 6>/03KE4G K3-3H'0@ 3 /0?3/ K&/E@E-&K -&Y- HE/&+ A%E= E= 34 3=(4?%'0406= )FB ?3// -%3- E4E-E3-&= -%& -3D/& 6>K3-& 34K E= /ER&/( -0 40-

D& HE4E=%&K H0' -%& '&=>04=& -0 -%& E4E-E3/ 6>K3-& '&c6&=-+ )= 3 '&=6/-7 -%& =-3-6= 0H -%& 0>&'3-E04 ?34 D& ?%&?R&K D(6=E4G -%& checkReult ?3// 34K -%& R&( -%3- E= '&-6'4&K 0'-E04 E= 0>-E043/+

Request Arguments


>'0>&'-E&= T3-3206'?&F'0>&'-E&= F'0>&'-E&= 0H -%& K3-3 D&E4G 6>/03K&K H0' -%& 6>K3-& 0>&'3-E04+

@3>>E4G .E&/Ka3>rs .E&/Ka3> 3''3( &'3-E04=%06/K 0*&'K3-&K D3=&K 04 &'-E&=Q


R&( =-'E4G ) R&( -%3- 3//0>/E?3-E04 -0 ?%&?R -%& =-3-6= 0H -%& 0>&'3-E04

D( 6=E4G -%& checkResult B4-&'3?- )FB ?3//+

?0@>/&-& D00/&34 ./3G E4KE?3-E4G &'3-E04 E= ?0@>/&-&K =6??&==H6//(7 3 *3/EK ?064-


53/107


Syntax

M&?0'K$064- q =&'*E?&+6>K3-&T3-3206'?&\=E4Ga6/-E>/&$0/6@4=IT3-3206'?&F'0>&'-E&= >'0>&'-E&=7 .E&/Ka3>rs

@3>>E4G7 =-'E4Grs @3-?%$0/6@4]3@&=J

Usage

A%& updateDataSourceUsingMultipleColumns ?3// E= 6=&K -0 @&'G& K3-3 IE4=&'-W6>K3-& '&?0'K=J E4 34 &YE=-E4G-3D/& D( 6>/03KE4G K3-3 H'0@ 3 /0?3/ K&/E@E-&K -&Y- HE/& 34K @3-?%E4G &YE=-E4G '&?0'K= D3=&K 04 3 @6/-EL?0/6@4

I-%3- E= 3 o?0@>0=E-&pJ @3-?%+ A%E= ?3// E= EK&4-E?3/ -0 -%& updateDataSource ?3// &Y?&>- -%3- E- E= E4-&4K&K H0'=E-63-E04= K3-& 0>&'3-E04

?34 D& ?%&?R&K D( 6=E4G -%& checkReult ?3// 34K -%& R&( -%3- E= '&-6'4&K 0'-E04 E= 0>-E043/+

Request Arguments


>'0>&'-E&= T3-3206'?&F'0>&'-E&= F'0>&'-E&= 0H K3-3 D&E4G 6>/03K&K H0' 6>K3-& 0>&'3-E04+

@3>>E4G .E&/Ka3>rs .E&/Ka3> 3''3( &'3-E04 =%06/K

0*&'K3-&K D3=&K 04 /&-& D00/&34 ./3G E4KE?3-E4G


54/107

CopyDataSource

CopyDataSource


55/107


py

Syntax

B4-&'@&KE3-&M&=6/- q =&'*E?&+?0>(T3-3206'?&I=-'E4G ='?.0/K&']3@&7 =-'E4G ='?T3-3206'?&]3@&7 =-'E4G

K=-.0/K&'43@&7 =-'E4G K=-T3-3206'?&43@&7 D00/&34 '&?0'K$0>(7 D00/&34 0*&'(0>&'3-E04 -%3- '&-6'4= 34 B4-&'@&KE3-&M&=6/- 0DZ&?- -%3- ?34 D& 6=&K (+

='?T3-3206'?&]3@& =-'E4G ]3@& 0H K3-3 =06'?& -0 D& ?0>E&K+K=-.0/K&']3@& =-'E4G ]3@& 0H H0/K&' E4 /3?& -%& 4&< ?0>(+

K=-T3-3206'?&]3@& =-'E4G ]3@& 0H 4&< K3-3 =06'?&+

'&?0'K$0>( D00/&34 ./3G -%3- KE?-3-&= 04=& E= 34 B4-&'@&KE3-&M&=6/- -%3- ?04-3E4= -%& H0//0'0>&'-E&=Q


R&( =-'E4G i&( -%3- 3//0>/E?3-E04 -0 ?%&?R -%& =-3-6= 0H -%& 0>&'3-E04 D(6=E4G -%& checkResult B4-&'3?- )FB ?3//+

?0@>/&-& D00/&34 ./3G E4KE?3-E4G


56/107


Syntax

B4-&'@&KE3-&M&=6/- q =&'*E?&+?0>(T3-3206'?&A0A3D/&I=-'E4G ='?.0/K&']3@&7 =-'E4G ='?T3-3206'?&]3@&7 =-'E4G

K=-.0/K&'43@&7 =-'E4G K=-T3-3206'?&43@&7 D00/&34 '&?0'K$0>(7 D00/&34 0*&'&'3-E04 E= ?0@>/&-&+

Request Arguments


='?.0/K&']3@& =-'E4G ]3@& 0H H0/K&' ?04-3E4E4G -%& K3-3 =06'?& -0 ?0>(+

='?T3-3206'?&]3@& =-'E4G ]3@& 0H 3 2[U7 .E/-&'7 0' ^0E4 K3-3 -0 D& ?0>E&K E4-0 3 4&< -3D/&

K=-.0/K&']3@& =-'E4G ]3@& 0H H0/K&' E4 /3?& -%& 4&< ?0>(+

K=-T3-3206'?&]3@& =-'E4G ]3@& 0H -%& 4&< -3D6/3' K3-3 =06'?&+

'&?0'K$0>( D00/&34 ./3G -%3- KE?-3-&= 04=& E= 34 B4-&'@&KE3-&M&=6/- -%3- ?04-3E4= -%& H0//0'0>&'-E&=Q


R&( =-'E4G i&( -%3- 3//0>/E?3-E04 -0 ?%&?R -%& =-3-6= 0H -%& 0>&'3-E04 D(

6=E4G -%& checkResult B4-&'3?- )FB ?3//+

?0@>/&-& D00/&34 ./3G E4KE?3-E4G


57/107


Syntax

D00/&34 ?'&3-&2[UT3-3206'?&M&-6'4 q =&'*E?&+?'&3-&2[UmE&04=(= 26>>0'- -&3@+

Request Arguments


H0/K&']3@& =-'E4G ]3@& 0H H0/K&' H0' -%& 4&< 2[U K3-3 =06'?&+

=c/T3-3206'?&]3@& =-'E4G ]3@& 0H 4&< 2[U K3-3 =06'?&+

D3=&.0/K&'= =-'E4Grs )''3( 0H H0/K&' 43@&=+

D3=&T3-3206'?&= =-'E4Grs )''3( 0H K3-3 =06'?& 43@&= H0' 6=& E4 -%& 2[U+

=c/[6&'( =-'E4G A%& 2[U -0 D& 6=&K H0' -%& K3-3 =06'?& *E&<

&@3E/)KK'&==.E&/K =-'E4G ]3@& 0H HE&/K -%3-


58/107


Syntax

D00/&34 q =&'*E?&+K&/&-&T3-3206'?&I=-'E4G H0/K&']3@&7 =-'E4G K3-3206'?&]3@&J

Usage

A%& deleteDataSource ?3// E= 6=&K -0 '&@0*& K3-3 =06'?&= H'0@ 34 B4-&'3?- 3??064-+

Request Arguments


H0/K&']3@& =-'E4G .0/K&' 0H K3-3 =06'?&+

K3-3206'?&]3@& =-'E4G ]3@& 0H K3-3 =06'?& -0 K&/&-&+

Response


K&/&-&T3-3206'?&M&-6'4 D00/&34 ./3G E4KE?3-E4G =6??&== 0H K&/&-E04 '&c6&=-+

TruncateTable

TruncateTable


59/107


Syntax

D00/&34 q =&'*E?&+-'64?3-&A3D/&I=-E4G H0/K&']3@&7 =-'E4G -3D/&]3@&J

Usage

A%& truncateTable ?3// E= 6=&K -0 '&@0*& 3// -%& '&?0'K= H'0@ 3 -3D/&+

Request Arguments


H0/K&']3@& =-'E4G ]3@& 0H H0/K&' ?04-3E4E4G -3D/& -0 -'64?3-&+

-3D/&]3@& =-'E4G ]3@& 0H -3D/& -0 -'64?3-&++

Response


'&=6/- D00/&34 26??&== H/3G H0' ?'&3-E04 0H H0/K&'+

DownloadDataSourceByTimestamp

DownloadDataSourceByTimestamp


60/107


Syntax

D3=&985E43'( q =&'*E?&+K06- HE/&+

Request Arguments


H0/K&']3@& =-'E4G .0/K&' 0H K3-3 =06'?&

K3-3206'?&]3@& =-'E4G ]3@& 0H K3-3 =06'?&

-E@&=-3@>.E&/K]3@& =-'E4G S>-E043/ 43@& H0' HE/-&'E4G -%& K0 HE&/K -%3- E= >'&=&4- E4 -%& K3-3 =06'?&

-E@&=-3@>.E&/K)H-&'m3/6& K3-&-E@& AE@&=-3@> *3/6& H0' E4?/6KE4G 04/( K3-3 '&?0'K= *3/6& 0?6''E4G 3H-&' -%E= E4>6- -E@&=-3@>+

-E@&=-3@>.E&/K5&H0'&m3/6& K3-&-E@& AE@&=-3@> *3/6& H0' E4?/6KE4G 04/( K3-3 '&?0'K= *3/6& 0?6''E4G D&H0'& -%E= E4>6- -E@&=-3@>+

\=& D0-% E4>6- 3'G6@&4-= -0 '&=-'E?- -%& K0 ?0@>'&==&K H0'@3-+

Highly recommended for large data downloads. K0


61/107


Response


K0'&=&4-3-E04 0H K3-3 K0'&==&K K&/E@E-&K -&Y- HE/&+ ) @0'& H/&YED/& K004=& D3=&985E43'( 5E43'( '&>'&=&4-3-E04 0H K3-3 K0


62/107


Syntax

M&?0'K$064- q =&'*E?&+>6'G&T3-3206'?&5(AE@&=-3@>IJ

Usage

A%& purgeDataSourceByTimestamp ?3// 3//06'G& 34K 3'?%E*& 3>>/E?3-E04= .E&/K]3@& =-'E4G S>-E043/ 43@& H0' >6'GE4G -%& K3-3 D( 3 -E@&=-3@> HE&/K -%3- E= >'&=&4- E4 -%& K3-3 =06'?&

-E@&=-3@>.E&/K)H-&'m3/6& K3-&-E@& AE@&=-3@> *3/6& H0' >6'GE4G 04/( K3-3 '&?0'K=

*3/6& 0?6''E4G 3H-&' -%E= E4>6- -E@&=-3@>+

-E@&=-3@>.E&/K5&H0'&m3/6& K3-&-E@& AE@&=-3@> *3/6& H0' >6'GE4G 04/( K3-3 '&?0'K=

*3/6& 0?6''E4G D&H0'& -%E= E4>6- -E@&=-3@>+

&c63/=.E&/K]3@& =-'E4G S>-E043/ 43@& H0' >6'GE4G -%& K3-3 D( 34 &c63/E-( ?0@>3'E=04 H0'3 HE&/K -%3- E= >'&=&4- E4 -%& K3-3 =06'?& IE& SFAB] q t]tJ

&c63/=.E&/Km3/6& =-'E4G m3/6& 0H -%& HE&/K -%3- 6'G&K+

Response

A%E= ?3// '&-6'4= 3 M&?0'K$064- 0DZ&?-7 &'3-E04 /&-&K =6??&==H6//( 0' 40-+A%E= H/3G =%06/K 04/( D& ?%&?R&K 04?& -%& .E4E=%&K H/3G E= -'6&+

?34?&//&K D00/&34 ./3G E4KE?3-E4G &'3-E04 E= ?0@>/&-&K =6??&==H6//(7 3 *3/EK ?064-


63/107


Syntax

M&?0'K$064- q =&'*E?&+>6'G&T3-3206'?&IF6'G&T3-3206'?&F'0>&'-E&= >'0>&'-E&=7 .E&/Ka3>rs @3-?%$0/6@4a3>J

Usage

A%& purgeDataSource ?3// E= 6=&K -0 >6'G& K3-3 '&?0'K= H'0@ 34 &YE=-E4G -3D/&+ A%& '&?0'K= -0 D& K&/&-&K 3'&

=>&?EHE&K D( 6>/03KE4G 3 /0?3/ K&/E@E-&K -&Y- HE/& 34K =>&?EH(E4G 3 @3>>E4G H0' @3-?%E4G 6> -0 -%'&& E4?0@E4GHE&/K= 3'- 0H -%E= 0>&'3-E04+ A%E= E= 34 3=(4?%'0406= )FB ?3// -%3- E4E-E3-&= -%& -3D/& >6'G& 34K E= 64/ER&/( -0?0@>/&-& E@@&KE3-&/(+ )= 3 '&=6/-7 -%& =-3-6= 0H -%& 0>&'3-E04 ?34 D& ?%&?R&K D( 6=E4G -%& checkReult ?3// 34K -%&R&( -%3- E= '&-6'4&K /&-E04 0H -%& 0>&'3-E04 =%06/K D&

K04& 04 -%& 0'K&' 0H &*&'( ,L;" @E46-&=+ For best peformance, it is highly recommended that data files be

compressed (Zip compression) prior to upload with this API call.

]0-& -%3- -%& 3==6@>-E04 6'G& )FB7 =&& F6'G&T3-3206'?&5(AE@&=-3@>+

Request Arguments


>'0>&'-E&= F6G&T3-3206'?&F'0>&'-E&= F'0>&'-E&= 0H -%& K3-3 D&E4G 6>/03K&K H0' -%& >6'G& 0>&'3-E04+

@3>>E4G .E&/Ka3>rs .E&/Ka3> 3''3( &'-E&=+


R&( =-'E4G ) R&( -%3- 3//0>/E?3-E04 -0 ?%&?R -%& =-3-6= 0H -%& 0>&'3-E04

D( 6=E4G -%& checkResult B4-&'3?- )FB ?3//+

?0@>/&-& D00/&34 ./3G E4KE?3-E4G &'3-E04 E= ?0@>/&-&K =6??&==H6//(7 3 *3/EK ?064-


64/107


Syntax

B4-&'@&KE3-&M&=6/- q =&'*E?&+=?'6DT3-3206'?&I2?'6DF'0>&'-E&= =?'6DF'0>&'-E&=J

Usage

A%& scrubDataSource ?3// E= 6=&K -0 =?'6D 34 &YE=-E4G -3D/& D3=&K 04 3 46@D&' 0H ?04HEG6'3D/& =?'6D '6/&=+ A%E=

?3// E4E-E3-&= 34 3=(4?%'0406= =?'6D 0>&'3-E04 -%3- '&-6'4= 34 B4-&'@&KE3-&M&=6/- -%3- ?34 D& 6=&K /&-&+

Request Arguments

A%& '&c6&=- E= 3 2?'6DF'0>&'-E&= 0DZ&?- -%3- ?04-3E4= -%& H0//0'0>&'-E&=+


'&>3E'e@3E/= D00/&34 ./3G -%3- KE?-3-&= /E?3-&e@3E/= D00/&34 ./3G -%3- KE?-3-&= &'3-E04 /&-&K =6??&==H6//(

0' 40-+ A%E= H/3G =%06/K 04/( D& ?%&?R&K 04?& -%& .E4E=%&K H/3G E=-'6&+

?34?&//&K D00/&34 ./3G E4KE?3-E4G


65/107


Syntax

B4-&'@&KE3-&M&=6/- q =&'*E?&+?%&?RM&=6/-I=-'E4G E4-&'@&KE3-&M&=6/-i&(J

Usage

A%& checkResult ?3// E= 6=&K -0 -'3?R -%& >'0G'&== 0H 3 >'&*E06=/( =6D@E--&K 3=(4?%'0406= B4-&'3?- )FB ?3//+

Request Arguments


E4-&'@&KE3-&M&=6/-i&( =-'E4G A%& oR&(p =-'E4G 04=& H'0@ -%E= ?3// E= 34 B4-&'@&KE3-&M&=6/- 0DZ&?- /&-& D00/&34 ./3G E4KE?3-E4G


66/107


Syntax

B4-&'@&KE3-&M&=6/- q =&'*E?&+?34?&/I=-'E4G E4-&'@&KE3-&M&=6/-i&(J

Usage

A%& cancel ?3// E= 6=&K -0 ?34?&/ 3 >'&*E06=/( =6D@E--&K 3=(4?%'0406= B4-&'3?- )FB ?3//+

Request Arguments


E4-&'@&KE3-&M&=6/-i&( =-'E4G A%& oR&(p =-'E4G 04=& H'0@ -%E= ?3// E= 34 B4-&'@&KE3-&M&=6/- 0DZ&?- /&-& D00/&34 ./3G E4KE?3-E4G


67/107


Syntax

D00/&34 q =&'*E?&+3KKB4K&YI=-'E4G H0/K&']3@&7 =-'E4G -3D/&]3@&7 =-'E4Grs HE&/K]3@&=7 =-'E4G E4K&Y]3@&7

D00/&34 E=\>>&'B4K&YJ

Usage

A%& addIndex ?3// E= 6=&K -0 ?'&3-& 34 E4K&Y 04 3 -3D/&+ B4K&Y&= 3'& c6E-& E@>0'-34- H0' &HHE?E&4- c6&'(

>&'H0'@34?&+ BH (06 6=& 2[U 0DZ&?-= 0' ?3@>3EG4 @&==3G& ?04-&4- &'H0'@&K7 -%&4 (06=%06/K ?04=EK&' 6=E4G E4K&Y&= H0' HE&/K= E4*0/*&K E4 -3D/& Z0E4= 34K -3D/& /00R6>=+

Request Arguments


H0/K&']3@& =-'E4G .0/K&' 0H -3D/& H0' &' H64?-E04

E4K&Y+

Response


'&=6/- D00/&34 ./3G E4KE?3-E4G -%& =6??&== 0H -%& 3KK E4K&Y 0>&'3-E04+

DeleteIndex

DeleteIndex


68/107


Syntax

D00/&34 q =&'*E?&+K&/&-&B4K&YI=-'E4G H0/K&']3@&7 =-'E4G -3D/&]3@&7 =-'E4G E4K&Y]3@&J

Usage

A%& deleteIndex ?3// E= 6=&K -0 K&/&-& 34 &YE=-E4G E4K&Y+

Request Arguments


H0/K&']3@& =-'E4G .0/K&' 0H -3D/& H0'


69/107


Syntax

2-'E4Grs q =&'*E?&+/E=-B4K&Y&=I=-'E4G H0/K&']3@&7 =-'E4G -3D/&]3@&J

Usage

A%& listIndexes ?3// E= 6=&K -0 /E=- -%& E4K&Y&= 3*3E/3D/& H0' 3 -3D/& E4 (06' 3??064-+

Request Arguments


H0/K&']3@& =-'E4G .0/K&' 0H -3D/& H0'


70/107


=-'E4G q =&'*E?&+G&-T3-3206'?&2?%&@3I=-'E4G H0/K&']3@&7 =-'E4G K3-3206'?&]3@&J

Usage

A%& getDataSourceSchema @&-%0K '&-6'4= 3 =-'E4G K&=?'EDE4G -%& =?%&@3 H0' -%& =>&?EHE&K K3-3 =06'?& I-3D/&7

HE/-&'7 0' 2[U c6&'(J+

Request Arguments


H0/K&']3@& =-'E4G .0/K&' 0H K3-3 =06'?&+

K3-3206'?&]3@& =-'E4G ]3@& 0H K3-3 =06'?&+

Response


'&=6/- =-'E4G 2?%&@3 E4H0'@3-E04 ?04=E=-= 0H -%& &@3E/ ?0/6@4 43@&7 K3-3 &Y-'3?-E04

R&( IEH 34(J7 34K 43@& 34K K3-3 -(>& 0H &3?% ?0/6@4 E4 -%& K3-3 =06'?&7 3=E4 -%E= &Y3@>/&+

re@3E/ R&(Q ea)BUs

rF'E@3'( R&(Q ea)BUs

.BM2A])aeQ =-'_,U)2A])aeQ =-'_,

$SaF)]PQ =-',"

$BAPQ =-'_,

ea)BUQ =-',"

ABae2A)aFfQ -E@&=-3@>

NoteQ .E&/K K3-3 -(>&= '&>0'-&K E4 -%& =-'E4G '&-6'4&K D(

getDataSourceSchema() 3'& -%& =3@& 3= -%0=& 6=&K K3-& 3 K3-3 =06'?&+

GetDataSourceRecordCount

GetDataSourceRecordCount

Syntax


71/107


Syntax

M&?0'K$064- q =&'*E?&+G&-T3-3206'?&M&?0'K$064-I=-'E4G H0/K&']3@&7 =-'E4G K3-3206'?&]3@&J

Usage

A%& getDataSourceRecordCount ?3// E= 6=&K -0 '&-'E&*& 3 ?064- 0H -%& 46@D&' 0H '&?0'K= E4 3 K3-3 =06'?&+ A%E= ?3//

E4E-E3-&= 34 3=(4?%'0406= ?064- 0>&'3-E04 -%3- '&-6'4= 3 M&?0'K$064- -%3- ?34 D& 6=&K /&-& 34K -%& '&?0'K ?064- E= '&3K(+

Request Arguments


H0/K&']3@& =-'E4G .0/K&' 0H K3-3 =06'?&+

K3-3206'?&]3@& =-'E4G ]3@& 0H K3-3 =06'?& H0' &'3-E04 /&-&K =6??&==H6//( 0' 40-+

A%E= H/3G =%06/K 04/( D& ?%&?R&K 04?& -%& .E4E=%&K H/3G E= -'6&+?34?&//&K D00/&34 ./3G E4KE?3-E4G &'3-E04 E= ?0@>/&-&K =6??&==H6//(7 3 *3/EK ?064-


72/107


UploadDocument

Syntax

D00/&34 q =&'*E?&+6>/03KT0?6@&4-ID00/&34 DE43'(.E/&7 =-'E4G H0/K&']3@&7 $%3'3?-&'e4?0KE4G ?%3'3?-&'e4?0KE4G7

=-'E4Grs HE/&]3@&=7 T0?6@&4-.E/&rs K0?6@&4-=J

Usage

A%& uploadDocument ?3// E= 6=&K -0 ?'&3-& 34 jAaU 0' -&Y- K0?6@&4- E4 34 B4-&'3?- $3@>3EG4 3??064-+

Request Arguments


DE43'(.E/& D00/&34 ./3G E4KE?3-E4G EH -%& K0?6@&4- E= 3 DE43'( HE/& H0' 6=& 3= 34 3--3?%@&4-+

H0/K&']3@& =-'E4G .0/K&' E4 >/E&K -0 -%& 4&/03K&K K0?6@&4- E4 -%& K&=EG43-&K H0/K&'+

DE43'(T3-3 T0?6@&4-.E/&rs )''3( 0H D3=&985E43'( '&>'&=&4-3-E04= 0H -%& HE/&= -0 6>/03K+

Response


'&=6/- D00/&34 ./3G E4KE?3-E4G -%& =6??&== 0H -%& 6>/03K '&c6&=-+

RemoveDocument

RemoveDocument

Syntax


73/107


Syntax

D00/&34 q =&'*E?&+'&@0*&T0?6@&4-I=-'E4G H0/K&']3@&7 =-'E4G K0?6@&4-]3@&J

Usage

A%& removeDocument ?3// E= 6=&K -0 K&/&-& K0?6@&4-= H'0@ 34 B4-&'3?- 3??064-+

Request Arguments


H0/K&']3@& =-'E4G ]3@& 0H H0/K&' ?04-3E4E4G K0?6@&4- -0 K&/&-&+

K0?6@&4-]3@& =-'E4G ]3@& 0H K0?6@&4- -0 K&/&-&+

Response


'&=6/- D00/&34 ./3G E4KE?3-E4G =6??&== 0H K0?6@&4- K&/&-E04 '&c6&=-+

CopyDocument

CopyDocument

Syntax


74/107


Syntax

D00/&34 q =&'*E?&+?0>(T0?6@&4-I=-'E4G7 ='?.0/K&']3@&7 =-'E4G ='?T0?6@&4-]3@&7 =-'E4G K=-.0/K&']3@&7 =-'E4G

K=-T0?6@&4-]3@&7 D00/&34 0*&'(+

='?T0?6@&4-]3@& =-'E4G ]3@& 0H K0?6@&4- -0 ?0>(+

K=-.0/K&']3@& =-'E4G .0/K&' H0' 4&< K0?6@&4-+

K=-T0?6@&4-]3@& =-'E4G ]3@& 0H 4&< K0?6@&4-+

0*&'&'3-E04 =%06/K 0*&'( '&c6&=-+

ShowDocument

ShowDocument

Syntax


75/107


y

=-'E4G q =&'*E?&+=%00E4- 3- 3 >6D/E? \MU+ .0' &Y3@>/&7 34 E@3G& '&H&'&4?& IH0' E@3G&= %0=-&K D( -%& M&=>04=(=W)R3@3E

$T]J H0' 3 K0?6@&4- '&-'E&*&K


76/107


CreateCampaign

Syntax

D00/&34 q =&'*E?&+?'&3-&$3@>3EG4I=-'E4G H0/K&']3@&7 =-'E4G ?3@>3EG4]3@&7 $3@>3EG4A(>& ?3@>3EG4A(>&J

Usage

\=& -%& createCampaign ?3// -0 ?'&3-& &@3E/ ?3@>3EG4=+ S4?& (06 %3*& ?'&3-&K 3 ?3@>3EG47 (06 3EG4V= >'0>&'-E&= 3EG4+

?3@>3EG4]3@& =-'E4G ]3@& 0H ?3@>3EG4 -0 ?'&3-&+

?3@>3EG4A(>& $3@>3EG4A(>& A(>& 0H ?3@>3EG4Q =-34K3'K7 H0'@7 0' '&3/L-E@&+

Response


'&=6/- D00/&34 ./3G E4KE?3-E4G -%& =6??&== 0H -%& ?'&3-& ?3@>3EG4 '&c6&=-+

CopyCampaign

CopyCampaign

Syntax


77/107


D00/&34 q =&'*E?&+?0>($3@>3EG4I=-'E4G ='?$3@>3EG4]3@&7 =-'E4G K&=-$3@>3EG4]3@&J

Usage

\=& -%& copyCampaign ?3// -0 ?'&3-& 3 4&< &@3E/ ?3@>3EG4 D3=&K 04 -%& >'0>&'-E&= 0H 34 &YE=-E4G ?3@>3EG4+

Request Arguments


='?$3@>3EG4]3@& =-'E4G ]3@& 0H ?3@>3EG4 -0 ?0>(+

K&=-$3@>3EG4]3@& =-'E4G ]3@& 0H ?3@>3EG4 -0 ?'&3-& 3= 3 ?0>(+

Response


'&=6/- D00/&34 ./3G E4KE?3-E4G -%& =6??&== 0H -%& ?0>( ?3@>3EG4 '&c6&=-

DeleteCampaign

DeleteCampaign

Syntax


78/107


D00/&34 q =&'*E?&+K&/&-&$3@>3EG4I=-'E4G ?3@>3EG4]3@&J

Usage

\=& -%& deleteCampaign ?3// -0 K&/&-& 3 ?3@>3EG4 E4 34 B4-&'3?- 3??064-+

Request Arguments


?3@>3EG4]3@& =-'E4G ]3@& 0H ?3@>3EG4 -0 K&/&-&+

Response


'&=6/- D00/&34 26??&== H/3G H0' K&/&-E04 0H ?3@>3EG4+

GetCampaignProperties

GetCampaignProperties

Syntax


79/107


$3@>3EG4F'0>&'-E&= q =&'*E?&+G&-$3@>3EG4F'0>&'-E&=I=-'E4G ?3@>3EG4]3@&J

Usage

\=& -%& getCampaignProperties ?3// -0 '&-'E&*& -%& >'0>&'-E&= H0' 3 GE*&4 ?3@>3EG4+

Request Arguments


?3@>3EG4]3@& =-'E4G $3@>3EG4 ]3@&+

Response


'&=6/- $3@>3EG4F'0>&'-E&= $3@>3EG4F'0>&'-E&= 0DZ&?- -%3- K&HE4&= -%& D&%3*E0' 0H 3?3@>3EG4+

SetCampaignProperties

SetCampaignProperties

Syntax


80/107


D00/&34 q =&'*E?&+=&-$3@>3EG4F'0>&'-E&=I=-'E4G ?3@>3EG47 $3@>3EG4F'0>&'-E&= ?3@>3EG4>'0>&'-E&=J

Usage

\=& -%& setCampaignProperties ?3// -0 K&HE4& -%& ?3@>3EG4 D&%3*E0' E4 -&'@= 0H 36KE&4?&7 @&==3G&7 -'3?RE4G7 34K

0>-E043/ =&--E4G=+

Request Arguments


?3@>3EG4F'0>&'-E&= $3@>3EG4F'0>&'-E&= $3@>3EG4F'0>&'-E&= 0DZ&?- -%3- K&HE4&= ?3@>3EG4 D&%3*E0'+

Response


'&=6/- D00/&34 ./3G E4KE?3-E4G =6??&== 0H =&- ?3@>3EG4 >'0>&'-E&= '&c6&=-+

LaunchCampaign

LaunchCampaign

Syntax


81/107


/04G q =&'*E?&+/364?%$3@>3EG4I=-'E4G ?3@>3EG4]3@&7 D00/&34 -&=-U364?%7 =-'E4G -&=-e@3E/)KK'&==7 E4-

M&?E>E&4-UE@E-7 2?%&K6/&.'&c6&4?( =?%&K6/&.'&c6&4?(7 K3-&AE@& =?%&K6/&T3-&7 =-'E4G KE=>/3(]3@&7 =-'E4G

'&>/(A0)KK'&==7 =-'E4G =6DZ&?-J

Usage

\=& -%& launchCampaign -0 /364?% 3 ?3@>3EG4 E@@&KE3-&/( 0' 3- 3 H6-6'& K3-&+

Request Arguments


?3@>3EG4]3@& =-'E4G $3@>3EG4 -0 /364?%+

-&=-U364?% D00/&34 ./3G E4KE?3-E4G &?EH( 3 *3/6& -%3- E4?/6K&= =&?04K= I+++%%Q@@Q==+++J7 (06V//

%3*& -0 E4?/6K& -%&@ 3G3E4 E4 34( =6D=&c6&4- ?3// -0

642?%&K6/&$3@>3EG4 -0 64=?%&K6/& -%E= /364?%+ ) 46//*3/6& =%06/K D& 6=&K H0' 34 E@@&KE3-& /364?%+

KE=>/3(]3@& =-'E4G S>-E043/ 0*&''EK& H0' -%& x.'E&4K/( .'0@V >0'-E04 0H -%&

&@3E/ H'0@ 3KK'&== %&3K&'

'&>/(A0)KK'&== =-'E4G S>-E043/ 0*&''EK& H0' '&>/( -0 3KK'&== %&3K&'

=6DZ&?- =-'E4G S>-E043/ 0*&''EK& H0' -%& ?3@>3EG4 =6DZ&?- /E4& %&3K&'

Response


'&=6/- /04G U364?% EK&4-EHE&'+

UnScheduleCampaign

UnScheduleCampaign

Syntax


82/107


D00/&34 q =&'*E?&+642?%&K6/&$3@>3EG4I=-'E4G ?3@>3EG4]3@&7 K3-&AE@& =?%&K6/&T3-&J

Usage

\=& -%& unScheduleCampaign ?3// -0 '&@0*& 3 ?6''&4-/( =?%&K6/&K ?3@>3EG4 /364?% H'0@ -%& ?3@>3EG4 ?3/&4K3'+

Request Arguments


?3@>3EG4]3@& =-'E4G ]3@& 0H ?3@>3EG4 -0 64=?%&K6/&K+

=?%&K6/&T3-& K3-&AE@& A%& E4=-34?& 0H -%& =?%&K6/&K /364?% -0 64=?%&K6/&+

Response


'&=6/- D00/&34 ./3G E4KE?3-E4G -%& =6??&== 0H -%& 64=?%&K6/& '&c6&=-

GetCampaignStatus

Syntax