SOAP integration API

339 Pages·2017·2.74 MB·English

Episerver Campaign
SOAP API
©Episerver2018
EpiserverCampaignSOAPAPI
Version6.70
TableofContents|3
Table of contents
Table of contents 3
SOAP API 16
What can I do with the SOAP API? 16
Modifications since the previous version 16
New methods 16
Introduction to the SOAP API 17
Information regarding general use 17
SOAP 1.1 compatibility 18
Type conversion and formatting rules 18
Batch call limits 18
Basic usage 18
Validity of a session 19
Web service endpoints 19
Coupon system web services 19
Error messages 19
Usage example 19
Native APIs 20
Java 20
PHP 21
.NET 22
Webservice overview 23
AttachmentWebservice 24
create 25
getAllIds 26
getColumnNames 27
getContent 28
©Episerver2018
4|TableofContents
getCount 29
getDataSet 30
getDataSetFlat 31
getFilename 32
getMimeType 33
getName 34
getSize 35
setContent 36
setFilename 37
setMimeType 38
setName 39
BlacklistWebservice 40
add 42
addAll 43
areBlacklisted 44
contains 45
containsAll 46
getAllAdvanced 47
getAllAdvancedFlat 48
getAllEntries 49
getColumnNames 50
getCount 51
getCreated 52
getDataSet 53
getDataSetFlat 54
getFirstMatchingEntry 55
getReason 56
isBlacklisted 57
©Episerver2018
TableofContents|5
remove 58
removeAll 59
ClosedLoopWebservice 60
getClicks 62
getCurrentTime 63
getCurrentTime 64
getLinks 65
getMailingIdByWaveId 66
getMailings 67
getMailingUnsubscribes 68
getOpens 69
getOutBounces 70
getRecipients 71
getResponses 72
getUnsubscribes 73
importFinishedAndScheduleMailing 74
importRecipients 75
prepareNewWave 76
CouponCodeWebservice 77
add 78
addAll 79
getAllAssigned 80
getAllUnAssigned 81
getAssignedMailing 82
getAssignedRecipientId 83
getByMailingAndRecipientId 84
getCreated 85
getModified 86
©Episerver2018
6|TableofContents
isAssigned 87
isUsed 88
markAsUsed 89
remove 90
removeAll 91
CouponBlockWebservice 92
create 93
getAllIds 94
getAssignedCodeCount 95
getAssignedMailings 96
getCodeCount 97
getCreated 98
getModified 99
getName 100
getUnAssignedCodeCount 101
remove 102
FolderWebservice 103
Folder type 103
assignFolder 104
createFolder 105
getAssignedFolder 106
getChildren 107
getFolderName 108
getParent 109
getRootFolders 110
moveFolder 111
removeFolder 112
renameFolder 113
©Episerver2018
TableofContents|7
MailIdWebservice 114
Using Mail-IDs 114
getMailingId 115
getMandatorId 116
getRecipientId 117
getRecipientListId 118
MailingReportingWebservice 119
getClickCount 120
getClickCountByUrl 121
getFailedRecipientCount 122
getLinkNames 123
getLinkUrls 124
getOpenCount 125
getOverallRecipientCount 126
getResponseCount 127
getSentRecipientCount 128
getUnsubscribeCount 129
MailingWebservice 130
Deprecated methods 133
Mailing type 133
MIME Types 133
cancel 135
copy 136
create 137
decodeTrackingLinks 138
encodeTrackingLinks 139
getAttachmentIds 140
getCharset 141
©Episerver2018
8|TableofContents
getColumnNames 142
getContent 143
getCount 144
getCreatedDate 145
getDataSet 146
getDataSetFlat 147
getDescription 148
getFailedRecipientCount 149
getFromEmailPrefix 150
getFromName 151
getHeader 152
getIds 153
getIdsInStatus 154
getMaxMailsPerHour 155
getMaxRecipients 156
getMimeType 157
getName 158
getOverallRecipientCount 159
getPredictedRecipientCount 160
getProperty 161
getRecipientFilterId 162
getRecipientFilterIds 163
getRecipientListIds 164
getScheduleDate 165
getSendingFinishedDate 166
getSendingStartedDate 167
getSendingStatus 168
getSentRecipientCount 169
©Episerver2018
TableofContents|9
getStatus 170
isClickTrackingEnabled 171
isDefaultRecipientFilterEnabled 172
isMaxRecipientsPercentage 173
isMaxRecipientsRandomOrder 174
isOpenTrackingEnabled 175
pause 176
remove 177
restart 178
resume 179
sendMail 180
sendMails 181
sendTestMail 182
sendTestMail2 183
sendTestMails 185
sendTestMailToAll 186
setAttachmentIds 187
setCharset 188
setClickTrackingEnabled 189
setContent 190
setDefaultRecipientFilterEnabled 191
setDescription 192
setFrom 193
setHeader 194
setMaxMailsPerHour 195
setMaxRecipients 196
setMaxRecipientsPercentage 197
setMimeType 198
©Episerver2018
10|TableofContents
setName 199
setOpenTrackingEnabled 200
setProperty 201
setRecipientFilterId 202
setRecipientFilterIds 203
setRecipientListIds 204
setReplyToAddress 205
setReplyToName 206
setSubject 207
start 208
validateContent 209
OptinProcessWebservice 210
createConfirmedOptinProcess 211
createDoubleOptinProcess 212
createSingleOptinProcess 213
getConfirmationMailingId 214
getConfirmationUrl 215
getDescription 216
getIds 217
getName 218
getType 219
setConfirmationMailingId 220
setConfirmationUrl 221
setDescription 222
setName 223
RecipientFilterWebservice 224
Temporary target groups 225
Conditions 225
©Episerver2018