LprRosterService

• getLprRoster
• getLprRostersByIds
• getLprRosterIdsByType
• getLprRostersByLui
• getLprRostersByTypeAndLui
• searchForLprRosterIds
• searchForLprRosters
• validateLprRoster
• createLprRoster
• updateLprRoster
• deleteLprRoster
• getLprRosterEntry
• getLprRosterEntriesByIds
• getLprRosterEntryIdsByType
• getLprRosterEntriesByLprRoster
• getLprRosterEntriesByLpr
• getLprRosterEntriesByLprRosterAndLpr
• searchForLprRosterEntryIds
• searchForLprRosterEntries
• validateLprRosterEntry
• createLprRosterEntry
• updateLprRosterEntry
• deleteLprRosterEntry
• moveLprRosterEntryToPosition
• reorderLprRosterEntries

• LprRosterInfo
• QueryByCriteria
• ValidationResultInfo
• StatusInfo
• LprRosterEntryInfo

Method	getLprRoster
Description	Retrieves a single LprRoster by an LprRoster Id.
Parameters	String	lprRosterId	the identifier for the LprRoster to be retrieved
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LprRosterInfo		the LprRoster requested
Errors	DoesNotExistException		lprRosterId is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		lprRosterId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getLprRostersByIds
Description	Retrieve a list of LprRosters from a list of LprRoster Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not ber returned.
Parameters	StringList	lprRosterIds	a list of LprRoster identifiers
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LprRosterInfoList		a list of LprRosters
Errors	DoesNotExistException		a lprRosterId in the list was not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		lprRosterIds, an Id in lprRosterIds, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getLprRosterIdsByType
Description	Retrieve a list of LprRosterIds by LprRoster Type.
Parameters	String	lprRosterTypeKey	an identifier for an LprRoster Type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StringList		a list of LprRosters identifiers matching lprRosterTypeKey or an empty list of none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		lprRosterTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getLprRostersByLui
Description	Gets a list of LprRosters associated with a given Lui.
Parameters	String	luiId	an identifier for a LUI
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LprRosterInfoList		list of LprRosters associated with the given Lui or an empty list if none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		luiId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getLprRostersByTypeAndLui
Description	Gets a list of LprRosters associated with a given LprRoster Type and Lui.
Parameters	String	lprRosterTypeKey	an identifier for an LprRoster Type
	String	luiId	an identifier for a Lui
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LprRosterInfoList		list of LprRosters of the given LprRoster Type and associated with the given Lui or an empty list if none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		lprRosterTypeKey, luiId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForLprRosterIds
Description	Searches for LprRosters that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StringList		a list of LprRoster identifiers matching the criteria
Errors	InvalidParameterException		criteria or contextInfo is not valid
	MissingParameterException		criteria or or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForLprRosters
Description	Searches for LprRosters that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LprRosterInfoList		a list of LprRosters matching the criteria
Errors	InvalidParameterException		criteria or contextInfo is not valid
	MissingParameterException		criteria or or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	validateLprRoster
