Upload
others
View
1
Download
0
Embed Size (px)
Citation preview
!!
Tripolis Dialogue - web services API 2.0
Reference Guide
October 2016 !!
! !
! !
p.#2#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
Table&of&Contents&Introduction!............................................................................................................................................................................!7!
Tripolis!Dialogue!Application!6!modules!overview!..................................................................................................................................!7!Services!overview!....................................................................................................................................................................................................!8!
Generic!.............................................................................................................................................................................!8!Contacts!...........................................................................................................................................................................!8!Content!............................................................................................................................................................................!8!Publishing!.........................................................................................................................................................................!8!Campaign!.........................................................................................................................................................................!9!Reporting!/!analysis!.........................................................................................................................................................!9!
MTOM!...........................................................................................................................................................................................................................!9!Authorities!................................................................................................................................................................................................................!10!AuthInfo!.....................................................................................................................................................................................................................!10!responseLanguage!................................................................................................................................................................................................!10!Dialogue!application!instance!..........................................................................................................................................................................!11!getServiceInfo!.........................................................................................................................................................................................................!11!Response!codes!......................................................................................................................................................................................................!11!
Services!6!Generic!...............................................................................................................................................................!13!
ClientDomainService!............................................................................................................................................................................................!13!ClientDomainService.create!..........................................................................................................................................!13!ClientDomainService.getByAuthInfo!.............................................................................................................................!14!ClientDomainService.getByPartnerDomain!...................................................................................................................!15!ClientDomainService.!getByUser!...................................................................................................................................!16!
FtpAccountService!................................................................................................................................................................................................!17!FtpAccountService.create!..............................................................................................................................................!17!
UserService!...............................................................................................................................................................................................................!18!UserService.getByAuthInfo!............................................................................................................................................!18!UserService.getUsersInClientDomainByAuthInfo!..........................................................................................................!19!
Services!6!Contacts!.............................................................................................................................................................!20!
Contacts!module!6!object!structure!................................................................................................................................................................!20!Contacts!module!6!types!......................................................................................................................................................................................!20!
contactDatabaseFieldType!............................................................................................................................................!20!kindOfField!.....................................................................................................................................................................!20!groupType!......................................................................................................................................................................!20!contactGroupSearchOperator!.......................................................................................................................................!20!contactFieldSearchOperator!..........................................................................................................................................!20!conditionType!................................................................................................................................................................!21!importMode!...................................................................................................................................................................!21!fileExtension!..................................................................................................................................................................!21!
ContactDatabaseService!.....................................................................................................................................................................................!22!ContactDatabaseService.create!.....................................................................................................................................!22!ContactDatabaseService.delete!.....................................................................................................................................!24!ContactDatabaseService.getAll!......................................................................................................................................!25!ContactDatabaseService.getById!...................................................................................................................................!26!ContactDatabaseService.update!....................................................................................................................................!27!
ContactDatabaseFieldGroupService!..............................................................................................................................................................!28!ContactDatabaseFieldGroupService.create!...................................................................................................................!28!ContactDatabaseFieldGroupService.delete!...................................................................................................................!29!ContactDatabaseFieldGroupService.getByContactDatabaseId!.....................................................................................!30!ContactDatabaseFieldGroupService.update!..................................................................................................................!31!
! !
p.#3#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!
ContactDatabaseFieldService!...........................................................................................................................................................................!32!ContactDatabaseFieldService.create!.............................................................................................................................!32!ContactDatabaseFieldService.delete!.............................................................................................................................!33!ContactDatabaseFieldService.getByContactDatabaseFieldGroupId!..............................................................................!34!ContactDatabaseFieldService.getByContactDatabaseId!................................................................................................!35!ContactDatabaseFieldService.update!............................................................................................................................!37!
ContactGroupService!...........................................................................................................................................................................................!38!ContactGroupService.addContactsToGroup!..................................................................................................................!38!ContactGroupService.create!..........................................................................................................................................!39!ContactGroupService.delete!..........................................................................................................................................!40!ContactGroupService.getByContactDatabaseId!............................................................................................................!41!ContactGroupService.getById!........................................................................................................................................!42!ContactGroupService.getByParentGroupId!...................................................................................................................!43!ContactGroupService.getContacts!.................................................................................................................................!45!ContactGroupService.removeAllContactsFromGroup!...................................................................................................!47!ContactGroupService.removeContactsFromGroup!.......................................................................................................!47!ContactGroupService.update!........................................................................................................................................!49!
SmartGroupService!...............................................................................................................................................................................................!50!SmartGroupService.getByContactDatabaseId!...............................................................................................................!50!SmartGroupService.getById!...........................................................................................................................................!52!SmartGroupService.getContacts!....................................................................................................................................!53!
ContactService!........................................................................................................................................................................................................!55!ContactService.addToContactGroup!.............................................................................................................................!56!ContactService.countByContactDatabaseId!..................................................................................................................!57!ContactService.countByContactGroupIds!......................................................................................................................!58!ContactService.countBySearch!......................................................................................................................................!59!ContactService.countBySmartGroupIds!........................................................................................................................!60!ContactService.create!....................................................................................................................................................!61!ContactService.delete!....................................................................................................................................................!62!ContactService.getBlacklistedByContactDatabaseId!.....................................................................................................!63!ContactService.getByContactDatabaseId!......................................................................................................................!65!ContactService.getByContactGroupId!...........................................................................................................................!67!ContactService.getById!..................................................................................................................................................!69!ContactService.getBySmartGroupId!..............................................................................................................................!71!ContactService.getCommunicationHistory!....................................................................................................................!73!ContactService.getContactGroupSubscriptions!.............................................................................................................!75!ContactService.removeFromContactGroup!...................................................................................................................!76!ContactService.search!...................................................................................................................................................!77!ContactService.update!...................................................................................................................................................!79!
ImportService!..........................................................................................................................................................................................................!80!ImportService.getImportStatus!.....................................................................................................................................!80!ImportService.importContacts!......................................................................................................................................!81!ImportService.importContactsFromFtp!.........................................................................................................................!82!ImportService.scheduleImportContacts!........................................................................................................................!83!ImportService.unscheduleImportContacts!....................................................................................................................!84!
SubscriptionService!..............................................................................................................................................................................................!85!SubscriptionService.subscribeContact!...........................................................................................................................!85!
Services!6!Content!...............................................................................................................................................................!87!
Content!module!6!object!structure!.................................................................................................................................................................!87!WorkspaceService!.................................................................................................................................................................................................!87!
WorkspaceService.copy!.................................................................................................................................................!88!WorkspaceService.copyForContactDatabase!................................................................................................................!89!WorkspaceService.create!..............................................................................................................................................!90!WorkspaceService.delete!..............................................................................................................................................!91!
! !
p.#4#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!!#
WorkspaceService.getAll!...............................................................................................................................................!92!WorkspaceService.getByContactDatabaseId!.................................................................................................................!93!WorkspaceService.getById!............................................................................................................................................!94!WorkspaceService.update!.............................................................................................................................................!95!
ArticleTypeService!................................................................................................................................................................................................!96!ArticleTypeService.countByWorkspaceId!......................................................................................................................!96!ArticleTypeService.create!..............................................................................................................................................!97!ArticleTypeService.delete!..............................................................................................................................................!98!ArticleTypeService.getById!............................................................................................................................................!99!ArticleTypeService.getByWorkspaceId!........................................................................................................................!100!ArticleTypeService.update!...........................................................................................................................................!101!
ArticleFieldService!.............................................................................................................................................................................................!102!ArticleFieldService.countByArticleTypeId!....................................................................................................................!102!ArticleFieldService.create!............................................................................................................................................!103!ArticleFieldService.delete!............................................................................................................................................!104!ArticleFieldService.getByArticleTypeId!........................................................................................................................!105!ArticleFieldService.getById!..........................................................................................................................................!106!ArticleFieldService.update!...........................................................................................................................................!107!
ArticleService!.......................................................................................................................................................................................................!108!ArticleService.assignToNewsletterSection!...................................................................................................................!109!ArticleService.countByNewsletterId!............................................................................................................................!110!ArticleService.countByTagIds!.......................................................................................................................................!111!ArticleService.countByWorkspaceId!............................................................................................................................!112!ArticleService.create!....................................................................................................................................................!113!ArticleService.createTag!..............................................................................................................................................!114!ArticleService.delete!....................................................................................................................................................!115!ArticleService.deleteTag!..............................................................................................................................................!116!ArticleService.getById!..................................................................................................................................................!117!ArticleService.getByNewsletterId!................................................................................................................................!118!ArticleService.getByNewsletterTypeIdAndTagIds!........................................................................................................!119!ArticleService.getByTagIds!...........................................................................................................................................!120!ArticleService.getByWorkspaceId!................................................................................................................................!121!ArticleService.getTagsByWorkspaceId!.........................................................................................................................!122!ArticleService.unassignFromNewsletterSection!..........................................................................................................!123!ArticleService.update!...................................................................................................................................................!124!ArticleService.updateTag!.............................................................................................................................................!125!
AttachmentService!(mtom)!............................................................................................................................................................................!126!AttachmentService.create!...........................................................................................................................................!126!AttachmentService.createTag!.....................................................................................................................................!127!AttachmentService.delete!...........................................................................................................................................!128!AttachmentService.deleteTag!.....................................................................................................................................!129!AttachmentService.getById!.........................................................................................................................................!130!AttachmentService.getByTagIds!..................................................................................................................................!131!AttachmentService.getByWorkspaceId!.......................................................................................................................!132!AttachmentService.getTagsByWorkspaceId!................................................................................................................!133!AttachmentService.update!..........................................................................................................................................!134!AttachmentService.updateTag!....................................................................................................................................!135!
ImageService!(mtom)!.......................................................................................................................................................................................!136!ImageService.countByTagIds!.......................................................................................................................................!136!ImageService.countByWorkspaceId!............................................................................................................................!137!ImageService.create!....................................................................................................................................................!138!ImageService.createTag!...............................................................................................................................................!139!ImageService.delete!....................................................................................................................................................!140!ImageService.deleteTag!...............................................................................................................................................!141!ImageService.getById!..................................................................................................................................................!142!
! !
p.#5#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
ImageService.getByTagIds!...........................................................................................................................................!143!ImageService.getByWorkspaceId!................................................................................................................................!144!ImageService.getTagsByWorkspaceId!.........................................................................................................................!145!ImageService.update!...................................................................................................................................................!146!ImageService.updateTag!..............................................................................................................................................!147!
DirectEmailTypeService!..................................................................................................................................................................................!148!DirectEmailTypeService.create!....................................................................................................................................!148!DirectEmailTypeService.delete!....................................................................................................................................!149!DirectEmailTypeService.getById!..................................................................................................................................!150!DirectEmailTypeService.getByWorkspaceId!................................................................................................................!151!DirectEmailTypeService.update!...................................................................................................................................!152!
DirectEmailService!.............................................................................................................................................................................................!153!DirectEmailService.assignAttachment!.........................................................................................................................!153!DirectEmailService.create!............................................................................................................................................!154!DirectEmailService.delete!............................................................................................................................................!155!DirectEmailService.getByDirectEmailTypeId!................................................................................................................!156!DirectEmailService.getById!..........................................................................................................................................!157!DirectEmailService.preview!.........................................................................................................................................!158!DirectEmailService.unassignAttachment!.....................................................................................................................!159!DirectEmailService.update!...........................................................................................................................................!160!
NewsletterTypeService!....................................................................................................................................................................................!161!NewsletterTypeService.create!.....................................................................................................................................!161!NewsletterTypeService.delete!.....................................................................................................................................!162!NewsletterTypeService.getById!...................................................................................................................................!163!NewsletterTypeService.getByWorkspaceId!.................................................................................................................!164!NewsletterTypeService.update!....................................................................................................................................!165!
NewsletterTemplateService!..........................................................................................................................................................................!166!NewsletterTemplateService.create!.............................................................................................................................!166!NewsletterTemplateService.delete!.............................................................................................................................!167!NewsletterTemplateService.getById!...........................................................................................................................!168!NewsletterTemplateService.getByNewsletterTypeId!..................................................................................................!169!NewsletterTemplateService.update!............................................................................................................................!170!
NewsletterSectionService!...............................................................................................................................................................................!171!NewsletterSectionService.create!.................................................................................................................................!171!NewsletterSectionService.delete!.................................................................................................................................!172!NewsletterSectionService.getById!...............................................................................................................................!173!NewsletterSectionService.getByNewsletterTypeId!.....................................................................................................!174!NewsletterSectionService.update!...............................................................................................................................!175!
NewsletterService!..............................................................................................................................................................................................!176!NewsletterService.assignAttachment!..........................................................................................................................!176!NewsletterService.copy!...............................................................................................................................................!177!NewsletterService.create!.............................................................................................................................................!178!NewsletterService.delete!.............................................................................................................................................!179!NewsletterService.getById!...........................................................................................................................................!180!NewsletterService.getByNewsletterTypeId!.................................................................................................................!181!NewsletterService.preview!..........................................................................................................................................!182!NewsletterService.unassignAttachment!......................................................................................................................!183!NewsletterService.update!...........................................................................................................................................!184!
NewsletterArticleTemplateService!.............................................................................................................................................................!185!NewsletterArticleTemplateService.create!...................................................................................................................!185!NewsletterArticleTemplateService.delete!...................................................................................................................!186!NewsletterArticleTemplateService.getById!.................................................................................................................!187!NewsletterArticleTemplateService.getByNewsletterTemplateId!................................................................................!188!NewsletterArticleTemplateService.update!..................................................................................................................!189!
SmsTypeService!..................................................................................................................................................................................................!190!
! !
p.#6#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
SmsTypeService.create!................................................................................................................................................!190!SmsTypeService.delete!................................................................................................................................................!191!SmsTypeService.getById!..............................................................................................................................................!192!SmsTypeService.getByWorkspaceId!............................................................................................................................!193!SmsTypeService.update!...............................................................................................................................................!194!
SmsMessageService!...........................................................................................................................................................................................!195!SmsMessageService.create!..........................................................................................................................................!195!SmsMessageService.delete!..........................................................................................................................................!196!SmsMessageService.getById!........................................................................................................................................!197!SmsMessageService.getBySmsMessageTypeId!...........................................................................................................!198!SmsMessageService.update!........................................................................................................................................!199!
Services!6!Publishing!......................................................................................................................................................!200!
PublishingService!...............................................................................................................................................................................................!200!PublishingService.createTag!........................................................................................................................................!201!PublishingService.deleteTag!........................................................................................................................................!202!PublishingService.getById!............................................................................................................................................!203!PublishingService.getByTagIds!.....................................................................................................................................!204!PublishingService.getTagsByWorkspaceId!...................................................................................................................!206!PublishingService.publishEmail!....................................................................................................................................!207!PublishingService.publishSampleTestEmail!.................................................................................................................!208!PublishingService.publishSms!......................................................................................................................................!209!PublishingService.publishTestEmail!.............................................................................................................................!210!PublishingService.publishTransactionalEmail!..............................................................................................................!211!PublishingService.updateTag!.......................................................................................................................................!212!PublishingService.viewLastMailing!..............................................................................................................................!213!PublishingService.viewLastSms!....................................................................................................................................!214!
MailJobService!.....................................................................................................................................................................................................!215!MailJobService.getById!................................................................................................................................................!216!MailJobService.getStatus!.............................................................................................................................................!217!MailJobService.pause!..................................................................................................................................................!218!MailJobService.remove!................................................................................................................................................!219!MailJobService.resume!................................................................................................................................................!220!
SmsJobService!......................................................................................................................................................................................................!221!SmsJobService.getById!................................................................................................................................................!222!SmsJobService.getStatus!.............................................................................................................................................!223!SmsJobService.pause!...................................................................................................................................................!224!SmsJobService.remove!................................................................................................................................................!225!SmsJobService.resume!................................................................................................................................................!226!
Services!6!Campaign!........................................................................................................................................................!227!
Campaign!module!6!object!structure!..........................................................................................................................................................!227!CampaignDefinitionService!............................................................................................................................................................................!227!
CampaignDefinitionService.getByWorkspaceId!..........................................................................................................!227!CampaignDefinitionService.getCampaigns!..................................................................................................................!228!
CampaignService!................................................................................................................................................................................................!229!CampaignService.activate!............................................................................................................................................!229!CampaignService.deactivate!........................................................................................................................................!230!CampaignService.getByCampaignDefinitionId!............................................................................................................!231!CampaignService.getById!............................................................................................................................................!232!
Services!6!Reporting!/!analysis!..................................................................................................................................!233!
ReportingService!................................................................................................................................................................................................!233!ReportingService.getBouncedByMailJobId!..................................................................................................................!234!
! !
p.#7#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
ReportingService.getBouncedBySmsJobId!..................................................................................................................!235!ReportingService.getClickedByMailJobId!.....................................................................................................................!236!ReportingService.getClicksPerLinkInHtmlByMailJobId!................................................................................................!237!ReportingService.getDeliveredByMailJobId!.................................................................................................................!238!ReportingService.getDeliveredBySmsJobId!.................................................................................................................!239!ReportingService.getEmailSummary!...........................................................................................................................!240!ReportingService.getOpenedByMailJobId!...................................................................................................................!241!ReportingService.getSkippedByMailJobId!...................................................................................................................!242!ReportingService.getSkippedBySmsJobId!....................................................................................................................!243!ReportingService.getSmsSummary!..............................................................................................................................!244!
ExportService!.......................................................................................................................................................................................................!245!ExportService.exportBounced!.....................................................................................................................................!246!ExportService.exportBouncedToFtp!............................................................................................................................!247!ExportService.exportClicked!........................................................................................................................................!248!ExportService.exportClickedToFtp!...............................................................................................................................!249!ExportService.exportComplained!................................................................................................................................!250!ExportService.exportComplainedToFtp!.......................................................................................................................!251!ExportService.exportConverted!...................................................................................................................................!252!ExportService.exportConvertedToFtp!.........................................................................................................................!253!ExportService.exportJobs!(Includes!sms!jobs)!.............................................................................................................!254!ExportService.!exportJobsToFtp!..................................................................................................................................!255!ExportService.exportLinks!...........................................................................................................................................!256!ExportService.exportLinksToFtp!..................................................................................................................................!257!ExportService.exportOpened!.......................................................................................................................................!258!ExportService.!exportOpenedToFtp!.............................................................................................................................!259!ExportService.exportSent!............................................................................................................................................!260!ExportService.exportSentToFtp!...................................................................................................................................!261!ExportService.exportSkipped!.......................................................................................................................................!262!ExportService.exportSkippedToFtp!.............................................................................................................................!263!ExportService.getExportStatus!....................................................................................................................................!264!
!
Introduction*!This!document!provides!technical!users!with!example!requests!for!implementing!Tripolis!Dialogue!integrations!using!the!Tripolis!API2.!!Detailed!information!on!the!services!and!methods!is!available!online:![DIALOGUE_INSTANCE_URL]/api2/docs/api!!
Tripolis*Dialogue*Application*4*modules*overview*
! !
p.#8#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
!
Services*overview*Generic*
• ClientDomainService;!for!maintaining!Client!Domains!• FtpAccountService;!for!administering!S/FTP!accounts!
Contacts*
• ContactDatabaseService,!for!maintaining!Contact!Databases!• ContactDatabaseFieldGroupService,!for!maintaining!Field!Groups!• ContactDatabaseFieldService,!for!maintain!Fields!• ContactGroupService,!for!maintaining!Contact!Groups!• SmartGroupService,!for!maintaining!Smart!Groups!• ContactService,!for!maintaining!Contacts!• ImportService,!for!importing!Contacts!
Content*
• WorkspaceService,!for!maintaining!Workspaces!• ArticleTypeService,!for!maintaining!Article!Types!• ArticleFieldService,!for!maintaining!Article!Fields!• ArticleService,!for!maintaining!Articles!• AttachmentService!(mtom),!for!maintaining!Attachments!• ImageService!(mtom),!for!maintaining!Images!• DirectEmailTypeService,!for!maintaining!Direct!Email!Types!• DirectEmailService,!for!maintaining!Direct!Emails!(editions)!• NewsletterTypeService,!for!maintaining!Newsletter!Types!• NewsletterTemplateService,!for!maintaining!Newsletter!Templates!• NewsletterSectionService,!for!maintaining!Newsletter!Sections!• NewsletterService,!for!maintaining!Newletters!(editions)!• NewsletterArticleTemplateService,!for!maintain!Article!Templates!• SmsTypeService,!for!maintaining!SMS!Types!• SmsMessageService,!for!maintaining!SMS!Messages!
Publishing*
• PublishingService,!for!publishing!Mail!and!SMS!jobs!• MailJobService,!for!maintaining!Mail!Jobs!• SmsJobService,!for!maintaining!SMS!Jobs!
! !
p.#9#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
Campaign*
• CampaignDefinitionService,!for!retrieving!Campaign!Definitions!• CampaignService,!for!maintaining!Campaigns!Runs!
Reporting*/*analysis*
• ReportingService,!for!retrieving!response!data!
&
MTOM&MTOM!is!the!recommended!W3C!Message&Transmission&Optimization&Mechanism,!a!method!of!efficiently!sending!binary!data!to!and!from!Web!services.!The!efficiency!claim!of!MTOM!refers!to!the!size!of!the!messages!sent!across!the!wire.!Since!SOAP!uses!XML,!any!binary!data!in!the!SOAP!message!will!have!to!be!encoded!as!text.!This!is!usually!done!using!Base64!encoding!which!increases!the!size!of!the!binary!data!by!33%.!MTOM!provides!a!way!to!send!the!binary!data!in!its!original!binary!form,!avoiding!any!increase!in!size!due!to!encoding!it!in!text.!!Some!PHP!and!.NET!implementations!are!known!to!have!difficulties!handling!attachments!with!MTOM.!For!that!purpose!we!provide!two!services!with!nofmtom!versions!(AttachmentService,!ImageService).!!Use!of!the!nofmtom!services!should!be!avoided,!because!the!files/data!are!placed!into!the!message!body.!Handling!large!message!bodies!can!result!in!time!outs.!!! &
! !
p.#10#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
Authorities*MODULE_CAMPAIGN!=!Campaign!MODULE_CONTACT!=!Contact!MODULE_CONTENT!=!Content!MODULE_OUTBOUND!=!Outbound!MODULE_REPORT!=!Report!MODULE_SETUP!=!Setup!MODULE_SUPPORT!=!Support!ROLE_ADMIN!=!Clientdomain!Administrator!ROLE_ADVANCED!=!Clientdomain!Advanced!User!ROLE_API_ADVANCED!=!Advanced!API!user!ROLE_API_BOUNCEHANDLER!=!Bouncehandler!user!ROLE_API_STANDARD!=!Standard!API!user!ROLE_INTERACTIVE!=!Interactive!user!ROLE_PARTNER_ADMIN!=!Partnerdomain!Administrator!ROLE_SYSTEM_ADMIN!=!System!Administrator!ROLE_SYSTEM_ATTACHMENT!=!Content!Attachment!Management!ROLE_SYSTEM_USER!=!System!User!ROLE_USER!=!Clientdomain!User!SUBMODULE_CONTENT_DIRECT_MAIL!=!Content!Direct!Mail!SUBMODULE_CONTENT_NEWSLETTER!=!Content!Newsletter!SUBMODULE_CONTENT_SMS!=!Content!SMS!SUBMODULE_OUTBOUND_MAIL!=!Outbound!Mail!SUBMODULE_OUTBOUND_SMS!=!Outbound!SMS!SUBMODULE_REPORT_CONTACTS!=!Report!Contacts!SUBMODULE_REPORT_PUBLISHING!=!Report!Publishing!SUBMODULE_SETUP_APPLICATION!=!Setup!Application!SUBMODULE_SETUP_CONTACT!=!Setup!Contact!SUBMODULE_SETUP_CONTENT!=!Setup!Content!SUBMODULE_SETUP_PUBLISHING!=!Setup!Publishing!!
AuthInfo*In!every!request!the!authInfo!information!is!required!for!authentication!and!permission!purposes.!For!security!reasons!we!advise!to!configure!a!separate!API!user,!not!related!to!a!person,!with!restricted!access!to!your!client!domain!data,!and!without!access!to!GUI.!!
<ser:authInfo> <client>CLIENT NAME</client> <username>USER NAME</username> <password>PASSWORD</password>
</ser:authInfo>
!For!example:!!
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo>
*
responseLanguage*This!feature!is!not!implemented!yet.!! *
! !
p.#11#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!!#
Dialogue*application*instance*In!this!document!you!will!frequently!find!the!placeholder![DIALOGUE_INSTANCE_URL].!Depending!on!the!Dialogue!application!instance!you!are!running!on,!you!must!fill!in!the!right!subdomain.!For!instance,!if!you!are!running!on!the!TD42!instance,!you!replace![DIALOGUE_INSTANCE_URL]!by!“https://td42.tripolis.com”!and!the!result!would!be!something!like!this:!https://td42.tripolis.com/api2/soap/ClientDomainService?wsdl!!
getServiceInfo*!All!services!have!a!method!getServiceInfo.!With!this!method!you!can!check!if!the!service!is!alive!or!not.!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header/> <soap:Body>
<ser:getServiceInfo/> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getServiceInfoResponse xmlns:ns2="http://services.tripolis.com/"> <response>
<message>The ClientDomainService is alive</message> <serviceInfoItems>
<serviceInfoItem> <key>buildNumber</key> <value>2011-11-30-15:07:58</value>
</serviceInfoItem> <serviceInfoItem>
<key>apiVersion</key> <value>2.0</value>
</serviceInfoItem> <serviceInfoItem>
<key>dialogueVersion</key> <value>3.5.2</value>
</serviceInfoItem> </serviceInfoItems>
</response> </ns2:getServiceInfoResponse>
</soap:Body> </soap:Envelope>
!
Response*codes*!
code&& name&& type&& category&100! CALL_NOT_ALLOWED! FAULT!! !200!! SUCCESS!! SUCCESS!! !300!! AUTHENTICATION!! FAULT!! AUTHENTICATION!400!! VALIDATION!! FAULT!! VALIDATION!401!! ALREADY_EXISTS!! FAULT!! VALIDATION!402!! REQUIRED!! FAULT!! VALIDATION!403!! INVALID!! FAULT!! VALIDATION!404!! VALUE_TOO_LOW!! FAULT!! VALIDATION!405!! VALUE_TOO_HIGH!! FAULT!! VALIDATION!406!! ONLY_ONE_ALLOWED!! FAULT!! VALIDATION!
! !
p.#12#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
407!! NOT_FOUND!! FAULT!! VALIDATION!408!! NOT_ALLOWED!! FAULT!! VALIDATION!409!! VALUE_TOO_SHORT!! FAULT!! VALIDATION!410!! VALUE_TOO_LONG!! FAULT!! VALIDATION!411!! ONE_IS_REQUIRED!! FAULT!! VALIDATION!412!! ATTACHMENT_NOT_POSSIBLE!! FAULT!! VALIDATION!413!! ATTACHMENT_TOO_LARGE!! FAULT!! VALIDATION!414!! NOT_EMPTY!! FAULT!! VALIDATION!401!! ALREADY_ASSIGNED!! FAULT!! VALIDATION!500!! APPLICATION!! FAULT!! APPLICATION!501!! NOT_POSSIBLE!! FAULT!! APPLICATION!900!! UNKNOWN!! FAULT! !
!!406:!This!ResponseCode!is!used!when!of!two!or!more!fields,!only!one!is!allowed.!You!should!always!check!for!more!than!one!of!these!error!codes!in!the!response.!!411:!This!ResponseCode!is!used!when!of!two!or!more!fields,!one!is!required.!You!should!always!check!for!more!than!one!of!these!error!codes!in!the!response.*! *
! !
p.#13#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
Services*4*Generic*
ClientDomainService*[DIALOGUE_INSTANCE_URL]/api2/soap/ClientDomainService?wsdl!!The!ClientDomainService!is!intended!for!use!by!Tripolis!Application!Engineers!and!high!level!system!integrators.!!Operations:!
• create!• getByAuthInfo!• getByPartnerDomain!• getByUser!• getServiceInfo!
*ClientDomainService.create**
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<ser:create> <createRequest>
<label>New Client Domain</label> <name>newclientdomain</name> <domainType>CLIENT</domainType>
<partnerDomainId>MTExMTExMTVSa2UKY8g</partnerDomainId> <supportPhone>+310123456789</supportPhone> <supportEmail>[email protected]</supportEmail> <partnerRss></partnerRss> <virtualMtaId></virtualMtaId> <properties>
<property> <key>MyFirstProperty</key> <value>Value_1</value>
</property> </properties>
</createRequest> </ser:create>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://services.tripolis.com/"> <response>
<id>NjY2NjY2NjY21U7jHPg</id> </response>
</ns2:createResponse> </soap:Body> </soap:Envelope>
!
! *
! !
p.#14#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
ClientDomainService.getByAuthInfo*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<ser:getByAuthInfo> <getByAuthInfoRequest/>
</ser:getByAuthInfo> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByAuthInfoResponse xmlns:ns2="http://services.tripolis.com/"> <response>
<clientDomain> <id>MTExMTExMTFE2UKY8g</id> <label>Tripolis API</label> <name>tripolisapi</name> <domainType>CLIENT</domainType> <parentDomainId>MTExMTEcVSa2UKY8g</parentDomainId>
</clientDomain> </response>
</ns2:getByAuthInfoResponse> </soap:Body> </soap:Envelope>
! !! *
! !
p.#15#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!!#
ClientDomainService.getByPartnerDomain*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<ser:getByPartnerDomain> <getByPartnerDomainRequest/>
</ser:getByPartnerDomain> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByPartnerDomainResponse xmlns:ns2="http://services.tripolis.com/"> <response>
<clientDomains> <clientDomain>
<id>MTExMTExMTFEcV2UKY8g</id> <label>Tripolis API</label> <name>tripolisapi</name> <domainType>CLIENT</domainType> <parentDomainId>MTEExMTFEcVSa2UKY8g</parentDomainId>
</clientDomain> <clientDomain>
<id>NjY2NjY2NjY21U7jH*fEPg</id> <label>New Client Domain</label> <name>newclientdomain</name> <domainType>CLIENT</domainType> <parentDomainId>MTEExMTFEcVSa2UKY8g</parentDomainId> <supportPhone>+310123456789</supportPhone> <supportEmail>[email protected]</supportEmail>
</clientDomain> </clientDomains>
</response> </ns2:getByPartnerDomainResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#16#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
ClientDomainService.*getByUser*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<ser:getByAuthInfo> <getByAuthInfoRequest/>
</ser:getByAuthInfo> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByAuthInfoResponse xmlns:ns2="http://services.tripolis.com/"> <response>
<clientDomain> <id>MTExMTExMTFEcVSKY8g</id>
<label>Tripolis API</label> <name>tripolisapi</name> <domainType>SYSTEM</domainType> <parentDomainId>MTExMTFEcVSa2UKY8g</parentDomainId>
</clientDomain> </response>
</ns2:getByAuthInfoResponse> </soap:Body> </soap:Envelope>
!! !
! !
p.#17#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
FtpAccountService*[DIALOGUE_INSTANCE_URL]/api2/soap/FtpAccountService?wsdl!!The!FtpAccountService!is!intended!for!use!by!Client!Domain!Admins.!!Operations:!
• create!• getServiceInfo!
*FtpAccountService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<ser:create> <createRequest>
<label>My SFTP account</label> <name>mysftpaccount</name> <protocol>FTP</protocol> <host>ftp.tripolis.com</host> <port>21</port> <username>tripolis-ftp-user</username> <password>FtpHoladijee</password> <remoteFolder></remoteFolder> <ftpMode>passive</ftpMode>
</createRequest> </ser:create>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://services.tripolis.com/"> <response>
<id>MzgyMzgyMzKn9HA</id> </response>
</ns2:createResponse> </soap:Body> </soap:Envelope>
!!
! !
p.#18#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
UserService*[DIALOGUE_INSTANCE_URL]/api2/soap/UserService?wsdl!!The!UserService!can!be!used!to!acces!details!on!users!and!for!setting!user!roles!and!rights!for!module!functions.!!Operations:!
• getByAuthInfo!• getServiceInfo!• getUsersInClientDomainByAuthInfo!
!
UserService.getByAuthInfo*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:user="http://user.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<user:getByAuthInfo> <getByAuthInfoRequest/>
</user:getByAuthInfo> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:getByAuthInfoResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://user.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <user>
<id>MjM1ODIzNTiTWrRtJA5hQw</id> <emailAddress>[email protected] </emailAddress> <firstName>Apie</firstName> <lastName>User</lastName> <enabled>true</enabled> <clientDomainId>MTAwMTAwMTC5qOZLQLM0IQ</clientDomainId> <clientDomainLabel> Tripolis API </clientDomainLabel> <timezone>Europe/Amsterdam</timezone> <language>en</language> <roles>
<role>CONTACTDATABASE_ALL</role> <role>MODULE_CAMPAIGN</role> <role>MODULE_CONTACT</role> <role>MODULE_CONTENT</role> <role>MODULE_REPORT</role> <role>MODULE_SETUP</role> <role>ROLE_ADMIN</role> <role>ROLE_API_ADVANCED</role> <role>ROLE_API_RAWEXPORT</role> <role>ROLE_SYSTEM_ATTACHMENT</role> <role>ROLE_SYSTEM_GOD</role> <role>ROLE_SYSTEM_SECURE_ATTACHMENT</role> <role>WORKSPACE_ALL</role>
</roles> </user>
</response> </ns3:getByAuthInfoResponse>
</soap:Body> </soap:Envelope>
! !
p.#19#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
!
UserService.getUsersInClientDomainByAuthInfo*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:user="http://user.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<user:getUsersInClientDomainByAuthInfo> <!--Optional:-->
<getUsersInClientDomainByAuthInfoRequest/> </user:getUsersInClientDomainByAuthInfo>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:getUsersInClientDomainByAuthInfoResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://user.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <users>
<user> <id>MTUwNjE1MDYd1bFo*ivtgw</id> <emailAddress>[email protected]</emailAddress> <firstName>Ad</firstName> <enabled>true</enabled> <clientDomainId>MTAwMTAwMTC5qOZLQLM0IQ</clientDomainId> <clientDomainLabel>Tripolis API</clientDomainLabel>
</user> <user>
<id>MTAxMTAxMTBulSSUb4xBcQ</id> <emailAddress>[email protected]</emailAddress> <firstName>Sup</firstName> <lastName>Port</lastName> <enabled>true</enabled> <clientDomainId>MTAwMTAwMTC5qOZLQLM0IQ</clientDomainId> <clientDomainLabel>Tripolis API</clientDomainLabel>
</user> <user>
<id>MTk1MTk1MTkGnNXMMCPsbQ</id> <emailAddress>[email protected]</emailAddress> <firstName>Devel</firstName> <lastName>Opment</lastName> <enabled>true</enabled> <clientDomainId>MTAwMTAwMTC5qOZLQLM0IQ</clientDomainId> <clientDomainLabel>Tripolis API</clientDomainLabel>
</user> </users>
</response> </ns3:getUsersInClientDomainByAuthInfoResponse>
</soap:Body> </soap:Envelope>
!!!!!
! !
p.#20#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
Services*4*Contacts*!
Contacts*module*4*object*structure*!
• ClientDomain,!this!is!the!toplevel!object,!every!user!logs!into!a!client!domain.!ContactDatabase,!every!ClientDomain!contains!N!ContactDatabases,!a!ContactDatabase!has!its!own!datamodel,!defined!in!Fields.!
• FieldGroups,!every!ContactDatabase!contains!N!FieldGroups,!these!are!used!for!grouping!Fields.!• Fields,!every!ContactDatabase!contains!N!Fields.!• ContactGroups,!every!ContactDatabase!contains!N!ContactGroups,!this!is!a!static!collection!of!Contacts!• SmartGroups,!every!ContactDatabase!contains!N!SmartGroups,!this!is!a!dynamic!collection!of!Contacts!• Contacts,!every!ContactDatabase!contains!N!Contacts!• ContactGroupMemberships,!Contacts!X!ContactGroups!• FieldValues,!Contacts!X!Fields!
!
Contacts*module*4*types*contactDatabaseFieldType*
• STRING!• INTEGER!• BOOLEAN!• DECIMAL!• DATE!• DATETIME!• PICKLIST!• EMAIL!• MOBILE!
!
kindOfField*
• GENERAL!• SUMMARY!• INTEREST!
!
groupType*
• STATIC!• SUBSCRIPTION!• TEST!
!
contactGroupSearchOperator*
• IN!• NOT_IN!
!
contactFieldSearchOperator*
• EQUALS!• STARTS_WITH!• ENDS_WITH!• CONTAINS!
! !
p.#21#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
• LESS_THAN!• LESS_THAN_OR_EQUAL!• GREATER_THAN!• GREATER_THAN_OR_EQUAL!• NOT_EQUALS!• DOES_NOT_CONTAIN!
!
conditionType*
• AND!• OR!
!
importMode*
• ADD_TO_GROUP!• SYNCHRONIZE_GROUP!• EXCLUDE_FROM_GROUP!• ONLY_ALLOW_ADD_TO_GROUP!• ADD_OR_UPDATE!• ONLY_ALLOW_ADD!• ONLY_ALLOW_UPDATE!• ACCEPTEMAIL_ADD_TO_GROUP!
!
fileExtension*
• CSV!• XLS!• XLSX!
! !
p.#22#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!
ContactDatabaseService*[DIALOGUE_INSTANCE_URL]/api2/soap/ContactDatabaseService?wsdl!!The!ContactDatabaseService!is!intended!for!maintaining!ContactDatabase!definitions.!!Operations:!
• create!• delete!• getAll!• getById!• getServiceInfo!• update!
!
ContactDatabaseService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contactdatabase.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:create> <createRequest>
<label>MyFirstDatabase</label> <name>myfirstdatabase</name> <properties>
<property> <key>MyFirstProperty</key> <value>Value_1</value>
</property> <property>
<key>MySecondProperty</key> <value>Value_2</value>
</property> </properties> <contactDatabaseFieldGroups>
<contactDatabaseFieldGroup> <label>Group_A</label> <name>groupa</name> <properties>
<property> <key>MyFirstProperty</key> <value>Value_1</value>
</property> </properties> <contactDatabaseFields>
<contactDatabaseField> <label>email address</label> <name>email</name> <type>EMAIL</type> <minLength></minLength> <maxLength></maxLength> <defaultValue></defaultValue> <key>1</key> <required>1</required> <inOverview>1</inOverview> <kindOfField>SUMMARY</kindOfField>
</contactDatabaseField> <contactDatabaseField>
<label>gender</label> <name>gender</name>
! !
p.#23#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!!#
<type>PICKLIST</type> <minLength></minLength> <maxLength></maxLength> <defaultValue>U</defaultValue> <key>0</key> <required>0</required> <inOverview>1</inOverview> <kindOfField></kindOfField> <picklistItems>
<picklistItem> <key>Unknown</key> <value>U</value>
</picklistItem> <picklistItem>
<key>Male</key> <value>M</value>
</picklistItem> <picklistItem>
<key>Female</key> <value>F</value>
</picklistItem> </picklistItems>
</contactDatabaseField> </contactDatabaseFields>
</contactDatabaseFieldGroup> </contactDatabaseFieldGroups>
</createRequest> </con:create>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://contactdatabase.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MTk4NjE5ODYmbteOz9UjLQ</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#24#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
ContactDatabaseService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contactdatabase.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:delete> <deleteRequest>
<id>MTk4NjE5ODYmbteOz9UjLQ</id> </deleteRequest>
</con:delete> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://contactdatabase.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response/> </ns2:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#25#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
ContactDatabaseService.getAll*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contactdatabase.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:getAll> <getAllRequest/>
</con:getAll> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getAllResponse xmlns:ns2="http://contactdatabase.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <contactDatabases>
<contactDatabase> <id>MzI0MzI0MzK_yaVN24Rmkw</id> <label>default</label> <name>default</name> <defaultContactDatabaseFieldGroup>
<id>Mzg1Mzg1MzhEjl5iz03YkA</id> <label>default</label> <name>default</name>
</defaultContactDatabaseFieldGroup> <modifiedAt>2010-06-16T16:20:58+02:00</modifiedAt>
</contactDatabase> <contactDatabase>
<id>MTU0MTU0MTX7aQmxE3j*ew</id> <label>DB_example1</label> <name>dbexample1</name> <defaultContactDatabaseFieldGroup>
<id>MTc1MTc1MTfUQL2ilrf_Lw</id> <label>default</label> <name>default</name>
</defaultContactDatabaseFieldGroup> <modifiedAt>2010-03-10T11:37:55+01:00</modifiedAt>
</contactDatabase> <contactDatabase>
<id>NDA0NDA0NDC4kPl3dvxqfw</id> <label>DB_example2</label> <name>!dbexample2</name><defaultContactDatabaseFieldGroup>
<id>NDg1NDg1NDieScQivEs4bw</id> <label>default</label> <name>default</name>
</defaultContactDatabaseFieldGroup> <modifiedAt>2010-08-09T17:03:35+02:00</modifiedAt>
</contactDatabase> </contactDatabases>
</response> </ns2:getAllResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#26#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
ContactDatabaseService.getById*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contactdatabase.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:getById> <getByIdRequest>
<id>MzI0MzI0MzK_yaVN24Rmkw</id> </getByIdRequest>
</con:getById> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://contactdatabase.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <contactDatabase>
<id>MzI0MzI0MzK_yaVN24Rmkw</id> <label>default</label> <name>default</name> <defaultContactDatabaseField>
<id>ODUxODUxODV0JmgJEl7W9A</id> <label>email</label> <name>email</name>
</defaultContactDatabaseField> <defaultContactDatabaseFieldGroup>
<id>Mzg1Mzg1MzhEjl5iz03YkA</id> <label>default</label> <name>default</name>
</defaultContactDatabaseFieldGroup> <modifiedAt>2010-06-16T16:20:58+02:00</modifiedAt>
</contactDatabase> </response>
</ns2:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#27#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
ContactDatabaseService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contactdatabase.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:update> <updateRequest>
<id>MzI0MzI0MzK_yaVN24Rmkw</id> <label>Default</label> <name>default</name>
<properties> <property>
<key>MySecondProperty</key> <value>Value_2</value>
</property> </properties>
</updateRequest> </con:update>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateResponse xmlns:ns2="http://contactdatabase.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MzI0MzI0MzK_yaVN24Rmkw</id>
</response> </ns2:updateResponse>
</soap:Body> </soap:Envelope>
!!! *
! !
p.#28#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
ContactDatabaseFieldGroupService*[DIALOGUE_INSTANCE_URL]/api2/soap/ContactDatabaseFieldGroupService?wsdl!!The!ContactDatabaseFieldGroupService!is!intended!for!maintaining!FieldGroup!definitions.!!Operations:!
• create!• delete!• getByContactDatabaseId!• getServiceInfo!• update!
!
ContactDatabaseFieldGroupService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<ser:create> <createRequest>
<contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <label>My First Field Group</label> <name>myfirstfieldgroup</name> <position>3</position> <properties>
<property> <key>MyFirstProperty</key> <value>Value_1</value>
</property> </properties>
</createRequest> </ser:create>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://services.tripolis.com/" xmlns:ns3="http://contact.services.tripolis.com/">
<response> <id>MjYxMTI2MTFnUydR54n7AA</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#29#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
ContactDatabaseFieldGroupService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<ser:delete> <deleteRequest>
<id>MjYxMTI2MTFnUydR54n7AA</id> <reassignContactDatabaseField-
GroupId>MjYxMDI2MTAihGPXza_Crg</reassignContactDatabaseFieldGroupId> </deleteRequest>
</ser:delete> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://services.tripolis.com/" xmlns:ns3="http://contact.services.tripolis.com/">
<response> <id>MjYxMTI2MTFnUydR54n7AA</id>
</response> </ns2:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#30#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
ContactDatabaseFieldGroupService.getByContactDatabaseId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<ser:getByContactDatabaseId> <getByContactDatabaseIdRequest>
<contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> </getByContactDatabaseIdRequest>
</ser:getByContactDatabaseId> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByContactDatabaseIdResponse xmlns:ns2="http://services.tripolis.com/" xmlns:ns3="http://contact.services.tripolis.com/">
<response> <contactDatabaseFieldGroups>
<contactDatabaseFieldGroup> <id>MTY1MTY1MTZGsyZb6HUn*g</id> <label>personal</label> <name>default</name> <position>1</position>
</contactDatabaseFieldGroup> <contactDatabaseFieldGroup>
<id>MjYxMDI2MTAihGPXza_Crg</id> <label>marketing</label> <name>marketing</name> <position>2</position>
</contactDatabaseFieldGroup> </contactDatabaseFieldGroups>
</response> </ns2:getByContactDatabaseIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#31#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
ContactDatabaseFieldGroupService.update*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<ser:update> <updateRequest>
<id>MTY1MTY1MTZGsyZb6HUn*g</id> <label>Changed label</label> <name>changedlabel</name> <position>2</position> <properties>
<property> <key>MySecondProperty</key> <value>Value_2</value>
</property> </properties>
</updateRequest> </ser:update>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateResponse xmlns:ns2="http://services.tripolis.com/" xmlns:ns3="http://contact.services.tripolis.com/">
<response> <id>MTY1MTY1MTZGsyZb6HUn*g</id>
</response> </ns2:updateResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#32#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
ContactDatabaseFieldService*[DIALOGUE_INSTANCE_URL]/api2/soap/ContactDatabaseFieldService?wsdl!!The!ContactDatabaseFieldService!is!intended!for!maintaining!Field!definitions.!!Operations:!
• create!• delete!• getByContactDatabaseFieldGroupId!• getByContactDatabaseId!• getServiceInfo!• update!!
!
ContactDatabaseFieldService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:fiel="http://field.contactdatabase.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<fiel:create> <createRequest>
<contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <label>My First Field</label> <name>myfirstfield</name> <type>STRING</type>
<minLength>1</minLength> <maxLength>64</maxLength> <defaultValue></defaultValue> <key>0</key> <required>0</required> <inOverview>1</inOverview> <contactDatabaseFieldGroupId>MjYxMDI2MTAihGPXza_Crg</contactDatabaseFieldGroupId> <position>4</position> <kindOfField>SUMMARY</kindOfField>
</createRequest> </fiel:create>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://field.contactdatabase.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>ODg4ODg4ODipfANmyEmMlw</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#33#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
ContactDatabaseFieldService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:fiel="http://field.contactdatabase.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<fiel:delete> <deleteRequest>
<id>ODg4ODg4ODipfANmyEmMlw</id> </deleteRequest>
</fiel:delete> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://field.contactdatabase.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>ODg4ODg4ODipfANmyEmMlw</id>
</response> </ns2:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#34#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
ContactDatabaseFieldService.getByContactDatabaseFieldGroupId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:fiel="http://field.contactdatabase.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<fiel:getByContactDatabaseFieldGroupId> <getByContactDatabaseFieldGroupIdRequest>
<contactDatabaseFieldGroupId>MjYxMDI2MTAihGPXza_Crg</contactDatabaseFieldGroupId> </getByContactDatabaseFieldGroupIdRequest>
</fiel:getByContactDatabaseFieldGroupId> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByContactDatabaseFieldGroupIdResponse xmlns:ns2="http://field.contactdatabase.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <contactDatabaseFields>
<contactDatabaseField> <id>ODEzODEzODEGo_AudvERMg</id> <label>Customernr</label> <name>customernr</name> <type>STRING</type> <maxLength>20</maxLength> <defaultValue/> <key>false</key> <required>false</required> <inOverview>true</inOverview> <contactDatabaseFieldGroupId>MjYxI2MTAihGPXza_Crg</contactDatabaseFieldGroupId> <position>1</position> <kindOfField>GENERAL</kindOfField>
<picklistItems/> </contactDatabaseField> <contactDatabaseField>
<id>ODEyODEyODGPgAP7WHZToA</id> <label>MailingNr</label> <name>mailingnr</name> <type>STRING</type> <maxLength>8</maxLength> <defaultValue/> <key>false</key> <required>false</required> <inOverview>true</inOverview> <contactDatabaseFieldGroupId>MjYxM2MTAihGPXza_Crg</contactDatabaseFieldGroupId> <position>2</position> <kindOfField>GENERAL</kindOfField> <picklistItems/>
</contactDatabaseField> </contactDatabaseFields> </response>
</ns2:getByContactDatabaseFieldGroupIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#35#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
ContactDatabaseFieldService.getByContactDatabaseId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:fiel="http://field.contactdatabase.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<fiel:getByContactDatabaseId> <getByContactDatabaseIdRequest>
<paging> <pageNr>2</pageNr> <pageSize>5</pageSize>
</paging> <sorting>
<sortBy>label</sortBy> <sortOrder>ASC</sortOrder>
</sorting> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId>
</getByContactDatabaseIdRequest> </fiel:getByContactDatabaseId>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByContactDatabaseIdResponse xmlns:ns2="http://field.contactdatabase.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>2</pageNr> <pageSize>5</pageSize> <totalItems>9</totalItems>
</paging> <sorting>
<sortBy>label</sortBy> <sortOrder>ASC</sortOrder>
</sorting> <contactDatabaseFields>
<contactDatabaseField> <id>NDM1NDM1NDP1Aksc0ZoMqQ</id> <label>mobile</label> <name>mobile</name> <type>MOBILE</type> <defaultValue/> <key>false</key> <required>false</required> <inOverview>true</inOverview> <contactDatabaseFieldGroupId>MTY1MTY1MGsyZb6HUn*g</contactDatabaseFieldGroupId> <position>2</position> <kindOfField>GENERAL</kindOfField> <picklistItems/>
</contactDatabaseField> <contactDatabaseField>
<id>NzkyNzkyNzl5hkZju42*WQ</id> <label>tussenvoegsel</label> <name>tussenvoegsel</name> <type>STRING</type> <maxLength>20</maxLength> <defaultValue/> <key>false</key>
! !
p.#36#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
<required>false</required> <inOverview>true</inOverview> <contactDatabaseFieldGroupId>MTY1Y1MTZGsyZb6HUn*g</contactDatabaseFieldGroupId> <position>4</position> <kindOfField>GENERAL</kindOfField>
<picklistItems/> </contactDatabaseField> <contactDatabaseField>
<id>ODAxODAxODDHLzd_maJfUw</id> <label>unsubscribe_string</label> <name>unsubscribe_string</name> <type>STRING</type> <maxLength>20</maxLength> <defaultValue/> <key>false</key> <required>true</required> <inOverview>true</inOverview>
<contactDatabaseFieldGroupId>MjYxI2MTAihGPXza_Crg</contactDatabaseFieldGroupId> <position>3</position> <kindOfField>GENERAL</kindOfField> <picklistItems/>
</contactDatabaseField> <contactDatabaseField>
<id>NzkzNzkzNzmpLBYHs4JMKQ</id> <label>firstname</label> <name>firstname</name> <type>STRING</type> <maxLength>100</maxLength> <defaultValue/> <key>false</key> <required>false</required> <inOverview>true</inOverview> <contactDatabaseFieldGroupId>MTY1MTYTZGsyZb6HUn*g</contactDatabaseFieldGroupId> <position>5</position> <kindOfField>GENERAL</kindOfField> <picklistItems/>
</contactDatabaseField> </contactDatabaseFields>
</response> </ns2:getByContactDatabaseIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#37#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
ContactDatabaseFieldService.update*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:fiel="http://field.contactdatabase.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<fiel:update> <updateRequest>
<id>ODg4OTg4ODnY_Il820qFaQ</id> <label>My First Field</label> <name>myfirstfield</name> <minLength>1</minLength> <maxLength>69</maxLength> <position>4</position> <properties>
<property> <key>MyFirstProperty</key> <value>Value_1</value>
</property> </properties>
</updateRequest> </fiel:update>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateResponse xmlns:ns2="http://field.contactdatabase.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>ODg4OTg4ODnY_Il820qFaQ</id>
</response> </ns2:updateResponse>
</soap:Body> </soap:Envelope>
!!! *
! !
p.#38#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
ContactGroupService*[DIALOGUE_INSTANCE_URL]/api2/soap/ContactGroupService?wsdl!!The!ContactGroupService!is!intended!for!maintaining!ContactGroup!definitions!and!it’s!memberships.!!Operations:!
• addContactsToGroup!• create!• delete!• getByContactDatabaseId!• getById!• getByParentGroupId!• getContacts!• getServiceInfo!• removeAllContactFromGroup!• removeContactsFromGroup!• update!
!
ContactGroupService.addContactsToGroup*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contactgroup.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:addContactsToGroup> <addContactsToGroupRequest>
<contactGroupId>MjM4OTAyMzh5tPnZZ7Hhyg</contactGroupId> <contactIds>
<contactId>MTMyOTU4OTmMdCzC_oRpaAAO2LvZr</contactId> <contactId>OTM5NjQ4OTO4500F*qmw</contactId>
</contactIds> </addContactsToGroupRequest>
</con:addContactsToGroup> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:addContactsToGroupResponse xmlns:ns2="http://contactgroup.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MjM4OTAyMzh5tPnZZ7Hhyg</id>
</response> </ns2:addContactsToGroupResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#39#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
ContactGroupService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contactgroup.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:create> <createRequest>
<contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <label>My First ContactGroup</label> <name>myfirstcontactgroup</name> <groupType>STATIC</groupType> <parentGroupId>MTE3NDExNzQBvvtRDdaM0Q</parentGroupId> <properties>
<property> <key>MyFirstProperty</key> <value>Value_1</value>
</property> </properties>
</createRequest> </con:create>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://contactgroup.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MjM4OTAyMzh5tPnZZ7Hhyg</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#40#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!
ContactGroupService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contactgroup.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:delete> <deleteRequest>
<id>MjM4OTAyMzh5tPnZZ7Hhyg</id> </deleteRequest>
</con:delete> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://contactgroup.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MjM4OTAyMzh5tPnZZ7Hhyg</id>
</response> </ns2:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#41#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
ContactGroupService.getByContactDatabaseId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contactgroup.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:getByContactDatabaseId> <getByContactDatabaseIdRequest>
<paging> <pageNr>1</pageNr> <pageSize>3</pageSize>
</paging> <sorting>
<sortBy>label</sortBy> <sortOrder>DESC</sortOrder>
</sorting> <contactDatabaseId>MTQ0MTMTTSXLrfiihpZg</contactDatabaseId> <groupType></groupType>
</getByContactDatabaseIdRequest> </con:getByContactDatabaseId>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByContactDatabaseIdResponse xmlns:ns2="http://contactgroup.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>3</pageSize> <totalItems>45</totalItems>
</paging> <sorting>
<sortBy>label</sortBy> <sortOrder>DESC</sortOrder>
</sorting> <contactGroups>
<contactGroup> <id>MTkwMDE5MDAulp68J4rA</id> <label>Active subscribers</label> <name>activesubscribers</name> <type>STATIC</type> <modifiedAt>2010-06-25T20:29:50+02:00</modifiedAt> <isArchived>false</isArchived>
</contactGroup> <contactGroup>
<id>MTY5MDE2OTDDZWN8vctg</id> <label>testgroup Tripolis</label> <name>testgrouptripolis</name> <type>TEST</type> <parentGroupId>MTE5MDExOTCUFQjP2MK3wQ</parentGroupId> <modifiedAt>2010-06-18T09:52:34+02:00</modifiedAt> <isArchived>false</isArchived>
</contactGroup> </contactGroups>
</response> </ns2:getByContactDatabaseIdResponse>
</soap:Body> </soap:Envelope>
!
! !
p.#42#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
ContactGroupService.getById*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contactgroup.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:getById> <getByIdRequest>
<id>MTY3MDEzCGksgLK16uJw</id> </getByIdRequest>
</con:getById> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://contactgroup.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <contactGroup>
<id>MTY3MDEzCGksgLK16uJw</id> <label>[email protected]</label> <name>supporttripoliscom</name> <type>STATIC</type> <modifiedAt>2010-06-16T16:00:49+02:00</modifiedAt> <isArchived>false</isArchived>
</contactGroup> </response>
</ns2:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#43#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
ContactGroupService.getByParentGroupId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contactgroup.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:getByParentGroupId> <getByParentGroupIdRequest>
<paging> <pageNr>1</pageNr> <pageSize>3</pageSize>
</paging> <sorting>
<sortBy>label</sortBy> <sortOrder>DESC</sortOrder>
</sorting> <parentGroupId>MTE3NDExNzQBvvtRDdaM0Q</parentGroupId> <groupType>TEST</groupType>
</getByParentGroupIdRequest> </con:getByParentGroupId>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByParentGroupIdResponse xmlns:ns2="http://contactgroup.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>3</pageSize> <totalItems>7</totalItems>
</paging> <sorting>
<sortBy>label</sortBy> <sortOrder>DESC</sortOrder>
</sorting> <contactGroups>
<contactGroup> <id>MTE3MjExNzLR_o4HvV3DJg</id> <label>testgroup Support</label> <name>testgroupsupport</name> <type>TEST</type> <parentGroupId>MTE3NDExNzQBvvtRDdaM0Q</parentGroupId> <modifiedAt>2010-06-03T16:31:09+02:00</modifiedAt> <isArchived>false</isArchived>
</contactGroup> <contactGroup>
<id>MTI5MDEyOTBW766Jh*r27A</id> <label>testgroup 1</label> <name>testgroup1</name> <type>TEST</type> <parentGroupId>MTE3NDExNzQBvvtRDdaM0Q</parentGroupId> <modifiedAt>2010-06-04T16:44:20+02:00</modifiedAt> <isArchived>false</isArchived>
</contactGroup> <contactGroup>
<id>MTY4MTE2ODEPd71LJ3MK1g</id> <label>testgroup 2</label> <name>testgroup2</name> <type>TEST</type>
! !
p.#44#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
<parentGroupId>MTE3NDExNzQBvvtRDdaM0Q</parentGroupId> <modifiedAt>2010-06-17T12:12:18+02:00</modifiedAt>
<isArchived>false</isArchived> </contactGroup>
</contactGroups> </response>
</ns2:getByParentGroupIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#45#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
ContactGroupService.getContacts*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contactgroup.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:getContacts> <getContactsRequest>
<paging> <pageNr>1</pageNr> <pageSize>999</pageSize>
</paging> <sorting>
<sortBy>email</sortBy> <sortOrder>DESC</sortOrder>
</sorting> <contactGroupId>MTY3MDE2NzCGksgLK16uJw</contactGroupId> <returnContactFields>
<contactDatabaseFieldIds> <contactDatabaseFieldId>NzkxNzkxNzmqAMNkXIBZUw</contactDatabaseFieldId> <contactDatabaseFieldId>NDMxNDMxNDOGCtpvu79hSA</contactDatabaseFieldId>
</contactDatabaseFieldIds> <returnAllContactFields>0</returnAllContactFields>
</returnContactFields> </getContactsRequest>
</con:getContacts> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getContactsResponse xmlns:ns2="http://contactgroup.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>999</pageSize> <totalItems>1</totalItems>
</paging> <sorting>
<sortBy>email</sortBy> <sortOrder>DESC</sortOrder>
</sorting> <contacts>
<contact> <contactId>OTM5NjQ4OTO4QG500F*qmw</contactId> <contactFields>
<contactField> <id>NzkxNzkxNzmqAMNkXIBZUw</id> <label>lastname</label> <name>lastname</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MTY1MTY1MTZGU</contactDatabaseFieldGroupId> <position>3</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>NDMxNDMxNDOGCtpvu79hSA</id> <value>[email protected]</value>
! !
p.#46#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!
<label>email</label> <name>email</name> <type>EMAIL</type> <key>true</key> <required>true</required> <contactDatabaseFieldGroupId>MTY1MTY1MTZGsy</contactDatabaseFieldGroupId> <position>1</position> <kindOfField>GENERAL</kindOfField>
</contactField> </contactFields>
</contact> </contacts>
</response> </ns2:getContactsResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#47#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
ContactGroupService.removeAllContactsFromGroup*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contactgroup.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<con:removeAllContactsFromGroup> <removeAllContactsFromGroupRequest>
<id>MzYyNDk5MzZgRueOqV91rg</id> </removeAllContactsFromGroupRequest>
</con:removeAllContactsFromGroup> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:removeAllContactsFromGroupResponse xmlns:ns2="http://contactgroup.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MzYyNDk5MzZgRueOqV91rg</id>
</response> </ns2:removeAllContactsFromGroupResponse>
</soap:Body> </soap:Envelope>
*
ContactGroupService.removeContactsFromGroup*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contactgroup.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:removeContactsFromGroup> <removeContactsFromGroupRequest>
<contactGroupId>MjM4OTEyMzh5tPnZZ7Hhyg</contactGroupId> <contactIds>
<contactId>MTMyOTU4OTmMdCDprzC_oRpaAAO2LvZr</contactId> </contactIds>
</removeContactsFromGroupRequest> </con:removeContactsFromGroup>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
! !
p.#48#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
<ns2:removeContactsFromGroupResponse xmlns:ns2="http://contactgroup.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MjM4OTEyMzh5tPnZZ7Hhyg</id>
</response> </ns2:removeContactsFromGroupResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#49#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
ContactGroupService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contactgroup.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>MjM4OTEyMzh5tPnZZ7Hhyg</ser:responseLanguage>
</soap:Header> <soap:Body>
<con:update> <updateRequest>
<id>MjM4OTEyMzh5tPnZZ7Hhyg</id> <label>Changed label</label> <name>changedlabel</name>
</updateRequest> </con:update>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateResponse xmlns:ns2="http://contactgroup.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MjM4OTEyMzh5tPnZZ7Hhyg</id>
</response> </ns2:updateResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#50#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
SmartGroupService*[DIALOGUE_INSTANCE_URL]/api2/soap/SmartGroupService?wsdl!!The!SmartGroupService!is!intended!for!retrieving!SmartGroup!definitions!and!it’s!memberships.!!Operations:!
• getByContactDatabaseId!• getById!• getContacts!• getServiceInfo!
!
SmartGroupService.getByContactDatabaseId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contactgroup.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:getByContactDatabaseId> <getByContactDatabaseIdRequest>
<paging> <pageNr>1</pageNr> <pageSize>10</pageSize>
</paging> <sorting>
<sortBy>label</sortBy> <sortOrder>DESC</sortOrder>
</sorting> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <groupType></groupType>
</getByContactDatabaseIdRequest> </con:getByContactDatabaseId>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:getByContactDatabaseIdResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://smartgroup.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>5</pageSize> <totalItems>3</totalItems>
</paging> <sorting>
<sortBy>label</sortBy> <sortOrder>DESC</sortOrder>
</sorting> <smartGroups>
<smartGroup> <id>MTMwNTEzMDVCaYQx8YybOQ</id> <label>mobile base</label> <name>mobilebase</name> <type>SMARTGROUP</type> <isArchived>false</isArchived>
</smartGroup>
! !
p.#51#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
<smartGroup> <id>MTMwNDEzMDRJ5G6IeEtBAg</id> <label>customernr is set</label> <name>customernrisset</name> <type>SMARTGROUP</type> <isArchived>false</isArchived>
</smartGroup> <smartGroup>
<id>MTMwMzEzMDPGxudvqp4UKQ</id> <label>email @tripolis</label> <name>emailtripolis</name> <type>SMARTGROUP</type> <isArchived>false</isArchived>
</smartGroup> </smartGroups>
</response> </ns3:getByContactDatabaseIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#52#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
SmartGroupService.getById*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:smar="http://smartgroup.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<smar:getById> <getByIdRequest>
<id>MTMwNDEzMDRJ5G6IeEtBAg</id> </getByIdRequest>
</smar:getById> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:getByIdResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://smartgroup.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <smartGroup>
<id>MTMwNDEzMDRJ5G6IeEtBAg</id> <label>customernr is set</label> <name>customernrisset</name> <type>SMARTGROUP</type> <isArchived>false</isArchived>
</smartGroup> </response>
</ns3:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#53#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
SmartGroupService.getContacts*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:smar="http://smartgroup.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<smar:getContacts> <getContactsRequest>
<paging> <pageNr>1</pageNr> <pageSize>3</pageSize>
</paging> <sorting>
<sortBy>lastname</sortBy> <sortOrder>ASC</sortOrder>
</sorting> <smartGroupId>MTMwNDEzMDRJ5G6IeEtBAg</smartGroupId> <returnContactFields>
<contactDatabaseFieldGroupNames> <contactDatabaseFieldGroupName>marketing</contactDatabaseFieldGroupName>
</contactDatabaseFieldGroupNames> <returnAllContactFields>0</returnAllContactFields>
</returnContactFields> </getContactsRequest>
</smar:getContacts> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:getContactsResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://smartgroup.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>3</pageSize> <totalItems>127030</totalItems>
</paging> <sorting>
<sortBy>lastname</sortBy> <sortOrder>ASC</sortOrder>
</sorting> <contacts>
<contact> <contactId>Mzk0Mzc4MzlaIeUuAQlb8g</contactId> <contactFields>
<contactField> <id>ODg4OTg4ODnY_Il820qFaQ</id> <label>My First Field</label> <name>myfirstfield</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MjYxMDPXza_Crg</contactDatabaseFieldGroupId> <position>4</position> <kindOfField>SUMMARY</kindOfField>
</contactField> <contactField>
<id>ODEyODEyODGPgAP7WHZToA</id> <value>99999999</value> <label>MailingNr</label>
! !
p.#54#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!
<name>mailingnr</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGrouId>MjYxMTAihGP_Crg</contactDatabaseFieldGroupId> <position>2</position> <kindOfField>GENERAL</kindOfField>
</contactField> </contactFields>
</contact> </contacts>
</response> </ns3:getContactsResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#55#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
ContactService*[DIALOGUE_INSTANCE_URL]/api2/soap/ContactService?wsdl!!The!ContactService!is!intended!for!retrieving!and!maintaining!Contacts!and!its!memberships.!!Operations:!
• addToContactGroup!• countByContactDatabaseId!• countByContactGroupIds!• countBySearch!• countBySmartGroupIds!• create!• delete!• getBlacklistedByContactDatabaseId!• getByContactDatabaseId!• getByContactGroupId!• getById!• getBySmartGroupId!• getCommunicationHistory!• getContactGroupSubscriptions!• getServiceInfo!• removeFromContactGroup!• search!• update!
!! *
! !
p.#56#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!
ContactService.addToContactGroup*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:addToContactGroup> <addToContactGroupRequest>
<contactId>MTY3MTI0MDmMdCDprzC_oRpaAAO2LvZr</contactId> <contactGroupSubscriptions>
<contactGroupSubscription> <contactGroupId>MTkwMDE5MDAulp8h68J4rA</contactGroupId> <confirmed>1</confirmed>
</contactGroupSubscription> <contactGroupSubscription> <contactGroupId>MjIwMzAyMjApt6PthAfbxg</contactGroupId>
<confirmed>1</confirmed> </contactGroupSubscription>
</contactGroupSubscriptions> <reference>webform_192.168.0.1</reference>
</addToContactGroupRequest> </con:addToContactGroup>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:addToContactGroupResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <id>MTY3MTI0MDmMdCDprzC_oRpaAAO2LvZr</id>
</response> </ns2:addToContactGroupResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#57#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
ContactService.countByContactDatabaseId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>d>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:countByContactDatabaseId> <countByContactDatabaseIdRequest>
<contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> </countByContactDatabaseIdRequest>
</con:countByContactDatabaseId> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:countByContactDatabaseIdResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <numberOfItems>155818</numberOfItems>
</response> </ns2:countByContactDatabaseIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#58#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
ContactService.countByContactGroupIds*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:countByContactGroupIds> <countByContactGroupIdsRequest>
<contactGroupIds> <contactGroupId>MTkwMDE5MDAulp8h68J4rA</contactGroupId> <contactGroupId>MjIwMzAyMjApt6PthAfbxg</contactGroupId>
</contactGroupIds> </countByContactGroupIdsRequest>
</con:countByContactGroupIds> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:countByContactGroupIdsResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <counts>
<count> <key>MTkwMDE5MDAulp8h68J4rA</key> <value>1965</value>
</count> <count>
<key>MjIwMzAyMjApt6PthAfbxg</key> <value>1</value>
</count> </counts>
</response> </ns2:countByContactGroupIdsResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#59#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
ContactService.countBySearch*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:countBySearch> <countBySearchRequest>
<contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <contactGroupSearchParameters>
<contactGroupSearchParameter> <operator>IN</operator> <contactGroupId>MTkwMDE5MDAulp8h68J4rA</contactGroupId>
</contactGroupSearchParameter> </contactGroupSearchParameters> <contactFieldSearchParameters>
<contactFieldSearchParameter> <contactDatabaseFieldId>NDMxNDMxNDOGCtpvu79hSA</contactDatabaseFieldId> <operator>ENDS_WITH</operator> <value>.com</value>
</contactFieldSearchParameter> </contactFieldSearchParameters> <fieldConditionType>AND</fieldConditionType>
</countBySearchRequest> </con:countBySearch>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:countBySearchResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <numberOfItems>580</numberOfItems>
</response> </ns2:countBySearchResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#60#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
ContactService.countBySmartGroupIds*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:countBySmartGroupIds> <countBySmartGroupIdsRequest>
<smartGroupIds> <smartGroupId>MTMwNDEzMDRJ5G6IeEtBAg</smartGroupId> <smartGroupId>MTMwNTEzMDVCaYQx8YybOQ</smartGroupId>
</smartGroupIds> </countBySmartGroupIdsRequest>
</con:countBySmartGroupIds> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:countBySmartGroupIdsResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <counts>
<count> <key>MTMwNDEzMDRJ5G6IeEtBAg</key> <value>127029</value>
</count> <count>
<key>MTMwNTEzMDVCaYQx8YybOQ</key> <value>1</value>
</count> </counts> </response>
</ns2:countBySmartGroupIdsResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#61#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
ContactService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:create> <createRequest>
<contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <contactFields>
<contactField> <name>email</name> <value>[email protected]</value>
</contactField> <contactField>
<name>customernr</name> <value>987654321</value>
</contactField> <contactField>
<id>ODAxODAxODDHLzd_maJfUw</id> <value>an example value</value>
</contactField> </contactFields>
</createRequest> </con:create>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header>
<soap:Body> <ns2:createResponse xmlns:ns2="http://contact.services.tripolis.com/"
xmlns:ns3="http://services.tripolis.com/"> <response>
<id>MTY3MTIzOTmMdCDprzC_oRpaAAO2LvZr</id> </response>
</ns2:createResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#62#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
ContactService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:delete> <deleteRequest>
<id>MTY3MTIzOTmMdCDprzC_oRpaAAO2LvZr</id> </deleteRequest>
</con:delete> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <id>MTY3MTIzOTmMdCDprzC_oRpaAAO2LvZr</id>
</response> </ns2:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#63#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!
ContactService.getBlacklistedByContactDatabaseId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client>
<username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:getBlacklistedByContactDatabaseId> <getBlacklistedByContactDatabaseIdRequest>
<contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <returnContactFields>
<contactDatabaseFieldGroupNames> <contactDatabaseFieldGroupName>marketing</contactDatabaseFieldGroupName>
</contactDatabaseFieldGroupNames> </returnContactFields> <timeRange>
<startTime>2010-06-05T13:00:00</startTime> <endTime>2010-06-06T23:59:59</endTime>
</timeRange> </getBlacklistedByContactDatabaseIdRequest>
</con:getBlacklistedByContactDatabaseId> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getBlacklistedByContactDatabaseIdResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <blacklistedContacts>
<blacklistedContact> <blacklistedEmail>[email protected]</blacklistedEmail> <blacklistedAt>2010-06-06T00:00:00+02:00</blacklistedAt> <reason>Hard bounce</reason> <reasonNote>5.1.1</reasonNote> <contact>
<contactId>NDY4NDc1NDZgcAnMuD8uSg</contactId> <contactFields>
<contactField> <id>ODg4OTg4ODnY_Il820qFaQ</id> <label>My First Field</label> <name>myfirstfield</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MjGPXza_Crg</contactDatabaseFieldGroupId> <position>4</position> <kindOfField>SUMMARY</kindOfField>
</contactField> <contactField>
<id>ODAxODAxODDHLzd_maJfUw</id> <value>WGPRSPOUFCWSNLBKILJW</value> <label>unsubscribe_string</label> <name>unsubscribe_string</name> <type>STRING</type> <key>false</key> <required>true</required> <contactDatabaseFieldGroupId>MjYxMDI2rg</contactDatabaseFieldGroupId> <position>3</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
! !
p.#64#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
<id>ODEyODEyODGPgAP7WHZToA</id> <value>20100723</value> <label>MailingNr</label> <name>mailingnr</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MihGPXzarg</contactDatabaseFieldGroupId> <position>2</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>ODEzODEzODEGo_AudvERMg</id> <value>225860</value> <label>Customernr</label> <name>customernr</name> <type>STRING</type>
<key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MjPXza_Crg</contactDatabaseFieldGroupId> <position>1</position> <kindOfField>GENERAL</kindOfField>
</contactField> </contactFields>
</contact> </blacklistedContact> <blacklistedContact>
<blacklistedEmail>[email protected]</blacklistedEmail> <blacklistedAt>2010-06-06T00:00:00+02:00</blacklistedAt> <reason>Hard bounce</reason> <reasonNote>5.1.1</reasonNote> <contact>
<contactId>Mzk2NDI4MzlaIeUuAQlb8g</contactId> <contactFields>
<contactField> <id>ODg4OTg4ODnY_Il820qFaQ</id> <label>My First Field</label> <name>myfirstfield</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MjYxza_Crg</contactDatabaseFieldGroupId> <position>4</position> <kindOfField>SUMMARY</kindOfField>
</contactField> <contactField>
<id>ODAxODAxODDHLzd_maJfUw</id> <value>MGQQXYFJCOSOFJAWCNRX</value> <label>unsubscribe_string</label> <name>unsubscribe_string</name> <type>STRING</type> <key>false</key> <required>true</required> <contactDatabaseFieldGroupId>MjYxMD_Crg</contactDatabaseFieldGroupId> <position>3</position> <kindOfField>GENERAL</kindOfField>
</contactField> </contactFields>
</contact> </blacklistedContact>
</blacklistedContacts> </response>
</ns2:getBlacklistedByContactDatabaseIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#65#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
ContactService.getByContactDatabaseId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:getByContactDatabaseId> <getByContactDatabaseIdRequest>
<paging> <pageNr>1</pageNr> <pageSize>3</pageSize>
</paging> <sorting>
<sortBy>customernr</sortBy> <sortOrder>ASC</sortOrder>
</sorting> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <returnContactFields>
<contactDatabaseFieldNames> <contactDatabaseFieldName>customernr</contactDatabaseFieldName> <contactDatabaseFieldName>firstname</contactDatabaseFieldName> <contactDatabaseFieldName>lastname</contactDatabaseFieldName>
</contactDatabaseFieldNames> </returnContactFields>
</getByContactDatabaseIdRequest> </con:getByContactDatabaseId>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByContactDatabaseIdResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>3</pageSize> <totalItems>155818</totalItems>
</paging> <sorting>
<sortBy>customernr</sortBy> <sortOrder>ASC</sortOrder>
</sorting> <contacts>
<contact> <contactId>NDQ4MTA3NDSbjWh9h0wvWQ</contactId> <contactFields>
<contactField> <id>NzkxNzkxNzmqAMNkXIBZUw</id> <label>lastname</label> <name>lastname</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MTY1MZb6HUn*g</contactDatabaseFieldGroupId> <position>3</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>ODEzODEzODEGo_AudvERMg</id> <value>10000013</value>
! !
p.#66#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
<label>Customernr</label> <name>customernr</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MjYhGPXza_Crg</contactDatabaseFieldGroupId> <position>1</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>NzkzNzkzNzmpLBYHs4JMKQ</id> <label>firstname</label> <name>firstname</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MTY1MTY6HUn*g</contactDatabaseFieldGroupId> <position>5</position> <kindOfField>GENERAL</kindOfField>
</contactField> </contactFields>
</contact> <contact>
<contactId>NDg5MTYzNDgUswYooVKTpQ</contactId> <contactFields>
<contactField> <id>NzkxNzkxNzmqAMNkXIBZUw</id> <label>lastname</label> <name>lastname</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MTY1yZb6HUn*g</contactDatabaseFieldGroupId> <position>3</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>ODEzODEzODEGo_AudvERMg</id> <value>10000021</value> <label>Customernr</label> <name>customernr</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MjYihGPXza_Crg</contactDatabaseFieldGroupId> <position>1</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>NzkzNzkzNzmpLBYHs4JMKQ</id> <label>firstname</label> <name>firstname</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MTY1MZb6HUn*g</contactDatabaseFieldGroupId> <position>5</position> <kindOfField>GENERAL</kindOfField>
</contactField> </contactFields>
</contact> </contacts>
</response> </ns2:getByContactDatabaseIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#67#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide#
ContactService.getByContactGroupId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:getByContactGroupId> <getByContactGroupIdRequest>
<paging> <pageNr>1</pageNr> <pageSize>3</pageSize>
</paging> <sorting>
<sortBy>email</sortBy> <sortOrder>ASC</sortOrder>
</sorting> <contactGroupId>MTY3MDE2NzCGksgLK16uJw</contactGroupId> <returnContactFields>
<returnAllContactFields>1</returnAllContactFields> </returnContactFields>
</getByContactGroupIdRequest> </con:getByContactGroupId>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByContactGroupIdResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>3</pageSize> <totalItems>1</totalItems>
</paging> <sorting>
<sortBy>email</sortBy> <sortOrder>ASC</sortOrder>
</sorting> <contacts>
<contact> <contactId>OTM5NjQ4OTO4QG500F*qmw</contactId> <contactFields>
<contactField> <id>NzkxNzkxNzmqAMNkXIBZUw</id> <label>lastname</label> <name>lastname</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MTY1MTY6HUn*g</contactDatabaseFieldGroupId> <position>3</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>ODg4OTg4ODnY_Il820qFaQ</id> <label>My First Field</label> <name>myfirstfield</name> <type>STRING</type> <key>false</key> <required>false</required>
! !
p.#68#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!#
<contactDatabaseFieldGroupId>MAihGPXza_Crg</contactDatabaseFieldGroupId> <position>4</position> <kindOfField>SUMMARY</kindOfField>
</contactField> <contactField>
<id>ODAxODAxODDHLzd_maJfUw</id> <value>a</value> <label>unsubscribe_string</label> <name>unsubscribe_string</name> <type>STRING</type> <key>false</key> <required>true</required> <contactDatabaseFieldGroupId>MjYxMDI2a_Crg</contactDatabaseFieldGroupId> <position>3</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>NDMxNDMxNDOGCtpvu79hSA</id> <value>[email protected]</value> <label>email</label> <name>email</name> <type>EMAIL</type> <key>true</key> <required>true</required> <contactDatabaseFieldGroupId>MTY1MZb6HUn*g</contactDatabaseFieldGroupId> <position>1</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>ODEyODEyODGPgAP7WHZToA</id> <label>MailingNr</label> <name>mailingnr</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MjYxMDIza_Crg</contactDatabaseFieldGroupId> <position>2</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>ODEzODEzODEGo_AudvERMg</id> <label>Customernr</label> <name>customernr</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MjYxhGPXza_Crg</contactDatabaseFieldGroupId> <position>1</position> <kindOfField>GENERAL</kindOfField>
</contactField> </contactFields>
</contact> </contacts>
</response> </ns2:getByContactGroupIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#69#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!
ContactService.getById*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:getById> <getByIdRequest>
<id>OTM5NjQ4OTO4QG500F*qmw</id> <returnContactFields>
<contactDatabaseFieldNames> <contactDatabaseFieldName>email</contactDatabaseFieldName> <contactDatabaseFieldName>customernr</contactDatabaseFieldName> <contactDatabaseFieldName>lastname</contactDatabaseFieldName>
</contactDatabaseFieldNames> </returnContactFields>
</getByIdRequest> </con:getById>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <contact>
<contactId>OTM5NjQ4OTO4QG500F*qmw</contactId> <contactFields>
<contactField> <id>NzkxNzkxNzmqAMNkXIBZUw</id> <label>lastname</label> <name>lastname</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MTY1MTZb6HUn*g</contactDatabaseFieldGroupId> <position>3</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>NDMxNDMxNDOGCtpvu79hSA</id> <value>[email protected]</value> <label>email</label> <name>email</name> <type>EMAIL</type> <key>true</key> <required>true</required> <contactDatabaseFieldGroupId>MTY1MTY1Zb6HUn*g</contactDatabaseFieldGroupId> <position>1</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>ODEzODEzODEGo_AudvERMg</id>
! !
p.#70#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
<label>Customernr</label> <name>customernr</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MjYxGPXza_Crg</contactDatabaseFieldGroupId> <position>1</position> <kindOfField>GENERAL</kindOfField>
</contactField> </contactFields>
</contact> </response>
</ns2:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#71#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
ContactService.getBySmartGroupId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:getBySmartGroupId> <getBySmartGroupIdRequest>
<paging> <pageNr>1</pageNr> <pageSize>5</pageSize>
</paging> <sorting>
<sortBy>email</sortBy> <sortOrder>ASC</sortOrder>
</sorting> <smartGroupId>MTMwNDEzMDRJ5G6IeEtBAg</smartGroupId> <returnContactFields>
<contactDatabaseFieldNames> <contactDatabaseFieldName>email</contactDatabaseFieldName> <contactDatabaseFieldName>customernr</contactDatabaseFieldName> <contactDatabaseFieldName>lastname</contactDatabaseFieldName>
</contactDatabaseFieldNames> </returnContactFields>
</getBySmartGroupIdRequest> </con:getBySmartGroupId>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getBySmartGroupIdResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>5</pageSize> <totalItems>127030</totalItems>
</paging> <sorting>
<sortBy>email</sortBy> <sortOrder>ASC</sortOrder>
</sorting> <contacts>
<contact> <contactId>Mzk0NDA4MzlaIeUuAQlb8g</contactId> <contactFields>
<contactField> <id>NzkxNzkxNzmqAMNkXIBZUw</id> <label>lastname</label> <name>lastname</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MTYGsyZb6HUn*g</contactDatabaseFieldGroupId>
<position>3</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>NDMxNDMxNDOGCtpvu79hSA</id> <value>[email protected]</value>
! !
p.#72#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide
<label>email</label> <name>email</name> <type>EMAIL</type> <key>true</key> <required>true</required> <contactDatabaseFieldGroupId>MTY1MTYb6HUn*g</contactDatabaseFieldGroupId> <position>1</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>ODEzODEzODEGo_AudvERMg</id> <value>14988808</value> <label>Customernr</label> <name>customernr</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MjYxMDPXza_Crg</contactDatabaseFieldGroupId> <position>1</position>
<kindOfField>GENERAL</kindOfField> </contactField>
</contactFields> </contact>
</contacts> </response>
</ns2:getBySmartGroupIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#73#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!
ContactService.getCommunicationHistory*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:getCommunicationHistory> <getCommunicationHistory>
<contactId>Mzk0MzIyMzlaIeUuAQlb8g</contactId> <workspaceId>MTM0MTM0MTOQPQ9zI8rN9A</workspaceId> <timeRange>
<startTime>2010-06-05T13:00:00</startTime> <endTime>2010-06-06T23:59:59</endTime>
</timeRange> <includeFullDetails>1</includeFullDetails> <includeTransactionalJobs>0</includeTransactionalJobs> <includeTestJobs>0</includeTestJobs>
</getCommunicationHistory> </con:getCommunicationHistory>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getCommunicationHistoryResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <databaseName>tripolis</databaseName> <historyObjects>
<historyObject> <contactId>Mzk0MzIyMzlaIeUuAQlb8g</contactId> <workspaceId>MTM0MTM0MTOQPQ9zI8rN9A</workspaceId> <channel>NEWSLETTER</channel> <jobId>MTM5NTYxMzmzKp7e_4cZbA</jobId> <editionId>MTQ0NTE0NDXfrIbNsbmsog</editionId> <jobLabel>TRIPOLIS newsletter week 23</jobLabel> <jobName>newsletterweek23</jobName> <jobSubject>This weeks news</jobSubject> <analyticsIntegrationPartners/> <timeSent>2010-06-06T10:00:00+02:00</timeSent> <status>Ended</status> <isTransactional>false</isTransactional> <isTest>false</isTest> <firstOpenedAt>2010-06-07T16:45:29+02:00</firstOpenedAt> <firstClickedAt>2010-07-02T13:22:43+02:00</firstClickedAt> <opens>
<open> <jobId>MTM5NTYxMzmzKp7e_4cZbA</jobId> <openedAt>2010-06-07T16:45:29+02:00</openedAt> <ip>193.172.8.38</ip> <os>win</os> <client>msoffice 12</client>
</open> <open>
<jobId>MTM5NTYxMzmzKp7e_4cZbA</jobId> <openedAt>2010-06-07T16:45:31+02:00</openedAt> <ip>193.172.8.38</ip> <os>win</os> <client>msoffice 12</client>
</open> </opens>
! !
p.#74#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
<clicks> <click>
<jobId>MTM5NTYxMzmzKp7e_4cZbA</jobId> <clickedAt>2010-07-02T13:22:43+02:00</clickedAt> <ip>193.172.8.38</ip> <os>Windows</os> <client>Chrome</client>
</click> </clicks>
</historyObject> </historyObjects>
</response> </ns2:getCommunicationHistoryResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#75#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ContactService.getContactGroupSubscriptions*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:getContactGroupSubscriptions> <getContactGroupSubscriptionsRequest>
<id>Mzk0MzIyMzlaIeUuAQlb8g</id> <groupTypes>
<groupType>STATIC</groupType> </groupTypes>
</getContactGroupSubscriptionsRequest> </con:getContactGroupSubscriptions>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getContactGroupSubscriptionsResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <contactGroupSubscriptions>
<contactGroupSubscription> <contactGroupId>MzI5MzI5MzJCIrmafU_qrg</contactGroupId> <confirmed>true</confirmed> <label>Partner Mailings</label> <name>partnermailings</name> <type>STATIC</type> <archived>false</archived>
</contactGroupSubscription> <contactGroupSubscription>
<contactGroupId>MTU3MjE1NzI7aEucTLyCxA</contactGroupId> <confirmed>true</confirmed> <label>Weekly Newsletter</label> <name>weeklynewsletter</name> <type>STATIC</type> <archived>false</archived>
</contactGroupSubscription> </contactGroupSubscriptions>
</response> </ns2:getContactGroupSubscriptionsResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#76#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ContactService.removeFromContactGroup*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:removeFromContactGroup> <removeFromContactGroupRequest>
<contactId>MTY3MTI0MDmMdCDprzC_oRpaAAO2LvZr</contactId> <contactGroupIds>
<contactGroupId>MjIwMzAyMjApt6PthAfbxg</contactGroupId> </contactGroupIds> <reference>webform_192.168.0.2</reference>
</removeFromContactGroupRequest> </con:removeFromContactGroup>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:removeFromContactGroupResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <id>MTY3MTI0MDmMdCDprzC_oRpaAAO2LvZr</id>
</response> </ns2:removeFromContactGroupResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#77#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ContactService.search*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:search> <searchRequest>
<paging> <pageNr>1</pageNr> <pageSize>3</pageSize>
</paging> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <contactGroupSearchParameters>
<contactGroupSearchParameter> <operator>IN</operator> <contactGroupId>MTkwMDE5MDAulp8h68J4rA</contactGroupId>
</contactGroupSearchParameter> </contactGroupSearchParameters> <contactFieldSearchParameters>
<contactFieldSearchParameter> <contactDatabaseFieldId>NDMxNDMxNDOGCtpvu79hSA</contactDatabaseFieldId> <operator>ENDS_WITH</operator> <value>.com</value>
</contactFieldSearchParameter> </contactFieldSearchParameters> <returnContactFields>
<returnAllContactFields>1</returnAllContactFields> </returnContactFields>
</searchRequest> </con:search>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:searchResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>3</pageSize> <totalItems>580</totalItems>
</paging> <contacts>
<contact> <contactId>Mzk5NDQ0MzlaIeUuAQlb8g</contactId> <contactFields>
<contactField> <id>NzkxNzkxNzmqAMNkXIBZUw</id> <label>lastname</label> <name>lastname</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MTY1MTYb6HUn*g</contactDatabaseFieldGroupId> <position>3</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>ODg4OTg4ODnY_Il820qFaQ</id>
! !
p.#78#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
<label>My First Field</label> <name>myfirstfield</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MjYxMDIza_Crg</contactDatabaseFieldGroupId> <position>4</position> <kindOfField>SUMMARY</kindOfField>
</contactField> <contactField>
<id>ODAxODAxODDHLzd_maJfUw</id> <value>XTTCEPPVHKAZQPYNNKQQ</value> <label>unsubscribe_string</label> <name>unsubscribe_string</name> <type>STRING</type> <key>false</key> <required>true</required> <contactDatabaseFieldGroupId>MjYxMGPXza_Crg</contactDatabaseFieldGroupId> <position>3</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>NDMxNDMxNDOGCtpvu79hSA</id> <value>[email protected]</value> <label>email</label> <name>email</name> <type>EMAIL</type> <key>true</key> <required>true</required> <contactDatabaseFieldGroupId>MZGsyZb6HUn*g</contactDatabaseFieldGroupId> <position>1</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>ODEyODEyODGPgAP7WHZToA</id> <value>20100723</value>
<label>MailingNr</label> <name>mailingnr</name> <type>STRING</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MjYxMDXza_Crg</contactDatabaseFieldGroupId> <position>2</position> <kindOfField>GENERAL</kindOfField>
</contactField> </contactFields>
</contact> </contacts>
</response> </ns2:searchResponse>
</soap:Body> </soap:Envelope>
! *
! !
p.#79#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ContactService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:con="http://contact.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<con:update> <updateRequest>
<id>MTY3MTIzOTmMdCDprzC_oRpaAAO2LvZr</id> <contactFields>
<contactField> <id>ODAxODAxODDHLzd_maJfUw</id> <value>another value</value>
</contactField> <contactField>
<name>mailingnr</name> <value>uno</value>
</contactField> </contactFields>
</updateRequest> </con:update>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <id>MTY3MTIzOTmMdCDprzC_oRpaAAO2LvZr</id>
</response> </ns2:updateResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#80#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ImportService*[DIALOGUE_INSTANCE_URL]/api2/soap/ImportService?wsdl!!!The!ImportService!is!intended!for!bulk!processing!of!contacts.!!Operations:!
• getImportStatus!• getServiceInfo!• importContacts!• importContactsFromFtp!• scheduleImportContacts!• unscheduleImportContacts!
!
ImportService.getImportStatus*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imp="http://importer.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<imp:getImportStatus> <getImportStatusRequest>
<importId>NjE3NDQ2MTcmYCG8tgi52A</importId> </getImportStatusRequest>
</imp:getImportStatus> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getImportStatusResponse xmlns:ns2="http://importer.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <startedAt>2011-12-14T12:05:00+01:00</startedAt> <validationDuration>9</validationDuration> <transferDuration>442</transferDuration> <databaseDuration>926</databaseDuration> <totalDuration>1000</totalDuration> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <contactDatabaseLabel>Tripolis</contactDatabaseLabel> <contactGroups/> <importedBy>[email protected]</importedBy> <importMode>ADD_OR_UPDATE</importMode> <importStatus>ENDED</importStatus> <importedFile>import.csv</importedFile> <ftpAccountId>NDMyNDMyNDPt7AEAmTripolisttg</ftpAccountId> <source>API</source> <created>0</created> <updated>2</updated> <skipped>0</skipped> <duplicates>0</duplicates> <addedToGroup>0</addedToGroup> <removedFromGroup>0</removedFromGroup> <numberOfErrors>0</numberOfErrors> <importErrors/>
</response> </ns2:getImportStatusResponse>
! !
p.#81#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
</soap:Body> </soap:Envelope>
*
ImportService.importContacts*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imp="http://importer.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<imp:importContacts> <importContactsRequest>
<contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <reportReceiverAddress>[email protected]</reportReceiverAddress> <importMode>ADD_OR_UPDATE</importMode> <fileName>import.csv</fileName> <extension>CSV</extension> <importFile>cid:913991291543</importFile>
</importContactsRequest> </imp:importContacts>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:importContactsResponse xmlns:ns2="http://importer.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <processId>Njk4NjU2OTjDc0vXVUUwtA</processId> <importId>NjE3NzM2MTcmYCG8tgi52A</importId>
</response> </ns2:importContactsResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#82#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ImportService.importContactsFromFtp*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imp="http://importer.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<imp:importContactsFromFtp> <importContactsFromFtpRequest>
<contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <reportReceiverAddress>[email protected]</reportReceiverAddress> <importMode>ADD_OR_UPDATE</importMode> <fileName>import.csv</fileName> <extension>CSV</extension> <ftpAccountId>NDMyNDMyNDPt7AEAmTripolisttg</ftpAccountId> <scheduleAt>2011-12-14T12:05:00</scheduleAt>
</importContactsFromFtpRequest> </imp:importContactsFromFtp>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:importContactsFromFtpResponse xmlns:ns2="http://importer.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <processId>Njk4MzY2OTjDc0vXVUUwtA</processId> <importId>NjE3NDQ2MTcmYCG8tgi52A</importId>
</response> </ns2:importContactsFromFtpResponse>
</soap:Body> </soap:Envelope>
!
! !
p.#83#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ImportService.scheduleImportContacts*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imp="http://importer.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<imp:scheduleImportContacts> <scheduleImportContactsRequest>
<contactDatabase> <id>MjI4MjI4MjL*Yv5AFFNgjw</id> <name>abcbank</name>
</contactDatabase>
<contactGroupIds> <!--Zero or more repetitions:--> <contactGroupId>MjEzNDIxMzRSY88XDeHDcQ</contactGroupId> <contactGroupId>MzYyNDk5MzZgRueOqV91rg</contactGroupId>
</contactGroupIds>
<importMode>ADD_TO_GROUP</importMode> <fileName>importfile.csv</fileName> <extension>CSV</extension> <ftpAccountId>MzUzMzUzMzWs2*lOJk4AsQ</ftpAccountId> <schedule>
<!-- Choose between 7 different items at this level--> <weeklyInterval>
<startAt>2012-10-25</startAt> <endAt>2013-02-25</endAt> <repeatCount>6</repeatCount> <intervalInWeeks>2</intervalInWeeks> <dayOfWeek>TUESDAY</dayOfWeek>
<hour>15</hour> <minute>35</minute>
</weeklyInterval> </schedule>
</scheduleImportContactsRequest> </imp:scheduleImportContacts>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:scheduleImportContactsResponse xmlns:ns2="http://importer.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NDE3NDcxNDGk0UJmgrZdog</id>
</response> </ns2:scheduleImportContactsResponse>
</soap:Body> </soap:Envelope>
! !
p.#84#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ImportService.unscheduleImportContacts*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imp="http://importer.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>ne</ser:responseLanguage>
</soap:Header> <soap:Body>
<imp:unscheduleImportContacts> <unscheduleImportContactsRequest>
<id>NDE3NDcxNDGk0UJmgrZdog</id> </unscheduleImportContactsRequest>
</imp:unscheduleImportContacts> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:unscheduleImportContactsResponse xmlns:ns2="http://importer.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response/> </ns2:unscheduleImportContactsResponse>
</soap:Body> </soap:Envelope>
! !
p.#85#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SubscriptionService*[DIALOGUE_INSTANCE_URL]/api2/soap/SubscriptionService?wsdl!!!The!SubscriptionService!can!be!used!to:!!
f import!or!update!a!contact.!f create!subscriptions!for!a!new!or!existing!contact.!f send!(confirmation/welcome)!direct!emails!or!newsletters!to!the!contact.!
!Operations:!
• getServiceInfo!• subscribeContact!
SubscriptionService.subscribeContact*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:sub="http://subscription.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>staging.Tripolis Demo</client> <username>[email protected]</username> <password>Sjoerd01</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<sub:subscribeContact> <!--Optional:--> <subscribeContactRequest>
<contactDatabase> <id>MjI4MjI4MjL*Yv5AFFNgjw</id>
</contactDatabase> <workspace>
<id>MTg4MTg4MTgHYgdawxYRMA</id> </workspace>
<!-- when performing an update, supply the contactId or (all) key contactField(s) <contactId></contactId>
-->
<contactFields> <contactField>
<name>email</name> <value>[email protected]</value>
</contactField> <contactField>
<name>mobile</name> <value>+31624824666</value>
</contactField> <contactField>
<name>firstname</name> <value>Kees</value>
</contactField> <contactField>
<name>lastname</name> <value>Test</value>
</contactField> </contactFields>
<contactGroupSubscriptions> <contactGroupSubscription>
<contactGroup> <id>MjEzNDIxMzRSY88XDeHDcQ</id>
</contactGroup> <confirmed>1</confirmed>
</contactGroupSubscription> <contactGroupSubscription>
<contactGroup>
! !
p.#86#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
<name>TestGroup1</name> </contactGroup> <confirmed>1</confirmed>
</contactGroupSubscription> </contactGroupSubscriptions>
<directEmail> <name>WelcomeMail</name>
</directEmail>
<ip>80.246.197.16</ip>
</subscribeContactRequest> </sub:subscribeContact>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:subscribeContactResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://subscription.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <id>MzgzMjEyNjOMdCDprzC_objSRVVM9XC*z</id>
</response> </ns3:subscribeContactResponse>
</soap:Body> </soap:Envelope>
! *
! !
p.#87#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
Services*4*Content*
Content*module*4*object*structure*!
• ClientDomain,!this!is!the!toplevel!object,!every!user!logs!into!a!client!domain.!• Workspace,!every!ClientDomain!contains!N!Workspaces!(content!database),!every!Workspace!is!linked!to!a!Conf
tactDatabase.!• ArticleType,!every!Workspace!contains!N!ArticleTypes.!An!ArticleType!defines!how!editors!should!create!Articles.!• ArticleField,!every!ArticleType!contains!N!ArticleFields.!• Article,!every!Workspace!contains!N!Articles.!Articles!can!be!used!in!Newsletters.!• Attachment,!every!Workspace!contains!N!Attachments.!Attachments!can!be!used!in!DirectEmails!and!Newsletf
ters.!• Image,!every!Workspace!contains!N!Images.!Images!can!be!used!in!DirectEmails!and!Newsletters.!• DirectEmailType,!every!Workspace!contains!N!DirectEmailTypes.!• DirectEmail,!every!DirectEmailType!contains!N!DirectEmails.!This!is!the!edition,!or!the!actual!content!being!used!
in!an!efmail.!• NewsletterType,!every!Workspace!contains!N!NewsletterTypes.!• NewsletterTemplate,!every!NewsletterType!contains!0f4!NewsletterTemplates!(html!/!txt!/!taffhtml!/!tafftxt).!• NewsletterSection,!every!NewsletterType!contains!N!Sections.!• NewsletterArticleTemplate,!NewsletterTemplate!X!ArticleType,!defines!how!the!article!is!rendered!in!the!Newsf
letterTemplate.!• Newsletter,!every!NewsletterType!contains!N!Newsletters.!Each!Newsletter!contains!N!Articles.!This!is!the!edif
tion,!or!the!actual!content!being!used!in!an!efmail.!• SmsType,!every!Workspace!contains!N!SMSTypes.!• SmsMessage,!every!SMSType!contains!N!SMSMessages.!This!is!the!edition,!or!the!actual!content!being!used!in!an!
SMS!message.!
WorkspaceService*[DIALOGUE_INSTANCE_URL]/api2/soap/WorkspaceService?wsdl!!!The!WorkspaceService!is!intended!for!maintaining!Workspace!definitions.!!Operations:!
• copy!• copyForContactDatabase!• create!• delete!• getAll!• getByContactDatabaseId!• getById!• getServiceInfo!• update!
!! *
! !
p.#88#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
WorkspaceService.copy*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:wor="http://workspace.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<wor:copy> <copyRequest>
<id>MTQ5NTE0OTWr1tGqq3lucA</id> <workspaceName>mysecondworkspace</workspaceName> <workspaceLabel>My Second Workspace</workspaceLabel>
</copyRequest> </wor:copy>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:copyResponse xmlns:ns2="http://workspace.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MTQ5NjE0OTaM*PGvuV4CIg</id>
</response> </ns2:copyResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#89#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
WorkspaceService.copyForContactDatabase*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:wor="http://workspace.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<wor:copyForContactDatabase> <copyWorkspaceForContactDatabaseRequestRequest>
<id>MTQ5NTE0OTWr1tGqq3lucA</id> <workspaceName>mythirdworkspace</workspaceName> <workspaceLabel>My Third Workspace</workspaceLabel> <contactDatabaseName>mythirddatabase</contactDatabaseName> <contactDatabaseLabel>My Third Database</contactDatabaseLabel>
</copyWorkspaceForContactDatabaseRequestRequest> </wor:copyForContactDatabase>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:copyForContactDatabaseResponse xmlns:ns2="http://workspace.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MTQ5NzE0OTc9_nbLsTkpig</id>
</response> </ns2:copyForContactDatabaseResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#90#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
WorkspaceService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:wor="http://workspace.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<wor:create> <createRequest>
<contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <label>My First Workspace</label> <name>myfirstworkspace</name><listUnsubscribeHeader>true</listUnsubscribeHeader>
</createRequest> </wor:create>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://workspace.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MTQ5NTE0OTWr1tGqq3lucA</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#91#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
WorkspaceService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:wor="http://workspace.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<wor:delete> <deleteRequest>
<id>MTQ5NzE0OTc9_nbLsTkpig</id> </deleteRequest>
</wor:delete> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://workspace.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MTQ5NzE0OTc9_nbLsTkpig</id>
</response> </ns2:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#92#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
WorkspaceService.getAll*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:wor="http://workspace.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<wor:getAll> <getAllRequest/>
</wor:getAll> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getAllResponse xmlns:ns2="http://workspace.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <workspaces>
<workspace> <id>MTQ5NTE0OTWr1tGqq3lucA</id> <label>My First Workspace</label> <name>myfirstworkspace</name> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <publicDomainName/> <bounceDomainName/> <listUnsubscribeHeader>true</listUnsubscribeHeader>
</workspace> <workspace>
<id>MTQ5NjE0OTaM*PGvuV4CIg</id> <label>My Second Workspace</label> <name>mysecondworkspace</name> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <publicDomainName/> <bounceDomainName/> <listUnsubscribeHeader>true</listUnsubscribeHeader>
</workspace> <workspace>
<id>MTQ5NzE0OTc9_nbLsTkpig</id> <label>My Third Workspace</label> <name>mythirdworkspace</name> <contactDatabaseId>MjAzNTIwMzW1D373Rm_6Xw</contactDatabaseId> <publicDomainName/> <bounceDomainName/> <listUnsubscribeHeader>true</listUnsubscribeHeader>
</workspace></workspaces>
</response> </ns2:getAllResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#93#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
WorkspaceService.getByContactDatabaseId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:wor="http://workspace.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<wor:getByContactDatabaseId> <getByContactDatabaseIdRequest>
<contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> </getByContactDatabaseIdRequest>
</wor:getByContactDatabaseId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByContactDatabaseIdResponse xmlns:ns2="http://workspace.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <workspaces>
<workspace> <id>MTM0MTM0MTOQPQ9zI8rN9A</id> <label>Tripolis</label> <name>tripolis</name> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <publicDomainName/> <bounceDomainName/> <listUnsubscribeHeader>false</listUnsubscribeHeader>
</workspace> <workspace>
<id>Mzk1Mzk1Mzlj_r9c9TgYvA</id> <label>Tripolis Images</label> <name>tripolisimages</name> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <publicDomainName/> <bounceDomainName/> <listUnsubscribeHeader>false</listUnsubscribeHeader>
</workspace> <workspace>
<id>MTI0NzEyNDfdiZx3HCCs6A</id> <label>Tripolis_qa_test</label> <name>qa_test</name> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <publicDomainName/> <bounceDomainName/> <listUnsubscribeHeader>false</listUnsubscribeHeader>
</workspace> </workspaces>
</response> </ns2:getByContactDatabaseIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#94#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
WorkspaceService.getById*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:wor="http://workspace.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<wor:getById> <getByIdRequest>
<id>Mzc0Mzc0MzeCz4aUdLJT3Q</id> </getByIdRequest>
</wor:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://workspace.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <workspace>
<id>Mzc0Mzc0MzeCz4aUdLJT3Q</id> <label>My Second Workspace</label> <name>mysecondworkspace</name> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <publicDomainName/> <bounceDomainName/>
<listUnsubscribeHeader>true</listUnsubscribeHeader> </workspace>
</response> </ns2:getByIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#95#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
WorkspaceService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:wor="http://workspace.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<wor:update> <updateRequest>
<id>MTQ5NzE0OTc9_nbLsTkpig</id> <label>My New Workspace</label>
<name>mynewworkspace</name><listUnsubscribeHeader>true</listUnsubscribeHeader>
</updateRequest> </wor:update>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateResponse xmlns:ns2="http://workspace.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MTQ5NzE0OTc9_nbLsTkpig</id>
</response> </ns2:updateResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#96#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleTypeService*[DIALOGUE_INSTANCE_URL]/api2/soap/ArticleTypeService?wsdl!!The!ArticleTypeService!is!intended!for!maintaining!ArticleType!definitions.!!Operations:!
• countByWorkspaceId!• create!• delete!• getById!• getByWorkspaceId!• getServiceInfo!• update!
!
ArticleTypeService.countByWorkspaceId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<type:countByWorkspaceId> <countByWorkspaceIdRequest>
<workspaceId>MTM0MTM0MTOQPQ9zI8rN9A</workspaceId> </countByWorkspaceIdRequest>
</type:countByWorkspaceId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:countByWorkspaceIdResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://type.article.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <numberOfItems>12</numberOfItems>
</response> </ns3:countByWorkspaceIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#97#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleTypeService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<type:create> <createRequest>
<workspaceId>MTM0MTM0MTOQPQ9zI8rN9A</workspaceId> <label>My First Article</label> <name>myfirstarticle</name> <articleFields>
<articleField> <label>Title</label> <name>Title</name> <defaultValue>myTitle</defaultValue> <required>false</required> <position>1</position> <articleFieldType>TEXTFIELD</articleFieldType>
</articleField> </articleFields>
</createRequest> </type:create>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:createResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://type.article.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <id>MjI3MjIyNzK_68dmV2c*8Q</id>
</response> </ns3:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#98#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleTypeService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<type:delete> <deleteRequest>
<id>MjI3MjIyNzK_68dmV2c*8Q</id> </deleteRequest>
</type:delete> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:deleteResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://type.article.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <id>MjI3MjIyNzK_68dmV2c*8Q</id>
</response> </ns3:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#99#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleTypeService.getById*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<type:getById> <getByIdRequest>
<id>MjI3MjIyNzK_68dmV2c*8Q</id> </getByIdRequest>
</type:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:getByIdResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://type.article.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <articleType>
<id>MjI3MjIyNzK_68dmV2c*8Q</id> <label>My First Article</label> <name>myfirstarticle</name> <workspaceId>MTM0MTM0MTOQPQ9zI8rN9A</workspaceId> <articleFields>
<articleField> <id>NjExODYxMTgAa8v31EYIjg</id> <label>Title</label> <name>Title</name> <defaultValue>myTitle</defaultValue> <required>false</required> <articleTypeId>MjI3MjIyNzK_68dmV2c*8Q</articleTypeId> <position>1</position> <articleFieldType>TEXTFIELD</articleFieldType>
</articleField> </articleFields>
</articleType> </response>
</ns3:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#100#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleTypeService.getByWorkspaceId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<type:getByWorkspaceId> <getByWorkspaceIdRequest>
<workspaceId>MTM0MTM0MTOQPQ9zI8rN9A</workspaceId> <returnArticleFields>false</returnArticleFields>
</getByWorkspaceIdRequest> </type:getByWorkspaceId>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:getByWorkspaceIdResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://type.article.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>12</totalItems>
</paging> <articleTypes>
<articleType> <id>ODg5ODg5ODgAO3_yCG_yqQ</id> <label>TRIPOLIS articletype 1</label> <name>articletype1</name> <workspaceId>MTM0MTM0MTOQPQ9zI8rN9A</workspaceId> <articleFields/>
</articleType> <articleType>
<id>ODkwODkwODn*hCMlH*2kGg</id> <label>TRIPOLIS articletype 2</label> <name>articletype2</name> <workspaceId>MTM0MTM0MTOQPQ9zI8rN9A</workspaceId> <articleFields/>
</articleType> <articleType>
<id>ODY5ODY5ODYWwNc57RmfGA</id> <label>TRIPOLIS header</label>
<name>header</name> <workspaceId>MTM0MTM0MTOQPQ9zI8rN9A</workspaceId> <articleFields/>
</articleType> </articleTypes>
</response> </ns3:getByWorkspaceIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#101#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleTypeService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<type:update> <updateRequest>
<id>MjI3MjIyNzK_68dmV2c*8Q</id> <label>My First Article-type</label> <name>myfirstarticletype</name>
</updateRequest> </type:update>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:updateResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://type.article.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <id>MjI3MjIyNzK_68dmV2c*8Q</id>
</response> </ns3:updateResponse>
</soap:Body> </soap:Envelope>
!!! *
! !
p.#102#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleFieldService*[DIALOGUE_INSTANCE_URL]/api2/soap/ArticleFieldService?wsdl!!The!ArticleFieldService!is!intended!for!maintaining!Article!Field!definitions.!!Operations:!
• countByArticleTypeId!• create!• delete!• getByArticleTypeId!• getById!• getServiceInfo!• update!
!
ArticleFieldService.countByArticleTypeId*
Request!example:! <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:fiel="http://field.article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<fiel:countByArticleTypeId> <countByArticleTypeIdRequest>
<articleTypeId>MjI4MjIyODKX8Jdqiv1Hbw</articleTypeId> </countByArticleTypeIdRequest>
</fiel:countByArticleTypeId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:countByArticleTypeIdResponse xmlns:ns2="http://field.article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <numberOfItems>1</numberOfItems>
</response> </ns2:countByArticleTypeIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#103#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleFieldService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:fiel="http://field.article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<fiel:create> <createRequest>
<label>My First Field</label> <name>myfirstfield</name><required>false</required> <articleTypeId>MjI4MjIyODKX8Jdqiv1Hbw</articleTypeId> <position>1</position> <articleFieldType>TEXTFIELD</articleFieldType>
</createRequest> </fiel:create>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://field.article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NjEyOTYxMjmZBh1MrxbX*Q</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#104#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleFieldService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:fiel="http://field.article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<fiel:delete> <deleteRequest>
<id>NjEyOTYxMjmZBh1MrxbX*Q</id> </deleteRequest>
</fiel:delete> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://field.article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <message>the article field has been deleted</message> <id>NjEyOTYxMjmZBh1MrxbX*Q</id>
</response> </ns2:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#105#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleFieldService.getByArticleTypeId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:fiel="http://field.article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<fiel:getByArticleTypeId> <getByArticleTypeIdRequest>
<articleTypeId>MjI4MjIyODKX8Jdqiv1Hbw</articleTypeId> </getByArticleTypeIdRequest>
</fiel:getByArticleTypeId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByArticleTypeIdResponse xmlns:ns2="http://field.article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>2</totalItems>
</paging> <articleFields>
<articleField> <id>NjEyOTYxMjmZBh1MrxbX*Q</id> <label>My First Field</label> <name>myfirstfield</name> <defaultValue/> <required>false</required> <articleTypeId>MjI4MjIyODKX8Jdqiv1Hbw</articleTypeId> <position>1</position> <articleFieldType>TEXTFIELD</articleFieldType>
</articleField> <articleField>
<id>NjEyODYxMjgyqql7rIcNIw</id> <label>Title</label> <name>Title</name> <defaultValue>myTitle</defaultValue> <required>false</required> <articleTypeId>MjI4MjIyODKX8Jdqiv1Hbw</articleTypeId> <position>2</position> <articleFieldType>TEXTFIELD</articleFieldType>
</articleField> </articleFields>
</response> </ns2:getByArticleTypeIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#106#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleFieldService.getById*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:fiel="http://field.article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<fiel:getById> <getByIdRequest>
<id>NjEyOTYxMjmZBh1MrxbX*Q</id> </getByIdRequest>
</fiel:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://field.article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <articleField>
<id>NjEyOTYxMjmZBh1MrxbX*Q</id> <label>My First Field</label> <name>myfirstfield</name> <defaultValue/> <required>false</required> <articleTypeId>MjI4MjIyODKX8Jdqiv1Hbw</articleTypeId> <position>1</position> <articleFieldType>TEXTFIELD</articleFieldType>
</articleField> </response>
</ns2:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#107#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleFieldService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:fiel="http://field.article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<fiel:update> <updateRequest>
<id>NjEyOTYxMjmZBh1MrxbX*Q</id> <label>My First Field</label> <name>myfirstfield</name> <required>false</required> <position>2</position> <articleFieldType>MjI4MjIyODKX8Jdqiv1Hbw</articleFieldType>
</updateRequest> </fiel:update>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateResponse xmlns:ns2="http://field.article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NjEyOTYxMjmZBh1MrxbX*Q</id>
</response> </ns2:updateResponse>
</soap:Body> </soap:Envelope>
!!! *
! !
p.#108#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService*[DIALOGUE_INSTANCE_URL]/api2/soap/ArticleService?wsdl!!The!ArticleService!is!intended!for!maintaining!and!assigning!Articles.!!Operations:!
• assignToNewsletterSection!• countByNewsletterId!• countByTagIds!• countByWorkspaceId!• create!• createTag!• delete!• deleteTag!• getById!• getByNewsletterId!• getByNewsletterTypeIdAndTagIds!• getByTagIds!• getByWorkspaceId!• getServiceInfo!• getTagsByWorkspaceId!• unassignFromNewsletterSection!• update!• updateTag!
!! *
! !
p.#109#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.assignToNewsletterSection*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:assignToNewsletterSection> <assignToNewsletterSectionRequest>
<id>MjA5MDEyMDlMb_8REdjwqw</id> <newsletterId>NjQyNjY0MjbS0fJJk6q3cA</newsletterId> <newsletterSectionId>Mjk3MTI5NzFZGJ4TesEOoA</newsletterSectionId> <position>1</position>
</assignToNewsletterSectionRequest> </art:assignToNewsletterSection>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:assignToNewsletterSectionResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MjA5MDEyMDlMb_8REdjwqw</id>
</response> </ns2:assignToNewsletterSectionResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#110#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.countByNewsletterId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:countByNewsletterId> <countByNewsletterIdRequest>
<newsletterId>NjQyNjY0MjbS0fJJk6q3cA</newsletterId> </countByNewsletterIdRequest>
</art:countByNewsletterId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:countByNewsletterIdResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <numberOfItems>1</numberOfItems>
</response> </ns2:countByNewsletterIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#111#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.countByTagIds*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:countByTagIds> <countByTagIdsRequest>
<tagIds> <tagId>NTA0MzY1MDR39Lzs6B160A</tagId>
</tagIds> </countByTagIdsRequest>
</art:countByTagIds> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:countByTagIdsResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <numberOfItems>1</numberOfItems>
</response> </ns2:countByTagIdsResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#112#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.countByWorkspaceId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:countByWorkspaceId> <countByWorkspaceIdRequest>
<workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> </countByWorkspaceIdRequest>
</art:countByWorkspaceId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:countByWorkspaceIdResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <numberOfItems>1</numberOfItems>
</response> </ns2:countByWorkspaceIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#113#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:create> <createRequest>
<articleTypeId>MjMyMjIzMjL7gQYua2Ngrg</articleTypeId> <label>My First Article</label> <name>myfirstarticle</name><articleTagIds>
<articleTagId>NTA0MzY1MDR39Lzs6B160A</articleTagId> </articleTagIds> <articleFieldValues>
<articleFieldValue> <key>Title</key> <value>My First Title</value>
</articleFieldValue> </articleFieldValues>
</createRequest> </art:create>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MjA5MDEyMDlMb_8REdjwqw</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#114#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.createTag*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:createTag> <createTagRequest>
<tag>mytag</tag> <workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId>
</createTagRequest> </art:createTag>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createTagResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NTA0MzY1MDR39Lzs6B160A</id>
</response> </ns2:createTagResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#115#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:delete> <deleteRequest>
<id>MjA5MDEyMDlMb_8REdjwqw</id> </deleteRequest>
</art:delete> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MjA5MDEyMDlMb_8REdjwqw</id>
</response> </ns2:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#116#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.deleteTag*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:deleteTag> <deleteTagRequest>
<tagId>NTA0MzY1MDR39Lzs6B160A</tagId> </deleteTagRequest>
</art:deleteTag> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteTagResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NTA0MzY1MDR39Lzs6B160A</id>
</response> </ns2:deleteTagResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#117#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.getById*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:getById> <getByIdRequest>
<id>MjA5MDEyMDlMb_8REdjwqw</id> </getByIdRequest>
</art:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <article>
<id>MjA5MDEyMDlMb_8REdjwqw</id> <label>My First Article</label> <name>myfirstarticle</name> <author>[email protected]</author> <modifiedAt>2011-12-20T15:18:36+01:00</modifiedAt> <articleTypeId>MjMyMjIzMjL7gQYua2Ngrg</articleTypeId> <articleTags>
<articleTag> <id>NTA0MzY1MDR39Lzs6B160A</id> <workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>mytag</label> <type>ARTICLE</type>
</articleTag> </articleTags>
</article> </response> </ns2:getByIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#118#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.getByNewsletterId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:getByNewsletterId> <getByNewsletterIdRequest>
<newsletterId>NjQyNjY0MjbS0fJJk6q3cA</newsletterId> </getByNewsletterIdRequest>
</art:getByNewsletterId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByNewsletterIdResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <articles>
<article> <id>MjA5MDEyMDlMb_8REdjwqw</id> <label>My Second Article</label> <name>my2ndarticle</name> <author>[email protected]</author> <modifiedAt>2011-12-20T15:45:46+01:00</modifiedAt> <articleTypeId>MjMyMjIzMjL7gQYua2Ngrg</articleTypeId> <articleTags>
<articleTag> <id>NTA0MzY1MDR39Lzs6B160A</id> <workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>mytag</label> <type>ARTICLE</type>
</articleTag> </articleTags> <newsletterSectionId>Mjk3MTI5NzFZGJ4TesEOoA</newsletterSectionId> <position>1</position> <hasConditions>false</hasConditions> <isReUsed>false</isReUsed>
</article> </articles>
</response> </ns2:getByNewsletterIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#119#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.getByNewsletterTypeIdAndTagIds*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:getByNewsletterTypeIdAndTagIds> <getByNewsletterTypeIdAndTagIdsRequest>
<newsletterTypeId>MTc1NTE3NTVLMlTripolisgLUTFA</newsletterTypeId> <tagIds>
<tagId>NTA0MzY1MDR39Lzs6B160A</tagId> </tagIds> <matchAnyTag>true</matchAnyTag>
</getByNewsletterTypeIdAndTagIdsRequest> </art:getByNewsletterTypeIdAndTagIds>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByNewsletterTypeIdAndTagIdsResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>0</totalItems>
</paging> </response>
</ns2:getByNewsletterTypeIdAndTagIdsResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#120#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.getByTagIds*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:getByTagIds> <getByTagIdsRequest>
<tagIds> <tagId>NTA0MzY1MDR39Lzs6B160A</tagId>
</tagIds> <matchAnyTag>true</matchAnyTag>
</getByTagIdsRequest> </art:getByTagIds>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByTagIdsResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response xsi:type="ns2:ArticleListResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<paging> <pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>1</totalItems>
</paging> <articles>
<article> <id>MjA5MDEyMDlMb_8REdjwqw</id> <label>My First Article</label> <name>myfirstarticle</name> <author>[email protected]</author> <modifiedAt>2011-12-20T15:18:36+01:00</modifiedAt>
<articleTypeId>MjMyMjIzMjL7gQYua2Ngrg</articleTypeId> <articleTags>
<articleTag> <id>NTA0MzY1MDR39Lzs6B160A</id> <workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>mytag</label> <type>ARTICLE</type>
</articleTag> </articleTags>
</article> </articles>
</response> </ns2:getByTagIdsResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#121#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.getByWorkspaceId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:getByWorkspaceId> <getByWorkspaceIdRequest>
<workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> </getByWorkspaceIdRequest>
</art:getByWorkspaceId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByWorkspaceIdResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>1</totalItems>
</paging> <articles>
<article> <id>MjA5MDEyMDlMb_8REdjwqw</id> <label>My First Article</label> <name>myfirstarticle</name> <author>[email protected]</author> <modifiedAt>2011-12-20T15:18:36+01:00</modifiedAt> <articleTypeId>MjMyMjIzMjL7gQYua2Ngrg</articleTypeId> <articleTags>
<articleTag> <id>NTA0MzY1MDR39Lzs6B160A</id> <workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>mytag</label> <type>ARTICLE</type>
</articleTag> </articleTags>
</article> </articles>
</response> </ns2:getByWorkspaceIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#122#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.getTagsByWorkspaceId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:getTagsByWorkspaceId> <getTagsByWorkspaceIdRequest>
<workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> </getTagsByWorkspaceIdRequest>
</art:getTagsByWorkspaceId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getTagsByWorkspaceIdResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>1</totalItems>
</paging> <tags>
<tag> <id>NTA0MzY1MDR39Lzs6B160A</id> <workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>mytag</label>
</tag> </tags>
</response> </ns2:getTagsByWorkspaceIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#123#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.unassignFromNewsletterSection*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:unassignFromNewsletterSection> <unassignFromNewsletterSectionRequest>
<id>MjA5MDEyMDlMb_8REdjwqw</id> <newsletterId>NjQyNjY0MjbS0fJJk6q3cA</newsletterId> <newsletterSectionId>MzAxMTMwMTEiLwJIT_HMCA</newsletterSectionId> <unassignAllArticles>FALSE</unassignAllArticles>
</unassignFromNewsletterSectionRequest> </art:unassignFromNewsletterSection>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:unassignFromNewsletterSectionResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response xsi:type="ns6:IDResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns6="http://response.services.tripolis.com/"/>
</ns2:unassignFromNewsletterSectionResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#124#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:update> <updateRequest>
<id>MjA5MDEyMDlMb_8REdjwqw</id> <label>My Second Article</label> <name>my2ndarticle</name><articleTagIds>
<articleTagId>NTA0MzY1MDR39Lzs6B160A</articleTagId> </articleTagIds> <articleFieldValues>
<articleFieldValue> <key>Title</key> <value>My Second Title</value>
</articleFieldValue> </articleFieldValues>
</updateRequest> </art:update>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MjE1MDEyMTWA2V4P89SHtA</id>
</response> </ns2:updateResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#125#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ArticleService.updateTag*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:updateTag> <updateTagRequest>
<tag>mytag</tag> <tagId>NTA0MzY1MDR39Lzs6B160A</tagId>
</updateTagRequest> </art:updateTag>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateTagResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NTA0MzY1MDR39Lzs6B160A</id>
</response> </ns2:updateTagResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#126#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
AttachmentService*(mtom)*[DIALOGUE_INSTANCE_URL]/api2/soap/AttachmentService?wsdl![DIALOGUE_INSTANCE_URL]/api2/soap/mtom/AttachmentService?wsdl!!The!AttachmentService!is!intended!for!maintaining!Attachments.!!Operations:!
• create!• createTag!• delete!• deleteTag!• getById!• getByTagIds!• getByWorkspaceId!• getServiceInfo!• getTagsByWorkspaceId!• update!• updateTag!
!
AttachmentService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:att="http://attachment.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<att:create> <createRequest>
<workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>My First Attachment</label> <name>myfirstattachment</name> <description>A description</description> <attachmentType>PDF</attachmentType> <content>cid:722533408722</content> <attachmentTagIds>
<attachmentTagId>NTA0MzQ1MDR39Lzs6B160A</attachmentTagId> </attachmentTagIds>
</createRequest> </att:create>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns4:createResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://attachment.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>MTA3MTA3MTCYKbm_*YN9gw</id>
</response> </ns4:createResponse>
</soap:Body> </soap:Envelope>
!
! !
p.#127#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
AttachmentService.createTag*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:att="http://attachment.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<att:createTag> <createTagRequest>
<tag>mytag</tag> <workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId>
</createTagRequest> </att:createTag>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns4:createTagResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://attachment.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>NTA0MzQ1MDR39Lzs6B160A</id>
</response> </ns4:createTagResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#128#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
AttachmentService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:att="http://attachment.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<att:delete> <deleteRequest>
<id>MTA3MTA3MTCYKbm_*YN9gw</id> </deleteRequest>
</att:delete> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns4:deleteResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://attachment.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>MTA3MTA3MTCYKbm_*YN9gw</id>
</response> </ns4:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#129#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
AttachmentService.deleteTag*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:att="http://attachment.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<att:deleteTag> <deleteTagRequest>
<tagId>NTA0MzQ1MDR39Lzs6B160A</tagId> </deleteTagRequest>
</att:deleteTag> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns4:deleteTagResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://attachment.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>NTA0MzQ1MDR39Lzs6B160A</id>
</response> </ns4:deleteTagResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#130#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
AttachmentService.getById*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:att="http://attachment.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<att:getById> <getByIdRequest>
<id>MTA3MTA3MTCYKbm_*YN9gw</id> <includeContent>false</includeContent>
</getByIdRequest> </att:getById>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns4:getByIdResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://attachment.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <attachment>
<id>MTA3MTA3MTCYKbm_*YN9gw</id> <label>My First Attachment</label> <name>myfirstattachment</name> <description>A description</description> <modifiedAt>2011-12-19T13:14:20.062+01:00</modifiedAt> <tags>
<tag> <id>NTA0MzQ1MDR39Lzs6B160A</id> <workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>mytag</label> <type>ATTACHMENT</type>
</tag> </tags> <attachmentType>PDF</attachmentType> <size>272205</size> <fileName>myfirstattachment.pdf</fileName>
</attachment> </response>
</ns4:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#131#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
AttachmentService.getByTagIds*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:att="http://attachment.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<att:getByTagIds> <getByTagIdsRequest>
<tagIds> <tagId>NTA0MzQ1MDR39Lzs6B160A</tagId>
</tagIds> <matchAnyTag>true</matchAnyTag>
</getByTagIdsRequest> </att:getByTagIds>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns4:getByTagIdsResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://attachment.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response xsi:type="ns4:AttachmentListResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<paging> <pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>1</totalItems>
</paging> <attachments>
<attachment> <id>MTA3MTA3MTCYKbm_*YN9gw</id> <label>My First Attachment</label> <name>myfirstattachment</name> <description>A description</description> <modifiedAt>2011-12-19T13:14:20.062+01:00</modifiedAt> <tags>
<tag> <id>NTA0MzQ1MDR39Lzs6B160A</id> <workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>mytag</label> <type>ATTACHMENT</type>
</tag> </tags> <attachmentType>PDF</attachmentType> <size>272205</size> <fileName>myfirstattachment.pdf</fileName>
</attachment> </attachments>
</response> </ns4:getByTagIdsResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#132#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
AttachmentService.getByWorkspaceId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:att="http://attachment.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<att:getByWorkspaceId> <getByIdRequest>
<workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> </getByIdRequest>
</att:getByWorkspaceId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns4:getByWorkspaceIdResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://attachment.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>1</totalItems>
</paging> <attachments>
<attachment> <id>MTA3MTA3MTCYKbm_*YN9gw</id> <label>My First Attachment</label> <name>myfirstattachment</name> <description>A description</description> <author>[email protected]</author> <modifiedAt>2011-12-19T13:14:20.062+01:00</modifiedAt> <tags>
<tag> <id>NTA0MzQ1MDR39Lzs6B160A</id> <workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>mytag</label> <type>ATTACHMENT</type>
</tag> </tags> <attachmentType>PDF</attachmentType> <size>272205</size> <fileName>myfirstattachment.pdf</fileName>
</attachment> </attachments>
</response> </ns4:getByWorkspaceIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#133#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
AttachmentService.getTagsByWorkspaceId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:att="http://attachment.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<att:getTagsByWorkspaceId> <getTagsByWorkspaceIdRequest>
<workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> </getTagsByWorkspaceIdRequest>
</att:getTagsByWorkspaceId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns4:getTagsByWorkspaceIdResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://attachment.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <tags>
<tag> <id>NTA0MzQ1MDR39Lzs6B160A</id> <workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>mytag</label> <type>ATTACHMENT</type>
</tag> </tags>
</response> </ns4:getTagsByWorkspaceIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#134#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
AttachmentService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:att="http://attachment.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<att:update> <updateRequest>
<id>MTA3MTA3MTCYKbm_*YN9gw</id> <label>My attachment</label> <name>Myattachment</name>
</updateRequest> </att:update>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns4:updateResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://attachment.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>MTA3MTA3MTCYKbm_*YN9gw</id>
</response> </ns4:updateResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#135#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
AttachmentService.updateTag*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:att="http://attachment.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<att:updateTag> <updateTagRequest>
<tag>mytag</tag> <tagId>NTA0MzQ1MDR39Lzs6B160A</tagId>
</updateTagRequest> </att:updateTag>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns4:updateTagResponse xmlns:ns2="http://article.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://attachment.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>NTA0MzQ1MDR39Lzs6B160A</id>
</response> </ns4:updateTagResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#136#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ImageService*(mtom)*[DIALOGUE_INSTANCE_URL]/api2/soap/ImageService?wsdl![DIALOGUE_INSTANCE_URL]/api2/soap/mtom/ImageService?wsdl!!The!ImageService!is!intended!for!maintaining!Images.!!Operations:!
• countByTagIds!• countByWorkspaceId!• create!• createTag!• delete!• deleteTag!• getById!• getByTagIds!• getByWorkspaceId!• getServiceInfo!• getTagsByWorkspaceId!• update!• updateTag!
!
ImageService.countByTagIds*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imag="http://image.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<imag:countByTagIds> <countByImageTagsRequest>
<imageTagIds> <imageTagId>NTAzNjE1MDMJ87zqyawP0g</imageTagId>
</imageTagIds> </countByImageTagsRequest>
</imag:countByTagIds> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:countByTagIdsResponse xmlns:ns2="http://image.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <numberOfItems>1</numberOfItems>
</response> </ns2:countByTagIdsResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#137#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ImageService.countByWorkspaceId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imag="http://image.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<imag:countByWorkspaceId> <countByWorkspaceIdRequest>
<workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> </countByWorkspaceIdRequest>
</imag:countByWorkspaceId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:countByWorkspaceIdResponse xmlns:ns2="http://image.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <numberOfItems>1</numberOfItems>
</response> </ns2:countByWorkspaceIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#138#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ImageService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imag="http://image.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>ne</ser:responseLanguage>
</soap:Header> <soap:Body>
<imag:create> <createRequest>
<workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>My First Image</label> <name>myfirstimage</name> <description>BlTripolisblTripolis</description> <imageType>JPEG</imageType> <content>cid:804718060828</content> <imageTagIds>
<imageTagId>NTAzNjE1MDMJ87zqyawP0g</imageTagId> </imageTagIds>
</createRequest> </imag:create>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://image.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>MTAwMjU5MzaMdCDprzC_oRpaAAO2LvZr</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#139#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ImageService.createTag*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imag="http://image.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<imag:createTag> <createTagRequest>
<tag>mytag</tag> <workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId>
</createTagRequest> </imag:createTag>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createTagResponse xmlns:ns2="http://image.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>NTAzNjE1MDMJ87zqyawP0g</id>
</response> </ns2:createTagResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#140#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ImageService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imag="http://image.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<imag:delete> <deleteRequest>
<id>MTAwMjU5MzaMdCDprzC_oRpaAAO2LvZr</id> </deleteRequest>
</imag:delete> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://image.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>MTAwMjU5MzaMdCDprzC_oRpaAAO2LvZr</id> </response>
</ns2:deleteResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#141#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ImageService.deleteTag*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imag="http://image.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<imag:deleteTag> <deleteTagRequest>
<tagId>NTAzNjE1MDMJ87zqyawP0g</tagId> </deleteTagRequest>
</imag:deleteTag> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteTagResponse xmlns:ns2="http://image.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>NTAzNjE1MDMJ87zqyawP0g</id>
</response> </ns2:deleteTagResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#142#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ImageService.getById*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imag="http://image.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>ne</ser:responseLanguage>
</soap:Header> <soap:Body>
<imag:getById> <getByIdRequest>
<id>MTAwMjU5MzaMdCDprzC_oRpaAAO2LvZr</id> </getByIdRequest>
</imag:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://image.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <image>
<id>MTAwMjU5MzaMdCDprzC_oRpaAAO2LvZr</id> <label>My First Image</label> <name>myfirstimage</name> <description>BlTripolisblTripolis</description> <author>[email protected]</author> <modifiedAt>2011-12-19T11:54:11+01:00</modifiedAt> <imageTags>
<imageTag> <id>NTAzNjE1MDMJ87zqyawP0g</id> <workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>mytag</label> <type>IMAGE</type>
</imageTag> </imageTags> <thumbnailUrl>http://tripolis.com/public/image_MAAO2LvZr.jpg?thumb</thumbnailUrl> <publicUrl>http://tripolis.com/public/image_MTAwMjU5MzaMdCDprzvZr.jpg</publicUrl> <imageType>JPEG</imageType> <height>1552</height> <width>822</width>
</image> </response>
</ns2:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#143#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ImageService.getByTagIds*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imag="http://image.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<imag:getByTagIds> <getByTagIdsRequest>
<tagIds> <tagId>NTAzNjE1MDMJ87zqyawP0g</tagId>
</tagIds> <matchAnyTag>true</matchAnyTag>
</getByTagIdsRequest> </imag:getByTagIds>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByTagIdsResponse xmlns:ns2="http://image.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response xsi:type="ns2:ImageListResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<paging> <pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>1</totalItems>
</paging> <images>
<image> <id>MTAwMjU5MzaMdCDprzC_oRpaAAO2LvZr</id> <label>My First Image</label> <name>myfirstimage</name> <description>BlTripolisblTripolis</description> <author>[email protected]</author> <modifiedAt>2011-12-19T11:54:11+01:00</modifiedAt> <imageTags>
<imageTag> <id>NTAzNjE1MDMJ87zqyawP0g</id> <workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>mytag</label> <type>IMAGE</type>
</imageTag> </imageTags> <thumbnailUrl>http://tripolis.com/public/image_YO*svZr.jpg?thumb</thumbnailUrl> <publicUrl>http://tripolis.com/public/image_RpaAAO2LvZr.jpg</publicUrl> <imageType>JPEG</imageType> <height>1552</height> <width>822</width>
</image> </images>
</response> </ns2:getByTagIdsResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#144#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ImageService.getByWorkspaceId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imag="http://image.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<imag:getByWorkspaceId> <getByWorkspaceIdRequest>
<workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> </getByWorkspaceIdRequest>
</imag:getByWorkspaceId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByWorkspaceIdResponse xmlns:ns2="http://image.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>1</totalItems>
</paging> <images>
<image> <id>MTAwMjU5MzaMdCDprzC_oRpaAAO2LvZr</id> <label>My First Image</label> <name>myfirstimage</name> <description>BlTripolisblTripolis</description> <author>[email protected]</author> <modifiedAt>2011-12-19T11:54:11+01:00</modifiedAt> <imageTags>
<imageTag> <id>NTAzNjE1MDMJ87zqyawP0g</id> <workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>mytag</label> <type>IMAGE</type>
</imageTag> </imageTags> <thumbnailUrl>http://tripolis.com/public/image_MaOvZr.jpg?thumb</thumbnailUrl> <publicUrl>http://tripolis.com/public/image_MTAwMjU5MzaMLvZr.jpg</publicUrl> <imageType>JPEG</imageType> <height>1552</height> <width>822</width>
</image> </images>
</response> </ns2:getByWorkspaceIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#145#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ImageService.getTagsByWorkspaceId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imag="http://image.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<imag:getTagsByWorkspaceId> <getTagsByWorkspaceIdRequest>
<workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> </getTagsByWorkspaceIdRequest>
</imag:getTagsByWorkspaceId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getTagsByWorkspaceIdResponse xmlns:ns2="http://image.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <tags>
<tag> <id>NTAzNjE1MDMJ87zqyawP0g</id> <workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>mytag</label>
</tag> </tags>
</response> </ns2:getTagsByWorkspaceIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#146#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ImageService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imag="http://image.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<imag:update> <updateRequest>
<id>MTAwMjU2NDWMdCDprzC_oRpaAAO2LvZr</id> <label>Demo Image</label> <name>demoimage</name> <description>A description</description>
</updateRequest> </imag:update>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateResponse xmlns:ns2="http://image.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>MTAwMjU2NDWMdCDprzC_oRpaAAO2LvZr</id>
</response> </ns2:updateResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#147#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ImageService.updateTag*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:imag="http://image.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<imag:updateTag> <updateTagRequest>
<tag>mytag</tag> <tagId>NTAzNjE1MDMJ87zqyawP0g</tagId>
</updateTagRequest> </imag:updateTag>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateTagResponse xmlns:ns2="http://image.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>NTAzNjE1MDMJ87zqyawP0g</id>
</response> </ns2:updateTagResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#148#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
DirectEmailTypeService**[DIALOGUE_INSTANCE_URL]/api2/soap/DirectEmailTypeService?wsdl!!The!DirectEmailTypeService!is!intended!for!maintaining!DirectEmailType!definitions.!!Operations:!
• create!• delete!• getById!• getByWorkspaceId!• getServiceInfo!• update!
!
DirectEmailTypeService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.directemail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<type:create> <createRequest>
<workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>My First DirectEmailType</label> <name>myfirstdmailtype</name> <fromName>Tripolis Support</fromName> <fromAddress>[email protected]</fromAddress> <toEmailFieldId>NDMxNDMxNDOGCtpvu79hSA</toEmailFieldId> <enableWysiwygEditor>true</enableWysiwygEditor> <encoding>UTF8</encoding> <enableAttachments>false</enableAttachments>
</createRequest> </type:create>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://type.directemail.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MTI5NDEyOTSEO2CbeFOpjQ</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#149#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
DirectEmailTypeService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.directemail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<type:delete> <deleteRequest>
<id>MTI5NDEyOTSEO2CbeFOpjQ</id> </deleteRequest>
</type:delete> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://type.directemail.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response/> </ns2:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#150#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
DirectEmailTypeService.getById*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.directemail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<type:getById> <getByIdRequest>
<id>MjIzMjIzMjJNeZMkjaeVjQ</id> </getByIdRequest>
</type:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://type.directemail.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <directEmailType>
<id>MTI5NDEyOTSEO2CbeFOpjQ</id> <label>My First DirectEmailType</label> <name>myfirstdmailtype</name> <fromName>Tripolis Support</fromName> <fromAddress>[email protected]</fromAddress> <toEmailFieldId>NDMxNDMxNDOGCtpvu79hSA</toEmailFieldId> <replyToAddress/> <externalHtmlUrl/> <externalTextUrl/> <enableWysiwygEditor>true</enableWysiwygEditor> <encoding>UTF8</encoding> <enableAttachments>false</enableAttachments>
</directEmailType> </response>
</ns2:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#151#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
DirectEmailTypeService.getByWorkspaceId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.directemail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>ne</ser:responseLanguage>
</soap:Header> <soap:Body>
<type:getByWorkspaceId> <getByWorkspaceIdRequest>
<workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> </getByWorkspaceIdRequest>
</type:getByWorkspaceId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByWorkspaceIdResponse xmlns:ns2="http://type.directemail.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <directEmailTypes>
<directEmailType> <id>MTI5NDEyOTSEO2CbeFOpjQ</id> <label>My First DirectEmailType</label> <name>myfirstdmailtype</name> <fromName>Tripolis Support</fromName> <fromAddress>[email protected]</fromAddress> <toEmailFieldId>NDMxNDMxNDOGCtpvu79hSA</toEmailFieldId> <replyToAddress/> <externalHtmlUrl/> <externalTextUrl/> <enableWysiwygEditor>true</enableWysiwygEditor> <encoding>UTF8</encoding> <enableAttachments>false</enableAttachments>
</directEmailType> </directEmailTypes>
</response> </ns2:getByWorkspaceIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#152#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
DirectEmailTypeService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.directemail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<type:update> <updateRequest>
<id>MTI5NDEyOTSEO2CbeFOpjQ</id> <label>My Second DirectEmail Type</label> <name>myseconddmailtype</name> <fromName>Tripolis Solutions</fromName> <fromAddress>[email protected]</fromAddress> <toEmailFieldId>NDMxNDMxNDOGCtpvu79hSA</toEmailFieldId> <enableWysiwygEditor>true</enableWysiwygEditor> <encoding>UTF8</encoding> <enableAttachments>true</enableAttachments>
</updateRequest> </type:update>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateResponse xmlns:ns2="http://type.directemail.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MTI5NDEyOTSEO2CbeFOpjQ</id>
</response> </ns2:updateResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#153#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
DirectEmailService*[DIALOGUE_INSTANCE_URL]/api2/soap/DirectEmailService?wsdl!!The!DirectEmailService!is!intended!for!maintaining!DirectEmails!definitions.!!Operations:!
• assignAttachment!• create!• delete!• getByDirectEmailTypeId!• getById!• getServiceInfo!• preview!• unassignAttachment!• update!
!
DirectEmailService.assignAttachment*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:dir="http://directemail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<dir:assignAttachment> <assignAttachmentRequest>
<id>MjUwNDI1MDQsO7DPpXDtCQ</id> <attachmentId>MTA4MTA4MTAR3HZCQQStxA</attachmentId>
</assignAttachmentRequest> </dir:assignAttachment>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:assignAttachmentResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://directemail.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response/> </ns3:assignAttachmentResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#154#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
DirectEmailService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:dir="http://directemail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>ne</ser:responseLanguage>
</soap:Header> <soap:Body>
<dir:create> <createRequest>
<directEmailTypeId>MTMwNDEzMDRJ5G6IeEtBAg</directEmailTypeId> <label>My First DirectEmail</label> <name>myfirstdirectemail</name> <subject>This is a test-subject</subject>
<description>A description</description> <fromName>Tripolis Support</fromName> <fromAddress>[email protected]</fromAddress>
<htmlSource><![CDATA[ <!doctype html> <html> <head> </head> <body> This is a demo-directemail. </body> </html> ]]> </htmlSource>
<textSource><![CDATA[ This is a demo-directemail. ]]></textSource>
</createRequest> </dir:create>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:createResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://directemail.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <id>MjUwNDI1MDQsO7DPpXDtCQ</id>
</response> </ns3:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#155#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
DirectEmailService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:dir="http://directemail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<dir:delete> <deleteRequest>
<id>MjUwNDI1MDQsO7DPpXDtCQ</id> </deleteRequest>
</dir:delete> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:deleteResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://directemail.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <message>Direct email is deleted</message>
</response> </ns3:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#156#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
DirectEmailService.getByDirectEmailTypeId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:dir="http://directemail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>ne</ser:responseLanguage>
</soap:Header> <soap:Body>
<dir:getByDirectEmailTypeId> <getByDirectEmailTypeIdRequest>
<directEmailTypeId>MTMwNDEzMDRJ5G6IeEtBAg</directEmailTypeId> </getByDirectEmailTypeIdRequest>
</dir:getByDirectEmailTypeId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:getByDirectEmailTypeIdResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://directemail.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>1</totalItems>
</paging> <directEmails>
<directEmail> <id>MjUwNDI1MDQsO7DPpXDtCQ</id> <directEmailTypeId>MTMwNDEzMDRJ5G6IeEtBAg</directEmailTypeId> <label>My First DirectEmail</label> <name>myfirstdirectemail</name> <subject>This is a test-subject</subject> <fromName>Tripolis Support</fromName> <fromAddress>[email protected]</fromAddress> <replyToAddress/> <description> A description</description> <author>[email protected]</author> <modifiedAt>2011-12-19T12:45:03+01:00</modifiedAt> <isArchived>false</isArchived>
</directEmail> </directEmails>
</response> </ns3:getByDirectEmailTypeIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#157#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
DirectEmailService.getById*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:dir="http://directemail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>ne</ser:responseLanguage>
</soap:Header> <soap:Body>
<dir:getById> <getByIdRequest>
<id>MjUwNDI1MDQsO7DPpXDtCQ</id> </getByIdRequest>
</dir:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:getByIdResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://directemail.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <directEmail>
<id>MjUwNDI1MDQsO7DPpXDtCQ</id> <directEmailTypeId>MTMwNDEzMDRJ5G6IeEtBAg</directEmailTypeId> <label>My First DirectEmail</label> <name>myfirstdirectemail</name> <subject>This is a test-subject</subject> <fromName>Tripolis Support</fromName> <fromAddress>[email protected]</fromAddress> <replyToAddress/> <description>A description</description> <author>[email protected]</author> <modifiedAt>2011-12-19T12:45:03+01:00</modifiedAt> <isArchived>false</isArchived> <htmlSource><![CDATA[<!doctype html>
<html> <head> </head> <body> This is a demo-directemail. </body> </html>]]></htmlSource>
<textSource>This is a demo-directemail.</textSource> </directEmail>
</response> </ns3:getByIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#158#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
DirectEmailService.preview*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:dir="http://directemail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<dir:preview> <previewRequest>
<id>MjUwNDI1MDQsO7DPpXDtCQ</id><contactId>OTM5NjQ4OTO4QG500F*qmw</contactId>
</previewRequest> </dir:preview>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:previewResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://directemail.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <directEmail>
<id>MjUwNDI1MDQsO7DPpXDtCQ</id> <directEmailTypeId>MTMwNDEzMDRJ5G6IeEtBAg</directEmailTypeId> <label>My First DirectEmail</label> <name>myfirstdirectemail</name> <subject>This is a test-subject</subject> <fromName>Tripolis Support</fromName> <fromAddress>[email protected]</fromAddress> <replyToAddress/> <description>A description</description> <author>[email protected]</author> <modifiedAt>2011-12-19T12:51:12+01:00</modifiedAt> <isArchived>false</isArchived> <htmlSource><![CDATA[<!doctype html>
<html> <head> </head> <body> This is a demo-directemail. </body> </html>]]></htmlSource>
<textSource>This is a demo-directemail.</textSource> </directEmail>
</response> </ns3:previewResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#159#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
DirectEmailService.unassignAttachment*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:dir="http://directemail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<dir:unassignAttachment> <unassignAttachmentRequest>
<id>MjUwNDI1MDQsO7DPpXDtCQ</id> <attachmentId>MTA4MTA4MTAR3HZCQQStxA</attachmentId>
</unassignAttachmentRequest> </dir:unassignAttachment>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:unassignAttachmentResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://directemail.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response/> </ns3:unassignAttachmentResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#160#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
DirectEmailService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:dir="http://directemail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<dir:update> <updateRequest>
<id>MjUwNDI1MDQsO7DPpXDtCQ</id><htmlSource><![CDATA[
<!doctype html> <html> <head> </head> <body> This is a demo-directemail. </body> </html> ]]></htmlSource>
</updateRequest> </dir:update>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:updateResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://directemail.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <id>MjUwNDI1MDQsO7DPpXDtCQ</id>
</response> </ns3:updateResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#161#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterTypeService*[DIALOGUE_INSTANCE_URL]/api2/soap/NewsletterTypeService?wsdl!!The!NewsletterTypeService!is!intended!for!maintaining!NewsletterType!definitions.!!Operations:!
• create!• delete!• getById!• getByWorkspaceId!• getServiceInfo!• update!
!
NewsletterTypeService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<type:create> <createRequest>
<workspaceId>MTM0MTM0MTOQPQ9zI8rN9A</workspaceId> <label>My First Newslettertype</label> <name>myfirstnewslettertype</name> <fromName>Tripolis Support</fromName> <fromAddress>[email protected]</fromAddress> <toEmailFieldId>NDMxNDMxNDOGCtpvu79hSA</toEmailFieldId> <defaultSubject>This is the default subject</defaultSubject> <encoding>UTF8</encoding> <enableAttachments>false</enableAttachments>
</createRequest> </type:create>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://type.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MTcxNTE3MTWBMgi6Q0*ZNg</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#162#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterTypeService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<type:delete> <deleteRequest>
<id>MTcxNTE3MTWBMgi6Q0*ZNg</id> </deleteRequest>
</type:delete> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://type.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MTcxNTE3MTWBMgi6Q0*ZNg</id>
</response> </ns2:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#163#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterTypeService.getById*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<type:getById> <getByIdRequest>
<id>Mzg0Mzg0Mzg2KSjtOlcbDg</id> </getByIdRequest>
</type:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://type.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <newsletterType>
<id>MTcxNTE3MTWBMgi6Q0*ZNg</id> <label>My First Newslettertype</label> <name>myfirstnewslettertype</name> <fromName>Tripolis Support</fromName> <fromAddress>[email protected]</fromAddress> <toEmailFieldId>NDMxNDMxNDOGCtpvu79hSA</toEmailFieldId> <replyToAddress/> <defaultSubject>This is the default subject</defaultSubject> <encoding>UTF8</encoding> <enableAttachments>false</enableAttachments>
</newsletterType> </response>
</ns2:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#164#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterTypeService.getByWorkspaceId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<type:getByWorkspaceId> <getByWorkspaceIdRequest>
<workspaceId>MTQ5NjE0OTaM*PGvuV4CIg</workspaceId> </getByWorkspaceIdRequest>
</type:getByWorkspaceId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByWorkspaceIdResponse xmlns:ns2="http://type.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <newsletterTypes/>
</response> </ns2:getByWorkspaceIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#165#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterTypeService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<type:update> <updateRequest>
<id>MTcxNTE3MTWBMgi6Q0*ZNg</id> <label>My Newslettertype</label> <name>mynewslettertype</name> <enableAttachments>true</enableAttachments>
</updateRequest> </type:update>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://type.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MTcxNTE3MTWBMgi6Q0*ZNg</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#166#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterTemplateService*[DIALOGUE_INSTANCE_URL]/api2/soap/NewsletterTemplateService?wsdl!!The!NewsletterTemplateService!is!intended!for!maintaining!NewsletterTemplate!definitions.!!Operations:!
• create!• delete!• getById!• getByWorkspaceId!• getServiceInfo!• update!
!
NewsletterTemplateService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:tem="http://template.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<tem:create> <createRequest>
<newsletterTypeId>MTcyNTE3MjVQniJUe2l*Tw</newsletterTypeId> <label>My First Newsletter Template</label> <name>myfirstnewsltrtemplate</name> <newsletterTemplateType>HTML</newsletterTemplateType> <description>A description</description> <source><![CDATA[
<!doctype html> <html> <head> </head> <body> This is a demo-newsletter. <getarticles section="main" /> </body> </html> ]]></source>
</createRequest> </tem:create>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://template.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MjE0NzIxNDfeTAal52FaFg</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!
! !
p.#167#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterTemplateService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:tem="http://template.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<tem:delete> <deleteRequest>
<id>MjE0NzIxNDfeTAal52FaFg</id> </deleteRequest>
</tem:delete> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://template.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <message>The newsletter template has been deleted</message> <id>MjE0NzIxNDfeTAal52FaFg</id>
</response> </ns2:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#168#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterTemplateService.getById*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:tem="http://template.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<tem:getById> <getByIdRequest>
<id>NTI1NTI1NTJhLZWKzcn7Wg</id> </getByIdRequest>
</tem:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://template.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <newsletterTemplate>
<id>NTI1NTI1NTJhLZWKzcn7Wg</id> <label>My First Newsletter Template</label> <name>myfirstnewsltrtemplate</name> <newsletterTemplateType>HTML</newsletterTemplateType> <description/> <source><![CDATA[<!doctype html>
<html> <head> </head> <body> This is a demo-newsletter. <getarticles section="main" /> </body> </html>]]></source>
<author>[email protected]</author> </newsletterTemplate>
</response> </ns2:getByIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#169#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterTemplateService.getByNewsletterTypeId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:tem="http://template.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<tem:getByNewsletterTypeId> <getByNewsletterTypeIdRequest>
<newsletterTypeId>MTcyNTE3MjVQniJUe2l*Tw</newsletterTypeId> </getByNewsletterTypeIdRequest>
</tem:getByNewsletterTypeId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByNewsletterTypeIdResponse xmlns:ns2="http://template.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <newsletterTemplates>
<newsletterTemplate> <id>MjE0NzIxNDfeTAal52FaFg</id> <label>My First Newsletter Template</label> <name>myfirstnewsltrtemplate</name> <newsletterTemplateType>HTML</newsletterTemplateType> <description/> <source><![CDATA[<!doctype html>
<html> <head> </head> <body> This is a demo-newsletter. <getarticles section="main" /> </body> </html>]]></source>
<author>[email protected]</author> </newsletterTemplate>
</newsletterTemplates> </response>
</ns2:getByNewsletterTypeIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#170#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterTemplateService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:tem="http://template.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<tem:update> <updateRequest>
<id>MjE0NzIxNDfeTAal52FaFg</id> <label>My First HTML Template</label> <name>myfirsthtmltemplate</name> <description>This is a demo HTML template</description>
</updateRequest> </tem:update>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateResponse xmlns:ns2="http://template.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MjE0NzIxNDfeTAal52FaFg</id>
</response> </ns2:updateResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#171#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterSectionService*[DIALOGUE_INSTANCE_URL]/api2/soap/NewsletterSectionService?wsdl!!The!NewsletterSectionService!is!intended!for!maintaining!Sections.!!Operations:!
• create!• delete!• getById!• getByNewsletterTypeId!• getServiceInfo!• update!
!
NewsletterSectionService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:sec="http://section.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<sec:create> <createRequest>
<newsletterTypeId>MTcyNTE3MjVQniJUe2l*Tw</newsletterTypeId> <label>My First Section</label> <name>myfirstsection</name> <defaultArticleTypeId>MjI4MjIyODKX8Jdqiv1Hbw</defaultArticleTypeId>
</createRequest> </sec:create>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://section.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MjkzMTI5MzFo5OGaCzfpQA</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#172#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterSectionService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:sec="http://section.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<sec:delete> <deleteRequest>
<id>MjkzMTI5MzFo5OGaCzfpQA</id> </deleteRequest>
</sec:delete> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://section.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <message>The newsletter section has been deleted</message> <id>MjkzMTI5MzFo5OGaCzfpQA</id>
</response> </ns2:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#173#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterSectionService.getById*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:sec="http://section.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<sec:getById> <getByIdRequest>
<id>Njg4Njg4NjiIo5eM4zSJog</id> </getByIdRequest>
</sec:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://section.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <newsletterSection>
<id>Njg4Njg4NjiIo5eM4zSJog</id> <newsletterTypeId>MTcyNTE3MjVQniJUe2l*Tw</newsletterTypeId> <label>My First Section</label> <name>myfirstsection</name> <defaultArticleTypeId>MjI4MjIyODKX8Jdqiv1Hbw</defaultArticleTypeId>
</newsletterSection> </response>
</ns2:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#174#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterSectionService.getByNewsletterTypeId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:sec="http://section.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<sec:getByNewsletterTypeId> <getByNewsletterTypeIdRequest>
<newsletterTypeId>MTcyNTE3MjVQniJUe2l*Tw</newsletterTypeId> </getByNewsletterTypeIdRequest>
</sec:getByNewsletterTypeId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByNewsletterTypeIdResponse xmlns:ns2="http://section.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>1</totalItems>
</paging> <newsletterSections>
<newsletterSection> <id>MjkzMTI5MzFo5OGaCzfpQA</id> <newsletterTypeId>MTcyNTE3MjVQniJUe2l*Tw</newsletterTypeId> <label>My First Section</label> <name>myfirstsection</name> <defaultArticleTypeId>MjI4MjIyODKX8Jdqiv1Hbw</defaultArticleTypeId>
</newsletterSection> </newsletterSections>
</response> </ns2:getByNewsletterTypeIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#175#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterSectionService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:sec="http://section.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<sec:update> <updateRequest>
<id>MjkzMTI5MzFo5OGaCzfpQA</id> <label>My Second Section</label> <name>mysecondsection</name>
</updateRequest> </sec:update>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateResponse xmlns:ns2="http://section.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <message>The newsletter section has been updated</message> <id>MjkzMTI5MzFo5OGaCzfpQA</id>
</response> </ns2:updateResponse>
</soap:Body> </soap:Envelope>
!!! *
! !
p.#176#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterService*[DIALOGUE_INSTANCE_URL]/api2/soap/NewsletterService?wsdl!!The!NewsletterService!is!intended!for!maintaining!Newsletters.!!Operations:!
• assignAttachment!• copy!• create!• delete!• getById!• getByNewsletterTypeId!• getServiceInfo!• preview!• unassignAttachment!• update!
!
NewsletterService.assignAttachment*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:new="http://newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<new:assignAttachment> <assignAttachmentRequest>
<id>NjQyNjY0MjbS0fJJk6q3cA</id> <attachmentId>MTA4MTA4MTAR3HZCQQStxA</attachmentId>
</assignAttachmentRequest> </new:assignAttachment>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:assignAttachmentResponse xmlns:ns2="http://newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response/> </ns2:assignAttachmentResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#177#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterService.copy*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:new="http://newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<new:copy> <copyRequest>
<newsletterId>NjQyNjY0MjbS0fJJk6q3cA</newsletterId> <label>My Newsletter Copy</label> <name>mynewslettercopy</name>
</copyRequest> </new:copy>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:copyResponse xmlns:ns2="http://newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NjQyNzY0MjfNhnPkT71tnQ</id>
</response> </ns2:copyResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#178#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:new="http://newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<new:create> <createRequest>
<newsletterTypeId>MTc1NTE3NTVLMlTripolisgLUTFA</newsletterTypeId> <label>My First Newsletter</label> <name>myfirstnewsletter</name> <subject>This is a demo-newsletter</subject> <fromName>Tripolis Support</fromName> <fromAddress>[email protected]</fromAddress>
</createRequest> </new:create>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NjQyNjY0MjbS0fJJk6q3cA</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#179#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:new="http://newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<new:delete> <deleteRequest>
<id>NjQ0ODY0NDjIYrSt0Axjhw</id> </deleteRequest>
</new:delete> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NjQ0ODY0NDjIYrSt0Axjhw</id>
</response> </ns2:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#180#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterService.getById*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:new="http://newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<new:getById> <getByIdRequest>
<id>MjE0NTIxNDUfKtlTxl9UrA</id> </getByIdRequest>
</new:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <newsletter>
<id>MjE0NTIxNDUfKtlTxl9UrA</id> <newsletterTypeId>MTc1NTE3NTVLMlTripolisgLUTFA</newsletterTypeId> <label>My Second Newsletter</label> <name>my2ndnewsletter</name> <subject>This is a test</subject> <fromAddress>[email protected]</fromAddress> <fromName>Tripolis Support</fromName> <replyToAddress/> <modifiedAt>2011-12-20T16:07:48+01:00</modifiedAt> <isArchived>false</isArchived>
</newsletter> <articlesInNewsletter/>
</response> </ns2:getByIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#181#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterService.getByNewsletterTypeId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:new="http://newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client>
<username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<new:getByNewsletterTypeId> <getByNewsletterTypeIdRequest>
<newsletterTypeId>MTc1NTE3NTVLMlTripolisgLUTFA</newsletterTypeId> </getByNewsletterTypeIdRequest>
</new:getByNewsletterTypeId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByNewsletterTypeIdResponse xmlns:ns2="http://newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>1</totalItems>
</paging> <newsletters>
<newsletter> <id>NjQyNjY0MjbS0fJJk6q3cA</id> <newsletterTypeId>MTc1NTE3NTVLMlTripolisgLUTFA</newsletterTypeId> <label>My Second Newsletter</label> <name>my2ndnewsletter</name> <subject>This is a test</subject> <fromAddress>[email protected]</fromAddress> <fromName>Tripolis Support</fromName> <replyToAddress/> <modifiedAt>2011-12-20T16:07:48+01:00</modifiedAt> <isArchived>false</isArchived>
</newsletter> </newsletters>
</response> </ns2:getByNewsletterTypeIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#182#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterService.preview*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:new="http://newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<new:preview> <previewRequest>
<id>NjQ0ODY0NDjIYrSt0Axjhw</id> <contactId>OTM5NjQ4OTO4QG500F*qmw</contactId>
</previewRequest> </new:preview>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:previewResponse xmlns:ns2="http://newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <newsletter>
<id>NjQ0ODY0NDjIYrSt0Axjhw</id> <newsletterTypeId>MTc1NTE3NTVLMlTripolisgLUTFA</newsletterTypeId> <label>My First Newsletter</label> <name>myfirstnewsletter</name> <subject>This is a demo-newsletter</subject> <fromAddress>[email protected]</fromAddress> <fromName>Tripolis Support</fromName> <replyToAddress/> <modifiedAt>2011-12-21T15:21:37+01:00</modifiedAt> <isArchived>false</isArchived>
</newsletter> <htmlPersonalized><![CDATA[<doctype html>
<html> <head> </head> <body> <table><tr><td>myTitle</td></tr></table> </body> </html>]]></htmlPersonalized>
<textPersonalized>the text-template</textPersonalized> </response>
</ns2:previewResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#183#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterService.unassignAttachment*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:new="http://newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<new:unassignAttachment> <unassignAttachmentRequest>
<id>NjQyNjY0MjbS0fJJk6q3cA</id> <attachmentId>MTA4MTA4MTAR3HZCQQStxA</attachmentId>
</unassignAttachmentRequest> </new:unassignAttachment>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:unassignAttachmentResponse xmlns:ns2="http://newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response/> </ns2:unassignAttachmentResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#184#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:new="http://newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<new:update> <updateRequest>
<id>NjQyNjY0MjbS0fJJk6q3cA</id> <label>My Second Newsletter</label> <name>my2ndnewsletter</name> <subject>This is a test</subject> <fromName>Tripolis Support</fromName> <fromAddress>[email protected]</fromAddress>
</updateRequest> </new:update>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateResponse xmlns:ns2="http://newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NjQyNjY0MjbS0fJJk6q3cA</id>
</response> </ns2:updateResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#185#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterArticleTemplateService*[DIALOGUE_INSTANCE_URL]/api2/soap/NewsletterArticleTemplateService?wsdl!!The!NewsletterArticleTemplateService!is!intended!for!maintaining!NewsletterArticleTemplate!definitions.!!Operations:!
• create!• delete!• getById!• getByNewsletterTemplateId!• getServiceInfo!• update!
!
NewsletterArticleTemplateService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.template.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:create> <createRequest>
<newsletterTemplateId>MjE0ODIxNDgaavcFstWGgw</newsletterTemplateId> <articleTypeId>MjMyMjIzMjL7gQYua2Ngrg</articleTypeId> <label>My First Article</label> <name>myfirstarticle</name> <description>blTripolisblTripolis</description> <source><![CDATA[
<table><tr><td>${Title}</td></tr></table> ]]></source>
</createRequest> </art:create>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://article.template.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MjQ0MDI0NDDJ*JAl_tfNng</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#186#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterArticleTemplateService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.template.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<art:delete> <deleteRequest>
<id>NjUyNjUyNjX9pfJ_ccy41A</id> </deleteRequest>
</art:delete> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://type.sms.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NjUyNjUyNjX9pfJ_ccy41A</id>
</response> </ns2:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#187#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterArticleTemplateService.getById*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.template.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:getById> <getByIdRequest>
<id>OTM5OTM5OTMM6gVqEEgcZQ</id> </getByIdRequest>
</art:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://article.template.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <newsletterArticleTemplate>
<id>OTM5OTM5OTMM6gVqEEgcZQ</id> <newsletterTemplateId>MjE0ODIxNDgaavcFstWGgw</newsletterTemplateId> <articleTypeId>MjMyMjIzMjL7gQYua2Ngrg</articleTypeId> <label>My First Article</label> <name>myfirstarticle</name> <type>HTML</type> <description/> <source><![CDATA[<table><tr><td></td></tr></table>]]></source>
</newsletterArticleTemplate> </response>
</ns2:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#188#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterArticleTemplateService.getByNewsletterTemplateId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.template.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:getByNewsletterTemplateId> <getByNewsletterTemplateIdRequest>
<newsletterTemplateId>MjE0ODIxNDgaavcFstWGgw</newsletterTemplateId> </getByNewsletterTemplateIdRequest>
</art:getByNewsletterTemplateId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByNewsletterTemplateIdResponse xmlns:ns2="http://article.template.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <newsletterArticleTemplates>
<newsletterArticleTemplate> <id>MjQ0MDI0NDDJ*JAl_tfNng</id> <newsletterTemplateId>MjE0ODIxNDgaavcFstWGgw</newsletterTemplateId> <articleTypeId>MjMyMjIzMjL7gQYua2Ngrg</articleTypeId> <label>My First Article</label> <name>myfirstarticle</name> <type>HTML</type> <description/> <source><![CDATA[<table><tr><td></td></tr></table>]]></source>
</newsletterArticleTemplate> </newsletterArticleTemplates>
</response> </ns2:getByNewsletterTemplateIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#189#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
NewsletterArticleTemplateService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:art="http://article.template.newsletter.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<art:update> <updateRequest>
<id>MjQ0MDI0NDDJ*JAl_tfNng</id> <label>My First Article</label> <name>myfirstarticle</name> <description>blTripolisblTripolis</description> <source><![CDATA[
<table><tr><td>${Title}</td></tr></table> ]]></source>
</updateRequest> </art:update>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateResponse xmlns:ns2="http://article.template.newsletter.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <message>The newsletter article template has been updated</message> <id>MjQ0MDI0NDDJ*JAl_tfNng</id>
</response> </ns2:updateResponse>
</soap:Body> </soap:Envelope>
!!! *
! !
p.#190#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SmsTypeService*[DIALOGUE_INSTANCE_URL]/api2/soap/SmsTypeService?wsdl!!The!SmsTypeService!is!intended!for!maintaining!SmsTypes.!!Operations:!
• create!• delete!• getById!• getByWorkspaceId!• getServiceInfo!• update!
!
SmsTypeService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.sms.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<type:create> <createRequest>
<workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> <label>My First SMS Type</label> <name>myfirstsmstype</name> <defaultOriginator>Tripolis</defaultOriginator> <toMobileFieldId>NDM1NDM1NDP1Aksc0ZoMqQ</toMobileFieldId> <longSmsEnabled>true</longSmsEnabled>
</createRequest> </type:create>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://type.sms.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NjUyNjUyNjX9pfJ_ccy41A</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#191#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SmsTypeService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.sms.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<type:delete> <deleteRequest>
<id>NjUyNjUyNjX9pfJ_ccy41A</id> </deleteRequest>
</type:delete> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://type.sms.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NjUyNjUyNjX9pfJ_ccy41A</id>
</response> </ns2:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#192#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SmsTypeService.getById*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.sms.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<type:getById> <getByIdRequest>
<id>NTE1MTUxNTHutxRbdnKRxA</id> </getByIdRequest>
</type:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://type.sms.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <smsType>
<id>NTE1MTUxNTHutxRbdnKRxA</id> <label>My First SMS Type</label> <name>myfirstsmstype</name> <defaultOriginator>Tripolis</defaultOriginator> <toMobileFieldId>NDM1NDM1NDP1Aksc0ZoMqQ</toMobileFieldId> <longSmsEnabled>true</longSmsEnabled>
</smsType> </response>
</ns2:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#193#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SmsTypeService.getByWorkspaceId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.sms.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<type:getByWorkspaceId> <getByWorkspaceIdRequest>
<workspaceId>MTQ5NTE0OTWr1tGqq3lucA</workspaceId> </getByWorkspaceIdRequest>
</type:getByWorkspaceId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByWorkspaceIdResponse xmlns:ns2="http://type.sms.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <smsTypes>
<smsType> <id>NjUyNjUyNjX9pfJ_ccy41A</id> <label>My First SMS Type</label> <name>myfirstsmstype</name> <defaultOriginator>Tripolis</defaultOriginator> <toMobileFieldId>NDM1NDM1NDP1Aksc0ZoMqQ</toMobileFieldId> <longSmsEnabled>true</longSmsEnabled>
</smsType> </smsTypes>
</response> </ns2:getByWorkspaceIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#194#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SmsTypeService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:type="http://type.sms.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<type:update> <updateRequest>
<id>NjUyNjUyNjX9pfJ_ccy41A</id> <label>My First SMS Type</label> <name>myfirstsmstype</name> <defaultOriginator>Tripolis</defaultOriginator> <toMobileFieldId>NDM1NDM1NDP1Aksc0ZoMqQ</toMobileFieldId> <longSmsEnabled>true</longSmsEnabled>
</updateRequest> </type:update>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateResponse xmlns:ns2="http://type.sms.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NjUyNjUyNjX9pfJ_ccy41A</id>
</response> </ns2:updateResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#195#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SmsMessageService*[DIALOGUE_INSTANCE_URL]/api2/soap/SmsMessageService?wsdl!!The!SmsMessageService!is!intended!for!maintaining!SmsMessages.!!Operations:!
• create!• delete!• getById!• getBySmsMessageTypeId!• getServiceInfo!• update!
!
SmsMessageService.create*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:sms="http://sms.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<sms:create> <createRequest>
<smsTypeId>NjUyNjUyNjX9pfJ_ccy41A</smsTypeId> <label>My First SMS</label> <name>myfirstsms</name> <originator>Tripolis</originator> <message>This is a test</message> <alternativeMessage>This is an alternative text</alternativeMessage> <description>blTripolisblTripolis blTripolisblTripolis</description>
</createRequest> </sms:create>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createResponse xmlns:ns2="http://sms.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NjkyNjkyNjlwwFiGVVmUFg</id>
</response> </ns2:createResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#196#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SmsMessageService.delete*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:sms="http://sms.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<sms:delete> <deleteRequest>
<id>NjkyNjkyNjlwwFiGVVmUFg</id> </deleteRequest>
</sms:delete> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteResponse xmlns:ns2="http://sms.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NjkyNjkyNjlwwFiGVVmUFg</id>
</response> </ns2:deleteResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#197#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SmsMessageService.getById*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:sms="http://sms.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<sms:getById> <getByIdRequest>
<id>NjE2MTYxNjHB_nJCTripolisGzxQ</id> </getByIdRequest>
</sms:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://sms.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <smsMessage>
<id>NjkyNjkyNjlwwFiGVVmUFg</id> <label>My First SMS</label> <name>myfirstsms</name> <smsTypeId>NjUyNjUyNjX9pfJ_ccy41A</smsTypeId> <originator>Tripolis</originator> <message>This is a test</message> <alternativeMessage>This is an alternative text</alternativeMessage> <description>blTripolisblTripolis blTripolisblTripolis</description>
</smsMessage> </response>
</ns2:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#198#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SmsMessageService.getBySmsMessageTypeId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:sms="http://sms.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<sms:getBySmsMessageTypeId> <getBySmsMessageTypeIdRequest>
<smsTypeId>NjUyNjUyNjX9pfJ_ccy41A</smsTypeId> </getBySmsMessageTypeIdRequest>
</sms:getBySmsMessageTypeId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getBySmsMessageTypeIdResponse xmlns:ns2="http://sms.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>1</totalItems>
</paging> <smsMessages>
<smsMessage> <id>NjkyNjkyNjlwwFiGVVmUFg</id> <label>My First SMS</label> <name>myfirstsms</name> <smsTypeId>NjUyNjUyNjX9pfJ_ccy41A</smsTypeId> <originator>Tripolis</originator> <message>This is a test</message> <alternativeMessage>This is an alternative text</alternativeMessage> <description>blTripolisblTripolis blTripolisblTripolis</description>
</smsMessage> </smsMessages>
</response> </ns2:getBySmsMessageTypeIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#199#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SmsMessageService.update*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:sms="http://sms.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<sms:update> <updateRequest>
<id>NjkyNjkyNjlwwFiGVVmUFg</id> <label>My First SMS</label> <name>myfirstsms</name> <originator>Tripolis</originator> <message>This is a test</message> <alternativeMessage>This is an alternative text</alternativeMessage> <description>blTripolisblTripolis blTripolisblTripolis</description>
</updateRequest> </sms:update>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateResponse xmlns:ns2="http://sms.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NjkyNjkyNjlwwFiGVVmUFg</id>
</response> </ns2:updateResponse>
</soap:Body> </soap:Envelope>
!
*
! *
! !
p.#200#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
Services*4*Publishing*
PublishingService*[DIALOGUE_INSTANCE_URL]/api2/soap/PublishingService?wsdl!!The!PublishingService!is!intended!for!testing!and!publishing!efmail!and!sms!jobs.!!Operations:!
• createTag!• deleteTag!• getById!• getByTagIds!• getServiceInfo!• getTagsByWorkspaceId!• publishEmail!• publishSampleTestEmail!• publishSms!• publishTestEmail!• publishTransactionalEmail!• updateTag!• viewLastMailing!• viewLastSms!
!! *
! !
p.#201#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
PublishingService.createTag*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:pub="http://publishing.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<pub:createTag> <createTagRequest>
<tag>MyFirstTag</tag> <workspaceId>MTM0MTM0MTOQPQ9zI8rN9A</workspaceId>
</createTagRequest> </pub:createTag>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createTagResponse xmlns:ns2="http://publishing.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>NTAzNTk1MDMJ87zqyawP0g</id>
</response> </ns2:createTagResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#202#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
PublishingService.deleteTag*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:pub="http://publishing.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<pub:deleteTag> <deleteTagRequest>
<tagId>NTAzNTk1MDMJ87zqyawP0g</tagId> </deleteTagRequest>
</pub:deleteTag> </soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deleteTagResponse xmlns:ns2="http://publishing.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>NTAzNTk1MDMJ87zqyawP0g</id>
</response> </ns2:deleteTagResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#203#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
PublishingService.getById*
!!Request!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:pub="http://publishing.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<pub:getById> <getByIdRequest>
<id>ODMyMTI4MzKBUal*TpKtjQ</id> </getByIdRequest>
</pub:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://publishing.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <job>
<jobId>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</jobId> <jobName>testgroup Tripolis - TRIPOLIS Newsletter week 27</jobName> <startTime>2012-01-20T12:51:02.482+01:00</startTime> <endTime>2012-01-20T12:51:14.669+01:00</endTime> <channel>NEWSLETTER</channel> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <contactDatabaseLabel>Tripolis</contactDatabaseLabel> <contactGroupId>MjIwMzAyMjApt6PthAfbxg</contactGroupId> <contactGroupLabel>testgroup Tripolis</contactGroupLabel> <workspaceId>MTI0NzEyNDfdiZx3HCCs6A</workspaceId> <workspaceLabel>Tripolis_qa_test</workspaceLabel> <status>ENDED</status> <isArchived>false</isArchived> <createdBy>[email protected]</createdBy> <requestedNumberOfSend>1</requestedNumberOfSend> <numberOfSend>1</numberOfSend> <numberOfSkipped>0</numberOfSkipped>
</job> </response>
</ns2:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#204#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
PublishingService.getByTagIds*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:pub="http://publishing.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<pub:getByTagIds> <getByTagIdsRequest>
<tagIds> <tagId>NTA2NDM1MDZ66o0QDVT5wA</tagId>
</tagIds> <matchAnyTag>TRUE</matchAnyTag>
<timeRange> <startTime>2011-10-25T00:00:00</startTime> <endTime>2012-01-21T23:00:00</endTime>
</timeRange> </getByTagIdsRequest>
</pub:getByTagIds> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByTagIdsResponse xmlns:ns2="http://publishing.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>5</totalItems>
</paging> <jobs>
<job> <jobId>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</jobId> <jobName>testgroup Tripolis - TRIPOLIS Newsletter week 27</jobName> <startTime>2012-01-20T12:51:02.482+01:00</startTime> <endTime>2012-01-20T12:51:14.669+01:00</endTime> <channel>NEWSLETTER</channel> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <contactDatabaseLabel>Tripolis</contactDatabaseLabel> <contactGroupId>MjIwMzAyMjApt6PthAfbxg</contactGroupId> <contactGroupLabel>testgroup Tripolis</contactGroupLabel> <workspaceId>MTI0NzEyNDfdiZx3HCCs6A</workspaceId> <workspaceLabel>Tripolis_qa_test</workspaceLabel> <status>ENDED</status> <isArchived>false</isArchived> <createdBy>[email protected]</createdBy> <jobTags>
<jobTag> <id>NTA2NDM1MDZ66o0QDVT5wA</id> <workspaceId>MTI0NzEyNDfdiZx3HCCs6A</workspaceId> <label>demo</label> <type>MAILJOB</type>
</jobTag> </jobTags> <requestedNumberOfSend>1</requestedNumberOfSend> <numberOfSend>1</numberOfSend> <numberOfSkipped>0</numberOfSkipped>
</job> <job>
<jobId>MTAxNTA5NDWMdCDprzC_oRpaAAO2LvZr</jobId>
! !
p.#205#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
<jobName>testgroup Tripolis - TRIPOLIS directmail week 31</jobName> <startTime>2012-01-20T12:53:02.595+01:00</startTime>
<endTime>2012-01-20T12:53:11.971+01:00</endTime> <channel>DIRECTEMAIL</channel> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <contactDatabaseLabel>Tripolis</contactDatabaseLabel> <contactGroupId>MjIwMzAyMjApt6PthAfbxg</contactGroupId> <contactGroupLabel>testgroup Tripolis</contactGroupLabel> <workspaceId>MTI0NzEyNDfdiZx3HCCs6A</workspaceId> <workspaceLabel>Tripolis_qa_test</workspaceLabel> <status>ENDED</status> <isArchived>false</isArchived> <createdBy>[email protected]</createdBy> <jobTags>
<jobTag> <id>NTA2NDM1MDZ66o0QDVT5wA</id> <workspaceId>MTI0NzEyNDfdiZx3HCCs6A</workspaceId> <label>demo</label> <type>MAILJOB</type>
</jobTag> </jobTags> <requestedNumberOfSend>1</requestedNumberOfSend> <numberOfSend>1</numberOfSend> <numberOfSkipped>0</numberOfSkipped>
</job> </jobs>
</response> </ns2:getByTagIdsResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#206#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
PublishingService.getTagsByWorkspaceId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:pub="http://publishing.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<pub:getTagsByWorkspaceId> <getTagsByWorkspaceIdRequest>
<paging> <pageNr>1</pageNr> <pageSize>15</pageSize>
</paging> <workspaceId>MTM0MTM0MTOQPQ9zI8rN9A</workspaceId>
</getTagsByWorkspaceIdRequest> </pub:getTagsByWorkspaceId>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getTagsByWorkspaceIdResponse xmlns:ns2="http://publishing.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <tags>
<tag> <id>NTAzNjA1MDMJ87zqyawP0g</id> <workspaceId>MTM0MTM0MTOQPQ9zI8rN9A</workspaceId> <label>TagChanged</label> <type>MAILJOB</type>
</tag> </tags>
</response> </ns2:getTagsByWorkspaceIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#207#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
PublishingService.publishEmail*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:pub="http://publishing.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<pub:publishEmail> <publishEmailRequest>
<contactGroupId>MjIwMzAyMjApt6PthAfbxg</contactGroupId><newsletterId>NjE2OTYxNjm*zNLtTqFtZg</newsletterId> <mailsPerHour>50000</mailsPerHour><mailJobTagIds>
<mailJobTagId>NTA2NDM1MDZ66o0QDVT5wA</mailJobTagId> </mailJobTagIds>
</publishEmailRequest> </pub:publishEmail>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:createTagResponse xmlns:ns2="http://publishing.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>NTA2NDM1MDZ66o0QDVT5wA</id>
</response> </ns2:createTagResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#208#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
PublishingService.publishSampleTestEmail*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:pub="http://publishing.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<pub:publishSampleTestEmail> <publishSampleTestEmailRequest>
<testContactGroupId>MjQ0MzAyNDSu_a58mx2S*g</testContactGroupId> <contactGroupId>MjIwMzAyMjApt6PthAfbxg</contactGroupId><directEmailId>MjE4MjIxODJftEFsG8RIFA</directEmailId><sampleRate>1</sampleRate><mailJobTagIds>
<mailJobTagId>NTA2NDM1MDZ66o0QDVT5wA</mailJobTagId> </mailJobTagIds>
</publishSampleTestEmailRequest> </pub:publishSampleTestEmail>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:publishSampleTestEmailResponse xmlns:ns2="http://publishing.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>MTAxNTA5NDWMdCDprzC_oRpaAAO2LvZr</id>
</response> </ns2:publishSampleTestEmailResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#209#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
PublishingService.publishSms*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:pub="http://publishing.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<pub:publishSms> <publishSmsRequest>
<smsMessageId>NTA4NTA4NTDPHoLPowpCrA</smsMessageId> <contactGroupId>MjIwMzAyMjApt6PthAfbxg</contactGroupId><smsJobTagIds>
<smsJobTagId>NTA2NDM1MDZ66o0QDVT5wA</smsJobTagId> </smsJobTagIds>
</publishSmsRequest> </pub:publishSms>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:publishSmsResponse xmlns:ns2="http://publishing.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>MTAxNTA5NDaMdCDprzC_oRpaAAO2LvZr</id>
</response> </ns2:publishSmsResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#210#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
PublishingService.publishTestEmail*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:pub="http://publishing.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<pub:publishTestEmail> <publishTestEmailRequest>
<testContactGroupId>MjQ0MzAyNDSu_a58mx2S*g</testContactGroupId> <directEmailId>MjE4MjIxODJftEFsG8RIFA</directEmailId><mailJobTagIds>
<mailJobTagId>NTA2NDM1MDZ66o0QDVT5wA</mailJobTagId> </mailJobTagIds>
</publishTestEmailRequest> </pub:publishTestEmail>
</soap:Body> </soap:Envelope>!
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:publishTestEmailResponse xmlns:ns2="http://publishing.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>MTAxNTA5NDeMdCDprzC_oRpaAAO2LvZr</id>
</response> </ns2:publishTestEmailResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#211#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
PublishingService.publishTransactionalEmail*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:pub="http://publishing.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<pub:publishTransactionalEmail> <publishTransactionalEmailRequest>
<contactId>MTMyOTU4OTmMdCDprzC_oRpaAAO2LvZr</contactId> <directEmailId>MjE4MjIxODJftEFsG8RIFA</directEmailId><mailJobTagIds>
<mailJobTagId>NTA2NDM1MDZ66o0QDVT5wA</mailJobTagId> </mailJobTagIds>
</publishTransactionalEmailRequest> </pub:publishTransactionalEmail>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:publishTransactionalEmailResponse xmlns:ns2="http://publishing.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>MTAxNTA5NDiMdCDprzC_oRpaAAO2LvZr</id>
</response> </ns2:publishTransactionalEmailResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#212#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
PublishingService.updateTag*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:pub="http://publishing.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<pub:updateTag> <updateTagRequest>
<tag>demo</tag> <tagId>NTA2NDM1MDZ66o0QDVT5wA</tagId>
</updateTagRequest> </pub:updateTag>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateTagResponse xmlns:ns2="http://publishing.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>NTA2NDM1MDZ66o0QDVT5wA</id>
</response> </ns2:updateTagResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#213#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
PublishingService.viewLastMailing*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:pub="http://publishing.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<pub:viewLastMailing> <viewLastMailingRequest>
<contactGroupId>MjIwMzAyMjApt6PthAfbxg</contactGroupId><mailingType>ALL</mailingType>
<sampleContactId>MTMyOTU4OTmMdCDprzC_oRpaAAO2LvZr</sampleContactId> </viewLastMailingRequest>
</pub:viewLastMailing> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:viewLastMailingResponse xmlns:ns2="http://publishing.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <snapshot>
<job> <jobId>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</jobId> <jobName>testgroup Tripolis - TRIPOLIS Newsletter week 27</jobName> <startTime>2012-01-20T12:51:02.482+01:00</startTime> <endTime>2012-01-20T12:51:14.669+01:00</endTime> <channel>NEWSLETTER</channel> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <contactDatabaseLabel>Tripolis</contactDatabaseLabel>
<contactGroupId>MjIwMzAyMjApt6PthAfbxg</contactGroupId> <contactGroupLabel>testgroup Tripolis</contactGroupLabel> <workspaceId>MTI0NzEyNDfdiZx3HCCs6A</workspaceId> <workspaceLabel>Tripolis_qa_test</workspaceLabel> <status>ENDED</status> <isArchived>false</isArchived> <createdBy>[email protected]</createdBy> <requestedNumberOfSend>1</requestedNumberOfSend> <numberOfSend>1</numberOfSend> <numberOfSkipped>0</numberOfSkipped>
</job> <htmlPersonalized><![CDATA[<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transi-
tional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> </html>]]></htmlPersonalized>
<textPersonalized> </textPersonalized>
<fromName>Tripolis</fromName> <fromAddress>[email protected]</fromAddress> <replyToAddress>[email protected]</replyToAddress> <subject>This week at Tripolis: Zomervoordeel</subject>
</snapshot> </response>
</ns2:viewLastMailingResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#214#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
PublishingService.viewLastSms*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:pub="http://publishing.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<pub:viewLastSms> <viewLastSmsRequest>
<contactGroupId>MjIwMzAyMjApt6PthAfbxg</contactGroupId><sampleContactId>MTMyOTU4OTmMdCDprzC_oRpaAAO2LvZr</sampleContactId>
</viewLastSmsRequest> </pub:viewLastSms>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:updateTagResponse xmlns:ns2="http://publishing.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://article.services.tripolis.com/" xmlns:ns5="http://contact.services.tripolis.com/">
<response> <id>NTA2NDM1MDZ66o0QDVT5wA</id>
</response> </ns2:updateTagResponse>
</soap:Body> </soap:Envelope>
!!! *
! !
p.#215#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
MailJobService*[DIALOGUE_INSTANCE_URL]/api2/soap/MailJobService?wsdl!!The!MailJobService!is!intended!for!managing!Mailjobs.!!Operations:!
• getById!• getServiceInfo!• getStatus!• pause!• remove!• resume!
!! *
! !
p.#216#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
MailJobService.getById*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:job="http://job.mail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<job:getById> <getByIdRequest>
<id>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</id> </getByIdRequest>
</job:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:getByIdResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://job.mail.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <mailJob>
<jobId>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</jobId> <jobName>testgroup Tripolis - Tripolis week 27</jobName> <startTime>2012-01-20T12:51:02.482+01:00</startTime> <endTime>2012-01-20T12:51:14.669+01:00</endTime> <channel>NEWSLETTER</channel> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <contactDatabaseLabel>Tripolis</contactDatabaseLabel> <contactGroupId>MjIwMzAyMjApt6PthAfbxg</contactGroupId> <contactGroupLabel>testgroup Tripolis</contactGroupLabel> <workspaceId>MTI0NzEyNDfdiZx3HCCs6A</workspaceId> <workspaceLabel>Tripolis_qa_test</workspaceLabel> <status>ENDED</status> <isArchived>false</isArchived> <createdBy>[email protected]</createdBy> <requestedNumberOfSend>1</requestedNumberOfSend> <numberOfSend>1</numberOfSend> <numberOfSkipped>0</numberOfSkipped> <typeId>MTU1MDE1NTACoLATOEBCdA</typeId> <typeLabel>TRIPOLIS newsletter - BONUS (plat)</typeLabel> <editionId>NjE2OTYxNjm*zNLtTqFtZg</editionId> <editionLabel>TRIPOLIS Newsletter week 27</editionLabel> <subject>This week at Tripolis: Zomervoordeel</subject> <replyToAddress>[email protected]</replyToAddress> <fromAddress>[email protected]</fromAddress> <fromName>Tripolis</fromName> <mailsPerHour>50000</mailsPerHour> <mailInterval>72</mailInterval> <sampleRate>0</sampleRate> <isTest>false</isTest> <isTransactional>false</isTransactional>
</mailJob> </response>
</ns3:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#217#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
MailJobService.getStatus*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:job="http://job.mail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<job:getStatus> <getStatusRequest>
<id>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</id> </getStatusRequest>
</job:getStatus> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:getStatusResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://job.mail.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <string>ENDED</string>
</response> </ns3:getStatusResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#218#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
MailJobService.pause*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:job="http://job.mail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<job:pause> <pauseRequest>
<id>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</id> </pauseRequest>
</job:pause> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:pauseResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://job.mail.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response/> </ns3:pauseResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#219#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
MailJobService.remove*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:job="http://job.mail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<job:remove> <removeRequest>
<id>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</id> </removeRequest>
</job:remove> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:removeResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://job.mail.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response/> </ns3:removeResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#220#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
MailJobService.resume*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:job="http://job.mail.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<job:resume> <resumeRequest>
<id>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</id> </resumeRequest>
</job:resume> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:resumeResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://job.mail.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response/> </ns3:resumeResponse>
</soap:Body> </soap:Envelope>
!!! *
! !
p.#221#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SmsJobService*[DIALOGUE_INSTANCE_URL]/api2/soap/SmsJobService?wsdl!!The!SMSJobService!is!intended!for!managing!SMS!jobs.!!Operations:!
• getById!• getStatus!• pause!• remove!• resume!
!! *
! !
p.#222#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SmsJobService.getById*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:job="http://job.sms.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<job:getById> <getByIdRequest>
<id>MTAxNTA5NDaMdCDprzC_oRpaAAO2LvZr</id> </getByIdRequest>
</job:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://job.sms.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response> <smsJob>
<jobId>MTAxNTA5NDaMdCDprzC_oRpaAAO2LvZr</jobId> <jobName>testgroup Tripolis - 2012-01-20 12:54:36</jobName> <startTime>2012-01-20T12:54:36.078+01:00</startTime> <endTime>2012-01-20T12:54:41.928+01:00</endTime> <channel>SMS</channel> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <contactDatabaseLabel>Tripolis</contactDatabaseLabel> <contactGroupId>MjIwMzAyMjApt6PthAfbxg</contactGroupId> <contactGroupLabel>testgroup Tripolis</contactGroupLabel> <workspaceId>MTI0NzEyNDfdiZx3HCCs6A</workspaceId> <workspaceLabel>Tripolis_qa_test</workspaceLabel> <status>ENDED</status> <isArchived>false</isArchived> <createdBy>[email protected]</createdBy> <requestedNumberOfSend>1</requestedNumberOfSend> <numberOfSend>1</numberOfSend> <numberOfSkipped>0</numberOfSkipped> <numberOfMessages>1</numberOfMessages> <smsTypeLabel>Tripolis</smsTypeLabel> <smsTypeId>NDY4NDY4NDY0nm*pW2D7Vw</smsTypeId> <smsMessageLabel>Action</smsMessageLabel> <smsMessageId>NTA4NTA4NTDPHoLPowpCrA</smsMessageId> <originator>TRIPOLIS Bonus</originator> <description/>
</smsJob> </response>
</ns2:getByIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#223#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SmsJobService.getStatus*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:job="http://job.sms.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<job:getStatus> <getStatusRequest>
<id>MTAxNTA5NDaMdCDprzC_oRpaAAO2LvZr</id> </getStatusRequest>
</job:getStatus> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns3:getStatusResponse xmlns:ns2="http://contact.services.tripolis.com/" xmlns:ns3="http://job.mail.services.tripolis.com/" xmlns:ns4="http://services.tripolis.com/">
<response> <string>ENDED</string> </response>
</ns3:getStatusResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#224#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SmsJobService.pause*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:job="http://job.sms.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<job:pause> <pauseRequest>
<id>MTAxNTA5NDaMdCDprzC_oRpaAAO2LvZr</id> </pauseRequest>
</job:pause> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:pauseResponse xmlns:ns2="http://job.sms.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response/> </ns2:pauseResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#225#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SmsJobService.remove*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:job="http://job.sms.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<job:remove> <removeRequest>
<id>MTAxNTA5NDaMdCDprzC_oRpaAAO2LvZr</id> </removeRequest>
</job:remove> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:removeResponse xmlns:ns2="http://job.sms.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response/> </ns2:removeResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#226#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
SmsJobService.resume*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:job="http://job.sms.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<job:resume> <resumeRequest>
<id>MTAxNTA5NDaMdCDprzC_oRpaAAO2LvZr</id> </resumeRequest>
</job:resume> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:resumeResponse xmlns:ns2="http://job.sms.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/">
<response/> </ns2:resumeResponse>
</soap:Body> </soap:Envelope>
!
! *
! !
p.#227#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
Services*4*Campaign*
Campaign*module*4*object*structure*ClientDomain!!
CampaignDefinitionService*[DIALOGUE_INSTANCE_URL]/api2/soap/CampaignDefinitionService?wsdl!!The!CampaignDefinitionService!is!intended!for!viewing!Campaign!Definitions.!!Operations:!
• getByWorkspaceId!• getCampaigns!• getServiceInfo!
!
CampaignDefinitionService.getByWorkspaceId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:def="http://definition.campaign.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<def:getByWorkspaceId> <getByWorkspaceIdRequest>
<workspaceId>MTI0NzEyNDfdiZx3HCCs6A</workspaceId> </getByWorkspaceIdRequest>
</def:getByWorkspaceId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByWorkspaceIdResponse xmlns:ns2="http://definition.campaign.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <campaignDefinitions>
<campaignDefinition> <id>NzQ0NzQ0NzRc5UzXodmiug</id> <name>demo</name> <label>demo</label> <description/>
</campaignDefinition> </campaignDefinitions>
</response> </ns2:getByWorkspaceIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#228#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
CampaignDefinitionService.getCampaigns*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:def="http://definition.campaign.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<def:getCampaigns> <getCampaignsRequest>
<id>NzQ0NzQ0NzRc5UzXodmiug</id> </getCampaignsRequest>
</def:getCampaigns> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getCampaignsResponse xmlns:ns2="http://definition.campaign.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <campaigns>
<campaign> <id>MTM1MzEzNTPeVNu9HRa0Lg</id> <name>run3</name> <label>Run 3</label> <campaignDefinitionId>NzQ0NzQ0NzRc5UzXodmiug</campaignDefinitionId> <description>A description</description> <active>false</active> <startTime>2012-01-23T10:55:00+01:00</startTime> <endTime>2012-01-23T11:40:30.626+01:00</endTime>
</campaign> <campaign>
<id>MTM1MjEzNTLxYPkTripolis91W0A</id> <name>run2</name> <label>run 2</label> <campaignDefinitionId>NzQ0NzQ0NzRc5UzXodmiug</campaignDefinitionId> <description/> <active>true</active> <startTime>2012-01-23T10:31:00+01:00</startTime> <endTime>2012-01-23T10:32:00+01:00</endTime>
</campaign> </campaigns>
</response> </ns2:getCampaignsResponse>
</soap:Body> </soap:Envelope>
!!! *
! !
p.#229#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
CampaignService*[DIALOGUE_INSTANCE_URL]/api2/soap/CampaignService?wsdl!!The!CampaignService!is!intended!for!managing!Campaign!runs.!!Operations:!
• activate!• deactivate!• getByCampaignDefinitionId!• getById!• getServiceInfo!
!
CampaignService.activate*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:cam="http://campaign.services.tripolis.com/"> !!!<soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<cam:activate> <activateRequest>
<campaignDefinitionId>NzQ0NzQ0NzRc5UzXodmiug</campaignDefinitionId> <name>run3</name> <label>Run 3</label>
<startTime>2012-01-23T10:55:00</startTime> <endTime>2012-01-23T11:55:00</endTime> <description>A description</description>
</activateRequest> </cam:activate>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:activateResponse xmlns:ns2="http://campaign.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>MTM1MzEzNTPeVNu9HRa0Lg</id>
</response> </ns2:activateResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#230#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
CampaignService.deactivate*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:cam="http://campaign.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<cam:deactivate> <deactivateRequest>
<id>MTM1MzEzNTPeVNu9HRa0Lg</id> </deactivateRequest>
</cam:deactivate> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:deactivateResponse xmlns:ns2="http://campaign.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response/> </ns2:deactivateResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#231#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
CampaignService.getByCampaignDefinitionId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:cam="http://campaign.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<cam:getByCampaignDefinitionId> <getByCampaignDefinitionIdRequest>
<campaignDefinitionId>NzQ0NzQ0NzRc5UzXodmiug</campaignDefinitionId> </getByCampaignDefinitionIdRequest>
</cam:getByCampaignDefinitionId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByCampaignDefinitionIdResponse xmlns:ns2="http://campaign.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <campaigns>
<campaign> <id>MTM1MjEzNTLxYPkTripolis91W0A</id> <name>run2</name> <label>run 2</label> <campaignDefinitionId>NzQ0NzQ0NzRc5UzXodmiug</campaignDefinitionId> <description/> <active>true</active> <startTime>2012-01-23T10:31:00+01:00</startTime> <endTime>2012-01-23T10:32:00+01:00</endTime>
</campaign> </campaigns>
</response> </ns2:getByCampaignDefinitionIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#232#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
CampaignService.getById*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:cam="http://campaign.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<cam:getById> <getByIdRequest>
<id>MTM1MjEzNTLxYPkTripolis91W0A</id> </getByIdRequest>
</cam:getById> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getByIdResponse xmlns:ns2="http://campaign.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <campaign>
<id>MTM1MjEzNTLxYPkTripolis91W0A</id> <name>run2</name> <label>run 2</label> <campaignDefinitionId>NzQ0NzQ0NzRc5UzXodmiug</campaignDefinitionId> <description/> <active>true</active> <startTime>2012-01-23T10:31:00+01:00</startTime> <endTime>2012-01-23T10:32:00+01:00</endTime>
</campaign> </response>
</ns2:getByIdResponse> </soap:Body> </soap:Envelope>
!
! *
! !
p.#233#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
Services*4*Reporting*/*analysis*
ReportingService*[DIALOGUE_INSTANCE_URL]/api2/soap/ReportingService?wsdl!!The!ReportingService!is!intended!for!retrieving!job!and!response!data.!!Operations:!
• getBouncedByMailJobId!• getBouncedBySmsJobId!• getClickedByMailJobId!• getClicksPerLinkInHtmlByMailJobId!• getDeliveredByMailJobId!• getDeliveredBySmsJobId!• getEmailSummary!• getOpenedByMailJobId!• getServiceInfo!• getSkippedByMailJobId!• getSkippedBySmsJobId!• getSmsSummary!
!! *
! !
p.#234#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ReportingService.getBouncedByMailJobId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:rep="http://reporting.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<rep:getBouncedByMailJobId> <getBouncedByMailJobIdRequest>
<mailJobId>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</mailJobId> <returnContactFields>
<returnAllContactFields>TRUE</returnAllContactFields> </returnContactFields> <timeRange>
<startTime>2011-01-01T00:00:00</startTime> <endTime>2012-01-21T00:00:00</endTime>
</timeRange> </getBouncedByMailJobIdRequest>
</rep:getBouncedByMailJobId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getBouncedByMailJobIdResponse xmlns:ns2="http://reporting.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize>
<totalItems>0</totalItems> </paging>
</response> </ns2:getBouncedByMailJobIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#235#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ReportingService.getBouncedBySmsJobId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:rep="http://reporting.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<rep:getBouncedBySmsJobId> <getBouncedBySmsJobIdRequest>
<mailJobId>MTAxNTA5NDaMdCDprzC_oRpaAAO2LvZr</mailJobId> <returnContactFields>
<returnAllContactFields>TRUE</returnAllContactFields> </returnContactFields> <timeRange>
<startTime>2011-01-01T00:00:00</startTime> <endTime>2012-02-01T00:00:00</endTime>
</timeRange> </getBouncedBySmsJobIdRequest>
</rep:getBouncedBySmsJobId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getBouncedBySmsJobIdResponse xmlns:ns2="http://reporting.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize>
<totalItems>0</totalItems> </paging>
</response> </ns2:getBouncedBySmsJobIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#236#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ReportingService.getClickedByMailJobId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:rep="http://reporting.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<rep:getClickedByMailJobId> <getClickedByMailJobIdRequest>
<mailJobId>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</mailJobId> <returnContactFields>
<returnAllContactFields>TRUE</returnAllContactFields> </returnContactFields> <timeRange>
<startTime>2011-01-01T00:00:00</startTime> <endTime>2012-01-20T00:00:00</endTime>
</timeRange> </getClickedByMailJobIdRequest>
</rep:getClickedByMailJobId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getClickedByMailJobIdResponse xmlns:ns2="http://reporting.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize>
<totalItems>0</totalItems> </paging>
</response> </ns2:getClickedByMailJobIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#237#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ReportingService.getClicksPerLinkInHtmlByMailJobId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:rep="http://reporting.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<rep:getClicksPerLinkInHtmlByMailJobId> <getClicksPerLinkInHtmlByMailJobIdRequest>
<mailJobId>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</mailJobId> </getClicksPerLinkInHtmlByMailJobIdRequest>
</rep:getClicksPerLinkInHtmlByMailJobId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getClicksPerLinkInHtmlByMailJobIdResponse xmlns:ns2="http://reporting.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <htmlUnpersonalized><![CDATA[<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transition-
al//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> </html>]]></htmlUnpersonalized>
</response> </ns2:getClicksPerLinkInHtmlByMailJobIdResponse>
</soap:Body> </soap:Envelope>
!! *
! !
p.#238#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ReportingService.getDeliveredByMailJobId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:rep="http://reporting.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<rep:getDeliveredByMailJobId> <getDeliveredByMailJobIdRequest>
<mailJobId>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</mailJobId> <returnContactFields>
<returnAllContactFields>TRUE</returnAllContactFields> </returnContactFields>
</getDeliveredByMailJobIdRequest> </rep:getDeliveredByMailJobId>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getDeliveredByMailJobIdResponse xmlns:ns2="http://reporting.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>1</totalItems>
</paging> <contacts>
<contact> <contactId>MTMyOTU4OTmMdCDprzC_oRpaAAO2LvZr</contactId> <contactFields>
<contactField> <id>NDMxNDMxNDOGCtpvu79hSA</id> <value>[email protected]</value> <label>email</label> <name>email</name> <type>EMAIL</type> <key>true</key> <required>true</required> <contactDatabaseFieldGroupId>MTYZGyZb6HUn*g</contactDatabaseFieldGroupId> <position>1</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>NDM1NDM1NDP1Aksc0ZoMqQ</id> <value>+31624737999</value> <label>mobile</label> <name>mobile</name> <type>MOBILE</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MTY1MTZb6HUn*g</contactDatabaseFieldGroupId> <position>2</position>
<kindOfField>GENERAL</kindOfField> </contactField>
</contactFields> </contact>
</contacts> </response>
</ns2:getDeliveredByMailJobIdResponse> </soap:Body> </soap:Envelope>
! !
p.#239#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ReportingService.getDeliveredBySmsJobId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:rep="http://reporting.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<rep:getDeliveredBySmsJobId> <getDeliveredBySmsJobIdRequest>
<mailJobId>MTAxNTA5NDaMdCDprzC_oRpaAAO2LvZr</mailJobId> <returnContactFields>
<returnAllContactFields>TRUE</returnAllContactFields> </returnContactFields>
</getDeliveredBySmsJobIdRequest> </rep:getDeliveredBySmsJobId>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getDeliveredBySmsJobIdResponse xmlns:ns2="http://reporting.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>1</totalItems>
</paging> <contacts>
<contact> <contactId>MTMyOTU4OTmMdCDprzC_oRpaAAO2LvZr</contactId> <contactFields>
<contactField> <id>NDMxNDMxNDOGCtpvu79hSA</id> <value>[email protected]</value> <label>email</label> <name>email</name> <type>EMAIL</type> <key>true</key> <required>true</required> <contactDatabaseFieldGroupId>MTY1MTY16HUn*g</contactDatabaseFieldGroupId> <position>1</position> <kindOfField>GENERAL</kindOfField>
</contactField> <contactField>
<id>NDM1NDM1NDP1Aksc0ZoMqQ</id> <value>+31624737999</value> <label>mobile</label> <name>mobile</name> <type>MOBILE</type> <key>false</key> <required>false</required> <contactDatabaseFieldGroupId>MTY1MTY1MHUn*g</contactDatabaseFieldGroupId> <position>2</position> <kindOfField>GENERAL</kindOfField>
</contactField> </contactFields>
</contact> </contacts>
</response> </ns2:getDeliveredBySmsJobIdResponse>
</soap:Body> </soap:Envelope>
! !
p.#240#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ReportingService.getEmailSummary*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:rep="http://reporting.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<rep:getEmailSummary> <getEmailSummaryRequest>
<mailJobId>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</mailJobId> </getEmailSummaryRequest>
</rep:getEmailSummary> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getEmailSummaryResponse xmlns:ns2="http://reporting.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <emailSummary>
<job> <jobId>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</jobId> <jobName>testgroup Tripolis Newsletter week 27</jobName> <startTime>2012-01-20T12:51:02.482+01:00</startTime> <endTime>2012-01-20T12:51:14.669+01:00</endTime> <channel>NEWSLETTER</channel> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <contactDatabaseLabel>Tripolis</contactDatabaseLabel> <contactGroupId>MjIwMzAyMjApt6PthAfbxg</contactGroupId> <contactGroupLabel>testgroup Tripolis</contactGroupLabel> <workspaceId>MTI0NzEyNDfdiZx3HCCs6A</workspaceId> <workspaceLabel>Tripolis_qa_test</workspaceLabel> <status>ENDED</status> <isArchived>false</isArchived> <createdBy>[email protected]</createdBy> <requestedNumberOfSend>1</requestedNumberOfSend> <numberOfSend>1</numberOfSend> <numberOfSkipped>0</numberOfSkipped>
</job> <numberOfSendPct>100.0</numberOfSendPct> <numberOfSkippedPct>0.0</numberOfSkippedPct> <queued>0</queued> <queuedPct>0.0</queuedPct> <hardBounces>0</hardBounces> <hardBouncesPct>0.0</hardBouncesPct> <softBounces>0</softBounces> <softBouncesPct>0.0</softBouncesPct> <totalOpens>0</totalOpens> <uniqueOpens>0</uniqueOpens> <totalClicks>0</totalClicks> <uniqueClicks>0</uniqueClicks> <ctrDelivered>0.0</ctrDelivered> <ctrOpened>0.0</ctrOpened>
<totalComplaints>0</totalComplaints> <totalComplaintsPct>0.0</totalComplaintsPct>
</emailSummary> </response>
</ns2:getEmailSummaryResponse> </soap:Body> </soap:Envelope>
!
! !
p.#241#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ReportingService.getOpenedByMailJobId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:rep="http://reporting.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<rep:getOpenedByMailJobId> <getOpenedByMailJobIdRequest>
<mailJobId>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</mailJobId> <returnContactFields>
<returnAllContactFields>TRUE</returnAllContactFields> </returnContactFields> <timeRange>
<startTime>2011-01-01T00:00:00</startTime> <endTime>2012-02-01T00:00:00</endTime>
</timeRange> </getOpenedByMailJobIdRequest>
</rep:getOpenedByMailJobId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getOpenedByMailJobIdResponse xmlns:ns2="http://reporting.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>0</totalItems>
</paging> </response>
</ns2:getOpenedByMailJobIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#242#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ReportingService.getSkippedByMailJobId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:rep="http://reporting.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<rep:getSkippedByMailJobId> <getSkippedByMailJobIdRequest>
<mailJobId>MTAxNTA5NDSMdCDprzC_oRpaAAO2LvZr</mailJobId> <returnContactFields>
<returnAllContactFields>TRUE</returnAllContactFields> </returnContactFields> <timeRange>
<startTime>2011-01-01T00:00:00</startTime> <endTime>2012-02-01T00:00:00</endTime>
</timeRange> </getSkippedByMailJobIdRequest>
</rep:getSkippedByMailJobId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getSkippedByMailJobIdResponse xmlns:ns2="http://reporting.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>0</totalItems>
</paging> </response>
</ns2:getSkippedByMailJobIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#243#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ReportingService.getSkippedBySmsJobId*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:rep="http://reporting.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<rep:getSkippedBySmsJobId> <getSkippedBySmsJobIdRequest>
<mailJobId>MTAxNTA5NDaMdCDprzC_oRpaAAO2LvZr</mailJobId> <returnContactFields>
<returnAllContactFields>TRUE</returnAllContactFields> </returnContactFields> <timeRange>
<startTime>2011-01-01T00:00:00</startTime> <endTime>2012-02-01T00:00:00</endTime>
</timeRange> </getSkippedBySmsJobIdRequest>
</rep:getSkippedBySmsJobId> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getSkippedBySmsJobIdResponse xmlns:ns2="http://reporting.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <paging>
<pageNr>1</pageNr> <pageSize>15</pageSize> <totalItems>0</totalItems>
</paging> </response>
</ns2:getSkippedBySmsJobIdResponse> </soap:Body> </soap:Envelope>
!! *
! !
p.#244#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ReportingService.getSmsSummary*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/" xmlns:rep="http://reporting.services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> </soap:Header> <soap:Body>
<rep:getSmsSummary> <getSmsSummaryRequest>
<mailJobId>MTAxNTA5NDaMdCDprzC_oRpaAAO2LvZr</mailJobId> </getSmsSummaryRequest>
</rep:getSmsSummary> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getSmsSummaryResponse xmlns:ns2="http://reporting.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <smsSummary>
<job> <jobId>MTAxNTA5NDaMdCDprzC_oRpaAAO2LvZr</jobId> <jobName>testgroup Tripolis - Action - 2012-01-20 12:54:36</jobName> <startTime>2012-01-20T12:54:36.078+01:00</startTime> <endTime>2012-01-20T12:54:41.928+01:00</endTime> <channel>SMS</channel> <contactDatabaseId>MTQ0MTQ0MTTSXLrfiihpZg</contactDatabaseId> <contactDatabaseLabel>Tripolis</contactDatabaseLabel> <contactGroupId>MjIwMzAyMjApt6PthAfbxg</contactGroupId> <contactGroupLabel>testgroup Tripolis</contactGroupLabel> <workspaceId>MTI0NzEyNDfdiZx3HCCs6A</workspaceId> <workspaceLabel>Tripolis_qa_test</workspaceLabel> <status>ENDED</status> <isArchived>false</isArchived> <createdBy>[email protected]</createdBy> <requestedNumberOfSend>1</requestedNumberOfSend> <numberOfSend>1</numberOfSend> <numberOfSkipped>0</numberOfSkipped>
</job> <numberOfSendPct>100.0</numberOfSendPct> <numberOfSkippedPct>0.0</numberOfSkippedPct> <queued>0</queued> <queuedPct>0.0</queuedPct> <hardBounces>0</hardBounces> <hardBouncesPct>0.0</hardBouncesPct> <softBounces>0</softBounces> <softBouncesPct>0.0</softBouncesPct> <totalComplaints>0</totalComplaints> <totalComplaintsPct>0.0</totalComplaintsPct>
</smsSummary> </response>
</ns2:getSmsSummaryResponse> </soap:Body> </soap:Envelope>
! !
p.#245#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService*[DIALOGUE_INSTANCE_URL]/api2/soap/ExportService?wsdl!!The!ExportService!is!intended!for!use!by!advanced!API!users!with!Raw!API!export!permissions.!The!Service!can!be!used!for!exporting!details!regarding!bounces,!clicks,!opens,!..!!etc.!of!Publications.!!Operations:!
• exportBounced!• exportBouncedToFtp!• exportClicked!• exportClickedToFtpexportComplained!• exportComplainedToFtp!• exportConverted!• exportConvertedToFtp!• exportJobs!• exportJobsToFtp!• exportLinks!• exportLinksToFtp!• exportOpened!• exportOpenedToFtp!• exportSent!• exportSentToFtp!• exportSkipped!• exportSkippedToFtp!• getExportStatus!• getServiceInfo!
&*&See&ExportService.exportBounced&on&how&to&use&<returnContactFields>&
! !
p.#246#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.exportBounced*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportBounced> <exportBouncedRequest>
<contactDatabaseId>MjI4MjI4MjL*Yv5AFFNgjw</contactDatabaseId> <timeRange>
<startTime>2012-09-26T10:00:00</startTime> <endTime>2012-09-26T18:00:00</endTime>
</timeRange> <returnContactFields>
<!-- Choose only one of the following 5 options --> <!-- option 1 -->
<contactDatabaseFieldIds> <contactDatabaseFieldId>OTk1OTk1OTkcVkFzEKakHw</contactDatabaseFieldId> <contactDatabaseFieldId>OTk4OTk4OTnd80k5msV7Bw</contactDatabaseFieldId>
</contactDatabaseFieldIds> <!-- Option 2: <contactDatabaseFieldNames>
<contactDatabaseFieldName>geslacht</contactDatabaseFieldName> <contactDatabaseFieldName>mobilephone</contactDatabaseFieldName>
</contactDatabaseFieldNames> Option 3: <contactDatabaseFieldGroupIds>
<contactDatabaseFieldGroupId>NjQxMTY0MTGI6zQEs</contactDatabaseFieldGroupId> </contactDatabaseFieldGroupIds>
Option 4: <contactDatabaseFieldGroupNames>
<contactDatabaseFieldGroupName>voorkeuren</contactDatabaseFieldGroupName> </contactDatabaseFieldGroupNames> Option 5:
<returnAllContactFields>1</returnAllContactFields> -->
</returnContactFields> </exportBouncedRequest>
</exp:exportBounced> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportBouncedResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <data>
<xop:Include href="cid:[email protected]" xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
</data> </response>
</ns2:exportBouncedResponse> </soap:Body> </soap:Envelope>
Response includes a .csv attachment
!
! !
p.#247#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.exportBouncedToFtp*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportBouncedToFtp> <exportBouncedToFtpRequest>
<contactDatabaseId>MjI4MjI4MjL*Yv5AFFNgjw</contactDatabaseId> <timeRange>
<startTime>2012-09-26T10:00:00</startTime> <endTime>2012-09-26T18:00:00</endTime>
</timeRange> <returnContactFields>
<contactDatabaseFieldIds> <contactDatabaseFieldId>OTk1OTk1OTkcVkFzEKakHw</contactDatabaseFieldId>
<contactDatabaseFieldId>OTk4OTk4OTnd80k5msV7Bw</contactDatabaseFieldId> </contactDatabaseFieldIds>
</returnContactFields> <ftpAccountId>MzUzMzUzMzWs2*lOJk4AsQ</ftpAccountId> <fileName>ExportTest1.csv</fileName> <sendNotificationMail>0</sendNotificationMail>
</exportBouncedToFtpRequest> </exp:exportBouncedToFtp>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportBouncedToFtpResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NDE3NDU1NDGk0UJmgrZdog</id>
</response> </ns2:exportBouncedToFtpResponse>
</soap:Body> </soap:Envelope>
*
! !
p.#248#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.exportClicked*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportClicked> <exportClickedRequest>
<contactDatabaseId>MjI4MjI4MjL*Yv5AFFNgjw</contactDatabaseId> <timeRange>
<startTime>2012-09-26T10:00:00</startTime> <endTime>2012-09-26T18:00:00</endTime>
</timeRange> <returnContactFields>
<contactDatabaseFieldIds> <contactDatabaseFieldId>OTk1OTk1OTkcVkFzEKakHw</contactDatabaseFieldId>
<contactDatabaseFieldId>OTk4OTk4OTnd80k5msV7Bw</contactDatabaseFieldId> </contactDatabaseFieldIds>
</returnContactFields> </exportClickedRequest>
</exp:exportClicked> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportClickedResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <data>
<xop:Include href="cid:[email protected]" xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
</data> </response>
</ns2:exportClickedResponse> </soap:Body> </soap:Envelope>
Response includes a .csv attachment
*
! !
p.#249#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.exportClickedToFtp*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportClickedToFtp> <exportClickedToFtpRequest>
<contactDatabaseId>MjI4MjI4MjL*Yv5AFFNgjw</contactDatabaseId> <timeRange>
<startTime>2012-09-26T10:00:00</startTime> <endTime>2012-09-26T18:00:00</endTime>
</timeRange> <returnContactFields>
<contactDatabaseFieldIds> <contactDatabaseFieldId>OTk1OTk1OTkcVkFzEKakHw</contactDatabaseFieldId>
<contactDatabaseFieldId>OTk4OTk4OTnd80k5msV7Bw</contactDatabaseFieldId> </contactDatabaseFieldIds>
</returnContactFields> <ftpAccountId>MzUzMzUzMzWs2*lOJk4AsQ</ftpAccountId> <fileName>ExportTest2.csv</fileName> <sendNotificationMail>0</sendNotificationMail>
</exportClickedToFtpRequest> </exp:exportClickedToFtp>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportClickedToFtpResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NDE3NDU2NDGk0UJmgrZdog</id>
</response> </ns2:exportClickedToFtpResponse>
</soap:Body> </soap:Envelope>
*
! !
p.#250#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.exportComplained*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportComplained> <exportComplainedRequest>
<contactDatabaseId>MjI4MjI4MjL*Yv5AFFNgjw</contactDatabaseId> <timeRange>
<startTime>2012-09-26T10:00:00</startTime> <endTime>2012-09-26T18:00:00</endTime>
</timeRange> <returnContactFields>
<contactDatabaseFieldIds> <contactDatabaseFieldId>OTk1OTk1OTkcVkFzEKakHw</contactDatabaseFieldId>
<contactDatabaseFieldId>OTk4OTk4OTnd80k5msV7Bw</contactDatabaseFieldId> </contactDatabaseFieldIds>
</returnContactFields> </exportComplainedRequest>
</exp:exportComplained> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportComplainedResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <data>
<xop:Include href="cid:[email protected]" xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
</data> </response>
</ns2:exportComplainedResponse> </soap:Body> </soap:Envelope>
Response includes a .csv attachment
*
! !
p.#251#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.exportComplainedToFtp*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportComplainedToFtp> <exportComplainedToFtpRequest>
<contactDatabaseId>MjI4MjI4MjL*Yv5AFFNgjw</contactDatabaseId> <timeRange>
<startTime>2012-09-26T10:00:00</startTime> <endTime>2012-09-26T18:00:00</endTime>
</timeRange> <returnContactFields>
<contactDatabaseFieldIds> <contactDatabaseFieldId>OTk1OTk1OTkcVkFzEKakHw</contactDatabaseFieldId>
<contactDatabaseFieldId>OTk4OTk4OTnd80k5msV7Bw</contactDatabaseFieldId> </contactDatabaseFieldIds>
</returnContactFields> <ftpAccountId>MzUzMzUzMzWs2*lOJk4AsQ</ftpAccountId> <fileName>ExportTest3.csv</fileName> <sendNotificationMail>0</sendNotificationMail>
</exportComplainedToFtpRequest> </exp:exportComplainedToFtp>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportComplainedToFtpResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NDE3NDU3NDGk0UJmgrZdog</id>
</response> </ns2:exportComplainedToFtpResponse>
</soap:Body> </soap:Envelope>
*
! !
p.#252#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.exportConverted*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportConverted> <exportConvertedRequest>
<contactDatabaseId>MjI4MjI4MjL*Yv5AFFNgjw</contactDatabaseId> <timeRange>
<startTime>2012-09-26T10:00:00</startTime> <endTime>2012-09-26T18:00:00</endTime>
</timeRange> <returnContactFields>
<contactDatabaseFieldIds> <contactDatabaseFieldId>OTk1OTk1OTkcVkFzEKakHw</contactDatabaseFieldId>
<contactDatabaseFieldId>OTk4OTk4OTnd80k5msV7Bw</contactDatabaseFieldId> </contactDatabaseFieldIds>
</returnContactFields> </exportConvertedRequest>
</exp:exportConverted> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportConvertedResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <data>
<xop:Include href="cid:[email protected]" xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
</data> </response>
</ns2:exportConvertedResponse> </soap:Body> </soap:Envelope>
Response includes a .csv attachment
*
! !
p.#253#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.exportConvertedToFtp*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportConvertedToFtp> <exportConvertedToFtpRequest>
<contactDatabaseId>MjI4MjI4MjL*Yv5AFFNgjw</contactDatabaseId> <timeRange>
<startTime>2012-09-26T10:00:00</startTime> <endTime>2012-09-26T18:00:00</endTime>
</timeRange> <returnContactFields>
<contactDatabaseFieldIds> <contactDatabaseFieldId>OTk1OTk1OTkcVkFzEKakHw</contactDatabaseFieldId>
<contactDatabaseFieldId>OTk4OTk4OTnd80k5msV7Bw</contactDatabaseFieldId> </contactDatabaseFieldIds>
</returnContactFields> <ftpAccountId>MzUzMzUzMzWs2*lOJk4AsQ</ftpAccountId> <fileName>ExportTest4.csv</fileName> <sendNotificationMail>0</sendNotificationMail>
</exportConvertedToFtpRequest> </exp:exportConvertedToFtp>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportConvertedToFtpResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NDE3NDY1NDGk1UJmgrZdog</id>
</response> </ns2:exportConvertedToFtpResponse>
</soap:Body> </soap:Envelope>
*
! !
p.#254#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.exportJobs*(Includes!sms!jobs)!
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage></ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportJobs> <exportJobsRequest>
<contactDatabaseId>MjA4MzIwODMPeHN*MNWsEA</contactDatabaseId> <timeRange>
<startTime>2012-09-25T14:00:00</startTime> <endTime>2012-09-25T18:00:00</endTime>
</timeRange> </exportJobsRequest>
</exp:exportJobs> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportJobsResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <data>
<xop:Include href="cid:[email protected]" xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
</data> </response>
</ns2:exportJobsResponse> </soap:Body> </soap:Envelope>
Response includes a .csv attachment
*
! !
p.#255#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.*exportJobsToFtp*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportJobsToFtp> <exportJobsToFtpRequest>
<contactDatabaseId>MjA4MzIwODMPeHN*MNWsEA</contactDatabaseId> <timeRange>
<startTime>2012-09-25T14:00:00</startTime> <endTime>2012-09-25T18:00:00</endTime>
</timeRange> <ftpAccountId>MzUyMzUyMzVqNbHauRMCTA</ftpAccountId> <fileName>ExportTest5.csv</fileName> <sendNotificationMail>0</sendNotificationMail>
</exportJobsToFtpRequest> </exp:exportJobsToFtp>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportJobsToFtpResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NDE3NDM0NDGk0UJmgrZdog</id>
</response> </ns2:exportJobsToFtpResponse>
</soap:Body> </soap:Envelope>
*
! !
p.#256#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.exportLinks*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportLinks> <exportLinksRequest>
<contactDatabaseId>MjA4MzIwODMPeHN*MNWsEA</contactDatabaseId> <timeRange>
<startTime>2012-09-25T14:00:00</startTime> <endTime>2012-09-25T18:00:00</endTime>
</timeRange> </exportLinksRequest>
</exp:exportLinks> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportLinksResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <data>
<xop:Include href="cid:[email protected]" xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
</data> </response>
</ns2:exportLinksResponse> </soap:Body> </soap:Envelope>
Response includes a .csv attachment
*
! !
p.#257#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.exportLinksToFtp*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportLinksToFtp> <exportLinksToFtpRequest>
<contactDatabaseId>MjA4MzIwODMPeHN*MNWsEA</contactDatabaseId> <timeRange>
<startTime>2012-09-25T14:00:00</startTime> <endTime>2012-09-25T18:00:00</endTime>
</timeRange> <ftpAccountId>MzUyMzUyMzVqNbHauRMCTA</ftpAccountId> <fileName>ExportTest6.csv</fileName> <sendNotificationMail>0</sendNotificationMail>
</exportLinksToFtpRequest> </exp:exportLinksToFtp>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportLinksToFtpResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NDE3NDM1NDGk0UJmgrZdog</id>
</response> </ns2:exportLinksToFtpResponse>
</soap:Body> </soap:Envelope>
*
! !
p.#258#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.exportOpened*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/">
<soap:Header> <ser:authInfo>
<client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportOpened> <exportOpenedRequest>
<contactDatabaseId>MjA4MzIwODMPeHN*MNWsEA</contactDatabaseId> <timeRange>
<startTime>2012-09-26T10:00:00</startTime> <endTime>2012-09-26T18:00:00</endTime>
</timeRange> <returnContactFields>
<!-- Choose only one of the following 5 options --> <!-- option 1 -->
<contactDatabaseFieldIds> <contactDatabaseFieldId>MjU4NDkyNThoQG8DO6AZdQ</contactDatabaseFieldId> <contactDatabaseFieldId>MjU4NDgyNThoQG8DO6AZdQ</contactDatabaseFieldId>
</contactDatabaseFieldIds>
<!-- Option 2: <contactDatabaseFieldNames>
<contactDatabaseFieldName>geslacht</contactDatabaseFieldName> <contactDatabaseFieldName>mobilephone</contactDatabaseFieldName>
</contactDatabaseFieldNames>
Option 3: <contactDatabaseFieldGroupIds>
<contactDatabaseFieldGroupId>NjQxMTY0MTGI6zQEs</contactDatabaseFieldGroupId> </contactDatabaseFieldGroupIds>
Option 4: <contactDatabaseFieldGroupNames>
<contactDatabaseFieldGroupName>voorkeuren</contactDatabaseFieldGroupName> </contactDatabaseFieldGroupNames>
Option 5: <returnAllContactFields>1</returnAllContactFields> -->
</returnContactFields> </exportOpenedRequest>
</exp:exportOpened> </soap:Body> </soap:Envelope>
Response!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportOpenedResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <data>
<xop:Include href="cid:[email protected]" xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
</data> </response>
</ns2:exportOpenedResponse> </soap:Body> </soap:Envelope>
Response includes a .csv attachment
! !
p.#259#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
*ExportService.*exportOpenedToFtp*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportOpenedToFtp> <exportOpenedToFtpRequest>
<contactDatabaseId>MjI4MjI4MjL*Yv5AFFNgjw</contactDatabaseId> <timeRange>
<startTime>2012-09-26T10:00:00</startTime> <endTime>2012-09-26T18:00:00</endTime>
</timeRange> <returnContactFields>
<contactDatabaseFieldIds> <contactDatabaseFieldId>OTk1OTk1OTkcVkFzEKakHw</contactDatabaseFieldId> <contactDatabaseFieldId>OTk4OTk4OTnd80k5msV7Bw</contactDatabaseFieldId>
</contactDatabaseFieldIds> </returnContactFields> <ftpAccountId>MzUzMzUzMzWs2*lOJk4AsQ</ftpAccountId> <fileName>ExportTest7.csv</fileName> <sendNotificationMail>0</sendNotificationMail>
</exportOpenedToFtpRequest> </exp:exportOpenedToFtp>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportOpenedToFtpResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NDE3NDQ1NDGk0UJmgrZdog</id>
</response> </ns2:exportOpenedToFtpResponse>
</soap:Body> </soap:Envelope>
*
! !
p.#260#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.exportSent*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportSent> <exportSentRequest>
<contactDatabaseId>MjI4MjI4MjL*Yv5AFFNgjw</contactDatabaseId> <timeRange>
<startTime>2012-09-26T10:00:00</startTime> <endTime>2012-09-26T18:00:00</endTime>
</timeRange> <returnContactFields>
<contactDatabaseFieldIds> <!--Zero or more repetitions:--> <contactDatabaseFieldId>OTk1OTk1OTkcVkFzEKakHw</contactDatabaseFieldId> <contactDatabaseFieldId>OTk4OTk4OTnd80k5msV7Bw</contactDatabaseFieldId>
</contactDatabaseFieldIds> </returnContactFields>
</exportSentRequest> </exp:exportSent>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportSentResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <data>
<xop:Include href="cid:[email protected]" xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
</data> </response>
</ns2:exportSentResponse> </soap:Body> </soap:Envelope>
Response includes a .csv attachment
*
! !
p.#261#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.exportSentToFtp*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportSentToFtp> <exportSentToFtpRequest>
<contactDatabaseId>MjI4MjI4MjL*Yv5AFFNgjw</contactDatabaseId> <timeRange>
<startTime>2012-09-26T10:00:00</startTime> <endTime>2012-09-26T18:00:00</endTime>
</timeRange> <returnContactFields>
<contactDatabaseFieldIds> <!--Zero or more repetitions:--> <contactDatabaseFieldId>OTk1OTk1OTkcVkFzEKakHw</contactDatabaseFieldId> <contactDatabaseFieldId>OTk4OTk4OTnd80k5msV7Bw</contactDatabaseFieldId>
</contactDatabaseFieldIds> </returnContactFields> <ftpAccountId>MzUzMzUzMzWs2*lOJk4AsQ</ftpAccountId> <fileName>ExportTest8.csv</fileName> <sendNotificationMail>0</sendNotificationMail>
</exportSentToFtpRequest> </exp:exportSentToFtp>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportSentToFtpResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NDE3NDQ3NDGk0UJmgrZdog</id>
</response> </ns2:exportSentToFtpResponse>
</soap:Body> </soap:Envelope>
*
! !
p.#262#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.exportSkipped*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportSkipped> <exportSkippedRequest>
<contactDatabaseId>MjI4MjI4MjL*Yv5AFFNgjw</contactDatabaseId> <timeRange>
<startTime>2012-09-26T10:00:00</startTime> <endTime>2012-09-26T18:00:00</endTime>
</timeRange> <returnContactFields>
<contactDatabaseFieldIds> <contactDatabaseFieldId>OTk1OTk1OTkcVkFzEKakHw</contactDatabaseFieldId> <contactDatabaseFieldId>OTk4OTk4OTnd80k5msV7Bw</contactDatabaseFieldId>
</contactDatabaseFieldIds>contactDatabaseFieldIds> </returnContactFields>
</exportSkippedRequest> </exp:exportSkipped>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportSkippedResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <data>
<xop:Include href="cid:[email protected]" xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
</data> </response>
</ns2:exportSkippedResponse> </soap:Body> </soap:Envelope>
Response includes a .csv attachment
*
! !
p.#263#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.exportSkippedToFtp*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:exportSkippedToFtp> <exportSkippedToFtpRequest>
<contactDatabaseId>MjI4MjI4MjL*Yv5AFFNgjw</contactDatabaseId> <timeRange>
<startTime>2012-09-26T10:00:00</startTime> <endTime>2012-09-26T18:00:00</endTime>
</timeRange> <returnContactFields>
<contactDatabaseFieldIds> <contactDatabaseFieldId>OTk1OTk1OTkcVkFzEKakHw</contactDatabaseFieldId>
<contactDatabaseFieldId>OTk4OTk4OTnd80k5msV7Bw</contactDatabaseFieldId> </contactDatabaseFieldIds>contactDatabaseFieldIds>
</returnContactFields> <ftpAccountId>MzUzMzUzMzWs2*lOJk4AsQ</ftpAccountId> <fileName>ExportTest9.csv</fileName> <sendNotificationMail>0</sendNotificationMail>
</exportSkippedToFtpRequest> </exp:exportSkippedToFtp>
</soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:exportSkippedToFtpResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <id>NDE3NDU0NDGk0UJmgrZdog</id>
</response> </ns2:exportSkippedToFtpResponse>
</soap:Body> </soap:Envelope>
*
! !
p.#264#Tripolis!Dialogue!.!web!services,!version!3.9!.!API!2.0!Reference!Guide!–!!#
ExportService.getExportStatus*
Request!example:!<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.tripolis.com/"> <soap:Header>
<ser:authInfo> <client>Tripolis API</client> <username>[email protected]</username> <password>Xxxxx</password>
</ser:authInfo> <ser:responseLanguage>en</ser:responseLanguage>
</soap:Header> <soap:Body>
<exp:getExportStatus> <getExportStatusRequest>
<id>NDE3NDQ1NDGk0UJmgrZdog</id> </getExportStatusRequest>
</exp:getExportStatus> </soap:Body> </soap:Envelope>
!Response!example:!
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"> <soap:Header>
<ns2:responseLanguage xmlns:ns2="http://services.tripolis.com/">en</ns2:responseLanguage> </soap:Header> <soap:Body>
<ns2:getExportStatusResponse xmlns:ns2="http://export.services.tripolis.com/" xmlns:ns3="http://services.tripolis.com/" xmlns:ns4="http://contact.services.tripolis.com/">
<response> <process>
<id>NDE3NDQ1NDGk0UJmgrZdog</id> <contactDatabaseId>MjI4MjI4MjL*Yv5AFFNgjw</contactDatabaseId> <userId>MjM1ODIzNTiTWrRtJA5hQw</userId> <startTime>2012-09-27T09:53:23.389+02:00</startTime> <endTime>2012-09-27T09:53:24.974+02:00</endTime> <status>FINISHED</status>
</process> </response>
</ns2:getExportStatusResponse> </soap:Body> </soap:Envelope>
*