Cisco Cisco Prime Collaboration Provisioning 11.2 User Guide

Page of 78
 
 
© 2012-2014 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public. 
Page 43 of 2 
•  endPointReference—String to convert to an EndpointReference object that the asynchronous result 
notification will be sent to. 
•  idPrefix—String that is added to the beginning of the NBI ID returned to the client. 
Returns
CupmApiResponseValue—Object with NBI ID. 
Throws
ListSubscriberServiceException—If server cannot execute NBI request. 
ASyncReturn
•  CupmApiResultValue—Contains CupmApiStatus and CupmApiList. CupmApiList contains one object, the 
EnumerationContextType, which is used to retrieve the list using WS-Enumeration suggested standards. 
•  CupmApiFaultType—Included if the NBI request fails. 
Note: The pullOp API can be used to retrieve a list of elements according to a specified enumeration context (for 
more information on pullOp, see 
pullOp Java Signature. 
getSubscriberService Java Signature 
Returns the following: 
•  Service details with the product information. 
•  Service Area ID. 
•  Domain ID. 
•  Subscriber ID. 
Syntax
public ResponseReturn getSubscriberService (CUPMServiceStub stub, SubscriberValue subscriber, 
ServiceAreaValue serviceArea, ProductValue product, String endPointReference, String idPrefix); 
Parameters
•  Subscriber—Specify the subscriber object with the key attribute, subscriberID, to retrieve the services for. 
•  ServiceAreaValue—The Service Area where the subscriber’s service was provisioned. 
•  product—Identifies the service to be returned. Key attributes (see Subscriber Product Key Attributes, page 
2-10) are used to search for the product. Nonkey attributes are ignored for product lookup. 
•  endPointReference—String to convert to an EndpointReference object that the asynchronous result 
notification will be sent to. 
•  idPrefix—String that is added to the beginning of the NBI ID returned to the client. 
Returns
CupmApiResponseValue—Object with NBI ID.