Description	Validates an LprRoster. Depending on the value of validationType, this validation could be limited to tests on just the current LprRoster and its directly contained sub-objects or expanded to perform all tests related to this LprRoster. If an identifier is present for the LprRoster (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the LprRoster can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the LprRoster with the given data can be created.
Parameters	String	validationTypeKey	the identifier for the validation Type
	String	lprRosterTypeKey	the identifier for the LprRoster Type to be validated
	LprRosterInfo	lprRosterInfo	the LprRoster to be validated
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	ValidationResultInfoList		a list of validation results or an empty list if validation succeeded
Errors	DoesNotExistException		validationTypeKey or lprRosterTypeKey is not found
	InvalidParameterException		lprRosterInfo or contextInfo is not valid
	MissingParameterException		validationTypeKey, lprRosterTypeKey, lprRosterInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	createLprRoster
Description	Creates a new LprRoster. The LprRoster Id, Type, and Meta information may not be set in the supplied data object.
Parameters	String	lprRosterTypeKey	the identifier for the Type of LprRoster to be created
	LprRosterInfo	lprRosterInfo	the data with which to create the LprRoster
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LprRosterInfo		the new LprRoster
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		lprRosterTypeKey does not exist or is not supported
	InvalidParameterException		lprRosterInfo or contextInfo is not valid
	MissingParameterException		lprRosterTypeKey, lprRosterInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred
	ReadOnlyException		an attempt at supplying information designated as read only

Back to Operations

Method	updateLprRoster
Description	Updates an existing LprRoster. The LprRoster Id, Type, and Meta information may not be changed.
Parameters	String	lprRosterId	the identifier for the LprRoster to be updated
	LprRosterInfo	lprRosterInfo	the new data for the LprRoster
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LprRosterInfo		the updated LprRoster
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		lprRosterId is not found
	InvalidParameterException		lprRosterInfo or contextInfo is not valid
	MissingParameterException		lprRosterId, lprRosterInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred
	ReadOnlyException		an attempt at supplying information designated as read only
	VersionMismatchException		an optimistic locking failure or the action was attempted on an out of date version

Back to Operations

Method	deleteLprRoster
Description	Deletes an existing LprRoster.
Parameters	String	lprRosterId	the identifier for the LprRoster to be deleted
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StatusInfo		the status of the delete operation. This must always be true.
Errors	DoesNotExistException		lprRosterId is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		lprRosterId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLprRosterEntry
Description	Retrieves a single LprRosterEntry by an LprRosterEntry Id.
Parameters	String	lprRosterEntryId	the identifier for the LprRosterEntry to be retrieved
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LprRosterEntryInfo		the LprRosterEntry requested
Errors	DoesNotExistException		lprRosterEntryId is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		lprRosterEntryId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getLprRosterEntriesByIds
Description	Retrieve a list of LprRosterEntriess from a list of LprRosterEntry Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not ber returned.
Parameters	StringList	lprRosterEntryIds	a list of LprRosterEntry identifiers
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LprRosterEntryInfoList		a list of LprRosterEntries
Errors	DoesNotExistException		a lprRosterEntryId in the list was not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		lprRosterEntryIds, an Id in lprRosterIds, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getLprRosterEntryIdsByType
Description	Retrieve a list of LprRosterENtryIds by LprRosterEntry Type.
Parameters	String	lprRosterEntryTypeKey	an identifier for an LprRosterEntry Type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StringList		a list of LprRosterEntries identifiers matching lprRosterEntryTypeKey or an empty list of none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		lprRosterEntryTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getLprRosterEntriesByLprRoster
Description	This method returns all the LprRosterEntries for an LprRoster.
Parameters	String	lprRosterId	an identifier for an LprRoster
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LprRosterEntryInfoList		a list of LprRosterEntries identifiers for the given LprRoster or an empty list of none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		lprRosterId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getLprRosterEntriesByLpr
Description	This method returns all the LprRosterEntries for an LPR.
Parameters	String	lprId	an identifier for an Lpr
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LprRosterEntryInfoList		a list of LprRosterEntries identifiers for the given Lpr or an empty list of none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		lprId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getLprRosterEntriesByLprRosterAndLpr
Description	This method returns all the LprRosterEntries to the given LprRoster and Lpr.
Parameters	String	lprRosterId	an identifier for an LprRoster
	String	lprId	an identifier for an Lpr
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LprRosterEntryInfoList		a list of LprRosterEntries identifiers for the given LprRoster and Lpr or an empty list of none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		lprRosterId, lprId, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForLprRosterEntryIds
Description	Searches for LprRosterEntries that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StringList		a list of LprRosterEntry identifiers matching the criteria
Errors	InvalidParameterException		criteria or contextInfo is not valid
	MissingParameterException		criteria or or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForLprRosterEntries
Description	Searches for LprRosterEntris that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LprRosterEntryInfoList		a list of LprRosterEntries matching the criteria
Errors	InvalidParameterException		criteria or contextInfo is not valid
	MissingParameterException		criteria or or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	validateLprRosterEntry
Description	Validates an LprRosterEntry. Depending on the value of validationType, this validation could be limited to tests on just the current LprRosterEntry and its directly contained sub-objects or expanded to perform all tests related to this LprRosterEntry. If an identifier is present for the LprRosterEntry (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the LprRosterEntry can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the LprRosterEntry with the given data can be created.
Parameters	String	validationTypeKey	the identifier for the validation Type
	String	lprRosterId	the LprRoster of the LprRosterEntry
	String	lprId	the Lpr of the LprRosterEntry
	String	lprRosterTypeKey	???
	LprRosterInfo	lprRosterInfo	???
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	ValidationResultInfoList		a list of validation results or an empty list if validation succeeded
Errors	DoesNotExistException		validationTypeKey, lprRosterId, or lprId, or lprRosterEntryTypeKey is not found
	InvalidParameterException		lprRosterEntryInfo or contextInfo is not valid
	MissingParameterException		validationTypeKey, lprRosterId, lprId, lprRosterTypeKey, lprRosterInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	createLprRosterEntry
Description	Creates a new LprRosterEntry. The LprRosterEntry Id, LprRosterId, Lpr Id, Type, and Meta information may not be set in the supplied data object.
Parameters	String	lprRosterId	the LprRoster of the LprRosterEntry
	String	lprId	the Lpr of the LprRosterEntry
	String	lprRosterEntryTypeKey	the identifier for the Type of LprRosterEntry to be created
	LprRosterEntryInfo	lprRosterEntryInfo	???
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LprRosterEntryInfo		the new LprRosterEntry
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		lprRosterId, lprId, or lprRosterEntryTypeKey does not exist or is not supported
	InvalidParameterException		lprRosterEntryInfo or contextInfo is not valid
	MissingParameterException		lprRosterId, lprId, lprRosterEntryTypeKey, lprRosterInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred
	ReadOnlyException		an attempt at supplying information designated as read only

Back to Operations

Method	updateLprRosterEntry
Description	Updates an existing LprRosterEntry. The LprRosterEntry Id, Type, and Meta information may not be changed.
Parameters	String	lprRosterEntryId	the identifier for the LprRosterEntry to be updated
	LprRosterEntryInfo	lprRosterEntryInfo	the new data for the LprRosterEntry
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LprRosterEntryInfo		the updated LprRosterEntry
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		lprRosterEntryId is not found
	InvalidParameterException		lprRosterEntryInfo or contextInfo is not valid
	MissingParameterException		lprRosterEntryId, lprRosterEntryInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred
	ReadOnlyException		an attempt at supplying information designated as read only
	VersionMismatchException		an optimistic locking failure or the action was attempted on an out of date version

Back to Operations

Method	deleteLprRosterEntry
Description	Deletes an existing LprRosterEntry.
Parameters	String	lprRosterEntryId	the identifier for the LprRosterEntry to be deleted
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StatusInfo		the status of the delete operation. This must always be true.
Errors	DoesNotExistException		lprRosterEntryId is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		lprRosterEntryId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	moveLprRosterEntryToPosition
Description	Inserts an existing roster entry at a particular position on the roster. If another roster entry already exists at that particular position within the roster then this method "bumps down" the rest of the roster entries until there is an open position.
Parameters	String	lprRosterEntryId	???
	Integer	position	the absolute position in the LprRoster
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StatusInfo		???
Errors	DoesNotExistException		lprRosterEntryId is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		lprRosterEntryId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	reorderLprRosterEntries
Description	Reorders all the LprRosterEntries setting their position to match the order within the specified list of LprRosterEntry Ids. This is a bulk method to reset the positions all of the entries in the LprRoster. Any entries in the LprRoster that arenot specified in the supplied list are ordered by their existing position and placed at the end of the LprRosterEntries in the specified list.
Parameters	String	lprRosterId	???
	StringList	lprRosterEntryIds	an ordered list of LprRosterEntries
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StatusInfo		???
Errors	DoesNotExistException		an lprRosterEntryId in the list is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		lprRosterEntryIds, an Id in lprRosterEntryIds, or conetxtInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations