LRCService

• getCreateFixedCreditResultValuesGroup
• getCreateRangeCreditResultValuesGroup
• getCreateMultipleCreditResultValuesGroup
• getCreateResultValueForScale
• getResultValuesGroup
• getResultValuesGroupsByKeys
• getResultValuesGroupsByResultValue
• getResultValuesGroupsByResultScale
• getResultValuesGroupKeysByType
• createResultValuesGroup
• updateResultValuesGroup
• deleteResultValuesGroup
• validateResultValuesGroup
• getResultValue
• getResultValuesByKeys
• getResultValueKeysByType
• getResultValuesForResultValuesGroup
• createResultValue
• updateResultValue
• deleteResultValue
• validateResultValue
• getResultScale
• getResultScalesByKeys
• getResultScaleKeysByType
• createResultScale
• updateResultScale
• deleteResultScale
• validateResultScale
• getResultValuesForScale
• getResultValueForScaleAndValue
• getResultValuesForResultValuesGroups
• getResultValuesGroupsByResultScaleType

• ResultValuesGroupInfo
• ResultValueInfo
• StatusInfo
• ValidationResultInfo
• ResultScaleInfo

Method	getCreateFixedCreditResultValuesGroup
Description	???
Parameters	String	creditValue	???
	String	scaleKey	???
	ContextInfo	contextInfo	???
Return	ResultValuesGroupInfo		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	getCreateRangeCreditResultValuesGroup
Description	???
Parameters	String	creditValueMin	???
	String	creditValueMax	???
	String	creditValueIncrement	???
	String	scaleKey	???
	ContextInfo	contextInfo	???
Return	ResultValuesGroupInfo		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	getCreateMultipleCreditResultValuesGroup
Description	???
Parameters	StringList	creditValues	???
	String	scaleKey	???
	ContextInfo	contextInfo	???
Return	ResultValuesGroupInfo		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	getCreateResultValueForScale
Description	???
Parameters	String	resultValue	???
	String	scaleKey	???
	ContextInfo	contextInfo	???
Return	ResultValueInfo		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	getResultValuesGroup
Description	Retrieves existing result values group by an identifier.
Parameters	String	resultValuesGroupKey	identifiers for resultValuesGroup to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultValuesGroupInfo		details of the results for these Ids
Errors	DoesNotExistException		resultValuesGroupKey not found
	InvalidParameterException		invalid resultValuesGroupKey
	MissingParameterException		invalid resultValuesGroupKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResultValuesGroupsByKeys
Description	Retrieves result values groups by a list of identifiers.
Parameters	StringList	resultValuesGroupKeys	identifiers for result values group
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultValuesGroupInfoList		result values group list
Errors	DoesNotExistException		resultValuesGroup not found
	InvalidParameterException		invalid resultValuesGroupKeys
	MissingParameterException		invalid resultValuesGroupKeys
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResultValuesGroupsByResultValue
Description	Retrieves a list of existing result values groups that a result value is tied to.
Parameters	String	resultValueKey	identifier for result value
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultValuesGroupInfoList		details of the results for these keys
Errors	DoesNotExistException		resultValue not found
	InvalidParameterException		invalid resultValueKey
	MissingParameterException		invalid resultValueKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResultValuesGroupsByResultScale
Description	Retrieves a list of existing result values groups that a result scale is tied to.
Parameters	String	resultScaleKey	identifier for result scale
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultValuesGroupInfoList		details of the results for these keys
Errors	DoesNotExistException		resultValue not found
	InvalidParameterException		invalid resultValueKey
	MissingParameterException		invalid resultValueKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResultValuesGroupKeysByType
Description	Retrieves a list of result group identifiers for a specified result values group type.
Parameters	String	resultValuesGroupTypeKey	identifier for the result group type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of result group identifiers
Errors	DoesNotExistException		resultValuesGroupTypeKey not found
	InvalidParameterException		invalid resultValuesGroupTypeKey
	MissingParameterException		missing resultValuesGroupTypeKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createResultValuesGroup
Description	Creates a new result Values Group.
Parameters	String	resultScaleKey	???
	String	resultValuesGroupTypeKey	???
	ResultValuesGroupInfo	resultValuesGroupInfo	information about the result values group being created
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultValuesGroupInfo		create result values group information
Errors	AlreadyExistsException		result values group already exists
	DataValidationErrorException		one or more values invalid for this operation
	InvalidParameterException		invalid resultValuesGroupInfo
	MissingParameterException		missing resultValuesGroupInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	updateResultValuesGroup
