API Reference Guide Release 11i - Oracle

Oracle MarketingAPI Reference GuideRelease 11iPart No. B10587-01March 2003

Oracle Marketing API Reference Guide, Release 11iPart No. B10587-01Copyright 2002, 2003 Oracle Corporation. All rights reserved.Primary Author: Sheralyn FowlerThe Programs (which include both the software and documentation) contain proprietary information ofOracle Corporation; they are provided under a license agreement containing restrictions on use anddisclosure and are also protected by copyright, patent and other intellectual and industrial propertylaws. Reverse engineering, disassembly or decompilation of the Programs, except to the extent requiredto obtain interoperability with other independently created software or as specified by law, is prohibited.The information contained in this document is subject to change without notice. If you find any problemsin the documentation, please report them to us in writing. Oracle Corporation does not warrant that thisdocument is error-free. Except as may be expressly permitted in your license agreement for thesePrograms, no part of these Programs may be reproduced or transmitted in any form or by any means,electronic or mechanical, for any purpose, without the express written permission of Oracle Corporation.If the Programs are delivered to the U.S. Government or anyone licensing or using the programs onbehalf of the U.S. Government, the following notice is applicable:Restricted Rights Notice Programs delivered subject to the DOD FAR Supplement are “commercialcomputer software” and use, duplication, and disclosure of the Programs, including documentation,shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement.Otherwise, Programs delivered subject to the Federal Acquisition Regulations are “restricted computersoftware” and use, duplication, and disclosure of the Programs shall be subject to the restrictions in FAR52.227-19, Commercial Computer Software - Restricted Rights (June, 1987). Oracle Corporation, 500Oracle Parkway, Redwood City, CA 94065.The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherentlydangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup,redundancy, and other measures to ensure the safe use of such applications if the Programs are used forsuch purposes, and Oracle Corporation disclaims liability for any damages caused by such use of thePrograms.Oracle is a registered trademark, and JInitiator, Oracle Discoverer, OracleMetaLink, Oracle9i, Oracle9iASDiscoverer are trademarks or registered trademarks of Oracle Corporation. Other names may betrademarks of their respective owners.

ContentsSend Us Your Comments . ixPreface. xiIntroduction .Intended Audience .How This Guide is Organized .How to Use This Guide.Typographic Conventions .Documentation Accessibility .Other Information Sources .Training and Support.Do Not Use Database Tools to Modify Oracle Applications Data .About Oracle 11.1.21.1.31.1.41.1.51.1.61.21.3Parameter Specifications .Standard In Parameters.Standard OUT parameters.Parameter Size .Missing Parameter Attributes .Parameter Validations .Invalid Parameters .Version Information.Status Messages .1-21-21-31-31-41-41-41-51-5iii

2User 3User Hook Procedures .Type Declaration.Standard Parameters for Campaign Schedule APIs.Campaign Schedule APIs .Create Campaign Schedule.Delete Campaign Schedule .Lock Campaign Schedule.Update Campaign Schedule .Validate Campaign Schedule .Copy Campaign Schedule.4-24-34-54-64-64-84-104-114-134-14Public Metrics5.15.1.15.1.2ivUser Hook Procedures .Type Declaration.Standard Parameters for Campaign APIs.Campaign APIs .Create Campaign.Delete Campaign .Lock Campaign.Update Campaign .Validate Campaign.Campaign 33.4.43.4.54Introduction.User Hook Registration .Available Campaign User Hooks.Available Event User Hooks .Parameters for User Hook Procedures .Package Name: AMS Metric Pub . 5-1Procedure: Update Metric . 5-2Procedure: Delete Metric. 5-3

5.1.35.25.2.15.2.25.2.35.2.46Type Declaration .Standard Parameters for Claims APIs.Claim Public API .Update Claim.Delete Claim.Create Claim Line Table.Update Claim Line Table .Delete Claim Line Table .6-16-106-106-116-136-156-176-19Third-Party d: AMS METRIC PVT.metric rec type .Package Name: AMS ACTMETRIC PUB.Procedure: Create ActMetric .Procedure: Update ActMetric.Procedure: Delete ActMetric .Record: AMS ActMetric PVT.act metric rec type .Validation Rules .Concurrent Programs .AMS-TM: Chargeback Accrual .AMS-TM: Chargeback Purge .Preparing the Concurrent Programs .Tables Updated by the Concurrent Program .7-27-27-27-27-27-3Type Declarations.Sales Lead Type .Sales Lead Line Type .Sales Lead Line Out Type .Sales Lead Contact Type .Lease Lead Count Out Type .Lead Engines Out Type .Standard Parameters for List Generation .38.1.48.1.58.1.68.2v

8-248-24Event .4.69.4.79.4.89.4.99.4.10viSales Lead APIs.Create Sales Lead.Update Sales Lead .Sales Lead Lines APIs .Create Sales Lead Lines .Update Sales Lead Lines .Delete Sales Lead Lines .Sales Lead Contact APIs .Create Sales Lead Contacts .Update Sales Lead Contacts.Delete Sales Lead Contacts .Sales Lead Score APIs .Get Sales Lead Score .Run Lead Engines.Lead Sales Team APIs .Build Lead Sales Team.Rebuild Lead Sales Team .Partner Matching APIs .Start Partner Matching.Event Registration User Hooks .Type Declarations.Standard Parameters for List Generation APIs .Registration APIs .Procedure Specification .Parameter Description .Initialization Registration Record .Update Registration .Cancel Registration .Delete Registration .Prioritize Registration Waitlist .Substitute Enrollee .Transfer Enrollee .Get Registration Record .9-19-29-49-59-59-69-89-89-99-119-129-139-159-17

10.41110-110-410-510-510-710-910-1010-1210-14Event ScheduleType Declaration .Standard Parameters for Event Schedule APIs.Event Schedule APIs .Create Event Schedule.Delete Event Schedule .Lock Event Schedule.Update Event Schedule .Validate Event Schedule .Event Offer API User Type Declaration .12.2Standard Parameters for List APIs .12.3List APIs.12.3.1Create List.12.3.2Delete List Header.12.3.3Lock List .12.3.4Update List .12.3.5Validate List .12.3.6Copy List .311.3.111.3.211.3.311.3.411.3.511.412Type Declaration .Standard Parameters for Event APIs.Event APIs .Create Event.Delete Event .

Oracle Marketing API Reference Guide Release 11i Part No. B10587-01 March 2003