Cisco Cisco Prime Collaboration Provisioning 11.1 User Guide

 

 

© 2012-2014 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public. 

Page 39 of 2 

•  CupmApiFaultType—Included if the NBI request fails. 

listSubscriber Java Signature 

Selects a set of subscribers. 

Syntax: 

public ResponseReturn listSubscriber (CUPMServiceStub stub, CupmApiFilterValue filter, String 

endPointReference, String idPrefix); 

Parameters: 

•  filter—Defines the object selection criteria and the device object attributes to be returned. 

 

You can filter using the following attributes: 

o

 

subscriberRoles 

o

 

lastName 

o

 

phone 

o

 

email 

o

 

domainID 

o

 

department 

o

 

subscriberID 

o

 

firstName 

•  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 internally generated numeric to form the NBI ID. Null 

allowed. 

Returns: 

CupmApiResponseValue—Object with NBI ID. 

Throws: 

ListSubscriberException—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.