Description	Updates an existing result values group.
Parameters	String	resultValuesGroupKey	identifier of the result values group to update
	ResultValuesGroupInfo	gradeValuesGroupInfo	???
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultValuesGroupInfo		updated result values group information
Errors	DataValidationErrorException		one or more values invalid for this operation
	DoesNotExistException		resultValuesGroupKey not found
	InvalidParameterException		???
	MissingParameterException		missing resultValuesGroupKey or resultValuesGroupInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	VersionMismatchException		action was attempted on an out of date version

Back to Operations

Method	deleteResultValuesGroup
Description	Deletes an existing result values group.
Parameters	String	resultValuesGroupKey	identifier of the result values group to update
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation
Errors	DoesNotExistException		resultValuesGroupKey not found
	InvalidParameterException		invalid resultValuesGroupKey
	MissingParameterException		missing resultValuesGroupKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateResultValuesGroup
Description	Validates a result values group. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object.
Parameters	String	validationType	Identifier of the extent of validation
	ResultValuesGroupInfo	gradeValuesGroupInfo	Result values group to be validated
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		???
Errors	DoesNotExistException		resultValuesGroupInfo does not exist
	InvalidParameterException		validationType or resultValuesGroupInfo does not exist
	MissingParameterException		missing validationType, resultValuesGroupInfo
	OperationFailedException		unable to complete request

Back to Operations

Method	getResultValue
Description	Retrieves result value by its id.
Parameters	String	resultValueKey	identifier for the result
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultValueInfo		details about a result value
Errors	DoesNotExistException		the resultValueKey is not found
	InvalidParameterException		invalid resultValueKey
	MissingParameterException		missing parameter
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResultValuesByKeys
Description	Retrieves a list of result value objects for a list of identifiers.
Parameters	StringList	resultValueKeys	identifier for the result
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultValueInfoList		list of result group identifiers
Errors	DoesNotExistException		a resultValueKey from the list is not found
	InvalidParameterException		invalid resultValueKeys
	MissingParameterException		missing resultValueKeys
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResultValueKeysByType
Description	Retrieves a list of result values by type.
Parameters	String	resultValueTypeKey	identifier for the result group type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of result group identifiers
Errors	DoesNotExistException		resultValueTypeKey not found
	InvalidParameterException		invalid resultValueTypeKey
	MissingParameterException		missing resultValueTypeKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResultValuesForResultValuesGroup
Description	Retrieves a list of result value objects for a specified result values group. It is sorted by the scale inside the values group.
Parameters	String	resultValuesGroupKey	identifier for the result values group
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultValueInfoList		list of result group identifiers
Errors	DoesNotExistException		resultValueKey not found
	InvalidParameterException		invalid resultValuesGroupKey
	MissingParameterException		missing resultValuesGroupKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createResultValue
Description	Create a new result value
Parameters	String	resultScaleKey	scale to which this value is attached
	String	resultValueTypeKey	type of the result value to be created
	ResultValueInfo	resultValueInfo	info about the result value
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultValueInfo		newly created resultValue
Errors	AlreadyExistsException		resultValue already exists
	DataValidationErrorException		one or more values invalid for this operation
	DoesNotExistException		???
	InvalidParameterException		invalid resultValueInfo
	MissingParameterException		missing resultValueInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	updateResultValue
Description	Update a result value
Parameters	String	resultValueKey	resultValueKey to be updated
	ResultValueInfo	resultValueInfo	update information for the result value
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultValueInfo		updated information about the result value
Errors	DataValidationErrorException		one or more values invalid for this operation
	DoesNotExistException		resultValueKey does not exist
	InvalidParameterException		invalid resultValueKey, resultValueInfo
	MissingParameterException		missing resultValueKey, resultValueInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	VersionMismatchException		action was attempted on an out of date version

Back to Operations

Method	deleteResultValue
Description	Delete a result value. This should not be allowed if any result values group is still referencing the result value.
Parameters	String	resultValueKey	result value to be deleted
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the delete operation
Errors	DoesNotExistException		resultValueKey does not exist
	DependentObjectsExistException		if a group is tied to this value
	InvalidParameterException		invalid resultValueKey
	MissingParameterException		missing resultValueKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateResultValue
Description	Validates a Result Value. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained subobjects or expanded to perform all tests related to this object. If an identifier is present for the academic calendar and a record is found for that identifier, the validation checks if the academic calendar can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.
Parameters	String	validationType	Identifier of the extent of validation
	ResultValueInfo	resultValueInfo	Result value to be validated
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		a ValidationResultInfo
Errors	DoesNotExistException		resultValueInfo does not exist
	InvalidParameterException		validationType or resultValueInfo does not exist
	MissingParameterException		missing validationType or resultValueInfo
	OperationFailedException		unable to complete request

Back to Operations

Method	getResultScale
Description	Retrieves result scale by an identifier.
Parameters	String	resultScaleKey	identifiers for result scale to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultScaleInfo		details of the result scale for the id
Errors	DoesNotExistException		resultValuesGroupKey not found
	InvalidParameterException		invalid resultValuesGroupKey
	MissingParameterException		invalid resultValuesGroupKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResultScalesByKeys
Description	Retrieves result scales by a list of identifiers.
Parameters	StringList	resultScaleKeys	identifiers for result scale
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultScaleInfoList		result scale list
Errors	DoesNotExistException		resultScale not found
	InvalidParameterException		invalid resultScaleKeys
	MissingParameterException		invalid resultScaleKeys
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResultScaleKeysByType
Description	Retrieves a list of result group identifiers for a specified result scale type.
Parameters	String	resultScaleTypeKey	identifier for the result group type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of result group identifiers
Errors	DoesNotExistException		resultScaleTypeKey not found
	InvalidParameterException		invalid resultScaleTypeKey
	MissingParameterException		missing resultScaleTypeKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createResultScale
Description	Creates a new result scale.
Parameters	String	resultScaleTypeKey	type key of the result scale
	ResultScaleInfo	resultScaleInfo	information about the result scale being created
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultScaleInfo		create result scale information
Errors	AlreadyExistsException		result scale already exists
	DataValidationErrorException		one or more values invalid for this operation
	InvalidParameterException		invalid resultScaleInfo
	MissingParameterException		missing resultScaleInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	updateResultScale
Description	Updates an existing result scale.
Parameters	String	resultScaleKey	identifier of the result scale to update
	ResultScaleInfo	resultScaleInfo	???
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultScaleInfo		updated result scale information
Errors	DataValidationErrorException		one or more values invalid for this operation
	DoesNotExistException		resultScaleKey not found
	InvalidParameterException		???
	MissingParameterException		missing resultScaleKey or resultScaleInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	VersionMismatchException		action was attempted on an out of date version

Back to Operations

Method	deleteResultScale
Description	Deletes an existing result scale.
Parameters	String	resultScaleKey	identifier of the result scale to update
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation
Errors	DoesNotExistException		resultScaleKey not found
	DependentObjectsExistException		if a group or value exists for this scale
	InvalidParameterException		invalid resultScaleKey
	MissingParameterException		missing resultScaleKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateResultScale
Description	Validates a result scale. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object.
Parameters	String	validationType	Identifier of the extent of validation
	ResultScaleInfo	gradeScaleInfo	Result scale to be validated
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		???
Errors	DoesNotExistException		resultScaleInfo does not exist
	InvalidParameterException		validationType or resultScaleInfo does not exist
	MissingParameterException		missing validationType, resultScaleInfo
	OperationFailedException		unable to complete request

Back to Operations

Method	getResultValuesForScale
Description	Retrieves result values by result scale key.
Parameters	String	resultScaleKey	key to the scale
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultValueInfoList		a list of result values for the scale
Errors	DoesNotExistException		resultScaleKey is not found
	InvalidParameterException		invalid resultScaleKey
	MissingParameterException		null resultScaleKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResultValueForScaleAndValue
Description	Retrieves a result value by result scale key and value
Parameters	String	resultScaleKey	key to the scale
	String	value	the specific value
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultValueInfo		the matching Result Value
Errors	DoesNotExistException		resultScaleKey is not found
	InvalidParameterException		invalid resultScaleKey
	MissingParameterException		null resultScaleKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResultValuesForResultValuesGroups
Description	Retrieves result values for the list of Result values groups. No values are selected for groups that are RANGES.
Parameters	StringList	resultValuesGroupKeys	list of result value groups for which to return values
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultValueInfoList		a list of unique result values for that set of groups
Errors	DoesNotExistException		resultScaleKey is not found
	InvalidParameterException		invalid resultScaleKey
	MissingParameterException		null resultScaleKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResultValuesGroupsByResultScaleType
Description	Retrieves a list of existing result values groups that have a scale of the specified type.
Parameters	String	resultScaleTypeKey	identifier for result scale type key
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ResultValuesGroupInfoList		details of the results for these keys
Errors	DoesNotExistException		resultValue not found
	InvalidParameterException		invalid resultValueKey
	MissingParameterException		invalid resultValueKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations