LuiPersonRelationService

• getLpr
• getLprsByIds
• getLuiIdsByPersonAndTypeAndState
• getPersonIdsByLuiAndTypeAndState
• getLprsByPersonAndLui
• getLprIdsByPersonAndLui
• getLprsByPerson
• getLprIdsByPerson
• getLprsByLui
• getLprIdsByLui
• getLprsByLuiAndType
• getLprsByPersonForAtp
• getLprsByPersonAndTypeForAtp
• getLprsByPersonAndLuiType
• getLprsByPersonForAtpAndLuiType
• validateLpr
• searchForLprIds
• searchForLprs
• createLpr
• createBulkRelationshipsForPerson
• createBulkRelationshipsForLui
• updateLpr
• deleteLpr
• updateLprRoster
• createLprRoster
• deleteLprRoster
• getLprRosterEntriesForRoster
• getLprRosterEntriesByIds
• getLprRostersByLuiAndType
• getLprRostersByLui
• getLprRoster
• createLprRosterEntry
• updateLprRosterEntry
• deleteLprRosterEntry
• insertLprRosterEntryInPosition
• reorderLprRosterEntries
• createLprTransaction
• createLprTransactionFromExisting
• updateLprTransaction
• getLprTransaction
• getLprTransactionsWithItemsByPersonAndLui
• getLprTransactionIdsByStateWithItemsByPerson
• getLprTransactionsByIds
• getLprTransactionsWithItemsByResultingLpr
• getLprTransactionsWithItemsByLui
• getLprTransactionsByRequestingPersonAndAtp
• deleteLprTransaction
• validateLprTransaction
• processLprTransaction
• searchForLprTransactions
• searchForLprTransactionIds
• searchForLprRosters
• searchForLprRosterIds

• LuiPersonRelationInfo
• ValidationResultInfo
• QueryByCriteria
• StatusInfo
• LprRosterInfo
• LprRosterEntryInfo
• LprTransactionInfo

Method	getLpr
Description	Retrieves the Relation for the specified LUI Person Relation id
Parameters	String	luiPersonRelationId	Identifier for the LUI Person Relation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiPersonRelationInfo		LUI Person Relation information
Errors	DoesNotExistException		luiPersonRelationId not found
	InvalidParameterException		invalid luiPersonRelationId
	MissingParameterException		missing luiPersonRelationId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLprsByIds
Description	Retrieves the Relation for the specified list of LUI Person Relation Ids
Parameters	StringList	luiPersonRelationIds	List of identifiers for LUI Person Relations
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiPersonRelationInfoList		List of LUI Person Relation information
Errors	DoesNotExistException		One or more luiPersonRelationIds not found
	InvalidParameterException		One or more invalid luiPersonRelationIds
	MissingParameterException		missing luiPersonRelationIds
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLuiIdsByPersonAndTypeAndState
Description	Retrieves the LUI Ids for Person, type and state. This would allow you to get all the active (state) courses (type=registration) for a student.
Parameters	String	personId	Identifier for the Person
	String	luiPersonRelationTypeKey	Type of LUI Person Relation
	String	relationState	Relation State
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		Simple list of LUI Ids
Errors	DoesNotExistException		personId, luiPersonRelationTypeKey, relationState, person to LUI relationship not found
	DisabledIdentifierException		personId found, but has been retired
	InvalidParameterException		invalid personId, luiPersonRelationTypeKey, relationState
	MissingParameterException		missing personId, luiPersonRelationTypeKey, relationState
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getPersonIdsByLuiAndTypeAndState
Description	Retrieves Person Ids related to the specified LUI, type and state This would allow you to get a list of people who are active (state) students (type=registration) for a particular course (luiId)
Parameters	String	luiId	Identifier for the LUI
	String	luiPersonRelationTypeKey	Type of LUI Person Relation
	String	relationState	Relation State
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		Simple list of Person Ids
Errors	DoesNotExistException		luiId, luiPersonRelationTypeKey, relationState, LUI to person relationship not found
	InvalidParameterException		invalid luiId, luiPersonRelationTypeKey, relationState
	MissingParameterException		missing luiId, luiPersonRelationTypeKey, relationState
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLprsByPersonAndLui
Description	Retrieves Person Relation for LUI
Parameters	String	personId	Identifier for person
	String	luiId	Identifier for LUI
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiPersonRelationInfoList		List of LUI Person Relation info
Errors	DoesNotExistException		personId, luiId not found
	DisabledIdentifierException		personId found, but has been retired
	InvalidParameterException		invalid personId, luiId
	MissingParameterException		missing personId, luiId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLprIdsByPersonAndLui
Description	Retrieves LUI Person Relation Ids for a person and LuiId Can be used to get course registrations for a person in a particular course. Although this would typically only return one registration for each set of values, but if a person adds a course then drops it then adds it again you could get multiple registrations.
Parameters	String	personId	Identifier for person
	String	luiId	Identifier for LUI
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		List of LUI Person Relation display info
Errors	DoesNotExistException		personId, luiId not found
	DisabledIdentifierException		personId found, but has been retired
	InvalidParameterException		invalid personId, luiId
	MissingParameterException		missing personId, luiId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLprsByPerson
Description	Retrieves LUI Person Relations for Person Can be used to get all the course registrations for a person for as long as they have been at the school, but please note it could include student registrations in things that are not courses OR student's acting as teaching assistants to courses.
Parameters	String	personId	Identifier for person
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiPersonRelationInfoList		List of LUI Person Relation info
Errors	DoesNotExistException		personId not found
	DisabledIdentifierException		personId found, but has been retired
	InvalidParameterException		invalid personId
	MissingParameterException		missing personId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLprIdsByPerson
Description	Retrieves LUI Person Relation Ids for a Person
Parameters	String	personId	Identifier for person
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		Simple list of person relation identifiers
Errors	DoesNotExistException		personId not found
	DisabledIdentifierException		personId found, but has been retired
	InvalidParameterException		invalid personId
	MissingParameterException		missing personId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLprsByLui
Description	Retrieves LUI Person Relation for a specified LUI Can be used to get all the people and their relationship to a particular course offering.
Parameters	String	luiId	Identifier for LUI
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiPersonRelationInfoList		List of LUI Person Relation info
Errors	DoesNotExistException		luiId not found
	InvalidParameterException		invalid luiId
	MissingParameterException		missing luiId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLprIdsByLui
Description	Retrieves LUIPersonRelation Ids for LUI Can be used to get all the people and their relationship to a particular course offering.
Parameters	String	luiId	Identifier for LUI
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		Simple list of LUI Person Relation identifiers
Errors	DoesNotExistException		luiId not found
	InvalidParameterException		invalid luiId
	MissingParameterException		missing luiId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLprsByLuiAndType
Description	Retrieves LUI Person Relation for a particular type and specified LUI Can be used to get all the people with a particular relationship to a specified course offering.
Parameters	String	luiId	???
	String	typeKey	???
	ContextInfo	context	???
Return	LuiPersonRelationInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	getLprsByPersonForAtp
Description	Retrieves a list of LPRs by person and ATP Can be used to get a list of registrations or instructor assignments for a person and a term Note: the ATP is not stored on the LPR but on the Lui so the ATP specified is used to select or filter the Lui ids that can appear on the LPRs that are returned.
Parameters	String	personId	???
	String	atpId	???
	ContextInfo	context	???
Return	LuiPersonRelationInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	getLprsByPersonAndTypeForAtp
Description	Retrieves a list of LPRs for a person and particular ATP by the type of LPR. Can be used to get a list of registrations for a person and a person but making sure to exclude other types of relations the student may have during that term such as also being an teaching assistant for a course.
Parameters	String	personId	???
	String	atpId	???
	String	typeKey	???
	ContextInfo	context	???
