Oracle Responsys SOAP API Developer's Guide
Total Page:16
File Type:pdf, Size:1020Kb
Oracle Responsys SOAP API Developer’s Guide — Standard IMPORTANT: The Oracle Responsys Web Services SOAP API is in maintenance mode. There will be no new enhancements to the SOAP API. Oracle Responsys continues to support the SOAP API but encourages you to use the REST API. Documentation for the REST API can be found on the Responsys documentation page: https://docs.oracle.com/cloud/latest/marketingcs_gs/responsys.html November 2020 Documentation for developers who use the Oracle Responsys SOAP API to access the data, content, and campaign management features of Oracle Responsys. Oracle Responsys SOAP API Developer’s Guide E65152-18 Copyright © 2020, Oracle and/or its affiliates. All rights reserved. Information in this document is subject to change without notice. Data used as examples in this document is fictitious. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, without prior written permission of Oracle Responsys. Address permission requests, comments, or suggestions about Oracle Responsys documentation by creating a MOS Service Request at https://support.oracle.com. Contents Oracle Responsys API functionality . .1 Oracle Responsys platform and data model overview . .4 Oracle Responsys Platform . .4 Oracle Responsys Object Data Model . .4 API Call Processing . .7 How Enactment Batching Affects Processing . .8 Access Controls . .8 Organizational access control . .8 Functional access control . .9 Login IP enforcement access control . .9 Getting started with the Oracle Responsys API . .9 Authenticate Using Username and Password (Login) . 18 Logout . 19 Authentication with Certificates (authenticateServer + loginWithCertificate) . 19 AuthenticateServer . 21 LoginWithCertificate . 22 CreateContentLibraryFolder. 24 CreateFolder. 24 DeleteContentLibraryFolder. 25 DeleteFolder. 25 DoesContentLibraryFolderExist . 26 ListContentLibraryFolders . 26 ListFolders . 27 List Management API calls. 27 MergeListMembers. 27 MergeListMembersRIID . 28 DeleteListMembers. 29 RetrieveListMembers. 30 Table Management API calls . 31 CreateProfileExtensionTable . 31 Response. 31 Contents — iii CreateTable . 31 CreateTableWithPK. 32 DeleteProfileExtensionMembers . 33 DeleteTable . 34 MergeIntoProfileExtension . 34 MergeTableRecords . 35 MergeTableRecordsWithPK . 36 DeleteTableRecords . 37 RetrieveTableRecords . 38 RetrieveProfileExtensionRecords . 38 TruncateTable . 39 Content Management API calls . 40 CopyContentLibraryItem. 40 CreateContentLibraryItem. 41 CreateDocument . 41 DeleteContentLibraryItem. 42 DeleteDocument . 42 GetContentLibraryItem . 43 GetDocumentContent . 43 GetDocumentImages. 44 MoveContentLibraryItem . 44 SetDocumentContent . 45 SetDocumentImages . 45 UpdateContentLibraryItem . 46 Campaign Management API calls . 47 GetLaunchStatus . 47 LaunchCampaign . 48 MergeTriggerEmail . 49 MergeTriggerSMS. 50 ScheduleCampaignLaunch. 51 TriggerCustomEvent . 52 TriggerCampaignMessage . 53 Interact Data Types . 55 Interact Objects. 55 CharacterEncoding . 56 ContentFormat . 56 CustomEvent . 56 DeleteResult . 56 EmailFormat . 57 Field. 57 FieldType. 57 iv — Contents FolderResult . 57 ImageData . 58 InteractObject . 58 LaunchPreferences . 58 LaunchResult . 59 ListMergeRule . 59 LoginResult . 61 MatchOperator . 61 MergeResult. 61 OptionalData.