PDF Archive

Easily share your PDF documents with your contacts, on the Web and Social Networks.

Share a file Manage my documents Convert Recover PDF Search Help Contact



eWSReference .pdf


Original filename: eWSReference.pdf

This PDF 1.4 document has been generated by PScript5.dll Version 5.2.2 / Acrobat Distiller 8.0.0 (Windows), and has been sent on pdf-archive.com on 19/02/2013 at 20:03, from IP address 72.43.x.x. The current document download page has been viewed 801 times.
File size: 884 KB (155 pages).
Privacy: public file




Download original PDF file









Document preview


Web Service: SdkService - Generated by wsdl-viewer.xsl

1 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

Target Namespace: uri:ws.sdk.edialog.com

Port eDialogWebServicesSoap11 Port type Source code
Location: https://sdk-beta.e-dialog.com:443/edialog-webservices/
Protocol: SOAP
Default style: document
Transport protocol: SOAP over HTTP
Operations:
1.

buildAudienceFromIBQuery

2.

buildPermutationProofSample

3.

buildRandomProofSample

4.

Detail Source code

5.

canAccessClient
cancelCell Detail

6.

cancelExportJob

Detail Source code

7.

clearSymbolMap

Detail Source code

8.

cloneAudience

9.
10.

cloneCell Detail Source code
cloneMailing Detail Source code

11.

createAudience

12.

createAudienceClass

13.
14.

createCampaign
createCell Detail

15.

createContent

16.

createDataUploadConfigForExistingAudience

17.
18.

createDataUploadConfigForExistingSuppression Detail Source code
createDataUploadConfigForGlobalUnsub Detail Source code

19.

createDataUploadConfigForNewAudience

20.

createDataUploadConfigForNewSuppression

21.

createGrid

22.
23.

createMailing Detail Source code
createRTMConfiguration Detail

24.

createTabSeparatedGrid

25.

createXmlGrid

26.
27.

deleteAllRTMVariations Detail Source code
deleteAudience Detail Source code

28.

deleteCampaign

29.

deleteCell

30.

deleteContent Detail Source code
deleteGrid Detail Source code

31.

Detail Source code
Detail Source code

Detail Source code

Source code

Detail Source code

Detail Source code
Detail Source code

Detail Source code
Source code

Detail Source code
Detail Source code

Detail Source code
Detail Source code

Detail Source code

Source code

Detail Source code

Detail Source code

Detail Source code

Detail Source code

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

2 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

33.

deleteMailing Detail Source code
deleteRTMConfiguration Detail

34.

downloadAudience

35.

getCellContentId

36.
37.

getDeliverabilityReport Detail Source code
getEReportsRefreshStatus Detail Source code

38.

getExportJobStatus

Detail Source code

39.

getGoodMailHeader

Detail Source code

40.

getIBJobStatus

41.
42.

getMailingVolumeReport Detail Source code
getMemberCount Detail Source code

43.

getProofGroupOptions

44.

getProofSampleSetting

45.
46.

getProofSampleStatus Detail Source code
hideContent Detail Source code

47.

listAllDataColumns

48.

listAudienceClasses

49.
50.

listAudiences Detail Source code
listAudiencesByFilter Detail Source code

51.

listAudienceUdfs

52.

listAvailableMeters

53.

listCampaigns

54.
55.

listCampaignUdfs Detail Source code
listCells Detail Source code

56.

listCellsByFilter

57.

listCellUdfCategoryNames

58.
59.

listCellUdfs Detail Source code
listClients Detail Source code

60.

listContent

61.

listContentAlt

62.
63.

listContentUdfs Detail Source code
listDataColumnsForAudience Detail

64.

listDataColumnsForCell

65.

listDomains

66.
67.

listEReportTypes Detail Source code
listExportedDataColumns Detail Source code

68.

listFeederQueues

69.

listForwardToFriendTemplates

70.

listGridColumns

71.
72.

listGridKeyValues Detail Source code
listGrids Detail Source code

73.

listIBQueries

74.

listLinks

32.

Source code

Detail Source code

Detail Source code

Detail Source code

Detail Source code
Detail Source code

Detail Source code
Detail Source code

Detail Source code
Detail Source code

Detail Source code

Detail Source code
Detail Source code

Detail Source code
Detail Source code

Source code

Detail Source code

Detail Source code

Detail Source code
Detail Source code

Detail Source code

Detail Source code

Detail Source code

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

3 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

76.

listMailings Detail Source code
listMailingsByFilter Detail Source code

77.

listMailingsByFilterAndMailingType

78.

listMailingUdfs

79.
80.

listMappingFunctionsForCell Detail Source code
listMasterUniqueKeyColumns Detail Source code

81.

listProofAudienceEmails

82.

listProofGroupSampleCIDs

83.

listProofSampleCIDs

84.
85.

listRealTimeMessageConfigurations Detail
listRecipientCellEvents Detail Source code

86.

listRecipientHistory

87.

listRTMConfigurations

88.
89.

listRTMQueues Detail Source code
listSymbolsInCell Detail Source code

90.

listSymbolsInContent

91.

listSymbolsInText

92.
93.

listUdfCategoryNamesAndValues Detail
listUnsubTemplates Detail Source code

94.

listWebAnalyticsTokens

95.

lookupAudienceByAlternateKey

96.

lookupAudienceById

97.
98.

lookupAudienceByIds
lookupCampaignById

99.

lookupCellAdvancedOptionsById

75.

Detail Source code

Detail Source code

Detail Source code
Detail Source code

Detail Source code
Source code

Detail Source code
Detail Source code

Detail Source code

Detail Source code
Source code

Detail Source code
Detail Source code

Detail Source code
Detail Source code
Detail Source code
Detail Source code

100.

lookupCellByAlternateKey

101.
102.

lookupCellById Detail Source code
lookupCellStatus Detail Source code

103.

lookupContentByAlternateKey

104.

lookupContentById

105.
106.

lookupContentDeliveryPart Detail Source code
lookupDataUploadStatus Detail Source code

107.

lookupGrid

108.

lookupIBQueryById

109.
110.

lookupLinkByEncodedURL Detail
lookupLinkById Detail Source code

111.

lookupMailingByAlternateKey

112.

lookupMailingById

113.

lookupRecipientAudienceProfile

114.
115.

lookupRecipientProfile Detail Source code
lookupRTMConfiguration Detail Source code

116.

lookupSymbolMap

117.

lookupTabSeparatedGrid

Detail Source code

Detail Source code

Detail Source code

Detail Source code
Detail Source code
Source code

Detail Source code

Detail Source code
Detail Source code

Detail Source code
Detail Source code

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

4 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

119.

lookupXmlGrid Detail Source code
mapAllGridColumnsToSymbols Detail

120.

mapAllGridColumnsToSymbolsByKeyLiteral

121.

mapGridColumnToSymbol

122.
123.

mapGridColumnToSymbolByKeyLiteral Detail
mapSymbolToContent Detail Source code

124.

mapSymbolToCustomFunction

125.

mapSymbolToDataColumn

Detail Source code

126.

mapSymbolToLiteralValue

Detail Source code

127.
128.

pauseCell Detail Source code
promoteRTMTestCell Detail

129.

refreshEReports

130.

resetSymbolMap

131.
132.

resumeCell Detail Source code
retrieveCellViewEReports Detail

133.

retrieveEReports

134.

retrieveMailingViewEReports

135.
136.

retrieveMailingViewEReportsUdfs Detail
retrievePulseReport Detail Source code

137.

scheduleCell

138.

scheduleMailing

139.

sendCellAsScheduled

140.
141.

sendCellLater Detail
sendCellNow Detail

142.

sendMailingAsScheduled

143.

sendMailingLater

144.
145.

sendMailingNow Detail Source code
sendMessage Detail Source code

146.

sendProofMessage

147.

sendProofsNow

148.
149.

setCellAudiences Detail
setCellProofAddresses

150.

setCellUnsubRules

151.

setSymbolMap

Detail Source code

152.

Detail Source code

153.

startExportJob
unhideContent

154.

updateAudience

155.

updateCampaign

156.

updateCell

157.
158.

updateCellAdvancedOptions Detail Source code
updateCellConversionTracking Detail Source code

159.

updateCellDropDate

160.

updateCellFeederQueue

118.

Source code
Detail Source code

Detail Source code
Source code

Detail Source code

Source code

Detail Source code
Detail Source code

Source code

Detail Source code
Detail Source code
Source code

Detail Source code
Detail Source code
Detail Source code

Source code
Source code
Detail Source code

Detail Source code

Detail Source code

Detail Source code
Source code
Detail Source code

Detail Source code

Detail Source code
Detail Source code
Detail Source code

Detail Source code

Detail Source code
Detail Source code

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

5 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

162.

updateCellHeaders
updateCellMetering

163.

updateCellWebAnalytics

164.

updateContent

165.
166.

updateContentDeliveryPart Detail
updateGrid Detail Source code

167.

updateLink

168.

updateMailing

169.

updateProofGroupOptions

170.
171.

updateProofGroupSampleCIDs Detail Source code
updateRecipientProfile Detail Source code

172.

updateRTMConfiguration

173.

updateRTMTestCell

174.
175.

updateRTMVariations Detail Source code
updateTabSeparatedGrid Detail Source code

176.

updateXmlGrid

Detail Source code

177.

wrapUrlsInText

Detail Source code

161.

Detail Source code
Detail Source code
Detail Source code

Detail Source code
Source code

Detail Source code
Detail Source code
Detail Source code

Detail Source code

Detail Source code

Port type eDialogWebServices Source code
1.

buildAudienceFromIBQuery
Source code
Description: Build an Audience based on a pre-defined Insight-Builder query. Introduced in e-Dialog
Web Services 1.4.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: buildAudienceFromIBQueryRequest (soap:body, use = literal) Source code
parameters type buildAudienceFromIBQuery
Build an Audience based on a pre-defined Insight-Builder query. Introduced in e-Dialog
Web Services 1.4.
queryId type int
Unique Query identifier
sourceAudienceId - nillable; type int
List to build the Audiece of off.
targetAudienceId type int
The new list which will have the built audience
notificationAddresses - optional, unbounded, nillable; type string
Emails to be notified after the Audience is built
scheduleDate - nillable; type dateTime
The date when the audience list will be built
Output: buildAudienceFromIBQueryResponse (soap:body, use = literal) Source code
parameters type buildAudienceFromIBQueryResponse
Unique Job identifier configured to build the Audience from List
jobId type int
Unique Identifier of the Job that creates and populates the Audience List

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

6 of 155

2.

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

buildPermutationProofSample
Source code
Description: Generates a file that contains a subset of data columns from the full export file. You can
get the list of data columns available for generating the permutation by using the
listExportedDataColumns function. To check the status of the operation, you can use the
getProofSampleStatus function. Introduced in e-Dialog Web Services 1.1.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: buildPermutationProofSampleRequest (soap:body, use = literal) Source code
parameters type buildPermutationProofSample
Generates a file that contains a subset of data columns from the full export file. You can
get the list of data columns available for generating the permutation by using the
listExportedDataColumns function. To check the status of the operation, you can use
the getProofSampleStatus function. Introduced in e-Dialog Web Services 1.1.
cellId type int
The ID of the cell for which to generate the subset of the full export file.
columnName - unbounded; type string
A list/array of column names to include in the subset of the export file.
Output: buildPermutationProofSampleResponse (soap:body, use = literal) Source code
parameters type buildPermutationProofSampleResponse
Empty response indicates success.

3.

buildRandomProofSample
Source code
Description: Generates the random sample file that contains a subset of rows from the full export file,
with a maximum number of records set by the sampleSize. Introduced in e-Dialog Web
Services 1.1.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: buildRandomProofSampleRequest (soap:body, use = literal) Source code
parameters type buildRandomProofSample
Generates the random sample file that contains a subset of rows from the full export
file, with a maximum number of records set by the sampleSize. Introduced in e-Dialog
Web Services 1.1.
cellId type int
The ID of the cell for which to generate the subset of the full export file.
sampleSize type int
The maximum number of rows from the full export file to include in the sample
file.
Output: buildRandomProofSampleResponse (soap:body, use = literal) Source code
parameters type buildRandomProofSampleResponse
Empty response indicates success.

4.

canAccessClient
Source code
Description: Returns true if the user has permission to access the client ID or schema name passed
as an argument. Introduced in e-Dialog Web Services 1.2.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: canAccessClientRequest (soap:body, use = literal) Source code
parameters type canAccessClient
Returns true if the user has permission to access the client ID or schema name passed
as an argument. Introduced in e-Dialog Web Services 1.2.
clientIdentifer type string
The client ID or the client schema.
Output: canAccessClientResponse (soap:body, use = literal) Source code

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

7 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

parameters type canAccessClientResponse
status type boolean
Whether the user may access the client.

5.

cancelCell
Source code
Description: Cancels further processing of a cell. A cell must be in the PAUSED, MAILING,
PROOFING, MERGING, or MERGED state to be cancelled. MERGING, MERGED status
support added in e-Dialog Web Services 1.3. Introduced in e-Dialog Web Services 1.1.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: cancelCellRequest (soap:body, use = literal) Source code
parameters type cancelCell
Cancels further processing of a cell. A cell must be in the PAUSED, MAILING,
PROOFING, MERGING, or MERGED state to be cancelled. MERGING, MERGED
status support added in e-Dialog Web Services 1.3. Introduced in e-Dialog Web
Services 1.1.
cellId type int
The ID of the cell to cancel.
Output: cancelCellResponse (soap:body, use = literal) Source code
parameters type cancelCellResponse
Empty response indicates success.

6.

cancelExportJob
Source code
Description: If an export job is running for the specified cell, cancels the export job. Introduced in
e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: cancelExportJobRequest (soap:body, use = literal) Source code
parameters type cancelExportJob
If an export job is running for the specified cell, cancels the export job. Introduced in
e-Dialog Web Services 1.0.
cellId type int
Required. The ID of the cell in which to cancel any running export job.
Output: cancelExportJobResponse (soap:body, use = literal) Source code
parameters type cancelExportJobResponse
Empty response indicates success.

7.

clearSymbolMap
Source code
Description: Removes all symbol mappings. Introduced in e-Dialog Web Services 1.3.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: clearSymbolMapRequest (soap:body, use = literal) Source code
parameters type clearSymbolMap
Removes all symbol mappings. Introduced in e-Dialog Web Services 1.3.
cellId type int
Uniquely identifies the cell whose symbols have to cleared/deleted
includeUnsupportedSymbols type boolean
If True: Delete all the symbols for the cell If False: Delete only symbols which
are supported by the SDK
Output: clearSymbolMapResponse (soap:body, use = literal) Source code
parameters type clearSymbolMapResponse

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

8 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

Empty response indicates successfull deletion of symbols.

8.

cloneAudience
Source code
Description: Creates a copy of an audience list. This function does not copy membership data (users)
into the new audience list. Instead, it creates an audience list that is empty. Introduced in
e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: cloneAudienceRequest (soap:body, use = literal) Source code
parameters type cloneAudience
Creates a copy of an audience list. This function does not copy membership data
(users) into the new audience list. Instead, it creates an audience list that is empty.
Introduced in e-Dialog Web Services 1.0.
audienceId type int
Required. The ID of the audience to clone.
Output: cloneAudienceResponse (soap:body, use = literal) Source code
parameters type cloneAudienceResponse
resultAudienceId type int
The ID of the newly created audience.

9.

cloneCell
Source code
Description: Creates a clone of the specified cell and places the new cell in the specified mailing.
Returns the new cell's ID. Throws an exception if the cell being cloned is in Proofing or
Mailing status, does not exist, or has been deleted. Introduced in e-Dialog Web Services
1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: cloneCellRequest (soap:body, use = literal) Source code
parameters type cloneCell
Creates a clone of the specified cell and places the new cell in the specified mailing.
Returns the new cell's ID. Throws an exception if the cell being cloned is in Proofing or
Mailing status, does not exist, or has been deleted. Introduced in e-Dialog Web
Services 1.0.
cellId type int
Required. The ID of the cell to clone.
mailingId type int
ID of the mailing in which to place the clone of the cell.
Output: cloneCellResponse (soap:body, use = literal) Source code
parameters type cloneCellResponse
resultCellId type int
The ID of the newly created cell.

10.

cloneMailing
Source code
Description: Clones a mailing. Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: cloneMailingRequest (soap:body, use = literal) Source code
parameters type cloneMailing
Clones a mailing. Introduced in e-Dialog Web Services 1.0.
mailingId type int
Required. The ID of the mailing to clone.
campaignId type int
Optional. The ID of the campaign in which to place the cloned mailing. There is

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

9 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

no default value; an empty/null or zero campaignId specifies that the cloned
mailing should not be located within a campaign. Mailings created this way
appear in eReports but may not be visible in the Campaign Builder graphical
user interface.
deepCopy type boolean
Required. Whether the cells inside the mailing should also be cloned (true).
Output: cloneMailingResponse (soap:body, use = literal) Source code
parameters type cloneMailingResponse
resultMailingId type int
The ID of the newly cloned mailing.

11.

createAudience
Source code
Description: Creates a new audience, either membership or suppression, based on the specified type,
and using the specified class identifier (which defines which member fields to include).
See listAudienceClasses. Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: createAudienceRequest (soap:body, use = literal) Source code
parameters type createAudience
Creates a new audience, either membership or suppression, based on the specified
type, and using the specified class identifier (which defines which member fields to
include). See listAudienceClasses. Introduced in e-Dialog Web Services 1.0.
audienceType type string
Required. Either "Membership" or "Suppression" to indicate the intended use of
this list.
classId type int
Optional. Identifies an audience class in the data dictionary, which binds an
audience list to a specific set of member columns in the master database. See
audienceClassType.
singleUse type boolean
Required. Specifies whether you intend to use this list more than once, or only
for a one-time mailing.
name type string
Required. The name of the audience.
description - nillable; type string
Optional. Describes the nature and purpose of the audience list.
udf - optional, nillable; type string
Optional. List/array of strings containing user-defined field (UDF) values with
which to categorize the audience. Each string can be up to 30 characters. The
order of the UDF values was defined by your account team as part of your initial
setup process. e-Dialog recommends that you use only the UDF values that
were defined at setup time for categorization purposes.
alternateKey - nillable; type string
Optional. A caller-supplied key to keep with the created audience. Throws an
exception if this value is provided (non-null, non-empty) and the key already
exists.
Output: createAudienceResponse (soap:body, use = literal) Source code
parameters type createAudienceResponse
resultAudienceId type int
The ID of the newly created audience.

12.

createAudienceClass
Source code
Description: Creates a class (group of data columns) by providing a list of data dictionary rows. Calling
this function with an empty column identifier list returns Class ID 95. To get a complete list
of data columns from the data dictionary, use listAllDataColumns. Introduced in e-Dialog
Web Services 1.0.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

10 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: createAudienceClassRequest (soap:body, use = literal) Source code
parameters type createAudienceClass
Creates a class (group of data columns) by providing a list of data dictionary rows.
Calling this function with an empty column identifier list returns Class ID 95. To get a
complete list of data columns from the data dictionary, use listAllDataColumns.
Introduced in e-Dialog Web Services 1.0.
columnId - optional, unbounded; type int
A list/array of column IDs.
Output: createAudienceClassResponse (soap:body, use = literal) Source code
parameters type createAudienceClassResponse
classId type int
The ID of an audience class in the data dictionary, which binds an audience list
to a specific set of member columns in the master database. The default class
identifier is 95 if you call createAudienceClass with an empty identifier list. See
audienceClassType.

13.

createCampaign
Source code
Description: Creates a new campaign. Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: createCampaignRequest (soap:body, use = literal) Source code
parameters type createCampaign
Creates a new campaign. Introduced in e-Dialog Web Services 1.0.
name type string
Required. The name of the campaign to create. The maximum length is 500
characters, but relatively short names are recommended because they appear
in lists. The name cannot be empty or null.
description - nillable; type string
Optional. Describes the nature and purpose of the campaign. Can be left blank.
Maximum length is 4000 characters.
udf - optional, nillable; type string
Optional. List/array of strings containing user-defined field (UDF) values with
which to categorize the object. Each string can be up to 30 characters. The
order of the UDF values was defined by your account team as part of your initial
setup process. e-Dialog recommends that you use only the UDF values that
were defined at setup time for categorization purposes.
Output: createCampaignResponse (soap:body, use = literal) Source code
parameters type createCampaignResponse
resultCampaignId type int
The ID of the newly created campaign.

14.

createCell
Source code
Description: Creates a new cell. Throws an exception if an alternateKey was provided and a cell with
that key already exists or the domain name of the fromAddress is not included in the set
of supported domain names and does not pass a basic validation check. Introduced in
e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: createCellRequest (soap:body, use = literal) Source code
parameters type createCell
Creates a new cell. Throws an exception if an alternateKey was provided and a cell with
that key already exists or the domain name of the fromAddress is not included in the set
of supported domain names and does not pass a basic validation check. Introduced in
e-Dialog Web Services 1.0.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

11 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

