Cisco Cisco Prime Central 1.3 Developer's Guide

Page of 203
Customer
operation:createCustomer 
input:
output:
fault:
createCustomerException 
Creates a customer instance. When this operation succeeds, it returns a customer reference and a
success set to True. When this operation fails, it returns an exception. 
Customer
operation:modifyCustomer 
input:
output:
fault:
modifyCustomerException
Modifies the properties of a customer instance. When this operation succeeds, it returns a success
set to True. When this operation fails, it returns an exception. 
Customer
operation:deleteCustomer 
input:
 
output:
   
fault:
deleteCustomerException
Deletes a customer instance. When this operation succeeds, it returns a success set to True. When
this operation fails, it returns an exception.
Customer 
operation:getCustomer 
input: 
 
output: 
 
fault: getCustomerException
Retrieves a specified customer. When this operation succeeds, it returns a customer object and a
success set to True. When this operation fails, it returns an exception. 
Customer
operation:getAllCustomerIDs
input: 
output: 
fault:
getAllCustomerIDsException
Retrieves a list of customer FDNs. When this operation succeeds, it returns customer FDNs and a
success set to True. When this operation fails, it returns an exception.
Customer
operation:getAllCustomer 
input: 
 
output: 
 
fault:
getAllCustomerException
Retrieves customer summary information, which consists of FDN, name, description, and status.
When this operation succeeds, it returns a list of customer objects and a success set to True.
When this operation fails, it returns an exception.
Alarm Management
AlarmMgmtAPI
Operations on this service can be used to acknowledge, deacknowledge, clear, and retire alarms, and add alarm notes. Operations are best
effort. When the username is passed, the OS marks the alarm or TCA as being monitored by that user.
Endpoint URL: https://<host>:9020/AlarmManagementAPI
WSDL URL: https://<host>:9020/AlarmManagementAPI?wsdl
Operations
Object
API
Description
AlarmId
 acknowledgeAlarm 
Operation:
Input:
Output:
Acknowledges an alarm.