Nortel Networks NN42020-123 manual Provisioning Interface, Success indication on remove methods

Page 12

Copyright © Nortel Networks Limited 2006

12

OPI authorizes each request to verify the incoming credentials have the appropriate role to perform the given action.

Provisioning Interface

The following list is a summary of the provisioning object types contained within the WSDL. Detailed information on the provisioning objects and their types can be found in the WSDL file.

Simple Types:

Boolean

Byte

Double

Float

Integer

Long

Short

String

Complex types (Domain, User, Route, etc..)

"Type[] = Array of Type (i.e. String[] = Array of Strings)

Method summaries consist of method description with return type

Return type of void implies no response

This document does not cover the various actions that can be performed through the OPI interface. Nor is it intended to cover in detail what affect these changes make to the MCS system, but rather to give an overview of the OPI the interface. The Provisioning Client User Guide (NN42020-105)details provisionable entities and their role in the MCS system. In addition, the MCS Bulk Provisioning Tool Reference Guide (NN42020-501)lists the provisioning methods available using the Bulk Provisioning Tool (BPT) command line. The BPT also uses the OPI interface.

Success indication on remove methods

Some OPI Interface methods, that provide the ability to remove data, return indication of success even though the data did not pre-exist in the database. This mirrors the functionality of the database. Basically, a success indication for a "remove" OPI Interface method indicates that the associated data no longer exists in the database.

When possible, OPI Interface methods provide additional indication (in the form of an error message) regarding specific data elements

NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006

Image 12
Contents Multimedia Communication Server Page Finding the latest updates on the Nortel Web site Page Getting help over the phone from a Nortel Solutions Center Getting help from the Nortel web siteGetting help through a Nortel distributor or reseller Web Services Description Language Wsdl Open Provisioning Interface introductionThird party client development Logical view of OPI interactionsGet the Wsdl Generate stubsAuthentication and authorization Implement interface accessing stubsAccess stubs from the third-party application AuthenticationAuthorization Domain-level authorization Provisioning-Level authorizationProvisioning Interface Success indication on remove methodsDeprecated methods and method fields ExampleProvisioning data visibility PROV606 logsDeprecated method elements Sheet 1 Affected method Deprecated method elements Sheet 2 Affected method Deprecated method elementPage Building OPI Stubs Clients RequirementsDownloading the Axis toolkit Procedure 1 Downloading the Axis toolkit Setting the ClasspathProcedure 2 Setting the Classpath Procedure 3 Downloadin the Wsdl file Compiling the stubs Procedure 4 Compiling the stubsDownloading the Wsdl file \opiclient\com\client\opi\service Writing a client to perform some specific OPI operations Copyright Nortel Networks Limited Two examples Example creating a user route to screen two numbers Page Example creating a route using simultaneous ringing Page Special note on .NET authentication headers Error codes and messages Data-Access error messages Error Code Error MessageDirectoriesImpl error messages Error Code Error Message AddressBookImpl error messages Error Code Error Message Error Code Error Message Error Code Error Message UserServicePkgImpl error messages UserMgrImpl error messages Error Code Error Message DomainMgrImpl error messages RouteMgrImpl error messagesError Code Error Message AddressBookGroupCondMgr error messages GlobalAddrBookCondMgr error messagesPersonalAddrBookCondMgr error messages PhoneNumberCondMgr error messages TimeBlockGroupCondMgr error messagesBannedSubscriberMgrImpl error messages DomainCosMgrImpl error messages DomainProfileMgrImpl error messages TimeZoneMgrImpl error messagesStatusReasonMgrImpl error messages ServiceMgrImpl error messages Error Code Error Message UserPropertiesServlet error messages UserDataMgrImpl error messages VoicemailMgrImpl error messagesDeviceMgrImpl error messages IPCMMgrImpl error messages UserTimeMgrImpl error messages Error Code Error Message Error Code Error Message Page Page Multimedia Communication Server