mailingId type int
Required. The ID of the mailing in which you want to place the cell. The ID must
be a valid mailing identifier.
name type string
Required. Specifies a name for the cell. The cell name appears in reports but
does not appear in any part of a mailing sent to an audience. Cell names cannot
contain underscore (_) or pound sign (#) characters.
description - nillable; type string
Optional. Describes the nature and purpose of the cell. The description does
not appear in reports or in any part of a mailing sent to an audience.
fromName type string
Required. The quoted name part of the from address. In the following address:
"Customer Support" <support@example.com> the quoted name is the
"Customer Support" part.
fromAddress type string
Required. Specifies an e-mail address to use as the "from" address in the
mailing. The domain of the address should be in the set of supported domains
(see listDomains), although external domains are allowed if the client is handling
responses. There are also deliverability implications if the domain name is not
configured correctly.
subject type string
Required. Specifies the subject line to appear in the outgoing e-mail. Limit
subject lines to fewer than 60 characters because some e-mail clients truncate
the text after 60 characters.
udf - optional, nillable; type string
Optional. A list/array of strings containing user-defined field (UDF) values with
which to categorize the object. Each string can be up to 30 characters. The
order of the UDF values was defined by your account team as part of your initial
setup process; e-Dialog recommends that you use only the UDF values that
were defined at setup time for categorization purposes.
alternateKey - nillable; type string
Optional. A value to use as a unique key for the cell.Throws an exception if a cell
already exists with this key. See lookupCellByAlternateKey.
Output: createCellResponse (soap:body, use = literal) Source code
parameters type createCellResponse
resultCellId type int
The ID of the newly created cell.

15.

createContent
Source code
Description: Creates a content object and stores it in the Content Library. Introduced in e-Dialog Web
Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: createContentRequest (soap:body, use = literal) Source code
parameters type createContent
Creates a content object and stores it in the Content Library. Introduced in e-Dialog
Web Services 1.0.
name type string
Required. The name of the content object.
textData - nillable; type string
Optional. The text version of the content, used in text-based e-mail messages.
e-Dialog Web Services finds links in the string you provide and adds anchor
tags (a href=) to them.
htmlData - nillable; type string
Optional. The HTML version of the content, used in HTML-based email
messages.
udf - optional, nillable; type string
Optional. A list/array of strings containing user-defined field (UDF) values with
which to categorize the object. Each string can be up to 30 characters. The
order of the UDF values was defined by your account team as part of your initial
setup process. e-Dialog recommends that you use only the UDF values that
were defined at setup time for categorization purposes.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

12 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

alternateKey - nillable; type string
Optional. A value to uniquely identify the content.
Output: createContentResponse (soap:body, use = literal) Source code
parameters type createContentResponse
contentId type int
The ID of the newly created content object.

16.

createDataUploadConfigForExistingAudience
Source code
Description: Creates a data upload configuration for an existing audience list ID. Introduced in e-Dialog
Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: createDataUploadConfigForExistingAudienceRequest (soap:body, use = literal) Source
code
parameters type createDataUploadConfigForExistingAudience
Creates a data upload configuration for an existing audience list ID. Introduced in
e-Dialog Web Services 1.0.
audienceId type int
Required. The ID of an existing audience list.
appendToAudience type boolean
Required. Whether to replace the existing audience list (false) or append to it
(true).
emailNotification - optional, unbounded; type string
A list/array of the e-mail address to which to send notifications.
Output: createDataUploadConfigForExistingAudienceResponse (soap:body, use =
literal) Source code
parameters type createDataUploadConfigForExistingAudienceResponse
dataUploadConfig type dataUploadConfigType
Complex type that describes a data upload configuration.
configId type int
The ID of a data upload configuration.
filenamePatternPrefix type string
The prefix of the filename(s) for files that you upload to the FTP/SFTP
server. Dynamic DataSYNC uses the file naming convention prefix*.suffix
where * is a unique identifier string. For example, if the upload
configuration prefix is "DEMO", the filename prefix is something like
"DEMO_DDSDK_S1234567_20081230".
filenamePatternSuffix type string
The suffix of the filename(s) for files that you upload to the FTP/SFTP
server. The suffix represents the encoding type of the file, typically
"UTF-8".

17.

createDataUploadConfigForExistingSuppression
Source code
Description: Creates a data upload configuration for an existing suppression list. Introduced in
e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: createDataUploadConfigForExistingSuppressionRequest (soap:body, use =
literal) Source code
parameters type createDataUploadConfigForExistingSuppression
Creates a data upload configuration for an existing suppression list. Introduced in
e-Dialog Web Services 1.0.
audienceId type int
Required. The ID of an existing suppression list.
appendToAudience type boolean
Required. Whether to replace the existing suppression list (false) or to append

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

13 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

to it (true).
emailNotification - optional, unbounded; type string
A list/array of the e-mail address to which to send notifications.
Output: createDataUploadConfigForExistingSuppressionResponse (soap:body, use =
literal) Source code
parameters type createDataUploadConfigForExistingSuppressionResponse
dataUploadConfig type dataUploadConfigType
Complex type that describes a data upload configuration.
configId type int
The ID of a data upload configuration.
filenamePatternPrefix type string
The prefix of the filename(s) for files that you upload to the FTP/SFTP
server. Dynamic DataSYNC uses the file naming convention prefix*.suffix
where * is a unique identifier string. For example, if the upload
configuration prefix is "DEMO", the filename prefix is something like
"DEMO_DDSDK_S1234567_20081230".
filenamePatternSuffix type string
The suffix of the filename(s) for files that you upload to the FTP/SFTP
server. The suffix represents the encoding type of the file, typically
"UTF-8".

18.

createDataUploadConfigForGlobalUnsub
Source code
Description: Creates a data upload configuration to perform a global unsubscribe. Introduced in
e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: createDataUploadConfigForGlobalUnsubRequest (soap:body, use = literal) Source
code
parameters type createDataUploadConfigForGlobalUnsub
Creates a data upload configuration to perform a global unsubscribe. Introduced in
e-Dialog Web Services 1.0.
emailNotification - optional, unbounded; type string
The e-mail address to which to send notifications.
Output: createDataUploadConfigForGlobalUnsubResponse (soap:body, use = literal) Source
code
parameters type createDataUploadConfigForGlobalUnsubResponse
dataUploadConfig type dataUploadConfigType
Complex type that describes a data upload configuration.
configId type int
The ID of a data upload configuration.
filenamePatternPrefix type string
The prefix of the filename(s) for files that you upload to the FTP/SFTP
server. Dynamic DataSYNC uses the file naming convention prefix*.suffix
where * is a unique identifier string. For example, if the upload
configuration prefix is "DEMO", the filename prefix is something like
"DEMO_DDSDK_S1234567_20081230".
filenamePatternSuffix type string
The suffix of the filename(s) for files that you upload to the FTP/SFTP
server. The suffix represents the encoding type of the file, typically
"UTF-8".

19.

createDataUploadConfigForNewAudience
Source code
Description: Creates a data upload configuration for a new audience list based on a defined Class ID.
Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

14 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

Input: createDataUploadConfigForNewAudienceRequest (soap:body, use = literal) Source
code
parameters type createDataUploadConfigForNewAudience
Creates a data upload configuration for a new audience list based on a defined Class
ID. Introduced in e-Dialog Web Services 1.0.
classId type int
The ID of the audience class in the data dictionary, which binds an audience list
to a specific set of member columns in the master database. See
audienceClassType.
namePrefix type string
Tthe filename prefix for data files associated with the upload configuration. Data
filenames consist of a prefix followed by a unique identifer. For example, if you
specify a prefix of "DEMO", an actual filename prefix would be something like:
"DEMO_DDSDK_S1234567_20081230".
udf - optional, nillable; type string
Optional. A list/array of strings containing user-defined field (UDF) values with
which to categorize the new audience list. Each string can be up to 30
characters. The order of the UDF values was defined by your account team as
part of your initial setup process. e-Dialog recommends that you use only the
UDF values that were defined at setup time for categorization purposes.
emailNotification - optional, unbounded; type string
The e-mail address to which to send notifications.
Output: createDataUploadConfigForNewAudienceResponse (soap:body, use = literal) Source
code
parameters type createDataUploadConfigForNewAudienceResponse
config type dataUploadConfigType
Complex type that describes a data upload configuration.
configId type int
The ID of a data upload configuration.
filenamePatternPrefix type string
The prefix of the filename(s) for files that you upload to the FTP/SFTP
server. Dynamic DataSYNC uses the file naming convention prefix*.suffix
where * is a unique identifier string. For example, if the upload
configuration prefix is "DEMO", the filename prefix is something like
"DEMO_DDSDK_S1234567_20081230".
filenamePatternSuffix type string
The suffix of the filename(s) for files that you upload to the FTP/SFTP
server. The suffix represents the encoding type of the file, typically
"UTF-8".

20.

createDataUploadConfigForNewSuppression
Source code
Description: Creates a data upload configuration for a new suppression list based on a default Class
ID 98. Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: createDataUploadConfigForNewSuppressionRequest (soap:body, use = literal) Source
code
parameters type createDataUploadConfigForNewSuppression
Creates a data upload configuration for a new suppression list based on a default Class
ID 98. Introduced in e-Dialog Web Services 1.0.
namePrefix type string
The filename prefix for data files associated with the upload configuration. Data
filenames consist of a prefix followed by a unique identifer. For example, if you
specify a prefix of "DEMO", an actual filename prefix would be something like:
"DEMO_DDSDK_S1234567_20081230".
udf - optional, nillable; type string
Optional. A list/array of strings containing user-defined field (UDF) values with
which to categorize the new suppression list. Each string can be up to 30
characters. The order of the UDF values was defined by your account team as
part of your initial setup process. e-Dialog recommends that you use only the
UDF values that were defined at setup time for categorization purposes.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

15 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

emailNotification - optional, unbounded; type string
The e-mail address to which to send notifications.
Output: createDataUploadConfigForNewSuppressionResponse (soap:body, use =
literal) Source code
parameters type createDataUploadConfigForNewSuppressionResponse
config type dataUploadConfigType
Complex type that describes a data upload configuration.
configId type int
The ID of a data upload configuration.
filenamePatternPrefix type string
The prefix of the filename(s) for files that you upload to the FTP/SFTP
server. Dynamic DataSYNC uses the file naming convention prefix*.suffix
where * is a unique identifier string. For example, if the upload
configuration prefix is "DEMO", the filename prefix is something like
"DEMO_DDSDK_S1234567_20081230".
filenamePatternSuffix type string
The suffix of the filename(s) for files that you upload to the FTP/SFTP
server. The suffix represents the encoding type of the file, typically
"UTF-8".

21.

createGrid
Source code
Description: Creates a grid for use in content, Each column of the grid represents a symbol. Each row
contains string values to merge into the content. The first column of the grid contains key
values used to determine the content to merge for each recipient. Introduced in e-Dialog
Web Services 1.3.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: createGridRequest (soap:body, use = literal) Source code
parameters type createGrid
Creates a grid for use in content, Each column of the grid represents a symbol. Each
row contains string values to merge into the content. The first column of the grid
contains key values used to determine the content to merge for each recipient.
Introduced in e-Dialog Web Services 1.3.
name type string
Required. A name for the grid. The name must be unique; no other grids can
have the same name.
description - optional; type string
Optional. A description of the grid.
row - unbounded; type GridRowType
A list/array of grid row contents as defined in a GridRowType.
Complex type. Contains the unique key for the row, and a name/value
pair for each column in the row.
column - unbounded; type GridColumnType
Grid columns
A name/value pair that specifies the column name and
value for that column in that row. If there is no value, you
can omit the name/value pair entirely.
name - required; type string
The name of the grid column.
value - required; type string
The value of the grid column.
key - required; type string
The value in the key column for the row.
Output: createGridResponse (soap:body, use = literal) Source code
parameters type createGridResponse
gridId type int
The identifier of the new grid.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

16 of 155

22.

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

createMailing
Source code
Description: Creates a new mailing. Throws an exception if the alternate key already exists in the
database (not null). Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: createMailingRequest (soap:body, use = literal) Source code
parameters type createMailing
Creates a new mailing. Throws an exception if the alternate key already exists in the
database (not null). Introduced in e-Dialog Web Services 1.0.
campaignId type int
Optional. The ID of the campaign in which to create the mailing. There is no
default value; an empty/null or zero campaignId specifies that the mailing should
not be located within a campaign (correct for automated mailings). Mailings
created this way appear in eReports but may not be visible in the Campaign
Builder graphical user interface.
name type string
Required. A string, up to 64 characters. The name of the mailing.
description - nillable; type string
Optional. A string up to 224 characters. A description for the mailing.
udf - optional; type string
Optional. A list/array of strings containing user-defined field (UDF) values with
which to categorize the object. Each string can be up to 30 characters. The
order of the UDF values was defined by your account team as part of your initial
setup process. e-Dialog recommends that you use only the UDF values that
were defined at setup time for categorization purposes.
alternateKey - nillable; type string
Optional. A user-provided unique key to use for this mailing. See
lookupMailingByAlternateKey.
Output: createMailingResponse (soap:body, use = literal) Source code
parameters type createMailingResponse
resultMailingId type int
The ID of the newly created mailing.

23.

createRTMConfiguration
Source code
Description: Creates a new realtime messaging configuration. Introduced in e-Dialog Web Services
1.2.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: createRTMConfigurationRequest (soap:body, use = literal) Source code
parameters type createRTMConfiguration
Creates a new realtime messaging configuration. Introduced in e-Dialog Web Services
1.2.
messageName type string
Required. The name of the configuration.
queueName - optional; type string
Optional. The name of the queue to handle the requests. If specified, the value
must be a name obtained by calling listRTMQueues. If null, a default queue is
used.
notificationAddress - optional, unbounded; type string
Optional. An array or list of e-mail addresses to notify for errors when
processing requests.
clonePeriod type string
Required. The period to automatically clone the cells associated with this RTM
configuration. Valid values include "NEVER", "DAILY", "WEEKLY",
"MONTHLY".
timeZone - optional; type string
THIS FEATURE IS NOT ENABLED. Optional. Timezone information is currently
persisted, but not used. Timezone for cell cloning and audience rollup. Use a TZ
zone name from the Olson database (for example, "America/Los_Angeles" or

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

17 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

specify the offset from GMT using the format GMT[+|-]HH:MM.
audienceClassId - optional; type int
Optional. An audience class identifier. The audience class will be used when
creating new audience lists at the beginning of the audience rollup period. The
audience class defines the set of fields available for storage. If not specified, a
default audience class is selected.
audienceRollupPeriod type string
Required. The period for which an audience is used and a new audience is
created. Valid values include "NEVER", "DAILY", "WEEKLY", "MONTHLY". At
the end of the period, a new audience is created and RTM requests sent to this
configuration will use the new audience for storing data associated with the
sendMessage/sendProofMessage requests.
Output: createRTMConfigurationResponse (soap:body, use = literal) Source code
parameters type createRTMConfigurationResponse
Empty response indicates success.

24.

createTabSeparatedGrid
Source code
Description: Creates a grid for use in content, based on tab-delimited data. Each column of the grid
represents a symbol. Each row contains string values to merge into the content. The first
column of the grid contains key values used to determine the content to merge for each
recipient. Introduced in e-Dialog Web Services 1.3.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: createTabSeparatedGridRequest (soap:body, use = literal) Source code
parameters type createTabSeparatedGrid
Creates a grid for use in content, based on tab-delimited data. Each column of the grid
represents a symbol. Each row contains string values to merge into the content. The
first column of the grid contains key values used to determine the content to merge for
each recipient. Introduced in e-Dialog Web Services 1.3.
name type string
Required. A name for the grid. The name must be unique; no other grids can
have the same name.
description - optional; type string
Optional. A description of the grid.
tabSeparatedData type string
The grid data that is stored using tab-separated-values.
Output: createTabSeparatedGridResponse (soap:body, use = literal) Source code
parameters type createTabSeparatedGridResponse
gridId type int
The identifier of the new grid.

25.

createXmlGrid
Source code
Description: Creates a grid for use in content from XML. Each column of the grid represents a symbol.
Each row contains string values to merge into the content. The first column of the grid
contains key values used to determine the content to merge for each recipient. Introduced
in e-Dialog Web Services 1.3.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: createXmlGridRequest (soap:body, use = literal) Source code
parameters type createXmlGrid
Creates a grid for use in content from XML. Each column of the grid represents a
symbol. Each row contains string values to merge into the content. The first column of
the grid contains key values used to determine the content to merge for each recipient.
Introduced in e-Dialog Web Services 1.3.
name type string
Required. A name for the grid. The name must be unique; no other grids can

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

18 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

have the same name.
description - optional; type string
Optional. A description of the grid.
xmlData type string
The grid data that is stored as XML.
Output: createXmlGridResponse (soap:body, use = literal) Source code
parameters type createXmlGridResponse
gridId type int
The identifier of the new grid.

26.

deleteAllRTMVariations
Source code
Description: Removes all RTM variations from an RTM configuration. Introduced in e-Dialog Web
Services 1.2.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: deleteAllRTMVariationsRequest (soap:body, use = literal) Source code
parameters type deleteAllRTMVariations
Removes all RTM variations from an RTM configuration. Introduced in e-Dialog Web
Services 1.2.
messageName type string
Required. The name of the RTM configuration to update.
Output: deleteAllRTMVariationsResponse (soap:body, use = literal) Source code
parameters type deleteAllRTMVariationsResponse
Complex type. Includes RTM configuration information. The RTM configuration is not
deleted, just its variations.
messageName type string
RTM configuration name.
queueName type string
Queue where messages directed to this RTM configuration are directed.
notificationAddress - optional, unbounded; type string
A list/array of e-mail addresses to notify for errors or events while processing
the RTM messages.
audienceClassId - optional; type int
Audiences created while processing messages directed to this RTM
configuration are created using this audience class.
clonePeriod type string
Cloning period of the cells associated with this RTM configuration.
cloningTimeZone type string
(Reserved field. Not yet functional.) Cloning will occur according to this
timezone.
audienceAlternateKeySelectionExpression - optional; type string
Audiences created while processing messages directed to this RTM
configuration are given an alternate key as defined by this expression.
audienceNamingExpression - optional; type string
Audiences created while processing messages directed to this RTM
configuration are given a name as defined by this expression.
audienceUDFExpression - optional, nillable; type string
Audiences created while processing messages directed to this RTM
configuration are given UDFs as defined by these expressions.
lastClonedDate - optional; type dateTime
Timestamp to indicate when the cells were most recently cloned.
productionCellId - optional; type int
Cell identifier for production messages. This value has no effect when the RTM
configuration has been configured with variations.
testCellId - optional; type int
Cell identifier for proof messages. This value has no effect when the RTM
configuration has been configured with variations.
variationConfiguration - optional; type RTMVariationsSettingsType
The variation configuration to use for this realtime message. Empty (null) if this
RTM has not been configured with variations.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

19 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

variationSelectionExpression type string
This expression is evaluated with each message directed to the RTM
configuration to select one of the RTM variations.
variation - unbounded; type RTMVariationType - extension of type
RTMVariationEntryType
A list/array of RTM variations associated with an RTM configuration.
variationKey type string
When the variation selection expression resolves to this value,
sendProofMessages are sent using the test cell and
sendMessages are sent using the production cell.
testCellId - optional; type int
Cell identifier for proof messages.
productionCellId - optional; type int
Cell identifier for production messages.

27.

deleteAudience
Source code
Description: Deletes an audience. Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: deleteAudienceRequest (soap:body, use = literal) Source code
parameters type deleteAudience
Deletes an audience. Introduced in e-Dialog Web Services 1.0.
audienceId type int
Required. The ID of the audience to delete.
Output: deleteAudienceResponse (soap:body, use = literal) Source code
parameters type deleteAudienceResponse
Empty response indicates success.

28.

deleteCampaign
Source code
Description: Deletes a campaign. Throws an exception on failure (the campaign does not exist, was
previously deleted, or has any mailings or cells that are in a state in which they cannot be
deleted (actively mailing or proofing). Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: deleteCampaignRequest (soap:body, use = literal) Source code
parameters type deleteCampaign
Deletes a campaign. Throws an exception on failure (the campaign does not exist, was
previously deleted, or has any mailings or cells that are in a state in which they cannot
be deleted (actively mailing or proofing). Introduced in e-Dialog Web Services 1.0.
campaignId type int
Required. The ID of the campaign to delete.
Output: deleteCampaignResponse (soap:body, use = literal) Source code
parameters type deleteCampaignResponse
Empty response indicates success.

29.

deleteCell
Source code
Description: Deletes the specified cell. You cannot delete a cell whose status is "Mailed." Introduced
in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: deleteCellRequest (soap:body, use = literal) Source code
parameters type deleteCell
Deletes the specified cell. You cannot delete a cell whose status is "Mailed."

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

20 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

Introduced in e-Dialog Web Services 1.0.
cellId type int
Required. The ID of the cell to delete.
Output: deleteCellResponse (soap:body, use = literal) Source code
parameters type deleteCellResponse
Empty response indicates success.

30.

deleteContent
Source code
Description: Marks content object as deleted. Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: deleteContentRequest (soap:body, use = literal) Source code
parameters type deleteContent
Marks content object as deleted. Introduced in e-Dialog Web Services 1.0.
contentId type int
Required. Database identifier of content object to mark as deleted.
Output: deleteContentResponse (soap:body, use = literal) Source code
parameters type deleteContentResponse
Empty response indicates success.

31.

deleteGrid
Source code
Description: Deletes a grid. If you delete a grid that is used in a mail that has not yet been mailed, the
symbols will resolve correctly. However, you cannot use a deleted grid in another cell.
Introduced in e-Dialog Web Services 1.3.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: deleteGridRequest (soap:body, use = literal) Source code
parameters type deleteGrid
Deletes a grid. If you delete a grid that is used in a mail that has not yet been mailed,
the symbols will resolve correctly. However, you cannot use a deleted grid in another
cell. Introduced in e-Dialog Web Services 1.3.
gridId type int
Required. The identifier of the grid to delete.
Output: deleteGridResponse (soap:body, use = literal) Source code
parameters type deleteGridResponse
Empty response indicates success.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

21 of 155

32.

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

deleteMailing
Source code
Description: Deletes a mailing. Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: deleteMailingRequest (soap:body, use = literal) Source code
parameters type deleteMailing
Deletes a mailing. Introduced in e-Dialog Web Services 1.0.
mailingId type int
Required. The ID of the mailing to delete.
Output: deleteMailingResponse (soap:body, use = literal) Source code
parameters type deleteMailingResponse
Empty response indicates success.

33.

deleteRTMConfiguration
Source code
Description: Deletes a realtime messaging configuration. Introduced in e-Dialog Web Services 1.2.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: deleteRTMConfigurationRequest (soap:body, use = literal) Source code
parameters type deleteRTMConfiguration
Deletes a realtime messaging configuration. Introduced in e-Dialog Web Services 1.2.
messageName type string
Required. The name of the RTM configuration to delete.
Output: deleteRTMConfigurationResponse (soap:body, use = literal) Source code
parameters type deleteRTMConfigurationResponse
Empty response indicates success.

34.

downloadAudience
Source code
Description: Retrieves an audience. Introduced in e-Dialog Web Services 1.2.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: downloadAudienceRequest (soap:body, use = literal) Source code
parameters type downloadAudience
Retrieves an audience. Introduced in e-Dialog Web Services 1.2.
audienceId type int
Required. The ID of the audience to download.
column - optional, unbounded; type string
Optional. The sets of columns to download. Null or empty array will download all
columns (except those encrypted). To get all columns, leave this blank.
option - optional, unbounded; type OptionType
Optional. A list/array of name-value pairs to modify the downloaded audience
file. You can use these options to compress the audience file, specify field and
record separator characters, include non-standard columns, encrypt the
audience file, and so on.
Required. Complex type.
name type string
Name of the option or property. Options include
COMPRESSION_METHOD, INCLUDE_CID,
CHARACTER_ENCODING, FIELD_SEPARATOR,
RECORD_SEPARATOR.
value type string
Value for the option or property.
Output: downloadAudienceResponse (soap:body, use = literal) Source code
parameters type downloadAudienceResponse

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

22 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

audienceId type int
The ID of the downloaded audience.
property - optional, unbounded; type OptionType
A set of name-value pairs with meta-data properties about the audience file.
Required. Complex type.
name type string
Name of the option or property. Options include
COMPRESSION_METHOD, INCLUDE_CID,
CHARACTER_ENCODING, FIELD_SEPARATOR,
RECORD_SEPARATOR.
value type string
Value for the option or property.
audienceFile type base64Binary
The SOAP attachment. If you use Java (Axis2 or JAX-WS) this is returned as a
javax.activation.DataHandler. By default the attachment is compressed using the
GZIP algorithm.

35.

getCellContentId
Source code
Description: Returns the content ID assigned to the cell. Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: getCellContentIdRequest (soap:body, use = literal) Source code
parameters type getCellContentId
Returns the content ID assigned to the cell. Introduced in e-Dialog Web Services 1.0.
cellId type int
Required. The ID of the cell for which you want to look up the content ID. See
also lookupCellById and lookupCellByAlternateKey.
Output: getCellContentIdResponse (soap:body, use = literal) Source code
parameters type getCellContentIdResponse
contentId type int
The content ID associated with the specified cell.

36.

getDeliverabilityReport
Source code
Description: Returns mailing information for a specific EventType (Undeliverable, Unsubscribe, Spam)
in a given date range. The results are grouped based on the 'Dimension' filters passed in.
Only 2 dimensions are allowed at a time. Some of the dimensions can take 'null' which
means group by all possible values.. The report can be broken down into different
dimensions: 1. CELLID - Single cellI ID (123) or all cell IDs (null) 2. DOMAIN - Domain to
which the mailing was sent/received. '***OTHER***' if the domain is not tracked.\ 3. TIME Group the results hourly (h) or daily (d). This cannot be 'null' 4. CATEGORY - Only valid
for "Undeliverable" 5. SOURCE - Only valid for "Undeliverable" and "Unsubscribe" events
"Undeliverables" can be by email (Undel_via_email) or by some other source (Undel).
"Unsubscribes" can be by email (unsub_via_email) or some other source (unsub) 6.
UNDELTYPE - Only valid for "Undeliverables" Valid values are 't' (temporary) and 'p'
(permanent) Valid start and end date are required. Null is reserved for the future.
Introduced in e-Dialog Web Services 1.4.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: getDeliverabilityReportRequest (soap:body, use = literal) Source code
parameters type getDeliverabilityReport - extension of type
DateRangeReportRequestType - extension of type DateRangeReportRequestType
Returns mailing information for a specific EventType (Undeliverable, Unsubscribe,
Spam) in a given date range. The results are grouped based on the 'Dimension' filters
passed in. Only 2 dimensions are allowed at a time. Some of the dimensions can take
'null' which means group by all possible values.. The report can be broken down into
different dimensions: 1. CELLID - Single cellI ID (123) or all cell IDs (null) 2. DOMAIN Domain to which the mailing was sent/received. '***OTHER***' if the domain is not
tracked.\ 3. TIME - Group the results hourly (h) or daily (d). This cannot be 'null' 4.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

23 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

CATEGORY - Only valid for "Undeliverable" 5. SOURCE - Only valid for
"Undeliverable" and "Unsubscribe" events "Undeliverables" can be by email
(Undel_via_email) or by some other source (Undel). "Unsubscribes" can be by email
(unsub_via_email) or some other source (unsub) 6. UNDELTYPE - Only valid for
"Undeliverables" Valid values are 't' (temporary) and 'p' (permanent) Valid start and end
date are required. Null is reserved for the future. Introduced in e-Dialog Web Services
1.4.
startDate - nillable; type dateTime
The start date of the range to be examined
endDate - nillable; type dateTime
The end date of the ranged to be examined
dimension - optional, unbounded; type DimensionType
The name of a dimension (e.g. "Cell", "Domain", etc.)
name - required; type string
filterValue - optional; type string
eventType type string
You can use the getDeliverabilityReport function to analyze the performance of
email campaigns. Mailing results for UNDELIVERABLE, SPAM, and
UNSUBSCRIBE events can be specified over a period of time. Introduced in
e-Dialog Web Services 1.4.
Output: getDeliverabilityReportResponse (soap:body, use = literal) Source code
parameters type getDeliverabilityReportResponse - extension of type
DateRangeReportResponseType - extension of type DateRangeReportResponseType
dimension - optional, unbounded; type string
The name of a dimension (e.g. "Cell", "Domain", etc.)
record - optional, unbounded; type RecordType
dimensionValue - optional, unbounded; type string
count type int

37.

getEReportsRefreshStatus
Source code
Description: Get the status of the eReports refresh. Introduced in e-Dialog Web Services 1.3.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: getEReportsRefreshStatusRequest (soap:body, use = literal) Source code
parameters type getEReportsRefreshStatus
Get the status of the eReports refresh. Introduced in e-Dialog Web Services 1.3.
mailingId type int
The unique identifier of the mailing for which to retrieve refresh status.
Output: getEReportsRefreshStatusResponse (soap:body, use = literal) Source code
parameters type getEReportsRefreshStatusResponse
mailingId type int
Unique identifier of the mailing.
name - nillable; type string
Name of the mailing.
status type string
Status of the most recently requested or executed eReports refresh for the
mailing. Status can be: SCHEDULED, CANCELLED, RUNNING, FAILED,
SUCCESS.
scheduleDate - nillable; type dateTime
Date when eReports was scheduled to be refreshed.
startDate - nillable; type dateTime
Date when the refresh started.
endDate - nillable; type dateTime
Date when the refresh completed.

38.

getExportJobStatus
Source code

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

24 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

Description: Returns the status of the export job associated with the cell (ExportJobStatus object).
Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: getExportJobStatusRequest (soap:body, use = literal) Source code
parameters type getExportJobStatus
Returns the status of the export job associated with the cell (ExportJobStatus object).
Introduced in e-Dialog Web Services 1.0.
cellId type int
Required. The ID of the cell for which to get the export job status.
Output: getExportJobStatusResponse (soap:body, use = literal) Source code
parameters type getExportJobStatusResponse
status type string
The status of the export job. On of the following: "none", " running", " success", "
failure". The value "none" indicates that no exporting has ever occurred.
statusText - optional; type string
A blob with the last messages logged by the exporter.
processedRows - optional; type int
Total number of rows in the audiences associated with the cell in the last export
job. Only returned if the status is "success".
exportedRows - optional; type int
Total number of rows exported by the last export job. Only returned if the status
is "success".
exportFileName - optional; type string
Filename used by the export process. Not present if the status is "none".

39.

getGoodMailHeader
Source code
Description: (Deprecated. GoodMail no longer exists.) Returns e-mail headers for use in GoodMail.
GoodMail provides a way to guarantee the delivery of a message to an inbox. You can
use the results of this function as the parameter to updateCellHeaders(). Introduced in
e-Dialog Web Services 1.1.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: getGoodMailHeaderRequest (soap:body, use = literal) Source code
parameters type getGoodMailHeader
(Deprecated. GoodMail no longer exists.) Returns e-mail headers for use in GoodMail.
GoodMail provides a way to guarantee the delivery of a message to an inbox. You can
use the results of this function as the parameter to updateCellHeaders(). Introduced in
e-Dialog Web Services 1.1.
transactional type boolean
Whether to return headers for transactional or promotional e-mail. If true, returns
transactional headers.
Output: getGoodMailHeaderResponse (soap:body, use = literal) Source code
parameters type getGoodMailHeaderResponse
header type string
The header to use in GoodMail.

40.

getIBJobStatus
Source code
Description: Returns the status of an InsightBuilder job. Introduced in e-Dialog Web Services 1.4.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: getIBJobStatusRequest (soap:body, use = literal) Source code

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

25 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

parameters type getIBJobStatus
Returns the status of an InsightBuilder job. Introduced in e-Dialog Web Services 1.4.
jobId type int
Required. The element ID.
Output: getIBJobStatusResponse (soap:body, use = literal) Source code
parameters type getIBJobStatusResponse
state type string
Represents that status of the job

41.

getMailingVolumeReport
Source code
Description: Returns mailing volume information over a specified date range. The report can be broken
down by domain, cell (identifier), or time (day or hour) or some combination of these
dimensions. Valid dimensions include CELLID, DOMAIN, TIME. For CELLID, you can
use a cell identifier to limit the result to the specified cell. For DOMAIN, you can use a
domain name (e.g., example.com) to limit the results to mail sent to the specified domain.
Use '***OTHER***' for domains not tracked. For TIME, use HOUR or H to obtain volume
broken down per hour; use DAY or D to obtain volume broken down per day. The
response will be broken down per day if you do not specify a value for this dimension.
Valid start and end date are required. Null is reserved for the future. Introduced in
e-Dialog Web Services 1.4.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: getMailingVolumeReportRequest (soap:body, use = literal) Source code
parameters type getMailingVolumeReport - extension of type
DateRangeReportRequestType - extension of type DateRangeReportRequestType
Returns mailing volume information over a specified date range. The report can be
broken down by domain, cell (identifier), or time (day or hour) or some combination of
these dimensions. Valid dimensions include CELLID, DOMAIN, TIME. For CELLID,
you can use a cell identifier to limit the result to the specified cell. For DOMAIN, you can
use a domain name (e.g., example.com) to limit the results to mail sent to the specified
domain. Use '***OTHER***' for domains not tracked. For TIME, use HOUR or H to
obtain volume broken down per hour; use DAY or D to obtain volume broken down per
day. The response will be broken down per day if you do not specify a value for this
dimension. Valid start and end date are required. Null is reserved for the future.
Introduced in e-Dialog Web Services 1.4.
startDate - nillable; type dateTime
The start date of the range to be examined
endDate - nillable; type dateTime
The end date of the ranged to be examined
dimension - optional, unbounded; type DimensionType
The name of a dimension (e.g. "Cell", "Domain", etc.)
name - required; type string
filterValue - optional; type string
Output: getMailingVolumeReportResponse (soap:body, use = literal) Source code
parameters type getMailingVolumeReportResponse - extension of type
DateRangeReportResponseType - extension of type DateRangeReportResponseType
dimension - optional, unbounded; type string
The name of a dimension (e.g. "Cell", "Domain", etc.)
record - optional, unbounded; type RecordType
dimensionValue - optional, unbounded; type string
count type int

42.

getMemberCount
Source code
Description: Returns the actual member count and updates the audience with the current total.
Introduced in e-Dialog Web Services 1.1.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

26 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: getMemberCountRequest (soap:body, use = literal) Source code
parameters type getMemberCount
Returns the actual member count and updates the audience with the current total.
Introduced in e-Dialog Web Services 1.1.
audienceId type int
Required. The ID of the audience for which you want to compute the member
count.
Output: getMemberCountResponse (soap:body, use = literal) Source code
parameters type getMemberCountResponse
memberCount type long
The number of members in the specified audience.

43.

getProofGroupOptions
Source code
Description: Returns the settings for the proof group specified, including whether to include in proofs,
include in the final e-mail, and send multipart samples as text. Introduced in e-Dialog Web
Services 1.1.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: getProofGroupOptionsRequest (soap:body, use = literal) Source code
parameters type getProofGroupOptions
Returns the settings for the proof group specified, including whether to include in
proofs, include in the final e-mail, and send multipart samples as text. Introduced in
e-Dialog Web Services 1.1.
cellId type int
The ID of the cell for which to get proof group options.
groupNumber type int
The Lproof group (1,2, or 3).
Output: getProofGroupOptionsResponse (soap:body, use = literal) Source code
parameters type getProofGroupOptionsResponse
proofGroupOptions type ProofGroupOptionsType
Complex type that describes proof group options.
cellId type int
The ID of the cell for which to get the proof group settings.
groupNumber type int
The LProof group number (1,2,or 3).
includeInProofs type boolean
Whether to send the proof to the e-mail addresses specified in the group
(true).
includeFinalEmail type boolean
Whether to send the final e-mail to the e-mail addresses specified in the
group (true).
sendMultipartText type boolean
Whether to send multipart samples as text (true).
emailAddress - optional, unbounded, nillable; type string
A list/array of e-mail addresses to send proofs.

44.

getProofSampleSetting
Source code
Description: Gets information about the proof sample. If the sample type is Random (created with the
buildRandomProofSample function), returns the size of the sample. If the sample type is
Permutation (created with the buildPermutationProofSample function), returns a list/array
of column names. Introduced in e-Dialog Web Services 1.1.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: getProofSampleSettingRequest (soap:body, use = literal) Source code

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

27 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

parameters type getProofSampleSetting
Gets information about the proof sample. If the sample type is Random (created with
the buildRandomProofSample function), returns the size of the sample. If the sample
type is Permutation (created with the buildPermutationProofSample function), returns a
list/array of column names. Introduced in e-Dialog Web Services 1.1.
cellId type int
The ID of the cell for which to get proof sample information.
Output: getProofSampleSettingResponse (soap:body, use = literal) Source code
parameters type getProofSampleSettingResponse
proofSampleSetting type ProofSampleSettingType
Complex type that describes the proof sample properties.
sampleSize type int
The maximum number of recipients of the randomly generated sample.
columnName - optional, unbounded, nillable; type string
A list/array of column names that is the subset of rows from the full
export file.

45.

getProofSampleStatus
Source code
Description: Returns the status of the operation to build the proof sample. One of the following:
"Processing", Processed", "Failed", "None". Introduced in e-Dialog Web Services 1.1.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: getProofSampleStatusRequest (soap:body, use = literal) Source code
parameters type getProofSampleStatus
Returns the status of the operation to build the proof sample. One of the following:
"Processing", Processed", "Failed", "None". Introduced in e-Dialog Web Services 1.1.
cellId type int
The ID of the cell for which to get information about the sample build process.
Output: getProofSampleStatusResponse (soap:body, use = literal) Source code
parameters type getProofSampleStatusResponse
ProofSampleStatus type ProofSampleStatusType
Complex type that includes the proof status and status message.
status type string
The status of the proof build operation: Processing, None, Failed,
Processed.
statusMessage - optional; type string
The message that includes additional information about the proof build
process status.

46.

hideContent
Source code
Description: Marks content object as hidden, which results if it is not appearing in listContent results.
However, you can look up hidden content with the lookupContentByAlternateKey() and
lookupContentById() functions. You cannot hide content that is a cell’s main content item.
Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: hideContentRequest (soap:body, use = literal) Source code
parameters type hideContent
Marks content object as hidden, which results if it is not appearing in listContent results.
However, you can look up hidden content with the lookupContentByAlternateKey() and
lookupContentById() functions. You cannot hide content that is a cell’s main content
item. Introduced in e-Dialog Web Services 1.0.
contentId type int
Required. The ID of the content object to hide.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

28 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

Output: hideContentResponse (soap:body, use = literal) Source code
parameters type hideContentResponse
Empty response indicates success.

47.

listAllDataColumns
Source code
Description: Gets a list of defined data column information from the data dictionary. Introduced in
e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listAllDataColumnsRequest (soap:body, use = literal) Source code
parameters type listAllDataColumns
Gets a list of defined data column information from the data dictionary. Introduced in
e-Dialog Web Services 1.0.
Output: listAllDataColumnsResponse (soap:body, use = literal) Source code
parameters type listAllDataColumnsResponse
column - optional, unbounded; type dataColumnType
Complex type that represents a row in the data dictionary. Each row describes a
column in the database.
dictionaryId type int
The unique ID for a row in the data dictionary. Each row contains
information about a column in the master database.
tableName type string
The name of the table that contains the data column described in the
data dictionary.
columnName type string
The name of the data column described in the data dictionary.
columnType type string
The data type of the data column described in the data dictionary.
maxLength - optional; type string
The maximum number of characters stored in the data column described
in the data dictionary.
dateTypeFormat - optional; type string
The format (if applicable) of the data column stored in the data dictionary.

48.

listAudienceClasses
Source code
Description: Lists all audience classes available in the master database. An audience class binds an
audience list to a specific set of member columns in the master database. Introduced in
e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listAudienceClassesRequest (soap:body, use = literal) Source code
parameters type listAudienceClasses
Lists all audience classes available in the master database. An audience class binds an
audience list to a specific set of member columns in the master database. Introduced
in e-Dialog Web Services 1.0.
Output: listAudienceClassesResponse (soap:body, use = literal) Source code
parameters type listAudienceClassesResponse
class - optional, unbounded; type audienceClassType
A list/array of audienceClassType elements, each of which describes a class
available in the master database.
Complex type. An audience class binds an audience list to a specific set of
member columns in the master database.
classId type int
The ID that identifies an audience class in the data dictionary, which
binds an audience list to a specific set of member columns in the master

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

29 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

database.
name type string
The name of the class.
column - optional, unbounded; type string
A list/array of strings, each containing a data dictionary row identifier.
Each data dictionary row describes a member column in the master
database.

49.

listAudiences
Source code
Description: (Deprecated. Use the service listAudiencesByFilter) Lists the available audiences, using
the specified filter settings. Does not list audiences that have a status of ARCHIVE,
ARCHIVED, INACTIVE, or DELETED. The filter* arguments are optional arguments used
to filter the results. Dates in date ranges are inclusive. Introduced in e-Dialog Web
Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listAudiencesRequest (soap:body, use = literal) Source code
parameters type listAudiences
(Deprecated. Use the service listAudiencesByFilter) Lists the available audiences,
using the specified filter settings. Does not list audiences that have a status of
ARCHIVE, ARCHIVED, INACTIVE, or DELETED. The filter* arguments are optional
arguments used to filter the results. Dates in date ranges are inclusive. Introduced in
e-Dialog Web Services 1.0.
filterType - nillable; type string
Optional. The type of mailing to return. One of the following: "Membership",
"Suppression" or "Proof". Leave null/blank to search all audience types.
filterNameExpression - nillable; type string
Optional. An expression that conforms to the syntax of the ANSI SQL LIKE
operator (sometimes referred to as the LIKE predicate). See the Developer's
Guide for details.
filterStartCreateDate - nillable; type dateTime
Optional. Lets you search for audiences created in the specified date range.
Leave this null if you do not want to include it as part of the search criteria.
filterEndCreateDate - nillable; type dateTime
Optional. Lets you search for audiences created in the specific date range.
Leave this null if you do not want to include it as part of the search criteria.
sortBy - optional, unbounded; type string
Optional. A list/array of mailing attribute names (in any order) used to sort the
results: "name", "id", or "createDate". If no sortBy criteria is provided, the results
are sorted by "createDate". Note: it probably doesn’t make sense to sort for
campaigns by more than one field at a time; however multiple sort-by criteria are
allowed for consistency with mailing and cell functions.
pageSize type int
Required. The maximum number of items to return each time you call the list
function (the page size). Must be a positive integer.
pageNumber type int
Required. Used for pagination of results. Indicates which page number to return,
where each page (list function call) returns the number of items specified by
pageSize.
Output: listAudiencesResponse (soap:body, use = literal) Source code
parameters type listAudiencesResponse
audienceList type audienceListType
Complex type that describes a list of audiences and includes a list/array of
audienceOverviewType structures.
currentPageNumber type int
Currently displayed page of audiences.
totalNumberOfRows type int
The number of audience lists that exist in the database as of the most
recent listAudiencesRequest. You can use this number to page through
the list.
totalNumberOfPages type int
The number of pages found by the most recent listAudiencesRequest.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

30 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

(See listAudiencesRequest.pageSize.)
audience - optional, unbounded; type audienceOverviewType
A list/array of audienceOverviewType complex types that includes
information about each audience.
Complex type that describes an audience list.
audienceId type int
The ID of the audience.
audienceType type string
Intended use of the audience. Either "Membership" or
"Suppression".
audienceClassId type int
The ID of an audience class in the data dictionary, which binds an
audience list to a specific set of member columns in the master
database.
singleUse type boolean
Whether the audience was created as a single-use audience or a
reusable audience.
name - nillable; type string
The name of the audience.
udf - nillable; type string
A list/array of strings containing user-defined field (UDF) values
used to categorize the object. Each string can be up to 30
characters. The order of the UDF values was defined by your
account team as part of your initial setup process.
createDate type dateTime
The date when the audience was created.
updateDate type dateTime
The date when the audience list was most recently updated.
alternateKey - nillable; type string
A user-supplied key to identify the created audience.
estimatedMemberCount type int
The number of members of the audience as of the most recent
data upload, or in the case of an Insight Builder audience, the
number of members at audience generation time.

50.

listAudiencesByFilter
Source code
Description: Lists the available audiences using the specified filter settings. Does not list audiences
that have a status of DELETED. The filter* arguments are optional arguments used to
filter the results. Dates in date ranges are inclusive. Introduced in e-Dialog Web Services
1.3.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listAudiencesByFilterRequest (soap:body, use = literal) Source code
parameters type listAudiencesByFilter
Lists the available audiences using the specified filter settings. Does not list audiences
that have a status of DELETED. The filter* arguments are optional arguments used to
filter the results. Dates in date ranges are inclusive. Introduced in e-Dialog Web
Services 1.3.
filterType - nillable; type string
Optional. The type of mailing to return. One of the following: "Membership",
"Suppression" or "Proof". Leave null/blank to search all audience types.
filterNameExpression - nillable; type string
Optional. An expression that conforms to the syntax of the ANSI SQL LIKE
operator (sometimes referred to as the LIKE predicate). See the Developer's
Guide for details.
filterStartCreateDate - nillable; type dateTime
Optional. Lets you search for audiences created in the specified date range.
Leave this null if you do not want to include it as part of the search criteria.
filterEndCreateDate - nillable; type dateTime
Optional. Lets you search for audiences created in the specific date range.
Leave this null if you do not want to include it as part of the search criteria.
filterStartUpdateDate - nillable; type dateTime
Optional. Lets you search for audiences updated in the specified date range.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

31 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

Leave this null if you do not want to include it as part of the search criteria.
filterEndUpdateDate - nillable; type dateTime
Optional. Lets you search for audiences updated in the specific date range.
Leave this null if you do not want to include it as part of the search criteria.
sortBy - optional, unbounded; type string
Optional. A list/array of mailing attribute names (in any order) used to sort the
results: "name", "id", or "createDate", "updateDate". If no sortBy criteria is
provided, the results are sorted by "createDate". Note: it probably doesn’t make
sense to sort for campaigns by more than one field at a time; however multiple
sort-by criteria are allowed for consistency with mailing and cell functions.
pageSize type int
Required. The maximum number of items to return each time you call the list
function (the page size). Must be a positive integer.
pageNumber type int
Required. Used for pagination of results. Indicates which page number to return,
where each page (list function call) returns the number of items specified by
pageSize.
Output: listAudiencesByFilterResponse (soap:body, use = literal) Source code
parameters type listAudiencesByFilterResponse
audienceList type audienceListWithStatusType
List/array of audiences that meet the criteria specified in the filters.
Complex type that describes a list of audiences and includes a list/array of
audienceOverviewType structures.
currentPageNumber type int
Currently displayed page of audiences.
totalNumberOfRows type int
The number of audience lists that exist in the database as of the most
recent listAudiencesRequest. You can use this number to page through
the list.
totalNumberOfPages type int
The number of pages found by the most recent listAudiencesRequest.
(See listAudiencesRequest.pageSize.)
audienceWithStatus - optional, unbounded; type
audienceOverviewWithStatusType
A list/array of audienceOverviewType complex types that includes
information about each audience.
Complex type that describes an audience list.
audienceId type int
The ID of the audience.
audienceType type string
Intended use of the audience. Either "Membership" or
"Suppression".
audienceStatus type string
Audience status can be Membership, Proof, Suppression
audienceClassId type int
The ID of an audience class in the data dictionary, which binds an
audience list to a specific set of member columns in the master
database.
singleUse type boolean
Whether the audience was created as a single-use audience or a
reusable audience.
name - nillable; type string
The name of the audience.
udf - nillable; type string
A list/array of strings containing user-defined field (UDF) values
used to categorize the object. Each string can be up to 30
characters. The order of the UDF values was defined by your
account team as part of your initial setup process.
createDate type dateTime
The date when the audience was created.
updateDate type dateTime
The date when the audience list was most recently updated.
alternateKey - nillable; type string
A user-supplied key to identify the created audience.
estimatedMemberCount type int

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

32 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

The number of members of the audience as of the most recent
data upload, or in the case of an Insight Builder audience, the
number of members at audience generation time.

51.

listAudienceUdfs
Source code
Description: Returns a list/array of all available values for each of the five audience UDFs. Introduced
in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listAudienceUdfsRequest (soap:body, use = literal) Source code
parameters type listAudienceUdfs
Returns a list/array of all available values for each of the five audience UDFs.
Introduced in e-Dialog Web Services 1.0.
Output: listAudienceUdfsResponse (soap:body, use = literal) Source code
parameters type listAudienceUdfsResponse
udfValueList type udfValueListType
A list/array of strings that contain UDF values.
udfValue - optional, unbounded; type string
A list/array of strings containing all predefined values available for a
particular user-defined field (UDF). These values are created by your
account team at initial setup time for categorization purposes. Each string
can be up to 30 characters.

52.

listAvailableMeters
Source code
Description: Returns a list of available metering schemes. Introduced in e-Dialog Web Services 1.1.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listAvailableMetersRequest (soap:body, use = literal) Source code
parameters type listAvailableMeters
Returns a list of available metering schemes. Introduced in e-Dialog Web Services 1.1.
Output: listAvailableMetersResponse (soap:body, use = literal) Source code
parameters type listAvailableMetersResponse
meter - optional, unbounded; type string
A list/array of available metering schemes.

53.

listCampaigns
Source code
Description: Returns a list of campaigns, including the ID, name, creation date, and user-defined field
values. Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listCampaignsRequest (soap:body, use = literal) Source code
parameters type listCampaigns
Returns a list of campaigns, including the ID, name, creation date, and user-defined
field values. Introduced in e-Dialog Web Services 1.0.
filterNameExpression - nillable; type string
Optional. An expression that conforms to the syntax of the ANSI SQL LIKE
operator (sometimes referred to as the LIKE predicate). See the Developer's
Guide for details.
filterCreateDateStart - nillable; type dateTime
Optional. The start of a date range in which to search for campaigns.
filterCreateDateEnd - nillable; type dateTime
Optional. The end of a date range in which to search for campaigns.
sortBy - optional, unbounded; type string

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

33 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

Optional. A list/array of campaign attribute names (in any order) used to sort the
results: "name", "id", or "createDate". The default is "createDate".
pageSize type int
Required. The maximum number of items to return each time you call the list
function (the page size). Must be a positive integer.
pageNumber type int
Required. Used for pagination of results. Indicates which page number to return
where each page (list function call) returns the number of items specified by
pageSize. Must be a positive integer.
Output: listCampaignsResponse (soap:body, use = literal) Source code
parameters type listCampaignsResponse
campaignList type campaignListType
Complex type. A sequence of campaignOverviewType elements arranged in
pages. Each use gets the next page.
currentPageNumber type int
The number of the page returned to the most recent
listCampaignsRequest.
totalNumberOfRows type int
The number of campaigns that exist in the database as of the most
recent listCampaignsRequest. You can use this number to page through
the list.
totalNumberOfPages type int
The number of pages found by the most recent listCampaignsRequest.
(See listCampaignsRequest.pageSize.)
campaign - optional, unbounded; type campaignOverviewType
Complex type that includes the identifier, name, creation date, and
user-defined field values.
campaignId type int
The ID of the campaign.
name - nillable; type string
The name of the campaign.
createDate type dateTime
Date the campaign was created.
updateDate type dateTime
Date the campaign was updated.
udf - nillable; type string
Five user-defined field (UDF) string values used to categorize the
campaign. Each string can be up to 30 characters. Some fields
may be empty.

54.

listCampaignUdfs
Source code
Description: Returns a list/array of all available values for each of the five campaign UDFs. Introduced
in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listCampaignUdfsRequest (soap:body, use = literal) Source code
parameters type listCampaignUdfs
Returns a list/array of all available values for each of the five campaign UDFs.
Introduced in e-Dialog Web Services 1.0.
Output: listCampaignUdfsResponse (soap:body, use = literal) Source code
parameters type listCampaignUdfsResponse
udfValueList type udfValueListType
A list/array of strings that contain UDF values.
udfValue - optional, unbounded; type string
A list/array of strings containing all predefined values available for a
particular user-defined field (UDF). These values are created by your
account team at initial setup time for categorization purposes. Each string
can be up to 30 characters.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

34 of 155

55.

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

listCells
Source code
Description: (Deprecated. Use the service listCellsByFilter) Returns a list of cells filtered by the
specified settings. Returns only a limited set of cell properties. Filter settings are optional.
Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listCellsRequest (soap:body, use = literal) Source code
parameters type listCells
(Deprecated. Use the service listCellsByFilter) Returns a list of cells filtered by the
specified settings. Returns only a limited set of cell properties. Filter settings are
optional. Introduced in e-Dialog Web Services 1.0.
filterMailingId - optional, unbounded; type int
Optional. A list/array of integers that specify the set of mailing IDs to search
through. Leaving this empty/blank searches through all mailings.
filterNameExpression - nillable; type string
Optional. An expression that conforms to the syntax of the ANSI SQL LIKE
operator (sometimes referred to as the LIKE predicate). See the Developer's
Guide for details.
filterCreateDateStart - nillable; type dateTime
Optional. When used with filterCreateDateEnd, allows you to search for cells
created in a specified date range. Leave these arguments null if you do not want
to include them as part of the search criteria.
filterCreateDateEnd - nillable; type dateTime
Optional. When used with filterCreateDateStart, allows you to search for cells
created in a specified date range. Leave these arguments null if you do not want
to include them as part of the search criteria.
filterFirstMailedDateStart - nillable; type dateTime
Optional. Used to filter cells by when the first piece of final/production mail was
sent. This allows you to search for mailings sent in a specified date range.
Leave these arguments null if you do not want to include them as part of the
search criteria.
filterFirstMailedDateEnd - nillable; type dateTime
Optional. Used to filter cells by when the last piece of final/production mail was
sent. This allows you to search for mailings sent in a specified date range.
Leave these arguments null if you do not want to include them as part of the
search criteria.
filterStatus - optional, unbounded; type string
Optional. A list/array of strings that specify a set of status values to include in the
search. Values include: "Setup", "Merging", "Merged", "Proofing", "Proofed",
"Mailing", "Mailed", "Cancelled", "Failed", "Paused".
sortBy - optional, unbounded; type string
Optional. A list/array of cell attribute names (in any order) used to sort the
results: "name", "id", "createDate", or "firstMailedDate". If no sortBy criteria is
provided, the default is to sort by "createDate".
pageSize type int
Required. Specifies the maximum number of items to return each time you call
the list function (the page size). The value must be a positive integer.
pageNumber type int
Required. Used for pagination of results. Indicates which page number to return
where each page (list function call) returns the number of items specified by
pageSize. Must be a positive integer.
Output: listCellsResponse (soap:body, use = literal) Source code
parameters type listCellsResponse
cellList type cellListType
Complex type. A list/array of cellOverviewType elements arranged in pages.
Each use gets the next page.
currentPageNumber type int
The number of the page returned to the most recent listCellsRequest.
totalNumberOfRows type int
The number of cells that exist in the database as of the most recent
listCellsRequest.
totalNumberOfPages type int
The number of pages found by the most recent listCellsRequest. (See

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

35 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

listCellsRequest.pageSize.)
cell - optional, unbounded; type cellOverviewType
Complex type that describes cell properties.
campaignId type int
The ID of the campaign that contains the cell.
mailingId type int
The ID of the mailing that contains the cell.
cellId type int
The ID of the cell.
name - nillable; type string
The name of the cell. The cell name appears in reports but does
not appear in any part of a mailing sent to an audience. Cell
names cannot contain an underscore (_) or a pound sign (#).
udf - nillable; type string
Optional. A list/array of up to five user-defined field (UDF) string
values with which to categorize the cell. Each string can be up to
30 characters. e-Dialog recommends that you use only the UDF
string values that were defined by your account team as part of
your initial setup process.
createDate type dateTime
Date when the cell was created.
updateDate type dateTime
Date when the cell was last updated.
firstMailedDate - nillable; type dateTime
Date when the cell started mailing. Cells can be metered over a
period of days and, in the case of triggers, a cell can be used
over a window of time.
status type string
The status of the cell with respect to live proofing and mailing
(read-only). Setup indicates that the cell is in the process of being
set up. Lproofed indicates that live proofs have been sent. Lproof
Mailing indicates that live proofs are in the process of being sent.
Mailed indicates that final e-mail has been sent. Mailing indicates
that final e-mail is in the process of being sent.
alternateKey - nillable; type string
The alternate key of the cell (caller-supplied value used as a
unique key into the cell table).

56.

listCellsByFilter
Source code
Description: Returns a list of cells filtered by the specified settings. Returns only a limited set of cell
properties. Filter settings are optional. Introduced in e-Dialog Web Services 1.3.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listCellsByFilterRequest (soap:body, use = literal) Source code
parameters type listCellsByFilter
Returns a list of cells filtered by the specified settings. Returns only a limited set of cell
properties. Filter settings are optional. Introduced in e-Dialog Web Services 1.3.
filterMailingId - optional, unbounded; type int
Optional. A list/array of integers that specify the set of mailing IDs to search
through. Leaving this empty/blank searches through all mailings.
filterNameExpression - nillable; type string
Optional. An expression that conforms to the syntax of the ANSI SQL LIKE
operator (sometimes referred to as the LIKE predicate). See the Developer's
Guide for details.
filterCreateDateStart - nillable; type dateTime
Optional. When used with filterCreateDateEnd, allows you to search for cells
created in a specified date range. Leave these arguments null if you do not want
to include them as part of the search criteria.
filterCreateDateEnd - nillable; type dateTime
Optional. When used with filterCreateDateStart, allows you to search for cells
created in a specified date range. Leave these arguments null if you do not want
to include them as part of the search criteria.
filterFirstMailedDateStart - nillable; type dateTime

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

36 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

Optional. Used to filter cells by when the first piece of final/production mail was
sent. This allows you to search for mailings sent in a specified date range.
Leave these arguments null if you do not want to include them as part of the
search criteria.
filterFirstMailedDateEnd - nillable; type dateTime
Optional. Used to filter cells by when the last piece of final/production mail was
sent. This allows you to search for mailings sent in a specified date range.
Leave these arguments null if you do not want to include them as part of the
search criteria.
filterStatus - optional, unbounded; type string
Optional. A list/array of strings that specify a set of status values to include in the
search. Values include: "Setup", "Merging", "Merged", "Proofing", "Proofed",
"Mailing", "Mailed", "Cancelled", "Failed", "Paused".
filterUpdateDateStart - nillable; type dateTime
Optional. When used with filterUpdateDateEnd allows you to search for cells
created in a specified date range according to the last update timestamp. Leave
these arguments null if you do not want to include them as part of the search
criteria.
filterUpdateDateEnd - nillable; type dateTime
Optional. When used with filterUpdateDateStart allows you to search for cells
created in a specified date range according to the last update timestamp. Leave
these arguments null if you do not want to include them as part of the search
criteria.
filterUdf - optional; type UDFFilterType
Complex type that describes a filtering condition on a UDF.
name type string
The category name representing a particular UDF that matches an entry
in the dictionary (e.g. "Genre" ) or the string UDF followed by the number
(e.g. "UDF3").
value - unbounded; type string
A set of values expected for a UDF.
Optional. List of filtering conditions on UDFs
sortBy - optional, unbounded; type string
Optional. A list/array of cell attribute names (in any order) used to sort the
results: "name", "id", "createDate", or "firstMailedDate". If no sortBy criteria is
provided, the default is to sort by "createDate".
pageSize type int
Required. Specifies the maximum number of items to return each time you call
the list function (the page size). The value must be a positive integer.
pageNumber type int
Required. Used for pagination of results. Indicates which page number to return
where each page (list function call) returns the number of items specified by
pageSize. Must be a positive integer.
Output: listCellsByFilterResponse (soap:body, use = literal) Source code
parameters type listCellsByFilterResponse
currentPageNumber type int
The number of the page returned.
totalNumberOfRows type int
The number of cells that exist in the database.
totalNumberOfPages type int
The number of pages found.
cell - optional, unbounded; type cellOverviewType
Complex type that describes cell properties.
campaignId type int
The ID of the campaign that contains the cell.
mailingId type int
The ID of the mailing that contains the cell.
cellId type int
The ID of the cell.
name - nillable; type string
The name of the cell. The cell name appears in reports but does not
appear in any part of a mailing sent to an audience. Cell names cannot
contain an underscore (_) or a pound sign (#).
udf - nillable; type string
Optional. A list/array of up to five user-defined field (UDF) string values

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

37 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

with which to categorize the cell. Each string can be up to 30 characters.
e-Dialog recommends that you use only the UDF string values that were
defined by your account team as part of your initial setup process.
createDate type dateTime
Date when the cell was created.
updateDate type dateTime
Date when the cell was last updated.
firstMailedDate - nillable; type dateTime
Date when the cell started mailing. Cells can be metered over a period of
days and, in the case of triggers, a cell can be used over a window of
time.
status type string
The status of the cell with respect to live proofing and mailing (read-only).
Setup indicates that the cell is in the process of being set up. Lproofed
indicates that live proofs have been sent. Lproof Mailing indicates that
live proofs are in the process of being sent. Mailed indicates that final
e-mail has been sent. Mailing indicates that final e-mail is in the process
of being sent.
alternateKey - nillable; type string
The alternate key of the cell (caller-supplied value used as a unique key
into the cell table).

57.

listCellUdfCategoryNames
Source code
Description: Returns a list of category names for cell UDFs. Introduced in e-Dialog Web Services 1.1.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listCellUdfCategoryNamesRequest (soap:body, use = literal) Source code
parameters type listCellUdfCategoryNames
Returns a list of category names for cell UDFs. Introduced in e-Dialog Web Services
1.1.
Output: listCellUdfCategoryNamesResponse (soap:body, use = literal) Source code
parameters type listCellUdfCategoryNamesResponse
category - optional, unbounded; type string
A list/array of category names.

58.

listCellUdfs
Source code
Description: Returns a list/array of all available values for each of the ten cell UDFs. Introduced in
e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listCellUdfsRequest (soap:body, use = literal) Source code
parameters type listCellUdfs
Returns a list/array of all available values for each of the ten cell UDFs. Introduced in
e-Dialog Web Services 1.0.
Output: listCellUdfsResponse (soap:body, use = literal) Source code
parameters type listCellUdfsResponse
udfValueList type udfValueListType
A list/array of strings that contain UDF values.
udfValue - optional, unbounded; type string
A list/array of strings containing all predefined values available for a
particular user-defined field (UDF). These values are created by your
account team at initial setup time for categorization purposes. Each string
can be up to 30 characters.

59.

listClients

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

38 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

Source code
Description: Returns a list of clients that are available to the currently logged in user. Introduced in
e-Dialog Web Services 1.2.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listClientsRequest (soap:body, use = literal) Source code
parameters type listClients
Returns a list of clients that are available to the currently logged in user. Introduced in
e-Dialog Web Services 1.2.
Output: listClientsResponse (soap:body, use = literal) Source code
parameters type listClientsResponse
A list/array of clientListType. The first client in the list is the default client assigned to
this user.
clientList - optional, unbounded; type ClientListType
Complex type that describes a client.
clientId type long
The ID of the client.
clientName type string
The name of the client.
isAssigned type boolean
The client that is assigned to the currently logged in user.
isDefault type boolean
The client that is set as the default for the currently logged in user.

60.

listContent
Source code
Description: Returns a list of content objects. Only a limited set of properties is returned. Introduced in
e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listContentRequest (soap:body, use = literal) Source code
parameters type listContent
Returns a list of content objects. Only a limited set of properties is returned. Introduced
in e-Dialog Web Services 1.0.
filterNameExpression - nillable; type string
Optional. An expression that conforms to the syntax of the ANSI SQL LIKE
operator (sometimes referred to as the LIKE predicate). See the Developer's
Guide for details.
filterCreateDateStart - nillable; type dateTime
Optional. Used to filter against the creation date of the content. This allows you
to search for content created in a specified date range. Leave these arguments
null if you do not want to include these as part of the search criteria.
filterCreateDateEnd - nillable; type dateTime
Optional. Used to filter against the creation date of the content. This allows you
to search for content created in a specified date range. Leave these arguments
null if you do not want to include these as part of the search criteria.
sortBy - optional, unbounded, nillable; type string
Optional. A list/array of content attribute names (in any order) used to sort the
results: "name", "createDate", "udf_". If no sortBy criteria is provided, the results
are sorted by "createDate".
pageSize type int
Required. The maximum number of items to return each time you call the list
function (the page size). Must be a positive integer.
pageNumber type int
Required, used for pagination of results. Indicates which page number to return
where each page (list function call) returns the number of items specified by
pageSize. Must be a positive integer.
Output: listContentResponse (soap:body, use = literal) Source code
parameters type listContentResponse
contentList type contentListType

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

39 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

One "page" of content objects that meet the specified criteria.
Complex type. Contains list of content objects organized in pages.
currentPageNumber type int
The number of the page returned to the most recent list request.
totalNumberOfRows type int
The number of content objects that exist in the database as of the most
recent listContentRequest.
totalNumberOfPages type int
Tthe number of pages found by the most recent listContentRequest.
content - optional, unbounded; type contentItemType
A list (one page) of contentItemType structures.
hidden type boolean
Whether the content object is marked as hidden.
contentId type int
The content object identifier.
name - nillable; type string
The name of the content object.
alternateKey - nillable; type string
The alternate key used to identify the content object.
textData - nillable; type string
The content of the object for text-only e-mail messages. e-Dialog
Web Services finds links in the content and adds anchor tags (a
href=) to them.
htmlData - nillable; type string
Content data for HTML mail messages.
udf - nillable; type string
Optional list of up to five user-defined field (UDF) string values
with which to categorize the content. Each string can be up to 30
characters. e-Dialog recommends that you use only the UDF
string values that were defined by your account team as part of
your initial setup process.
createDate type dateTime
The date when the content object was created.
updateDate type dateTime
The date when the content object was most recently updated.

61.

listContentAlt
Source code
Description: Returns a list of content objects. Returns only a limited set of properties. Introduced in
e-Dialog Web Services 1.2.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listContentAltRequest (soap:body, use = literal) Source code
parameters type listContentAlt
Returns a list of content objects. Returns only a limited set of properties. Introduced in
e-Dialog Web Services 1.2.
filterNameExpression - nillable; type string
Optional. An expression that conforms to the syntax of the ANSI SQL LIKE
operator (sometimes referred to as the LIKE predicate). See the Developer's
Guide for details.
filterCreateDateStart - nillable; type dateTime
Optional. Used to filter against the creation date of the content. This allows you
to search for content created in a specified date range. Leave these arguments
null if you do not want to include them as part of the search criteria.
filterCreateDateEnd - nillable; type dateTime
Optional. Used to filter against the creation date of the content. This allows you
to search for content created in a specified date range. Leave these arguments
null if you do not want to include these as part of the search criteria.
filterUpdateDateStart - nillable; type dateTime
Optional. Used to filter against the update date of the content. This allows you to
search for content updated with in a specified date range. Leave these
arguments null if you do not want to include these as part of the search criteria.
filterUpdateDateEnd - nillable; type dateTime
Optional. Used to filter against the update date of the content. This allows you to

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

40 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

search for content updated with in a specified date range. Leave these
arguments null if you do not want to include these as part of the search criteria.
sortBy - optional, unbounded, nillable; type string
Optional. A list/array of content attribute names (in any order) used to sort the
results: "name", "createDate", "udf_". If no sortBy criteria is provided, the results
are sorted by "createDate".
pageSize type int
Required. The maximum number of items to return each time you call the list
function (the page size). Must be a positive integer.
pageNumber type int
Required. Used for pagination of results. Indicates which page number to return
where each page (list function call) returns the number of items specified by
pageSize. Must be a positive integer.
Output: listContentAltResponse (soap:body, use = literal) Source code
parameters type listContentAltResponse
contentAltList type contentListItemAltType
One "page" of content objects that meets the specified criteria.
Complex type. One page of content objects that meet specified criteria.
currentPageNumber type int
The number of the page returned to the most recent list request.
totalNumberOfRows type int
The number of content objects that exist in the database as of the most
recent listContentRequest.
totalNumberOfPages type int
The number of pages found by the most recent listContentRequest.
content - optional, unbounded; type contentItemAltType
A list (one page) of contentItemType structures.
hidden type boolean
Whether the content object is marked as hidden.
contentId type int
The content object identifier.
name - nillable; type string
The name of the content object.
fsName - nillable; type string
If available the file system name locator of the content. Only valid
for library content. For cell content this value is always null.
alternateKey - nillable; type string
The alternate key used to identify the content object.
textDataSize type int
The content size of the object for text-only e-mail messages.
e-Dialog Web Services finds links in the content and adds anchor
tags (a href=) to them.
htmlDataSize type int
Content size of the data for HTML mail messages.
landPageDataSize type int
Content size of the landing page.
udf - nillable; type string
Optional list of up to five user-defined field (UDF) string values
with which to categorize the content. Each string can be up to 30
characters. e-Dialog recommends that you use only the UDF
string values that were defined by your account team as part of
your initial setup process.
createDate type dateTime
The date when the content object was created.
updateDate type dateTime
The date when the content object was most recently updated.

62.

listContentUdfs
Source code
Description: Returns a list/array of all available values for each of the five content object UDFs.
Introduced in e-Dialog Web Services 1.0.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

41 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listContentUdfsRequest (soap:body, use = literal) Source code
parameters type listContentUdfs
Returns a list/array of all available values for each of the five content object UDFs.
Introduced in e-Dialog Web Services 1.0.
Output: listContentUdfsResponse (soap:body, use = literal) Source code
parameters type listContentUdfsResponse
udfValueList type udfValueListType
A list/array of strings that contain UDF values.
udfValue - optional, unbounded; type string
A list/array of strings containing all predefined values available for a
particular user-defined field (UDF). These values are created by your
account team at initial setup time for categorization purposes. Each string
can be up to 30 characters.

63.

listDataColumnsForAudience
Source code
Description: Gets a list of defined master data column information from the data dictionary for a
specific list. Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listDataColumnsForAudienceRequest (soap:body, use = literal) Source code
parameters type listDataColumnsForAudience
Gets a list of defined master data column information from the data dictionary for a
specific list. Introduced in e-Dialog Web Services 1.0.
audienceId type int
Required. The ID of an existing audience list.
Output: listDataColumnsForAudienceResponse (soap:body, use = literal) Source code
parameters type listDataColumnsForAudienceResponse
column - optional, unbounded; type dataColumnType
Complex type that represents a row in the data dictionary. Each row describes a
column in the database.
dictionaryId type int
The unique ID for a row in the data dictionary. Each row contains
information about a column in the master database.
tableName type string
The name of the table that contains the data column described in the
data dictionary.
columnName type string
The name of the data column described in the data dictionary.
columnType type string
The data type of the data column described in the data dictionary.
maxLength - optional; type string
The maximum number of characters stored in the data column described
in the data dictionary.
dateTypeFormat - optional; type string
The format (if applicable) of the data column stored in the data dictionary.

64.

listDataColumnsForCell
Source code
Description: Returns a list of all master database columns to which a symbol within the specified cell
can be mapped (see mapSymbolToDataColumn). Assign audience lists to the cell before
you call this function. Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listDataColumnsForCellRequest (soap:body, use = literal) Source code
parameters type listDataColumnsForCell

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

42 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

Returns a list of all master database columns to which a symbol within the specified cell
can be mapped (see mapSymbolToDataColumn). Assign audience lists to the cell
before you call this function. Introduced in e-Dialog Web Services 1.0.
cellId type int
Required. The ID of the cell for which to list symbols.
Output: listDataColumnsForCellResponse (soap:body, use = literal) Source code
parameters type listDataColumnsForCellResponse
columnName - optional, unbounded; type string
A list/array of master database columns to which a symbol within the specified
cell can be mapped.

65.

listDomains
Source code
Description: Returns a list of domains that you can use in mailings. There are two different types/sets
of domains: domains that can be used in from addresses, and domains that can be used
for redirected links. Introduced in e-Dialog Web Services 1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listDomainsRequest (soap:body, use = literal) Source code
parameters type listDomains
Returns a list of domains that you can use in mailings. There are two different
types/sets of domains: domains that can be used in from addresses, and domains that
can be used for redirected links. Introduced in e-Dialog Web Services 1.0.
domainType type string
The type of domain to list. Either "Redirect" or "From".
Output: listDomainsResponse (soap:body, use = literal) Source code
parameters type listDomainsResponse
domain - optional, unbounded; type string
A list/array of available domain names.

66.

listEReportTypes
Source code
Description: Returns a list of available eReports report types. Introduced in e-Dialog Web Services
1.3.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listEReportTypesRequest (soap:body, use = literal) Source code
parameters type listEReportTypes
Returns a list of available eReports report types. Introduced in e-Dialog Web Services
1.3.
Output: listEReportTypesResponse (soap:body, use = literal) Source code
parameters type listEReportTypesResponse
Reports - optional, unbounded; type reportType
A list/array of eReports report types.
Complex type that includes the name of the eReports report type.
name type string
eReports report name as it is stored in the database. The name includes
an underscore, for example mailing_cell.
description type string
eReports report name. The name includes spaces, for example mailing
cell.

67.

listExportedDataColumns
Source code

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

43 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

Description: Returns a list of columns from the exported data file. Introduced in e-Dialog Web
Services 1.1.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listExportedDataColumnsRequest (soap:body, use = literal) Source code
parameters type listExportedDataColumns
Returns a list of columns from the exported data file. Introduced in e-Dialog Web
Services 1.1.
cellId type int
The ID of the cell for which to list exported data columns.
Output: listExportedDataColumnsResponse (soap:body, use = literal) Source code
parameters type listExportedDataColumnsResponse
columnName - optional, unbounded, nillable; type string
A list/array of column names to permutate.

68.

listFeederQueues
Source code
Description: Returns a list of available feeder queues. Introduced in e-Dialog Web Services 1.1.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listFeederQueuesRequest (soap:body, use = literal) Source code
parameters type listFeederQueues
Returns a list of available feeder queues. Introduced in e-Dialog Web Services 1.1.
Output: listFeederQueuesResponse (soap:body, use = literal) Source code
parameters type listFeederQueuesResponse
queueName - optional, unbounded; type string
A list/array of feeder queues.

69.

listForwardToFriendTemplates
Source code
Description: Returns a list of available Forward-to-a-Friend template names. Introduced in e-Dialog
Web Services 1.1.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listForwardToFriendTemplatesRequest (soap:body, use = literal) Source code
parameters type listForwardToFriendTemplates
Returns a list of available Forward-to-a-Friend template names. Introduced in e-Dialog
Web Services 1.1.
Output: listForwardToFriendTemplatesResponse (soap:body, use = literal) Source code
parameters type listForwardToFriendTemplatesResponse
templateName - optional, unbounded; type string
A list/array of Forward-to-a-Friend templates.

70.

listGridColumns
Source code
Description: Lists all the columns in the grid, excluding the key column. Introduced in e-Dialog Web
Services 1.3.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listGridColumnsRequest (soap:body, use = literal) Source code
parameters type listGridColumns
Lists all the columns in the grid, excluding the key column. Introduced in e-Dialog Web
Services 1.3.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

44 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

gridId type int
Required. The identifier of the grid whose columns to list.
Output: listGridColumnsResponse (soap:body, use = literal) Source code
parameters type listGridColumnsResponse
column - unbounded; type string
List/array of strings that contain the names of the columns in the grid, excluding
the key column.

71.

listGridKeyValues
Source code
Description: Lists all the values in the key column of the grid. These are the values that are used to
determine what content to merge for each recipient. Introduced in e-Dialog Web Services
1.3.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listGridKeyValuesRequest (soap:body, use = literal) Source code
parameters type listGridKeyValues
Lists all the values in the key column of the grid. These are the values that are used to
determine what content to merge for each recipient. Introduced in e-Dialog Web
Services 1.3.
gridId type int
Required. The identifier of the grid for which you want to list the the key values.
Output: listGridKeyValuesResponse (soap:body, use = literal) Source code
parameters type listGridKeyValuesResponse
key - optional, unbounded; type string
List/array of strings that contain the key values in the grid.

72.

listGrids
Source code
Description: List grids according matching filtering conditions. Introduced in e-Dialog Web Services
1.3.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listGridsRequest (soap:body, use = literal) Source code
parameters type listGrids
List grids according matching filtering conditions. Introduced in e-Dialog Web Services
1.3.
filterGridName - nillable; type string
Optional. The name of the Grid. Leave this null if you do not want to include it as
part of the search criteria.
filterGridDescription - nillable; type string
Optional. The description of the grid. Leave this null if you do not want to include
it as part of the search criteria.
filterAddDateStart - nillable; type dateTime
Optional. The date when the grid was created. Leave this null if you do not want
to include it as part of the search criteria. If this is non-null then return all the grid
created on and after the date specified
filterAddDateEnd - nillable; type dateTime
Optional. The date when the grid was created. Leave this null if you do not want
to include it as part of the search criteria. If this is non-null then return all the grid
created on and before the date specified
filterUpdateDateStart - nillable; type dateTime
Optional. The last modified date of the grid. Leave this null if you do not want to
include it as part of the search criteria. If this non-null then return all the grids
updated on and after the date specified.
filterUpdateDateEnd - nillable; type dateTime
Optional. The last modified date of the Grid. Leave this null if you do not want to
include it as part of the search criteria. If this is non-null then return all the grids

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

45 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

updated on and before then date specified.
sortBy - optional, unbounded; type string
Optional. A list/array of grid attribute names (in any order) used to sort the
results: "gridName", "gridId", "gridAddDate", "gridUpdateDate". If no sortBy
criteria is provided, the results are sorted by "gridName".
pageSize type int
Required. The maximum number of items to return each time you call the list
function (the page size). Must be a positive integer.
pageNumber type int
Required. Used for pagination of results. Indicates which page number to return,
where each page (list function call) returns the number of items specified by
pageSize.
Output: listGridsResponse (soap:body, use = literal) Source code
parameters type listGridsResponse
Complex type that describes a list of grids and includes a list/array of grid structures.
currentPageNumber type int
Currently displayed page of grid.
totalNumberOfRows type int
The number of grid lists that exist in the database as of the most recent
listGridRequest. You can use this number to page through the list.
totalNumberOfPages type int
The number of pages found by the most recent listGridsByFilter. (See
listGridsByFilter.pageSize.)
grid - optional, unbounded; type GridEntryType
A list/array of GridEntryType complex types that includes information about each
grid.
Complex type that includes information about the grid.
gridId type int
Grid identifier, used in reportable links.
name type string
The name of the grid.
description - optional; type string
The description of the grid.
dateAdded - optional; type dateTime
The date when the grid was created.
dateUpdate - optional; type dateTime
The date when the grid was most recently updated.
onlyAsXML type boolean
Whether the grid data is available only in XML format.

73.

listIBQueries
Source code
Description: Returns the properties of an InsightBuilder query identified by a given ID. Introduced in
e-Dialog Web Services 1.4.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listIBQueriesRequest (soap:body, use = literal) Source code
parameters type listIBQueries
Returns the properties of an InsightBuilder query identified by a given ID. Introduced in
e-Dialog Web Services 1.4.
filterQueryId - optional, unbounded; type int
A list/array of InsightBuilder Query identifiers to retrieve
filterNameExpression - nillable; type string
Optional. An expression to filter InsightBuilder queries by name. Use % as
wildcard to match any substring of characters. Leave this null if you do not want
to include it as part of the search criteria.
filterCreateDateStart - nillable; type dateTime
Optional. If this is non-null then return all the queries created on and after the
date specified. Leave this null if you do not want to include it as part of the
search criteria.
filterCreateDateEnd - nillable; type dateTime
Optional. If this is non-null then return all the queries created on and before the

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

46 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

date specified. Leave this null if you do not want to include it as part of the
search criteria.
filterUpdateDateStart - nillable; type dateTime
Optional. If this is non-null then return all the queries updated on and after the
date specified. Leave this null if you do not want to include it as part of the
search criteria.
filterUpdateDateEnd - nillable; type dateTime
Optional. If this is non-null then return all the queries updated on and before the
date specified. Leave this null if you do not want to include it as part of the
search criteria.
filterState - optional, unbounded; type string
Optional. A list/array of strings that specify a set of state values to include in the
search. Values include: "VALID", "WIP", "INVALID".
sortBy - optional, unbounded; type string
Optional. A list/array of IB Query attribute names (in any order) used to sort the
results: "queryId", "name", "addDate", "updateDate". If no sortBy criteria is
provided, the results are sorted by "name".
pageSize type int
Required. The maximum number of items to return each time you call the list
function (the page size). Must be a positive integer.
pageNumber type int
Required. Used for pagination of results. Indicates which page number to return,
where each page (list function call) returns the number of items specified by
pageSize.
Output: listIBQueriesResponse (soap:body, use = literal) Source code
parameters type listIBQueriesResponse
A page of InsightBuilder Queries.
currentPageNumber type int
Page number.
totalNumberOfRows type int
The number of IB Queries that exist in the database as of the most recent call to
listIBQueries.
totalNumberOfPages type int
The number of pages found by the most recent listIBQueries.
IBQuery - optional, unbounded; type IBQueryType
A list/array of IBQueryType complex types that includes information about each
InsightBuilder query
queryId type int
The InsightBuilder Query Identifier
name type string
The name of the InsightBuilder Query.
description type string
InsightBuilder Query description
state type string
The state of the query. A value of "Valid" indicates that the query can be
executed, "Invalid" indicates that a previous execution produced an error
and the query cannot be exectued until modified, "WIP" indicates that a
query execution is taking place and the query is not updatable
temporarily.
notificationEmailAddress - optional, unbounded; type string
A list/array of e-mail addresses that receive notifications whenever this
InsightBuilder query is executed.
createDate type dateTime
Timestamp when the InsightBuilder Query was created
updateDate type dateTime
Timestamp when the InsightBuilder Query was last updated
recipientCount type int
Recipient count -using as the universe all registered recipient- at the last
time when this query was updated. Note that this count is not updated
when the query is executed, therefore it is not a reliable estimate of the
number of recipients that would match the query if executed.

74.

listLinks

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

47 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

Source code
Description: Get a list of links filtered by the specified settings. Filter settings are optional. Introduced
in e-Dialog Web Services 1.3.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listLinksRequest (soap:body, use = literal) Source code
parameters type listLinks
Get a list of links filtered by the specified settings. Filter settings are optional.
Introduced in e-Dialog Web Services 1.3.
filterMailingId - nillable; type int
Optional. The mailing ID to use to filter the list of links. The list will include links in
all the mailed cells in the specified mailing.
filterCellId - nillable; type int
Optional. The cell ID to use to filter the list of links. The list will include links in the
cell if it has been mailed.
filterEnabled - nillable; type boolean
Optional. Specifies whether the list of links should include only enabled links. If
false, the list will include only disabled links.
filterExpiresAfter - nillable; type dateTime
Optional. When used with filterExpiresBefore, lets you search for links that will
expire (will no longer be redirected) within the specified date range. Leave these
arguments null if you do not want to include them as part of the search criteria.
filterExpiresBefore - nillable; type dateTime
Optional. When used with filterExpiresAfter, lets you search for links that will
expire (will no longer be redirected) within the specified date range. Leave these
arguments null if you do not want to include them as part of the search criteria.
sortBy - optional, unbounded; type string
Optional. A list/array of link attribute names (in any order) used to sort the results:
"expirationDate", "id", "targetURL", "reportName", "enabled", "udf1" ... "udf5" If
no sortBy criteria is provided, the default is to sort by "expirationDate".
pageSize type int
Required. Specifies the maximum number of items to return each time you call
the list function (the page size). The value must be a positive integer.
pageNumber type int
Required. Used for pagination of results. Indicates which page number to return,
where each page (list function call) returns the number of items specified by
pageSize. Must be a positive integer.
Output: listLinksResponse (soap:body, use = literal) Source code
parameters type listLinksResponse
A list of links that meet the filter criteria, if any.
currentPageNumber type int
The number of the page returned to the most recent listLinksRequest.
totalNumberOfRows type int
The number of links that exist in the database as of the most recent
listLinksRequest.
totalNumberOfPages type int
The number of pages found by the most recent listLinksRequests (See
listLinksRequest.pageSize.)
link - optional, unbounded; type LinkType
A list/array of links that meet the filtering requirements.
The reportable link.
linkId type int
Reportable link ID.
contentId type int
The ID of the content in which the link appears.
targetURL type string
The URL that is the destination the recipient expects to go to after
clicking the link. For example, your organization's home page on your
web site.
originalTargetURL type string
The target URL as it originally appears in the content.
enabled type boolean
Whether the link is enabled for redirection.
udf - optional, nillable; type string

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

48 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

List/array of strings that contain user-defined field (UDF) values to use to
categorize the reportable link.
reportName - optional; type string
The name of the report that will appear in eReports.
expirationDate - optional; type dateTime
Date after which this link will no longer be redirected through the e-Dialog
Redirection Service.

75.

listMailings
Source code
Description: (Deprecated. Use the service listMailingsByFilter) Returns a list of mailings. Only a limited
set of properties for each campaign are returned. Introduced in e-Dialog Web Services
1.0.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listMailingsRequest (soap:body, use = literal) Source code
parameters type listMailings
(Deprecated. Use the service listMailingsByFilter) Returns a list of mailings. Only a
limited set of properties for each campaign are returned. Introduced in e-Dialog Web
Services 1.0.
filterCampaignId - optional, unbounded; type int
Optional. List/array of campaign IDs to search through. Leaving this empty/blank
searches through all campaigns.
filterNameExpression - nillable; type string
Optional. String that contains an expression that conforms to the syntax of the
ANSI SQL LIKE operator (sometimes referred to as the LIKE predicate). See
the Developer's Guide for details.
filterCreateDateStart - nillable; type dateTime
Optional. Used to filter against the creation date of the mailing. This allows you
to search for mailings created in any given date range. Leave these arguments
null if you do not want to include these as part of the search criteria.
filterCreateDateEnd - nillable; type dateTime
Optional. Used to filter against the creation date of the mailing. This allows you
to search for mailings created in any given date range. Leave these arguments
null if you do not want to include these as part of the search criteria.
filterFirstMailedDateStart - nillable; type dateTime
Optional. Used to filter mailings by when the first piece of final/production mail
was sent. This allows you to search for mailings created in any given date range.
Leave these arguments null if you do not want to include these as part of the
search criteria.
filterFirstMailedDateEnd - nillable; type dateTime
Optional. Used to filter mailings by when the first piece of final/production mail
was sent. This allows you to search for mailings created in any given date range.
Leave these arguments null if you do not want to include these as part of the
search criteria.
filterStatus - optional, unbounded; type string
Optional. A list/array of strings that indicate a set of statuses to include in the
search. Values include: "Setup", "Mailed", "Deleted".
sortBy - optional, unbounded; type string
Optional. A list/array of mailing attribute names (in any order) used to sort the
results: "name", "id", "createDate", or "firstMailedDate". If no sortBy criteria is
provided, the results are sorted by "createDate".
pageSize type int
Required. The maximum number of items to return each time you call the list
function (the page size). Must be a positive integer.
pageNumber type int
Required. Used for pagination of results. Indicates which page number to return
where each page (list function call) returns the number of items specified by
pageSize. Must be a positive integer.
Output: listMailingsResponse (soap:body, use = literal) Source code
parameters type listMailingsResponse
mailingList type mailingListType
Complex type. A sequence of mailingOverviewType elements arranged into

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

49 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

pages. Each user gets the next page.
currentPageNumber type int
The number of the page returned to the most recent listMailingsRequest.
totalNumberOfRows type int
The number of mailings that exist in the database as of the most recent
listMailingsRequest.
totalNumberOfPages type int
The number of pages found by the most recent listMailingssRequest.
(See listMailingsRequest.pageSize.)
mailing - optional, unbounded; type mailingOverviewType
Complex type. Subset of mailingDetailType.
campaignId type int
The ID of the campaign that contains the mailing.
mailingId type int
The ID of the mailing.
name - nillable; type string
The name of the mailing.
createDate type dateTime
The date the mailing was created.
updateDate type dateTime
The date the mailing was last updated.
udf - nillable; type string
A list/array of user defined field values.
status type string
The status of the maililng. Either "Setup" or "Mailed".
alternateKey - nillable; type string
A user-provided unique key to use for this mailing. See
lookupMailingByAlternateKey.

76.

listMailingsByFilter
Source code
Description: Returns a list of mailings. Only a limited set of properties for each campaign are returned.
Introduced in e-Dialog Web Services 1.3.
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: listMailingsByFilterRequest (soap:body, use = literal) Source code
parameters type listMailingsByFilter
Returns a list of mailings. Only a limited set of properties for each campaign are
returned. Introduced in e-Dialog Web Services 1.3.
filterCampaignId - optional, unbounded; type int
Optional. List/array of campaign IDs to search through. Leaving this empty/blank
searches through all campaigns.
filterNameExpression - nillable; type string
Optional. String that contains an expression that conforms to the syntax of the
ANSI SQL LIKE operator (sometimes referred to as the LIKE predicate). See
the Developer's Guide for details.
filterCreateDateStart - nillable; type dateTime
Optional. Used to filter against the creation date of the mailing. This allows you
to search for mailings created in any given date range. Leave these arguments
null if you do not want to include these as part of the search criteria.
filterCreateDateEnd - nillable; type dateTime
Optional. Used to filter against the creation date of the mailing. This allows you
to search for mailings created in any given date range. Leave these arguments
null if you do not want to include these as part of the search criteria.
filterFirstMailedDateStart - nillable; type dateTime
Optional. Used to filter mailings by when the first piece of final/production mail
was sent. This allows you to search for mailings created in any given date range.
Leave these arguments null if you do not want to include these as part of the
search criteria.
filterFirstMailedDateEnd - nillable; type dateTime
Optional. Used to filter mailings by when the first piece of final/production mail
was sent. This allows you to search for mailings created in any given date range.
Leave these arguments null if you do not want to include these as part of the
search criteria.

5/15/2012 1:57 PM

Web Service: SdkService - Generated by wsdl-viewer.xsl

50 of 155

file:///C:/Webserver/htdocs/Labs/eWS141Reference.htm

filterStatus - optional, unbounded; type string
Optional. A list/array of strings that indicate a set of statuses to include in the
search. Values include: "Setup", "Mailed", "Deleted".
filterUpdateDateStart - nillable; type dateTime
Optional. When used with filterUpdateDateEnd allows you to search for mailings
created in a specified date range according to the last update timestamp. Leave
these arguments null if you do not want to include them as part of the search
criteria.
filterUpdateDateEnd - nillable; type dateTime
Optional. When used with filterUpdateDateStart allows you to search for mailings
created in a specified date range according to the last update timestamp. Leave
these arguments null if you do not want to include them as part of the search
criteria.
filterUdf - optional; type UDFFilterType
Complex type that describes a filtering condition on a UDF.
name type string
The category name representing a particular UDF that matches an entry
in the dictionary (e.g. "Genre" ) or the string UDF followed by the number
(e.g. "UDF3").
value - unbounded; type string
A set of values expected for a UDF.
Optional. List of filtering conditions on UDFs
sortBy - optional, unbounded; type string
Optional. A list/array of mailing attribute names (in any order) used to sort the
results: "name", "id", "createDate", or "firstMailedDate". If no sortBy criteria is
provided, the results are sorted by "createDate".
pageSize type int
Required. The maximum number of items to return each time you call the list
function (the page size). Must be a positive integer.
pageNumber type int
Required. Used for pagination of results. Indicates which page number to return
where each page (list function call) returns the number of items specified by
pageSize. Must be a positive integer.
Output: listMailingsByFilterResponse (soap:body, use = literal) Source code
parameters type listMailingsByFilterResponse
currentPageNumber type int
The number of the page returned.
totalNumberOfRows type int
The number of mailings that exist in the database.
totalNumberOfPages type int
The number of pages found.
mailing - optional, unbounded; type mailingOverviewType
Complex type. Subset of mailingDetailType.
campaignId type int
The ID of the campaign that contains the mailing.
mailingId type int
The ID of the mailing.
name - nillable; type string
The name of the mailing.
createDate type dateTime
The date the mailing was created.
updateDate type dateTime
The date the mailing was last updated.
udf - nillable; type string
A list/array of user defined field values.
status type string
The status of the maililng. Either "Setup" or "Mailed".
alternateKey - nillable; type string
A user-provided unique key to use for this mailing. See
lookupMailingByAlternateKey.

77.

listMailingsByFilterAndMailingType
Source code

5/15/2012 1:57 PM


Related documents


ewsreference
arma 3 sqf cheat sheet revision 3
yxc api spec advanced
e dialog web services developer guide v1 4
javasyllabus
crpitv102nguyen


Related keywords