Table Of Contents
About this Guide
Audience
Document Revision History
Organization
Related Publications
Document Conventions
Obtaining Documentation, Obtaining Support, and Security Guidelines
About this Guide
Revised: May 30, 2007, OL-8236-04
The SCMS SCE Subscriber API Programmer Guide is used for integrations that require direct access to the SCE platform for subscriber provisioning purposes.
This introduction provides information about the following topics:
•
Audience
• Document Revision History
• Organization
• Related Publications
• Document Conventions
• Obtaining Documentation, Obtaining Support, and Security Guidelines
Audience
This guide is intended for the networking or computer technician responsible for integrations involving policy servers that perform subscriber provisioning with the SCE platform.
Document Revision History
Cisco Service Control Release
|
Part Number
|
Publication Date
|
Release 3.1.0
|
OL-8236-04
|
May, 2007
|
Description of Changes
•Added new RedundancyStateListener interface to support cascade SCE setups. See Information About SCE Cascade Topology Support
Cisco Service Control Release
|
Part Number
|
Publication Date
|
Release 3.0.5
|
OL-8236-03
|
November, 2006
|
Description of Changes
•Added new section on Quota State Restore Event.
•Updated SCAS_BB_Quota class.
•Updated the QuotaListenerEx interface due to deprecation of the QuotaListener interface. See Information About the QuotaListenerEx Interface Class /
Cisco Service Control Release
|
Part Number
|
Publication Date
|
Release 3.0.3
|
OL-8236-02
|
May, 2006
|
Description of Changes
•Updated API code examples. See API Code Examples.
Cisco Service Control Release
|
Part Number
|
Publication Date
|
Release 3.0
|
OL-8236-01
|
December, 2005
|
Description of Changes
•First version of this document.
Organization
The major sections of this guide are as follows:
Table 1
Chapter
|
Title
|
Description
|
Chapter 1
|
Getting Started
|
Discusses the platforms on which the SCE Subscriber API can be used, and how to install, compile, and start running the API.
|
Chapter 2
|
Concepts and Terms
|
Describes various terms and concepts that are utilized when working with the SCE Subscriber API.
|
Chapter 3
|
API Events
|
Describes various events accessed by the SCE Subscriber API.
|
Chapter 4
|
Getting Familiar with the API Data Types
|
Describes the various API data types.
|
Chapter 5
|
Programming with the SCE Subscriber API
|
Provides a detailed description of the API programming structure, classes, methods, and interfaces.
|
Chapter 6
|
Troubleshooting
|
Describes the usage of the API logging abilities for troubleshooting the integration with the API. API logging enables the user to monitor the operations being called including the received parameters both at the API client and at the SCE side.
|
Appendix A
|
List of Error Codes
|
Lists the error codes that are returned by the API.
|
Related Publications
Use this API Guide in conjunction with the following Cisco documentation:
•Cisco SCMS Subscriber Manager User Guide
•Cisco Service Control Application for Broadband (SCA BB) User Guide
•Cisco SCE 1000 2xGBE Installation and Configuration Guide
•Cisco SCE 2000 4xGBE Installation and Configuration Guide
Document Conventions
This guide uses the following conventions:
•Bold is used for commands, keywords, and buttons.
•Italics are used for command input for which you supply values.
•Screen font is used for examples of information that are displayed on the screen.
•Bold screen font is used for examples of information that you enter.
•Vertical bars ( | ) indicate separate alternative, mutually exclusive elements.
•Square brackets ( [ ] ) indicate optional elements.
•Braces ( {} ) indicate a required choice.
•Braces within square brackets ( [{}] ) indicate a required choice within an optional element.
Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the guide.
Timesaver Means the described action saves time. You can save time by performing the action described in the paragraph.
Caution Means
reader be careful. In this situation, you might do something that could result in equipment damage or loss of data.
Warning Means danger. You are in a situation that could cause bodily injury. Before you work on any equipment, you must be aware of the hazards involved with electrical circuitry and familiar with standard practices for preventing accidents. To see translated versions of warnings, refer to the Regulatory Compliance and Safety Information document that accompanied the device.
Obtaining Documentation, Obtaining Support, and Security Guidelines
For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