Return	LuiPersonRelationInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	getLprsByPersonAndLuiType
Description	Gets the LPRs for a person and the type Lui. Can be used to get a list of all the relations a person may have to a course offering (which is a lui type).
Parameters	String	personId	person identifier
	String	luiTypeKey	type of the LUI
	ContextInfo	context	???
Return	LuiPersonRelationInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	getLprsByPersonForAtpAndLuiType
Description	Gets the the LPRs for a person and atp and Lui type. Can be used to get the relations a person may have to a course offering (which is a lui type) and a particular term (atpId)
Parameters	String	personId	???
	String	atpId	???
	String	luiTypeKey	???
	ContextInfo	context	???
Return	LuiPersonRelationInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	validateLpr
Description	Validates the particular relation in a state for a Person and LUI
Parameters	String	validationType	Identifier of the extent of validation
	LuiPersonRelationInfo	luiPersonRelationInfo	LuiPersonRelation to be validated
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		list of validation results, list should be be zero length if no validation rsults are generated
Errors	DoesNotExistException		luiPersonRelationInfo not found
	InvalidParameterException		invalid luiPersonRelationInfo relationState
	MissingParameterException		missing luiPersonRelationInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForLprIds
Description	Retrieves detail of LUI Person Relation Ids
Parameters	QueryByCriteria	criteria	Criteria to be used for retrieval of multiple LUI Person Relation identifiers
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		Simple list of LUI Person Relation identifiers
Errors	InvalidParameterException		invalid relation criteria
	MissingParameterException		missing relation criteria
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForLprs
Description	Retrieves detail of LUI Person Relation by search criteria
Parameters	QueryByCriteria	criteria	Criteria to be used for retrieval of multiple LUI Person Relation identifiers
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiPersonRelationInfoList		Simple list of LUI Person Relation identifiers
Errors	InvalidParameterException		invalid relation criteria
	MissingParameterException		missing relation criteria
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createLpr
Description	Creates relation between the specified Person and LUI
Parameters	String	personId	Person Identifier
	String	luiId	LUI Identifier
	String	luiPersonRelationTypeKey	Type of LUI to Person Relation
	LuiPersonRelationInfo	luiPersonRelationInfo	Information required to create the LUI Person relation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	String		Structure containing LUI Person relation identifiers
Errors	DataValidationErrorException		if luiPeronsRelationInfo is not valid
	AlreadyExistsException		relation already exists
	DoesNotExistException		personId, luiId, relationState, luiPersonRelationTypeKey does not exist
	DisabledIdentifierException		personId found, but has been retired
	ReadOnlyException		attempt to update a read only attribute
	InvalidParameterException		invalid personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo
	MissingParameterException		missing personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createBulkRelationshipsForPerson
Description	Creates bulk relationships for one specified person. This is an all or nothing transaction - any error will invalidate the entire transaction.
Parameters	String	personId	Identifier for Person
	StringList	luiIds	Simple list of LUI identifiers
	String	relationState	Relation state
	String	luiPersonRelationTypeKey	Type of LUI Person relation
	LuiPersonRelationInfo	luiPersonRelationInfo	Information required to create the LUI Person relation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		Structure containing LUI Person relation identifiers
Errors	DataValidationErrorException		if luiPeronsRelationInfo is not valid
	AlreadyExistsException		relation already exists
	DoesNotExistException		personId, luiId, relationState, luiPersonRelationTypeKey does not exist
	DisabledIdentifierException		personId found, but has been retired
	ReadOnlyException		attempt to update a read only attribute
	InvalidParameterException		invalid personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo
	MissingParameterException		missing personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createBulkRelationshipsForLui
Description	Creates bulk relationships for one specified LUI. This is an all or nothing transaction - any error will invalidate the entire transaction.
Parameters	String	luiId	Identifier for Lui
	StringList	personIds	Simple list of Person identifiers
	String	relationState	Relation state
	String	luiPersonRelationTypeKey	Type of LUI Person relation
	LuiPersonRelationInfo	luiPersonRelationInfo	Information required to create the LUI Person relation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		Structure containing LUI Person relation identifiers
