Table Of Contents

About This Guide

Objective

Who Should Use This Book

How This Book Is Organized

Related Documentation

Obtaining Cisco PTC - VS API Development Support

Obtaining Documentation

Cisco.com

Documentation CD-ROM

Ordering Documentation

Documentation Feedback

Obtaining Technical Assistance

Cisco.com

Technical Assistance Center

Cisco TAC Website

Cisco TAC Escalation Center

Obtaining Additional Publications and Information

About This Guide

---

Objective

The Cisco Packet Telephony Center - Virtual Switch API Reference and Programmer Guide, 3.0 describes how to use the Cisco PTC - VS North Bound Application Programming Interface (NBAPI) to access and link to client-exposed internal services.

The API Programmer chapters provide general information about how the APIs and their functions can be used in your client application. Specific API details are described in the API Reference chapters. Client sample code, showing you how to use the functions, is provided in "Sample Client Program."

Who Should Use This Book

This guide is intended to be a technical resource for client programmers who develop client-specific CLI network inventory retrieval and provisioning services for managing a large network for various Voice over IP (VoIP) solutions.

You should have an advanced level of understanding of Internet network design, operation, and terminology and you should be familiar with Cisco Internetwork Operating System (IOS) software and its commands.

You should also be familiar with the XML scripting language, and with either or, preferably both, the Java and C++ programming languages.

See the "Obtaining Cisco PTC - VS API Development Support" for information on how to obtain API development support for Cisco PTC - VS.

How This Book Is Organized

This book is organized as follows:

"Northbound API Overview," describes the Northbound API.

"Object Model," provides an overview and description of the Cisco PTC - VS Object Model.

"XML and DTD," describes the encoding scheme supported through the Java API.

"Cisco PTC - VS API Reference," describes the general characteristics of different APIs.

"Inventory Query Result API," describes the interface that gets the first batch of data.

"Service Manager API," describes inventory and provisioning methods.

"Service Manager Home API," documents the home interface for the Service Manager.

"Sample Client Program," contains a client code example that demonstrates how to access the internal services through the NBAPI.

An Index is also provided.

Related Documentation

The following documents are companion documents to this API manual and comprise the
Cisco PTC - VS documentation set:

•Documentation Guide for Cisco Packet Telephony Center - Virtual Switch, 3.0

•Release Notes for Cisco Packet Telephony Center - Virtual Switch, 3.0

•Cisco Packet Telephony Center - Virtual Switch Installation and Configuration Guide, 3.0

•Cisco Packet Telephony Center - Virtual Switch User Guide, 3.0.

---

Note All of the Cisco Packet Telephony Center - Virtual Switch documents can be found online on the Cisco Documentation CD, as well as, at the Cisco Connection Online (CCO) URL:
http://www.cisco.com/univercd/cc/td/doc/product/rtrmgmt/ptc/3_0/index.htm.

See the "Obtaining Documentation" section for detailed information about the Cisco Documentation CD and the Cisco Connection Online website.

---

Obtaining Cisco PTC - VS API Development Support

Cisco has a new support program for developers who are enabling products with Cisco supported interfaces. The Developer Support Program is being developed to provide formalized support for Cisco interfaces to accelerate the delivery of compatible solutions to Cisco customers!

The Developer Support Program offer the following benefits:

•Minimal support fees

•Flexible support model—purchase support as needed or for a period of time

•Consistent level of support—defined problem priority and escalation guidelines

•Deliver products to market faster—dedicated program with interface experts to assist you.

To find out more about this program and obtain the Developer Support Agreement, visit our web site at http://www.cisco.com/go/developersupport. Upon receipt of your signed agreement, we will send you your contract ID number and instructions for opening support case3s with Cisco Developer Support Engineers.

We look forward to working with you! Please don't hesitate to contact us if you have further questions about this program.

Cisco Developer Support
developer-support@cisco.com
http://www.cisco.com/go/developersupport

Obtaining Documentation

Cisco provides several ways to obtain documentation, technical assistance, and other technical resources. These sections explain how to obtain technical information from Cisco Systems.

Cisco.com

You can access the most current Cisco documentation on the World Wide Web at this URL:

http://www.cisco.com/univercd/home/home.htm

You can access the Cisco website at this URL:

http://www.cisco.com

International Cisco websites can be accessed from this URL:

http://www.cisco.com/public/countries_languages.shtml

Documentation CD-ROM

Cisco documentation and additional literature are available in a Cisco Documentation CD-ROM package, which may have shipped with your product. The Documentation CD-ROM is updated regularly and may be more current than printed documentation. The CD-ROM package is available as a single unit or through an annual or quarterly subscription.

Registered Cisco.com users can order a single Documentation CD-ROM (product number DOC-CONDOCCD=) through the Cisco Ordering tool:

http://www.cisco.com/en/US/partner/ordering/ordering_place_order_ordering_tool_launch.html

All users can order monthly or quarterly subscriptions through the online Subscription Store:

http://www.cisco.com/go/subscription

Ordering Documentation

You can find instructions for ordering documentation at this URL:

http://www.cisco.com/univercd/cc/td/doc/es_inpck/pdi.htm

You can order Cisco documentation in these ways:

•Registered Cisco.com users (Cisco direct customers) can order Cisco product documentation from the Networking Products MarketPlace:

http://www.cisco.com/en/US/partner/ordering/index.shtml

•Nonregistered Cisco.com users can order documentation through a local account representative by calling Cisco Systems Corporate Headquarters (California, U.S.A.) at 408 526-7208 or, elsewhere in North America, by calling 800 553-NETS (6387).

Documentation Feedback

You can submit comments electronically on Cisco.com. On the Cisco Documentation home page, click Feedback at the top of the page.

You can e-mail your comments to bug-doc@cisco.com.

You can submit comments by using the response card (if present) behind the front cover of your document or by writing to the following address:

Cisco Systems
Attn: Customer Document Ordering
170 West Tasman Drive
San Jose, CA 95134-9883

We appreciate your comments.

Obtaining Technical Assistance

Cisco provides Cisco.com, which includes the Cisco Technical Assistance Center (TAC) website, as a starting point for all technical assistance. Customers and partners can obtain online documentation, troubleshooting tips, and sample configurations from the Cisco TAC website. Cisco.com registered users have complete access to the technical support resources on the Cisco TAC website, including TAC tools and utilities.

Cisco.com

Cisco.com offers a suite of interactive, networked services that let you access Cisco information, networking solutions, services, programs, and resources at any time, from anywhere in the world.

Cisco.com provides a broad range of features and services to help you with these tasks:

•Streamline business processes and improve productivity

•Resolve technical issues with online support

•Download and test software packages

•Order Cisco learning materials and merchandise

•Register for online skill assessment, training, and certification programs

To obtain customized information and service, you can self-register on Cisco.com at this URL:

http://tools.cisco.com/RPF/register/register.do

Technical Assistance Center

The Cisco TAC is available to all customers who need technical assistance with a Cisco product, technology, or solution. Two types of support are available: the Cisco TAC website and the Cisco TAC Escalation Center. The type of support that you choose depends on the priority of the problem and the conditions stated in service contracts, when applicable.

We categorize Cisco TAC inquiries according to urgency:

•Priority level 4 (P4)—You need information or assistance concerning Cisco product capabilities, product installation, or basic product configuration. There is little or no impact to your business operations.

•Priority level 3 (P3)—Operational performance of the network is impaired, but most business operations remain functional. You and Cisco are willing to commit resources during normal business hours to restore service to satisfactory levels.

•Priority level 2 (P2)—Operation of an existing network is severely degraded, or significant aspects of your business operations are negatively impacted by inadequate performance of Cisco products. You and Cisco will commit full-time resources during normal business hours to resolve the situation.

•Priority level 1 (P1)—An existing network is "down," or there is a critical impact to your business operations. You and Cisco will commit all necessary resources around the clock to resolve the situation.

Cisco TAC Website

The Cisco TAC website provides online documents and tools to help troubleshoot and resolve technical issues with Cisco products and technologies. To access the Cisco TAC website, go to this URL:

http://www.cisco.com/tac

All customers, partners, and resellers who have a valid Cisco service contract have complete access to the technical support resources on the Cisco TAC website. Some services on the Cisco TAC website require a Cisco.com login ID and password. If you have a valid service contract but do not have a login ID or password, go to this URL to register:

http://tools.cisco.com/RPF/register/register.do

If you are a Cisco.com registered user, and you cannot resolve your technical issues by using the Cisco TAC website, you can open a case online at this URL:

http://www.cisco.com/tac/caseopen

If you have Internet access, we recommend that you open P3 and P4 cases online so that you can fully describe the situation and attach any necessary files.

Cisco TAC Escalation Center

The Cisco TAC Escalation Center addresses priority level 1 or priority level 2 issues. These classifications are assigned when severe network degradation significantly impacts business operations. When you contact the TAC Escalation Center with a P1 or P2 problem, a Cisco TAC engineer automatically opens a case.

To obtain a directory of toll-free Cisco TAC telephone numbers for your country, go to this URL:

http://www.cisco.com/warp/public/687/Directory/DirTAC.shtml

Before calling, please check with your network operations center to determine the Cisco support services to which your company is entitled: for example, SMARTnet, SMARTnet Onsite, or Network Supported Accounts (NSA). When you call the center, please have available your service agreement number and your product serial number.

Obtaining Additional Publications and Information

Information about Cisco products, technologies, and network solutions is available from various online and printed sources.

•The Cisco Product Catalog describes the networking products offered by Cisco Systems, as well as ordering and customer support services. Access the Cisco Product Catalog at this URL:

http://www.cisco.com/en/US/products/products_catalog_links_launch.html

•Cisco Press publishes a wide range of networking publications. Cisco suggests these titles for new and experienced users: Internetworking Terms and Acronyms Dictionary, Internetworking Technology Handbook, Internetworking Troubleshooting Guide, and the Internetworking Design Guide. For current Cisco Press titles and other information, go to Cisco Press online at this URL:

http://www.ciscopress.com

•Packet magazine is the Cisco quarterly publication that provides the latest networking trends, technology breakthroughs, and Cisco products and solutions to help industry professionals get the most from their networking investment. Included are networking deployment and troubleshooting tips, configuration examples, customer case studies, tutorials and training, certification information, and links to numerous in-depth online resources. You can access Packet magazine at this URL:

http://www.cisco.com/go/packet

•iQ Magazine is the Cisco bimonthly publication that delivers the latest information about Internet business strategies for executives. You can access iQ Magazine at this URL:

http://www.cisco.com/go/iqmagazine

•Internet Protocol Journal is a quarterly journal published by Cisco Systems for engineering professionals involved in designing, developing, and operating public and private internets and intranets. You can access the Internet Protocol Journal at this URL:

http://www.cisco.com/en/US/about/ac123/ac147/about_cisco_the_internet_protocol_journal.html

•Training—Cisco offers world-class networking training. Current offerings in network training are listed at this URL:

http://www.cisco.com/en/US/learning/le31/learning_recommended_training_list.html