Errors	AlreadyExistsException		relation already exists
	DataValidationErrorException		errors validating luiPersonRelationInfo with all data filled in
	DoesNotExistException		personId, luiId, relationState, luiPersonRelationTypeKey does not exist
	DisabledIdentifierException		personId found, but has been retired
	ReadOnlyException		attempt to update a read only attribute
	InvalidParameterException		invalid personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo
	MissingParameterException		missing personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	updateLpr
Description	Update relation between Person and LUI
Parameters	String	luiPersonRelationId	Identifier for the LUI Person Relation
	LuiPersonRelationInfo	luiPersonRelationInfo	Changed information about the LUI Person Relation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiPersonRelationInfo		Updated information about the LUI Person Relation
Errors	DoesNotExistException		luiPersonRelationId does not exist
	DataValidationErrorException		if luiPersonRelationInfo is not valid
	InvalidParameterException		invalid luiPersonRelationId, luiPersonRelationInfo
	MissingParameterException		missing luiPersonRelationId, luiPersonRelationInfo
	ReadOnlyException		attempt to update a read only attribute
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	VersionMismatchException		if optimistic lock version ind has changed

Back to Operations

Method	deleteLpr
Description	Deletes relation between the specified Person and LUI
Parameters	String	luiPersonRelationId	Identifier for the LUI Person Relation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		luiPersonRelationId does not exist
	InvalidParameterException		invalid luiPersonRelationId
	MissingParameterException		missing luiPersonRelationId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	updateLprRoster
Description	Update relation between Person and LUI
Parameters	String	lprRosterId	Identifier for the LUI Person Relation
	LprRosterInfo	lprRosterInfo	Changed information about the LUI Person Relation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LprRosterInfo		Updated information about the LUI Person Relation
Errors	DoesNotExistException		luiPersonRelationId does not exist
	DataValidationErrorException		if luiPersonRelationInfo is not valid
	InvalidParameterException		invalid luiPersonRelationId, luiPersonRelationInfo
	MissingParameterException		missing luiPersonRelationId, luiPersonRelationInfo
	ReadOnlyException		attempt to update a read only attribute
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	VersionMismatchException		if optimistic lock version ind has changed

Back to Operations

Method	createLprRoster
Description	Creates a roster
Parameters	LprRosterInfo	lprRosterInfo	Information required to create the LUI Person relation roster
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	String		Structure containing LUI Person relation identifiers
Errors	DataValidationErrorException		if luiPeronsRelationInfo is not valid
	AlreadyExistsException		relation already exists
	DoesNotExistException		personId, luiId, relationState, luiPersonRelationTypeKey does not exist
	DisabledIdentifierException		personId found, but has been retired
	ReadOnlyException		attempt to update a read only attribute
	InvalidParameterException		invalid personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo
	MissingParameterException		missing personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	deleteLprRoster
Description	Deletes the LPRRoster
Parameters	String	lprRosterId	Identifier for the LUI Person Relation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		lprRosterId does not exist
	InvalidParameterException		invalid lprRosterId
	MissingParameterException		missing lprRosterId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLprRosterEntriesForRoster
Description	This method returns all the LPR roster entries contained in the LPR Roster.
Parameters	String	lprRosterId	Identifier of LPR Roster
	ContextInfo	context	???
Return	LprRosterEntryInfoList		???
Errors	DoesNotExistException		lprRosterId does not exist
	InvalidParameterException		invalid lprRosterId
	MissingParameterException		missing lprRosterId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLprRosterEntriesByIds
Description	Retrieves the LPR Roster Entries for the specified list of LPR Roster Entry Ids
Parameters	StringList	lprRosterEntryIds	List of identifiers for LPR Roster Entries
	ContextInfo	context	???
Return	LprRosterEntryInfoList		List of LPR Roster Entry information
Errors	DoesNotExistException		One or more lprRosterEntryIds not found
	InvalidParameterException		One or more invalid lprRosterEntryIds
	MissingParameterException		missing lprRosterEntryIds
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLprRostersByLuiAndType
Description	This method returns a list of Lpr Rosters by LUI and Type. Can be used to get the waitlist (type) roster for a particular course offering (lui).
Parameters	String	luiId	LUI Identifier
	String	lprRosterTypeKey	LPR Roster Key
	ContextInfo	context	???
Return	LprRosterInfoList		???
Errors	DoesNotExistException		luiId or lprRosterTypeKey invalid
	InvalidParameterException		Invalid luiId or lprRosterTypeKey
	MissingParameterException		Missing luiId or lprRosterTypeKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLprRostersByLui
Description	Retrieve all LPR Rosters that are associated with a LUI. Can be used to get all the rosters, waitlists, hold until lists, grade sheets, etc for a particular course offering.
Parameters	String	luiId	LUI Identifier
	ContextInfo	context	???
Return	LprRosterInfoList		???
Errors	DoesNotExistException		luiId invalid
	InvalidParameterException		Invalid luiId
	MissingParameterException		Missing luiId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLprRoster
Description	This method returns a LPR Roster by it's id.
Parameters	String	lprRosterId	LPR Roster identifier
	ContextInfo	context	???
Return	LprRosterInfo		???
Errors	DoesNotExistException		lprRosterId invalid
	InvalidParameterException		Invalid lprRosterEntryInfo
	MissingParameterException		Missing lprRosterEntryInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createLprRosterEntry
Description	Creates an Lpr Roster Entry at the position specified by the value of the relative position field inside the roster info. An empty position would mean add to the last position, a specified position means insert to that position.
Parameters	LprRosterEntryInfo	lprRosterEntryInfo	???
	ContextInfo	context	???
Return	String		???
Errors	DataValidationErrorException		lprRosterEntryInfo data is not valid
	AlreadyExistsException		???
	InvalidParameterException		Invalid lprRosterEntryInfo
	MissingParameterException		Missing lprRosterEntryInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	updateLprRosterEntry
Description	Update The roster entry
Parameters	String	lprRosterEntryId	Identifier for the roster entry
	LprRosterEntryInfo	lprRosterEntryInfo	Changed information about the roster entry
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LprRosterInfo		Updated information about the roster entry
Errors	DoesNotExistException		luiPersonRelationId does not exist
	DataValidationErrorException		if lprRosterEntryInfo is not valid
	InvalidParameterException		invalid luiPersonRelationId, luiPersonRelationInfo
	MissingParameterException		missing luiPersonRelationId, luiPersonRelationInfo
	ReadOnlyException		attempt to update a read only attribute
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	VersionMismatchException		if optimistic lock version ind has changed

Back to Operations

Method	deleteLprRosterEntry
Description	Delete the Lpr Roster Entry
Parameters	String	lprRosterEntryId	???
	ContextInfo	context	???
Return	StatusInfo		???
Errors	DoesNotExistException		not a valid lprRosterEntryId
	InvalidParameterException		Invalid lprRosterEntryId
	MissingParameterException		Missing lprRosterEntryId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	insertLprRosterEntryInPosition
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	absolutePosition	the position the person would be in if they
	ContextInfo	context	???
Return	StatusInfo		???
Errors	DoesNotExistException		One of the roster entry id in the list is not a valid id
	InvalidParameterException		Invalid lprRosterEntryIds
	MissingParameterException		Missing lprRosterEntryIds in the input
	OperationFailedException		unable to complete request

Back to Operations

Method	reorderLprRosterEntries
Description	Reorders all the roster entries setting their position to match the order within the specified list of LPR roster entry ids. This is a bulk method to reset the positions all of the entries in the roster. Any entries in the roster that are not contained in the list are ordered by their existing position and placed at the end of the entries in the specified list.
Parameters	StringList	lprRosterEntryIds	ordered list of LPR roster entry Ids
	ContextInfo	context	???
Return	StatusInfo		???
Errors	DoesNotExistException		One of the roster entry id in the list is not a valid roster entry id
	InvalidParameterException		Invalid lprRosterEntryIds
	MissingParameterException		Missing lprRosterEntryIds in the input
	OperationFailedException		unable to complete request
	PermissionDeniedException		???

Back to Operations

Method	createLprTransaction
Description	This method creates a LPR transaction of the specified type Validates the transaction generates a unique id for the request and persists it in the back-end. TODO: Add requesting person Id and ATP id to these signature
Parameters	String	lprTransactionType	LPR transaction type
	LprTransactionInfo	lprTransactionInfo	LPR transaction info
	ContextInfo	context	???
Return	LprTransactionInfo		???
Errors	DataValidationErrorException		if LprTransactionInfo fields are not valid
	AlreadyExistsException		LprTransactionInfo / LPR already exists
	InvalidParameterException		Invalid lprTransactionType, lprTransaction
	MissingParameterException		Missing fields on LprTransactionInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createLprTransactionFromExisting
Description	Creates a new Lpr Transaction from an existing LPR transaction Copies the transaction's Items as well. The new transaction has the same type as the existing transaction. Since transactions can only be processed once this method was intended to allow the application to easily create a new transaction with all of it's items that the user be able to fix and update any problems that resulted from processing the existing transaction.
Parameters	String	lprTransactionId	LprTransaction identifier
	ContextInfo	context	???
Return	LprTransactionInfo		???
Errors	DoesNotExistException		lprTransactionId doesn't exist
	InvalidParameterException		Invalid lprTransactionId
	MissingParameterException		Missing lprTransactionId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	updateLprTransaction
Description	This method updates an LPR Transaction and all of it's items.
Parameters	String	lprTransactionId	The transaction identifier
	LprTransactionInfo	lprTransactionInfo	The updated Lpr Transaction
	ContextInfo	context	???
Return	LprTransactionInfo		???
Errors	DataValidationErrorException		LprTransactionInfo is not valid
	DoesNotExistException		lprTransactionId doesn't exist
	InvalidParameterException		Invalid lprTransactionId or lprTransactionInfo
	MissingParameterException		Missing lprTransactionId or lprTransactionInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLprTransaction
Description	Retrieves the LPR Transactions based on it's identifier.
Parameters	String	lprTransactionId	The transaction identifier
	ContextInfo	context	???
Return	LprTransactionInfo		???
Errors	DoesNotExistException		lprTransactionId doesn't exist
	InvalidParameterException		Invalid lprTransactionId
	MissingParameterException		Missing lprTransactionId
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Authorization failure

Back to Operations

Method	getLprTransactionsWithItemsByPersonAndLui
Description	Retrieves LPR Transactions with an item by Person and LUI Selects all transactions that have at least one item that matches the specified person and either the existing or new lui. Note: this matches the person on the item not the person requesting the transaction which is on the transaction. TODO: Think about recasting this to return Transaction Items instead, that is what we really want here and if we have to track back to the Transaction then put the transaction id on the item so that can be done.
Parameters	String	personId	The person identifier
	String	luiId	The LUI id
	ContextInfo	context	???
Return	LprTransactionInfoList		???
Errors	DoesNotExistException		personId or luiId doesn't exist
	InvalidParameterException		Invalid personId or luiId
	MissingParameterException		Missing personId or luiId
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Authorization failure

Back to Operations

Method	getLprTransactionIdsByStateWithItemsByPerson
Description	Retrieves LPR Transactions with an item by Person and transaction states Note: this matches the person on the item not the person requesting the transaction which is on the transaction. TODO: Think about recasting this to return Transaction Items instead, that is what we really want here and if we have to track back to the Transaction then put the transaction id on the item so that can be done.
Parameters	String	personId	The person identifier
	StringList	lprTransactionStates	???
	ContextInfo	context	???
Return	StringList		???
Errors	DoesNotExistException		personId doesn't exist
	InvalidParameterException		Invalid personId
	MissingParameterException		Missing personId
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Authorization failure

Back to Operations

Method	getLprTransactionsByIds
Description	Get lpr transactions for the specified list of ids.
Parameters	StringList	lprIds	???
	ContextInfo	context	???
Return	LprTransactionInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	getLprTransactionsWithItemsByResultingLpr
Description	Retrieves LPR Transactions based on the resulting LPR. Selects all transactions that have at least one item who's resulting lpr matches the specified lpr. TODO: Think about recasting this to return Transaction Items instead, that is what we really want here and if we have to track back to the Transaction then put the transaction id on the item so that can be done.
Parameters	String	lprId	The resulting lpr
	ContextInfo	context	???
Return	LprTransactionInfoList		???
Errors	DoesNotExistException		personId doesn't exist
	InvalidParameterException		Invalid personId
	MissingParameterException		Missing personId
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Authorization failure

Back to Operations

Method	getLprTransactionsWithItemsByLui
Description	Retrieves LPR Transactions based on an item with the specified LUI. Selects all transactions that have at least one item with the specified LUI. TODO: Think about recasting this to return Transaction Items instead, that is what we really want here and if we have to track back to the Transaction then put the transaction id on the item so that can be done.
Parameters	String	luiId	The LUI identifier
	ContextInfo	context	???
Return	LprTransactionInfoList		???
Errors	DoesNotExistException		personId doesn't exist
	InvalidParameterException		Invalid personId
	MissingParameterException		Missing personId
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Authorization failure

Back to Operations

Method	getLprTransactionsByRequestingPersonAndAtp
Description	Retrieves transactions for the requesting person and the ATP. TODO: This method originally also additionally filtered on transaction state but other evidence had it by lpr type consider adding back in so I took it out. Perhaps it should be added back in.
Parameters	String	requestingPersonId	The person identifier
	String	atpId	The ATP Id
	ContextInfo	context	???
Return	LprTransactionInfoList		???
Errors	DoesNotExistException		atpId or personId doesn't exist
	InvalidParameterException		Invalid personId or atpId
	MissingParameterException		Missing personId or atpId
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Authorization failure

Back to Operations

Method	deleteLprTransaction
Description	Deletes an lpr Transaction based on Id.
Parameters	String	lprTransactionId	LPR Transaction identifier
	ContextInfo	context	???
Return	StatusInfo		???
Errors	DoesNotExistException		lprTransactionId doesn't exist
	InvalidParameterException		Invalid lprTransactionId
	MissingParameterException		Missing lprTransactionId
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Authorization failure

Back to Operations

Method	validateLprTransaction
Description	Validate the LPR Transaction
Parameters	String	lprTransactionId	???
	ContextInfo	context	???
Return	ValidationResultInfoList		???
Errors	DoesNotExistException		lprTransactionId doesn't exist
	InvalidParameterException		Invalid lprTransactionId
	MissingParameterException		Missing lprTransactionId
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Authorization failure

Back to Operations

Method	processLprTransaction
Description	Submits a LPR transaction - validates the input and based on the type of transaction creates, updates, cancels or removes LPRs.
Parameters	String	lprTransactionId	the id for the LPR transaction
	ContextInfo	context	???
Return	LprTransactionInfo		???
Errors	AlreadyExistsException		LPR is already present
	DoesNotExistException		lprTransactionId doesn't exist
	InvalidParameterException		Invalid lprTransactionId
	MissingParameterException		Missing lprTransactionId
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Authorization failure

Back to Operations

Method	searchForLprTransactions
Description	search for matching LPR transactions
Parameters	QueryByCriteria	criteria	???
	ContextInfo	context	???
Return	LprTransactionInfoList		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	searchForLprTransactionIds
Description	Search for matching LPR transactions returning their ids
Parameters	QueryByCriteria	criteria	???
	ContextInfo	context	???
Return	StringList		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	searchForLprRosters
Description	Search for matching LPR rosters
Parameters	QueryByCriteria	criteria	???
	ContextInfo	context	???
Return	LprRosterInfoList		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	searchForLprRosterIds
Description	Search for matching LPR rosters returning the ids
Parameters	QueryByCriteria	criteria	???
	ContextInfo	context	???
Return	StringList		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations