| Name | Lu | |
|---|---|---|
| Version | ||
| Included Services | VersionManagementService, SearchService, DictionaryService | |
| Method | getDeliveryMethodTypes | ||
|---|---|---|---|
| Description | Retrieves the list of delivery method types | ||
| Parameters | None | None | No Parameters |
| Return | DeliveryMethodTypeInfoList | list of delivery method type information | |
| Errors | OperationFailedException | unable to complete request | |
| Method | getDeliveryMethodType | ||
|---|---|---|---|
| Description | Retrieves information about a delivery method type | ||
| Parameters | String | deliveryMethodTypeKey | Key of the Delivery Method Type |
| Return | DeliveryMethodTypeInfo | information about a Delivery Method Type | |
| Errors | DoesNotExistException | deliveryMethodType not found | |
| InvalidParameterException | invalid deliveryMethodType | ||
| MissingParameterException | missing deliveryMethodType | ||
| OperationFailedException | unable to complete request | ||
| Method | getInstructionalFormatTypes | ||
|---|---|---|---|
| Description | Retrieves the list of instructional format types | ||
| Parameters | None | None | No Parameters |
| Return | InstructionalFormatTypeInfoList | list of instructional format type information | |
| Errors | OperationFailedException | unable to complete request | |
| Method | getInstructionalFormatType | ||
|---|---|---|---|
| Description | Retrieves information about a Instructional Format Type | ||
| Parameters | String | instructionalFormatTypeKey | Key of the Instructional Format Type |
| Return | InstructionalFormatTypeInfo | information about a Instructional Format Type | |
| Errors | DoesNotExistException | instructionalFormatType not found | |
| InvalidParameterException | invalid instructionalFormatType | ||
| MissingParameterException | missing instructionalFormatType | ||
| OperationFailedException | unable to complete request | ||
| Method | getLuTypes | ||
|---|---|---|---|
| Description | Retrieves the list of LU types | ||
| Parameters | None | None | No Parameters |
| Return | LuTypeInfoList | list of LU type information | |
| Errors | OperationFailedException | unable to complete request | |
| Method | getLuType | ||
|---|---|---|---|
| Description | Retrieves information about a LU Type | ||
| Parameters | String | luTypeKey | Key of the LU Type |
| Return | LuTypeInfo | information about a LU Type | |
| Errors | DoesNotExistException | luType not found | |
| InvalidParameterException | invalid luType | ||
| MissingParameterException | missing luType | ||
| OperationFailedException | unable to complete request | ||
| Method | getLuCodeTypes | ||
|---|---|---|---|
| Description | Retrieves the list of learning unit code types | ||
| Parameters | None | None | No Parameters |
| Return | LuCodeTypeInfoList | list of lu code type information | |
| Errors | OperationFailedException | unable to complete request | |
| Method | getLuCodeType | ||
|---|---|---|---|
| Description | Retrieves information about a learning unit code type | ||
| Parameters | String | luCodeTypeKey | Key of the learning unit code type |
| Return | LuCodeTypeInfo | information about a learning unit code type | |
| Errors | DoesNotExistException | luCodeTypeKey not found | |
| InvalidParameterException | invalid luCodeTypeKey | ||
| MissingParameterException | missing luCodeTypeKey | ||
| OperationFailedException | unable to complete request | ||
| Method | getLuLuRelationTypes | ||
|---|---|---|---|
| Description | Retrieves the complete list of LU to LU relation types | ||
| Parameters | None | None | No Parameters |
| Return | LuLuRelationTypeInfoList | list of LU to LU relation type information | |
| Errors | OperationFailedException | unable to complete request | |
| Method | getLuLuRelationType | ||
|---|---|---|---|
| Description | Retrieves the LU to LU relation type | ||
| Parameters | String | luLuRelationTypeKey | Key of the LU to LU Relation Type |
| Return | LuLuRelationTypeInfo | LU to LU relation type information | |
| Errors | OperationFailedException | unable to complete request | |
| MissingParameterException | missing luLuRelationTypeKey | ||
| DoesNotExistException | luLuRelationTypeKey not found | ||
| Method | getAllowedLuLuRelationTypesForLuType | ||
|---|---|---|---|
| Description | Retrieves the list of allowed relation types between the two specified LU Types | ||
| Parameters | String | luTypeKey | Key of the first LU Type |
| String | relatedLuTypeKey | Key of the second LU Type | |
| Return | StringList | list of LU to LU relation types | |
| Errors | DoesNotExistException | luTypeKey, relatedLuTypeKey not found | |
| InvalidParameterException | invalid luTypeKey, relatedLuTypeKey | ||
| MissingParameterException | missing luTypeKey, relatedLuTypeKey | ||
| OperationFailedException | unable to complete request | ||
| Method | getLuPublicationTypes | ||
|---|---|---|---|
| Description | Retrieves the list of Learning Unit publication types | ||
| Parameters | None | None | No Parameters |
| Return | LuPublicationTypeInfoList | list of Learning Unit publication type information | |
| Errors | OperationFailedException | unable to complete request | |
| Method | getLuPublicationType | ||
|---|---|---|---|
| Description | Retrieves information about a publication type | ||
| Parameters | String | luPublicationTypeKey | Key of the Learning Unit Publication Type |
| Return | LuPublicationTypeInfo | information about a Learning Unit Publication Type | |
| Errors | DoesNotExistException | luPublicationType not found | |
| InvalidParameterException | invalid luPublicationType | ||
| MissingParameterException | missing luPublicationType | ||
| OperationFailedException | unable to complete request | ||
| Method | getLuPublicationTypesForLuType | ||
|---|---|---|---|
| Description | Retrieves information about a publication type | ||
| Parameters | String | luTypeKey | Key of the LU Type |
| Return | StringList | list of LU publication types | |
| Errors | DoesNotExistException | luPublicationType not found | |
| InvalidParameterException | invalid luPublicationType | ||
| MissingParameterException | missing luPublicationType | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluResultTypes | ||
|---|---|---|---|
| Description | Retrieves a list of types for clu result objects. | ||
| Parameters | None | None | No Parameters |
| Return | CluResultTypeInfoList | list of clu result type information | |
| Errors | OperationFailedException | unable to complete request | |
| Method | getCluResultType | ||
|---|---|---|---|
| Description | Retrieves information about a publication type | ||
| Parameters | String | cluResultTypeKey | Key of the Canonical Learning Unit Result Type |
| Return | CluResultTypeInfo | information about a Learning Unit Publication Type | |
| Errors | DoesNotExistException | luPublicationType not found | |
| InvalidParameterException | invalid luPublicationType | ||
| MissingParameterException | missing luPublicationType | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluResultTypesForLuType | ||
|---|---|---|---|
| Description | Retrieves the list of clu result types which are allowed to be used in conjunction with a particular lu type. | ||
| Parameters | String | luTypeKey | luTypeKey |
| Return | CluResultTypeInfoList | list of clu result types | |
| Errors | DoesNotExistException | luTypeKey not found | |
| InvalidParameterException | invalid luTypeKey | ||
| MissingParameterException | missing luTypeKey | ||
| OperationFailedException | unable to complete request | ||
| Method | getResultUsageTypes | ||
|---|---|---|---|
| Description | Retrieves a list of result usage types | ||
| Parameters | None | None | No Parameters |
| Return | ResultUsageTypeInfoList | list of result usage type information | |
| Errors | OperationFailedException | unable to complete request | |
| Method | getResultUsageType | ||
|---|---|---|---|
| Description | Retrieves information about a Result Usage Type | ||
| Parameters | String | resultUsageTypeKey | Key of the Result Usage Type |
| Return | ResultUsageTypeInfo | information about a Result Usage Type | |
| Errors | DoesNotExistException | resultUsageTypeKey not found | |
| InvalidParameterException | invalid resultUsageTypeKey | ||
| MissingParameterException | missing resultUsageTypeKey | ||
| OperationFailedException | unable to complete request | ||
| Method | getAllowedResultUsageTypesForLuType | ||
|---|---|---|---|
| Description | Retrieves the list of result usage types which are allowed to be used in conjunction with an lu type. | ||
| Parameters | String | luTypeKey | luTypeKey |
| Return | StringList | list of result usage types | |
| Errors | DoesNotExistException | luTypeKey not found | |
| InvalidParameterException | invalid luTypeKey | ||
| MissingParameterException | missing luTypeKey | ||
| OperationFailedException | unable to complete request | ||
| Method | getAllowedResultComponentTypesForResultUsageType | ||
|---|---|---|---|
| Description | Retrieves the list of result component types which are allowed to be used in conjunction with result usage type. | ||
| Parameters | String | resultUsageTypeKey | resultUsageTypeKey |
| Return | StringList | list of result component types | |
| Errors | DoesNotExistException | resultUsageTypeKey not found | |
| InvalidParameterException | invalid resultUsageTypeKey | ||
| MissingParameterException | missing resultUsageTypeKey | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluLoRelationTypes | ||
|---|---|---|---|
| Description | Retrieves the complete list of CLU to LO relation types | ||
| Parameters | None | None | No Parameters |
| Return | CluLoRelationTypeInfoList | list of CLU to LO relation type information | |
| Errors | OperationFailedException | unable to complete request | |
| Method | getCluLoRelationType | ||
|---|---|---|---|
| Description | Retrieves information for a specified CLU to LO relation type | ||
| Parameters | String | cluLoRelationTypeKey | Key of the CLU to LO Relation Type |
| Return | CluLoRelationTypeInfo | CLU to LO relation type information | |
| Errors | DoesNotExistException | cluLoRelationTypeKey not found | |
| InvalidParameterException | invalid cluLoRelationTypeKey | ||
| MissingParameterException | missing cluLoRelationTypeKey | ||
| OperationFailedException | unable to complete request | ||
| Method | getAllowedCluLoRelationTypesForLuType | ||
|---|---|---|---|
| Description | Retrieves the list of CLU LO relation types which are allowed to be used in conjunction with an lu type. | ||
| Parameters | String | luTypeKey | luTypeKey |
| Return | StringList | list of clu lo relation types | |
| Errors | DoesNotExistException | luTypeKey not found | |
| InvalidParameterException | invalid luTypeKey | ||
| MissingParameterException | missing luTypeKey | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluSetTypes | ||
|---|---|---|---|
| Description | Retrieves the list of CLU set types known by the service | ||
| Parameters | None | None | No Parameters |
| Return | CluSetTypeInfoList | list of CLU set type information | |
| Errors | OperationFailedException | unable to complete request | |
| Method | getCluSetType | ||
|---|---|---|---|
| Description | Retrieves information about a specified CLU set type | ||
| Parameters | String | cluSetTypeKey | Key of the CLU set type |
| Return | CluSetTypeInfo | information about a CLU set type | |
| Errors | DoesNotExistException | cluSetTypeKey not found | |
| InvalidParameterException | invalid cluSetTypeKey | ||
| MissingParameterException | missing cluSetTypeKey | ||
| OperationFailedException | unable to complete request | ||
| Method | getClu | ||
|---|---|---|---|
| Description | Retrieves core information about a CLU | ||
| Parameters | String | cluId | identifier of the CLU |
| Return | CluInfo | information about a CLU | |
| Errors | DoesNotExistException | cluId not found | |
| InvalidParameterException | invalid cluId | ||
| MissingParameterException | missing cluId | ||
| OperationFailedException | unable to complete request | ||
| Method | getClusByIdList | ||
|---|---|---|---|
| Description | Retrieves information about CLUs from a list of ids | ||
| Parameters | StringList | cluIdList | List of CLU identifiers |
| Return | CluInfoList | information a list of CLUs | |
| Errors | DoesNotExistException | One or more cluIds not found | |
| InvalidParameterException | One or more invalid cluIds | ||
| MissingParameterException | missing cluIdList | ||
| OperationFailedException | unable to complete request | ||
| Method | getClusByLuType | ||
|---|---|---|---|
| Description | Retrieves the list of CLUs for the specified LU Type and state | ||
| Parameters | String | luTypeKey | Type of the CLUs to retrieve |
| String | luState | State of the CLUs to retrieve. | |
| Return | CluInfoList | list of CLU information | |
| Errors | DoesNotExistException | luType or luState not found | |
| InvalidParameterException | invalid luType or luState | ||
| MissingParameterException | missing luType or luState | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluIdsByLuType | ||
|---|---|---|---|
| Description | Retrieves the list of CLU ids for the specified LU Type and state | ||
| Parameters | String | luTypeKey | Type of the CLUs whose identifiers should be retrieved |
| String | luState | State of the CLUs whose identifiers should be retrieved | |
| Return | StringList | list of CLU identifiers | |
| Errors | DoesNotExistException | luType or luState not found | |
| InvalidParameterException | invalid luType or luState | ||
| MissingParameterException | missing luType or luState | ||
| OperationFailedException | unable to complete request | ||
| Method | getAllowedLuLuRelationTypesByCluId | ||
|---|---|---|---|
| Description | Retrieves the list of allowed relation types between the two specified CLUs | ||
| Parameters | String | cluId | identifier of the first CLU |
| String | relatedCluId | identifier of the second CLU | |
| Return | StringList | list of LU to LU relation types | |
| Errors | DoesNotExistException | clu, relatedClu not found | |
| InvalidParameterException | invalid cluId, relatedCluId | ||
| MissingParameterException | missing cluId, relatedCluId | ||
| OperationFailedException | unable to complete request | ||
| Method | getClusByRelation | ||
|---|---|---|---|
| Description | Retrieves the list of CLU information for the CLUs related to a specified CLU Id with a certain LU to LU relation type (getRelatedClusByCluId from the other direction) | ||
| Parameters | String | relatedCluId | identifier of the child or To CLU |
| String | luLuRelationType | the LU to LU relation type | |
| Return | CluInfoList | list of CLU information | |
| Errors | DoesNotExistException | relatedCluId, luLuRelationType not found | |
| InvalidParameterException | invalid relatedCluId, luLuRelationType | ||
| MissingParameterException | missing relatedCluId, luLuRelationType | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluIdsByRelation | ||
|---|---|---|---|
| Description | Retrieves the list of CLU Ids for the specified related CLU Id and LU to LU relation type (getRelatedCluIdsByCluId from the other direction) | ||
| Parameters | String | relatedCluId | identifier of the child or To CLU |
| String | luLuRelationType | the LU to LU relation type | |
| Return | StringList | list of CLU identifiers | |
| Errors | DoesNotExistException | relatedClu, luLuRelationType not found | |
| InvalidParameterException | invalid relatedCluId, luLuRelationType | ||
| MissingParameterException | missing relatedCluId, luLuRelationType | ||
| OperationFailedException | unable to complete request | ||
| Method | getRelatedClusByCluId | ||
|---|---|---|---|
| Description | Retrieves the list of related CLU information for the specified CLU Id and LU to LU relation type (getClusByRelation from the other direction) | ||
| Parameters | String | cluId | identifier of the parent or From CLU |
| String | luLuRelationType | the LU to LU relation type | |
| Return | CluInfoList | list of CLU information | |
| Errors | DoesNotExistException | clu, luLuRelationType not found | |
| InvalidParameterException | invalid cluId, luLuRelationType | ||
| MissingParameterException | missing cluId, luLuRelationType | ||
| OperationFailedException | unable to complete request | ||
| Method | getRelatedCluIdsByCluId | ||
|---|---|---|---|
| Description | Retrieves the list of related CLU Ids for the specified CLU Id and LU to LU relation type (getCluIdsByRelation from the other direction) | ||
| Parameters | String | cluId | identifier of the parent or From CLU |
| String | luLuRelationType | the LU to LU relation type | |
| Return | StringList | list of CLU identifiers | |
| Errors | DoesNotExistException | clu, luLuRelationType not found | |
| InvalidParameterException | invalid cluId, luLuRelationType | ||
| MissingParameterException | missing cluId, luLuRelationType | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluCluRelation | ||
|---|---|---|---|
| Description | Retrieves the relationship information between CLUs for a particular Relation instance | ||
| Parameters | String | cluCluRelationId | identifier of the CLU to CLU relation |
| Return | CluCluRelationInfo | information on the relation between two CLUs | |
| Errors | DoesNotExistException | cluCluRelation not found | |
| InvalidParameterException | invalid cluCluRelationId | ||
| MissingParameterException | missing cluCluRelationId | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluCluRelationsByClu | ||
|---|---|---|---|
| Description | Retrieves the list of relationship information for the specified CLU | ||
| Parameters | String | cluId | identifier of the parent or From CLU |
| Return | CluCluRelationInfoList | list of CLU to CLU relation information | |
| Errors | DoesNotExistException | clu not found | |
| InvalidParameterException | invalid cluId | ||
| MissingParameterException | missing cluId | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluPublicationsByCluId | ||
|---|---|---|---|
| Description | Retrieves a list of publication objects for a particular clu | ||
| Parameters | String | cluId | clu identifier |
| Return | CluPublicationInfoList | list of publication objects used by the specified clu | |
| Errors | DoesNotExistException | clu not found | |
| InvalidParameterException | invalid cluId | ||
| MissingParameterException | cluId not specified | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluPublicationsByType | ||
|---|---|---|---|
| Description | Retrieves a list of publication objects of a particular Type | ||
| Parameters | String | luPublicationTypeKey | luPublicationType identifier |
| Return | CluPublicationInfoList | list of CLU Publication objects using the specified type | |
| Errors | DoesNotExistException | luPublicationType not found | |
| InvalidParameterException | invalid luPublicationTypeKey | ||
| MissingParameterException | luPublicationTypeKey not specified | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluPublication | ||
|---|---|---|---|
| Description | Retrieves an LU publication object by its identifier | ||
| Parameters | String | cluPublicationId | CLU publication identifier |
| Return | CluPublicationInfo | CLU Publication information | |
| Errors | DoesNotExistException | CLU Publication not found | |
| InvalidParameterException | invalid cluPublicationId | ||
| MissingParameterException | cluPublicationId not specified | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluResult | ||
|---|---|---|---|
| Description | Retrieves information about a Clu Result | ||
| Parameters | String | cluResultId | identifier of the Clu Result |
| Return | CluResultInfo | information about a Clu Result | |
| Errors | DoesNotExistException | cluResult not found | |
| InvalidParameterException | invalid cluResultId | ||
| MissingParameterException | missing cluResultId | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluResultByClu | ||
|---|---|---|---|
| Description | Retrieves the cluResult for a particular clu | ||
| Parameters | String | cluId | clu identifier |
| Return | CluResultInfoList | result information for a clu | |
| Errors | DoesNotExistException | clu not found | |
| InvalidParameterException | invalid cluId | ||
| MissingParameterException | cluId not specified | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluIdsByResultUsageType | ||
|---|---|---|---|
| Description | Retrieves the list of clu ids with the results of the specified usage type. This would for example allow requests for all clus which have a final grade. | ||
| Parameters | String | resultUsageTypeKey | identifier of the result usage type |
| Return | StringList | list of clu ids | |
| Errors | DoesNotExistException | resultUsageType not found | |
| InvalidParameterException | invalid resultUsageTypeKey | ||
| MissingParameterException | missing resultUsageTypeKey | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluIdsByResultComponent | ||
|---|---|---|---|
| Description | Retrieves the list of clu ids which use a particular result component | ||
| Parameters | String | resultComponentId | identifier of the result component |
| Return | StringList | list of clu ids | |
| Errors | DoesNotExistException | resultComponent not found | |
| InvalidParameterException | invalid resultComponentId | ||
| MissingParameterException | missing resultComponentId | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluLoRelation | ||
|---|---|---|---|
| Description | Retrieve information on a CLU LO Relation. | ||
| Parameters | String | cluLoRelationId | Identifier of the CLU LO Relation |
| Return | CluLoRelationInfo | The retrieved CLU LO Relation information | |
| Errors | DoesNotExistException | cluLoRelation not found | |
| InvalidParameterException | invalid cluLoRelationId | ||
| MissingParameterException | missing cluLoRelationId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getCluLoRelationsByClu | ||
|---|---|---|---|
| Description | Retrieves the list of canonical learning unit to learning objective relationships for a given CLU. | ||
| Parameters | String | cluId | Identifier for the CLU |
| Return | CluLoRelationInfoList | List of canonical learning unit to learning objective relationships | |
| Errors | DoesNotExistException | clu not found | |
| InvalidParameterException | invalid cluId | ||
| MissingParameterException | missing cluId | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluLoRelationsByLo | ||
|---|---|---|---|
| Description | Retrieves the list of CLU identifiers associated with a given learning objective identifier. | ||
| Parameters | String | loId | Identifier for the learning objective |
| Return | CluLoRelationInfoList | List of CLU LO Relations | |
| Errors | DoesNotExistException | lo not found | |
| InvalidParameterException | invalid loId | ||
| MissingParameterException | missing loId | ||
| OperationFailedException | unable to complete request | ||
| Method | getResourceRequirementsForCluId | ||
|---|---|---|---|
| Description | Retrieves the list of Resource requirements for the specified CLU | ||
| Parameters | String | cluId | Unique identifier for the CLU |
| Return | StringList | List of resource requirements | |
| Errors | DoesNotExistException | clu not found | |
| InvalidParameterException | cluId invalid | ||
| MissingParameterException | cluId missing | ||
| OperationFailedException | unable to complete request | ||
| Method | getCluSetInfo | ||
|---|---|---|---|
| Description | Retrieve information on a CLU set. This information should be about the set itself, and in the case of a dynamic CLU set, should include the criteria used to generate the set. | ||
| Parameters | String | cluSetId | Identifier of the CLU set |
| Return | CluSetInfo | The retrieved CLU set information | |
| Errors | DoesNotExistException | cluSet not found | |
| InvalidParameterException | invalid cluSetId | ||
| MissingParameterException | missing cluSetId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getCluSetTreeView | ||
|---|---|---|---|
| Description | Retrieve information on a CLU set and its sub clu set fully expanded. | ||
| Parameters | String | cluSetId | Identifier of the CLU set |
| Return | CluSetTreeViewInfo | The retrieved CLU set tree view information | |
| Errors | DoesNotExistException | cluSet not found | |
| InvalidParameterException | invalid cluSetId | ||
| MissingParameterException | missing cluSetId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getCluSetInfoByIdList | ||
|---|---|---|---|
| Description | Retrieve information on CLU sets from a list of cluSet Ids. | ||
| Parameters | StringList | cluSetIdList | List of identifiers of CLU sets |
| Return | CluSetInfoList | The retrieved list of CLU set information | |
| Errors | DoesNotExistException | One or more cluSets not found | |
| InvalidParameterException | One or more cluSetIds invalid | ||
| MissingParameterException | missing cluSetIdList | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getCluSetIdsFromCluSet | ||
|---|---|---|---|
| Description | Retrieve the list of CLU Set Ids within a CLU Set | ||
| Parameters | String | cluSetId | Identifier of the CLU set |
| Return | StringList | The retrieved list of CLU Set Ids within the specified CLU set | |
| Errors | DoesNotExistException | cluSet not found | |
| InvalidParameterException | invalid cluSetId | ||
| MissingParameterException | missing cluSetId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | isCluSetDynamic | ||
|---|---|---|---|
| Description | Check if the given CluSet is dynamic | ||
| Parameters | String | cluSetId | Identifier of the CLU set |
| Return | Boolean | The retrieved list of CLU Set Ids within the specified CLU set | |
| Errors | DoesNotExistException | cluSet not found | |
| InvalidParameterException | invalid cluSetId | ||
| MissingParameterException | missing cluSetId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getClusFromCluSet | ||
|---|---|---|---|
| Description | Retrieves the list of CLUs in a CLU set. This only retrieves the direct members. | ||
| Parameters | String | cluSetId | Identifier of the CLU set |
| Return | CluInfoList | The retrieved list of information on the CLUs within the CLU set (flattened and de-duped) | |
| Errors | DoesNotExistException | cluSet not found | |
| InvalidParameterException | invalid cluSetId | ||
| MissingParameterException | missing cluSetId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getCluIdsFromCluSet | ||
|---|---|---|---|
| Description | Retrieves the list of CLU Identifiers within a CLU Set. This only retrieves the direct members. | ||
| Parameters | String | cluSetId | Identifier of the CLU set |
| Return | StringList | The retrieved list of CLU Ids within the specified CLU set (flattened and de-duped) | |
| Errors | DoesNotExistException | cluSet not found | |
| InvalidParameterException | invalid cluSetId | ||
| MissingParameterException | missing cluSetId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getAllClusInCluSet | ||
|---|---|---|---|
| Description | Retrieves the full list of CLUs in this CLU set or any cluset that is included within that. | ||
| Parameters | String | cluSetId | Identifier of the CLU set |
| Return | CluInfoList | The retrieved list of information on the CLUs | |
| Errors | DoesNotExistException | cluSet not found | |
| InvalidParameterException | invalid cluSetId | ||
| MissingParameterException | missing cluSetId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getAllCluIdsInCluSet | ||
|---|---|---|---|
| Description | Retrieves the list of CLU Identifiers within a CLU Set or any cluset that is included within that. | ||
| Parameters | String | cluSetId | Identifier of the CLU set |
| Return | StringList | The retrieved list of CLU Ids within the specified CLU set | |
| Errors | DoesNotExistException | cluSet not found | |
| InvalidParameterException | invalid cluSetId | ||
| MissingParameterException | missing cluSetId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | isCluInCluSet | ||
|---|---|---|---|
| Description | Checks if a CLU is a member of a CLU set or any contained CLU set | ||
| Parameters | String | cluId | Identifier of the CLU to check |
| String | cluSetId | Identifier of the CLU set | |
| Return | Boolean | True if the CLU is a member of the CLU Set | |
| Errors | DoesNotExistException | clu, cluSet not found | |
| InvalidParameterException | invalid cluId, cluSetId | ||
| MissingParameterException | missing cluId, cluSetId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getLui | ||
|---|---|---|---|
| Description | Retrieves information about a LUI | ||
| Parameters | String | luiId | identifier of the LUI |
| Return | LuiInfo | information about a LUI | |
| Errors | DoesNotExistException | lui not found | |
| InvalidParameterException | invalid luiId | ||
| MissingParameterException | missing luiId | ||
| OperationFailedException | unable to complete request | ||
| Method | getLuisByIdList | ||
|---|---|---|---|
| Description | Retrieves information about LUIs from a list of Ids | ||
| Parameters | StringList | luiIdList | List of LUI identifiers |
| Return | LuiInfoList | information about a list of LUIs | |
| Errors | DoesNotExistException | One or more luis not found | |
| InvalidParameterException | One or more invalid luiIds | ||
| MissingParameterException | missing luiIdList | ||
| OperationFailedException | unable to complete request | ||
| Method | getLuisInAtpByCluId | ||
|---|---|---|---|
| Description | Retrieves the list of LUIs for the specified CLU and period | ||
| Parameters | String | cluId | identifier of the CLU |
| String | atpKey | identifier for the academic time period | |
| Return | LuiInfoList | list of LUI information | |
| Errors | DoesNotExistException | clu, atp not found | |
| InvalidParameterException | invalid cluId, atpKey | ||
| MissingParameterException | missing cluId, atpKey | ||
| OperationFailedException | unable to complete request | ||
| Method | getLuiIdsByCluId | ||
|---|---|---|---|
| Description | Retrieves the list of LUI ids for the specified CLU | ||
| Parameters | String | cluId | identifier of the CLU |
| Return | StringList | list of LUI identifiers | |
| Errors | DoesNotExistException | clu not found | |
| InvalidParameterException | invalid cluId | ||
| MissingParameterException | missing cluId | ||
| OperationFailedException | unable to complete request | ||
| Method | getLuiIdsInAtpByCluId | ||
|---|---|---|---|
| Description | Retrieves the list of LUI ids for the specified CLU and Time period | ||
| Parameters | String | cluId | identifier of the CLU |
| String | atpKey | identifier for the academic time period | |
| Return | StringList | list of LUI identifiers | |
| Errors | DoesNotExistException | clu, atp not found | |
| InvalidParameterException | invalid cluId, atpKey | ||
| MissingParameterException | missing cluId, atpKey | ||
| OperationFailedException | unable to complete request | ||
| Method | getAllowedLuLuRelationTypesByLuiId | ||
|---|---|---|---|
| Description | Retrieves the list of allowed relation types between the two specified LUIs | ||
| Parameters | String | luiId | identifier of the first LUI |
| String | relatedLuiId | identifier of the second LUI | |
| Return | StringList | list of LU to LU relation types | |
| Errors | DoesNotExistException | lui, relatedLui not found | |
| InvalidParameterException | invalid luiId, relatedLuiId | ||
| MissingParameterException | missing luiId, relatedLuiId | ||
| OperationFailedException | unable to complete request | ||
| Method | getLuisByRelation | ||
|---|---|---|---|
| Description | Retrieves the list of LUI information for the LUIs related to the specified LUI Id with a certain LU to LU relation type (getRelatedLuisByLuiId from the other direction) | ||
| Parameters | String | relatedLuiId | identifier of the LUI |
| String | luLuRelationType | the LU to LU relation type | |
| Return | LuiInfoList | list of LUI information | |
| Errors | DoesNotExistException | relatedLui, luLuRelationType not found | |
| InvalidParameterException | invalid relatedLuiId, luLuRelationType | ||
| MissingParameterException | missing relatedLuiId, luLuRelationType | ||
| OperationFailedException | unable to complete request | ||
| Method | getLuiIdsByRelation | ||
|---|---|---|---|
| Description | Retrieves the list of LUI Ids for the specified related LUI Id and LU to LU relation type (getRelatedLuiIdsByLuiId from the other direction) | ||
| Parameters | String | relatedLuiId | identifier of the LUI |
| String | luLuRelationType | the LU to LU relation type | |
| Return | StringList | list of LUI identifiers | |
| Errors | DoesNotExistException | relatedLui, luLuRelationType not found | |
| InvalidParameterException | invalid relatedLuiId, luLuRelationType | ||
| MissingParameterException | missing relatedLuiId, luLuRelationType | ||
| OperationFailedException | unable to complete request | ||
| Method | getRelatedLuisByLuiId | ||
|---|---|---|---|
| Description | Retrieves the list of related LUI information for the specified LUI Id and LU to LU relation type (getLuisByRelation from the other direction) | ||
| Parameters | String | luiId | identifier of the LUI |
| String | luLuRelationType | the LU to LU relation type | |
| Return | LuiInfoList | list of LUI information | |
| Errors | DoesNotExistException | lui, luLuRelationType not found | |
| InvalidParameterException | invalid luiId, luLuRelationType | ||
| MissingParameterException | missing luiId, luLuRelationType | ||
| OperationFailedException | unable to complete request | ||
| Method | getRelatedLuiIdsByLuiId | ||
|---|---|---|---|
| Description | Retrieves the list of related LUI Ids for the specified LUI Id and LU to LU relation type. (getLuiIdsByRelation from the other direction) | ||
| Parameters | String | luiId | identifier of the LUI |
| String | luLuRelationType | the LU to LU relation type | |
| Return | StringList | list of LUI identifiers | |
| Errors | DoesNotExistException | luiId, luLuRelationType not found | |
| InvalidParameterException | invalid luiId, luLuRelationType | ||
| MissingParameterException | missing luiId, luLuRelationType | ||
| OperationFailedException | unable to complete request | ||
| Method | getLuiLuiRelation | ||
|---|---|---|---|
| Description | Retrieves the relationship information between LUIs given a specific relation instance | ||
| Parameters | String | luiLuiRelationId | identifier of LUI to LUI relation |
| Return | LuiLuiRelationInfo | information on the relation between two LUIs | |
| Errors | DoesNotExistException | luiLuiRelation not found | |
| InvalidParameterException | invalid luiLuiRelationId | ||
| MissingParameterException | missing luiLuiRelationId | ||
| OperationFailedException | unable to complete request | ||
| Method | getLuiLuiRelationsByLui | ||
|---|---|---|---|
| Description | Retrieves the list of relationship information for the specified LUI | ||
| Parameters | String | luiId | identifier of the LUI |
| Return | LuiLuiRelationInfoList | list of LUI to LUI relation information | |
| Errors | DoesNotExistException | lui not found | |
| InvalidParameterException | invalid luiId | ||
| MissingParameterException | missing luiId | ||
| OperationFailedException | unable to complete request | ||
| Method | validateClu | ||
|---|---|---|---|
| Description | Validates a CLU. 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. If an identifier is present for the CLU (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the CLU can be shifted to the new values. If an identifier is not present or 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. | ||
| Parameters | String | validationType | identifier of the extent of validation |
| CluInfo | cluInfo | CLU information to be tested. | |
| Return | ValidationResultInfoList | results from performing the validation | |
| Errors | DoesNotExistException | validationTypeKey not found | |
| InvalidParameterException | invalid validationTypeKey, cluInfo | ||
| MissingParameterException | missing validationTypeKey, cluInfo | ||
| OperationFailedException | unable to complete request | ||
| Method | createClu | ||
|---|---|---|---|
| Description | Creates a new CLU | ||
| Parameters | String | luTypeKey | identifier of the LU Type for the CLU being created |
| CluInfo | cluInfo | information about the CLU being created | |
| Return | CluInfo | the created CLU information | |
| Errors | AlreadyExistsException | CLU already exists | |
| DataValidationErrorException | One or more values invalid for this operation | ||
| DoesNotExistException | luTypeKey not found | ||
| InvalidParameterException | invalid luTypeKey, cluInfo | ||
| MissingParameterException | missing luTypeKey, cluInfo | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | updateClu | ||
|---|---|---|---|
| Description | Updates an existing CLU | ||
| Parameters | String | cluId | identifier for the CLU to be updated |
| CluInfo | cluInfo | updated information about the CLU | |
| Return | CluInfo | the updated CLU information | |
| Errors | DataValidationErrorException | One or more values invalid for this operation | |
| DoesNotExistException | cluId not found | ||
| InvalidParameterException | invalid cluId, cluInfo | ||
| MissingParameterException | missing cluId, cluInfo | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| VersionMismatchException | The action was attempted on an out of date version | ||
| Method | deleteClu | ||
|---|---|---|---|
| Description | Deletes an existing CLU | ||
| Parameters | String | cluId | identifier for the CLU to be deleted |
| Return | StatusInfo | status of the operation | |
| Errors | DoesNotExistException | cluId not found | |
| InvalidParameterException | invalid cluId | ||
| MissingParameterException | missing cluId | ||
| DependentObjectsExistException | delete would leave orphaned objects or violate integrity constraints | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | createNewCluVersion | ||
|---|---|---|---|
| Description | Creates a new CLU version based on the current clu | ||
| Parameters | String | cluId | identifier for the CLU to be versioned |
| String | versionComment | comment for the current version | |
| Return | CluInfo | the new versioned CLU information | |
| Errors | DataValidationErrorException | One or more values invalid for this operation | |
| DoesNotExistException | cluId not found | ||
| InvalidParameterException | invalid cluId | ||
| MissingParameterException | missing cluId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| VersionMismatchException | The action was attempted on an out of date version | ||
| Method | setCurrentCluVersion | ||
|---|---|---|---|
| Description | Sets a specific version of the Clu as current. The sequence number must be greater than the existing current Clu version. This will truncate the current version's end date to the currentVersionStart param. If a Clu exists which is set to become current in the future, that clu's currentVersionStart and CurrentVersionEnd will be nullified. The currentVersionStart must be in the future to prevent changing historic data. |
||
| Parameters | String | cluVersionId | Version Specific Id of the Clu |
| Date | currentVersionStart | Date when this clu becomes current. Must be in the future and be after the most current clu's start date. | |
| Return | StatusInfo | status of the operation | |
| Errors | DoesNotExistException | cluVersionId not found | |
| InvalidParameterException | invalid cluVersionId, previousState, newState | ||
| MissingParameterException | missing cluVersionId, previousState, newState | ||
| IllegalVersionSequencingException | a Clu with higher sequence number from the one provided is marked current | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | updateCluState | ||
|---|---|---|---|
| Description | Updates the state of the specified CLU | ||
| Parameters | String | cluId | identifier for the CLU to be updated |
| String | luState | new state for the CLU. Value is expected to be constrained to those in the luState enumeration. | |
| Return | CluInfo | the updated CLU information | |
| Errors | DataValidationErrorException | new state not valid for existing state of CLU | |
| DoesNotExistException | cluId, luState not found | ||
| InvalidParameterException | invalid cluId, luState | ||
| MissingParameterException | missing cluId, luState | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | validateCluCluRelation | ||
|---|---|---|---|
| Description | Validates a cluCluRelation. 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. If an identifier is present for the cluCluRelation (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the relationship can be shifted to the new values. If an identifier is not present or 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. | ||
| Parameters | String | validationType | identifier of the extent of validation |
| CluCluRelationInfo | cluCluRelationInfo | cluCluRelation information to be tested. | |
| Return | ValidationResultInfoList | results from performing the validation | |
| Errors | DoesNotExistException | validationTypeKey not found | |
| InvalidParameterException | invalid validationTypeKey, cluCluRelationInfo | ||
| MissingParameterException | missing validationTypeKey, cluCluRelationInfo | ||
| OperationFailedException | unable to complete request | ||
| Method | createCluCluRelation | ||
|---|---|---|---|
| Description | Create a directional relationship between two CLUs | ||
| Parameters | String | cluId | identifier of the first CLU in the relationship - The From or Parent of the relation |
| String | relatedCluId | identifier of the second CLU in the relationship to be related to - the To or Child of the Relation | |
| String | luLuRelationTypeKey | the LU to LU relationship type of the relationship | |
| CluCluRelationInfo | cluCluRelationInfo | information about the relationship between the two CLUs | |
| Return | CluCluRelationInfo | the created CLU to CLU relation information | |
| Errors | AlreadyExistsException | relationship already exists | |
| CircularRelationshipException | cluId equals relatedCluId | ||
| DataValidationErrorException | One or more values invalid for this operation | ||
| DoesNotExistException | cluId, relatedCluId, luLuRelationType not found | ||
| InvalidParameterException | invalid cluId, relatedCluId, luluRelationType, cluCluRelationInfo | ||
| MissingParameterException | missing cluId, relatedCluId, luluRelationType, cluCluRelationInfo | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | updateCluCluRelation | ||
|---|---|---|---|
| Description | Updates a relationship between two CLUs | ||
| Parameters | String | cluCluRelationId | identifier of the CLU to CLU relation to be updated |
| CluCluRelationInfo | cluCluRelationInfo | changed information about the CLU to CLU relationship | |
| Return | CluCluRelationInfo | the updated CLU to CLU relation information | |
| Errors | DataValidationErrorException | One or more values invalid for this operation | |
| DoesNotExistException | cluCluRelation not found | ||
| InvalidParameterException | invalid cluCluRelationId, cluCluRelationInfo | ||
| MissingParameterException | missing cluCluRelationId, cluCluRelationInfo | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| VersionMismatchException | The action was attempted on an out of date version. | ||
| Method | deleteCluCluRelation | ||
|---|---|---|---|
| Description | Deletes a relationship between two CLUs | ||
| Parameters | String | cluCluRelationId | identifier of CLU to CLU relationship to delete |
| Return | StatusInfo | status of the operation (success or failure) | |
| Errors | DoesNotExistException | cluCluRelation not found | |
| InvalidParameterException | invalid cluCluRelationId | ||
| MissingParameterException | missing cluCluRelationId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | validateCluPublication | ||
|---|---|---|---|
| Description | Validates information about publication for a clu. 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. If an identifier is present for the clu publication object (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the clu publication object can be shifted to the new values. If an identifier is not present or 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. | ||
| Parameters | String | validationType | identifier of the extent of validation |
| CluPublicationInfo | cluPublicationInfo | CLU publication information to be tested. | |
| Return | ValidationResultInfoList | results from performing the validation | |
| Errors | DoesNotExistException | validationTypeKey not found | |
| InvalidParameterException | invalid validationTypeKey, cluPublicationInfo | ||
| MissingParameterException | missing validationTypeKey, cluPublicationInfo | ||
| OperationFailedException | unable to complete request | ||
| Method | createCluPublication | ||
|---|---|---|---|
| Description | Create a clu publication object, which contains information about publication for a clu. | ||
| Parameters | String | cluId | identifier of a clu |
| String | luPublicationType | type of lu publication | |
| CluPublicationInfo | cluPublicationInfo | information about publication for a clu | |
| Return | CluPublicationInfo | information about the created clu publication object | |
| Errors | AlreadyExistsException | clu publication object already exists | |
| DataValidationErrorException | One or more values invalid for this operation | ||
| InvalidParameterException | invalid cluId, luPublicationType, cluPublicationInfo | ||
| MissingParameterException | missing cluId, luPublicationType, cluPublicationInfo | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | updateCluPublication | ||
|---|---|---|---|
| Description | Updates an existing clu publication object | ||
| Parameters | String | cluPublicationId | identifier for the clu publication object to be updated |
| CluPublicationInfo | cluPublicationInfo | updated information about the clu publication object | |
| Return | CluPublicationInfo | the updated clu publication information | |
| Errors | DataValidationErrorException | One or more values invalid for this operation | |
| DoesNotExistException | cluPublication not found | ||
| InvalidParameterException | invalid cluPublicationId, cluPublicationInfo | ||
| MissingParameterException | missing cluPublicationId, cluPublicationInfo | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| VersionMismatchException | The action was attempted on an out of date version. | ||
| Method | deleteCluPublication | ||
|---|---|---|---|
| Description | Deletes an existing clu publication object | ||
| Parameters | String | cluPublicationId | identifier for the clu publication object to be deleted |
| Return | StatusInfo | status of the operation | |
| Errors | DoesNotExistException | cluPublication not found | |
| InvalidParameterException | invalid cluPublicationId | ||
| MissingParameterException | missing cluPublicationId | ||
| DependentObjectsExistException | delete would leave orphaned objects or violate integrity constraints | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | validateCluResult | ||
|---|---|---|---|
| Description | Validates information about results for a clu. 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. If an identifier is present for the clu result object (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the clu result object can be shifted to the new values. If an identifier is not present or 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. | ||
| Parameters | String | validationType | identifier of the extent of validation |
| CluResultInfo | cluResultInfo | CLU result information to be tested. | |
| Return | ValidationResultInfoList | results from performing the validation | |
| Errors | DoesNotExistException | validationTypeKey not found | |
| InvalidParameterException | invalid validationTypeKey, cluResultInfo | ||
| MissingParameterException | missing validationTypeKey, cluResultInfo | ||
| OperationFailedException | unable to complete request | ||
| Method | createCluResult | ||
|---|---|---|---|
| Description | Create a clu result object, which contains information about potential results for a clu. | ||
| Parameters | String | cluId | identifier of a clu |
| String | cluResultType | type of clu result | |
| CluResultInfo | cluResultInfo | information about potential results for a clu | |
| Return | CluResultInfo | information about the created clu result | |
| Errors | AlreadyExistsException | clu result already exists | |
| DataValidationErrorException | One or more values invalid for this operation | ||
| InvalidParameterException | invalid cluId, cluResultType, cluResultInfo | ||
| MissingParameterException | missing cluId, cluResultType, cluResultInfo | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| DoesNotExistException | resultUsageTypeKey not found | ||
| Method | updateCluResult | ||
|---|---|---|---|
| Description | Updates an existing clu result | ||
| Parameters | String | cluResultId | identifier for the clu result to be updated |
| CluResultInfo | cluResultInfo | updated information about the clu result | |
| Return | CluResultInfo | the updated clu result information | |
| Errors | DataValidationErrorException | One or more values invalid for this operation | |
| DoesNotExistException | cluResult not found | ||
| InvalidParameterException | invalid cluResultId, cluResultInfo | ||
| MissingParameterException | missing cluResultId, cluResultInfo | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| VersionMismatchException | The action was attempted on an out of date version. | ||
| Method | deleteCluResult | ||
|---|---|---|---|
| Description | Deletes an existing clu result | ||
| Parameters | String | cluResultId | identifier for the clu result to be deleted |
| Return | StatusInfo | status of the operation | |
| Errors | DoesNotExistException | cluResult not found | |
| InvalidParameterException | invalid cluResultId | ||
| MissingParameterException | missing cluResultId | ||
| DependentObjectsExistException | delete would leave orphaned objects or violate integrity constraints | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | validateCluLoRelation | ||
|---|---|---|---|
| Description | Validates a cluLoRelation. 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. If an identifier is present for the cluLoRelation (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the relationship can be shifted to the new values. If an identifier is not present or 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. | ||
| Parameters | String | validationType | identifier of the extent of validation |
| CluLoRelationInfo | cluLoRelationInfo | cluLoRelation information to be tested. | |
| Return | ValidationResultInfoList | results from performing the validation | |
| Errors | DoesNotExistException | validationTypeKey not found | |
| InvalidParameterException | invalid validationTypeKey, cluLoRelationInfo | ||
| MissingParameterException | missing validationTypeKey, cluLoRelationInfo | ||
| OperationFailedException | unable to complete request | ||
| Method | createCluLoRelation | ||
|---|---|---|---|
| Description | Creates a relationship between a learning objective and a CLU. | ||
| Parameters | String | cluId | CLU identifier |
| String | loId | learning objective identifier | |
| String | cluLoRelationType | type of clu learning objective relationship | |
| CluLoRelationInfo | cluLoRelationInfo | clu learning objective relationship information | |
| Return | CluLoRelationInfo | the newly created clu learning objective relationship | |
| Errors | AlreadyExistsException | connection between clu and learning objective already exists | |
| DoesNotExistException | cluId, loId, cluLoRelationType not found | ||
| InvalidParameterException | one or more parameters invalid | ||
| MissingParameterException | one or more parameters not specified | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| DataValidationErrorException | data validation error | ||
| Method | updateCluLoRelation | ||
|---|---|---|---|
| Description | Updates a relationship between a clu and learning objective | ||
| Parameters | String | cluLoRelationId | identifier of the clu learning objective relationship to be updated |
| CluLoRelationInfo | cluLoRelationInfo | information about the clu learning objective relationship to be updated | |
| Return | CluLoRelationInfo | the updated clu learning objective relationship information | |
| Errors | DataValidationErrorException | One or more values invalid for this operation | |
| DoesNotExistException | cluLoRelation not found | ||
| InvalidParameterException | one or more parameters invalid | ||
| MissingParameterException | one or more parameters missing | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| VersionMismatchException | The action was attempted on an out of date version. | ||
| Method | deleteCluLoRelation | ||
|---|---|---|---|
| Description | Removes a relationship between a learning objective and a Clu. | ||
| Parameters | String | cluLoRelationId | CLU learning objective Relationship identifier |
| Return | StatusInfo | Status | |
| Errors | DoesNotExistException | cluLoRelation not found | |
| InvalidParameterException | invalid cluLoRelationId | ||
| MissingParameterException | cluLoRelationId not specified | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | addCluResourceRequirement | ||
|---|---|---|---|
| Description | Add a Resource requirement to a CLU | ||
| Parameters | String | resourceTypeKey | identifier of the resource requirement type to be added to the CLU |
| String | cluId | identifier of the CLU | |
| Return | StatusInfo | status of the operation (success or failure) | |
| Errors | AlreadyExistsException | resourceTypeKey is already associated with the cluId | |
| DoesNotExistException | resourceTypeKey or cluId not found | ||
| InvalidParameterException | resourceTypeKey or cluId invalid | ||
| MissingParameterException | resourceTypeKey or cluId missing | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | removeCluResourceRequirement | ||
|---|---|---|---|
| Description | Remove a Resource requirement from a CLU | ||
| Parameters | String | resourceTypeKey | identifier of the resource type to be removed from the CLU |
| String | cluId | identifier of the CLU | |
| Return | StatusInfo | status of the operation (success or failure) | |
| Errors | DoesNotExistException | resourceTypeKey or cluId or relationship not found | |
| InvalidParameterException | resourceTypeKey or cluId invalid | ||
| MissingParameterException | resourceTypeKey or cluId missing | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | validateCluSet | ||
|---|---|---|---|
| Description | Validates information about a clu set. 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. If an identifier is present for the clu set (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the clu set can be shifted to the new values. If an identifier is not present or 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. | ||
| Parameters | String | validationType | identifier of the extent of validation |
| CluSetInfo | cluSetInfo | CLU set information to be tested. | |
| Return | ValidationResultInfoList | results from performing the validation | |
| Errors | DoesNotExistException | validationTypeKey not found | |
| InvalidParameterException | invalid validationTypeKey, cluSetInfo | ||
| MissingParameterException | missing validationTypeKey, cluSetInfo | ||
| OperationFailedException | unable to complete request | ||
| Method | createCluSet | ||
|---|---|---|---|
| Description | Creates a CLU set. | ||
| Parameters | String | cluSetType | type of the CLU set to be created |
| CluSetInfo | cluSetInfo | information required to create a CLU set | |
| Return | CluSetInfo | the created CLU set information | |
| Errors | AlreadyExistsException | the cluSet already exists | |
| DataValidationErrorException | One or more values invalid for this operation | ||
| InvalidParameterException | invalid cluSetName, cluSetInfo | ||
| MissingParameterException | missing cluSetName, cluSetInfo | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| UnsupportedActionException | CLU set need to be static or dynamic but not both | ||
| Method | updateCluSet | ||
|---|---|---|---|
| Description | Update the information for a CLU set | ||
| Parameters | String | cluSetId | identifier of the CLU set to be updated |
| CluSetInfo | cluSetInfo | updated information about the CLU set | |
| Return | CluSetInfo | the updated CLU set information | |
| Errors | DataValidationErrorException | One or more values invalid for this operation | |
| DoesNotExistException | cluSet not found | ||
| InvalidParameterException | invalid cluSetId, cluSetInfo | ||
| MissingParameterException | missing cluSetId, cluSetInfo | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| VersionMismatchException | The action was attempted on an out of date version. | ||
| UnsupportedActionException | CLU set need to be static or dynamic but not both | ||
| CircularRelationshipException | addedCluSetId cannot be added to the cluSetId | ||
| Method | deleteCluSet | ||
|---|---|---|---|
| Description | Delete a CLU set | ||
| Parameters | String | cluSetId | identifier of the CLU set to be deleted |
| Return | StatusInfo | status of the operation (success or failure) | |
| Errors | DoesNotExistException | cluSet not found | |
| InvalidParameterException | invalid cluSetId | ||
| MissingParameterException | missing cluSetId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | addCluSetToCluSet | ||
|---|---|---|---|
| Description | Adds one CLU set to another | ||
| Parameters | String | cluSetId | identifier of the host CLU set |
| String | addedCluSetId | identifier of the CLU set to be added | |
| Return | StatusInfo | status of the operation (success or failure) | |
| Errors | CircularRelationshipException | addedCluSetId cannot be added to the cluSetId | |
| DoesNotExistException | cluSet, addedCluSet not found | ||
| InvalidParameterException | invalid cluSetId, addedCluSetId | ||
| MissingParameterException | missing cluSetId, addedCluSetId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| UnsupportedActionException | CLU set is dynamically determined | ||
| Method | addCluSetsToCluSet | ||
|---|---|---|---|
| Description | Adds a list of CLU sets to another CluSet. If any individual one would fail, then an error is returned and none are added. | ||
| Parameters | String | cluSetId | identifier of the host CLU set |
| StringList | addedCluSetIdList | list of identifiers of the CLU sets to be added | |
| Return | StatusInfo | status of the operation (success or failure) | |
| Errors | CircularRelationshipException | addedCluSetId cannot be added to the cluSetId | |
| DoesNotExistException | cluSet, addedCluSet not found | ||
| InvalidParameterException | invalid cluSetId, addedCluSetId | ||
| MissingParameterException | missing cluSetId, addedCluSetId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| UnsupportedActionException | CLU set is dynamically determined | ||
| Method | removeCluSetFromCluSet | ||
|---|---|---|---|
| Description | Removes one CLU set from another | ||
| Parameters | String | cluSetId | identifier of the host CLU set |
| String | removedCluSetId | identifier of the CLU set to be removed | |
| Return | StatusInfo | status of the operation (success or failure) | |
| Errors | DoesNotExistException | cluSet, removedCluSet not found | |
| InvalidParameterException | invalid cluSetId, removedCluSetId | ||
| MissingParameterException | missing cluSetId, removedCluSetId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| UnsupportedActionException | CLU set is dynamically determined | ||
| Method | addCluToCluSet | ||
|---|---|---|---|
| Description | Add a CLU to a CLU set | ||
| Parameters | String | cluId | identifier of CLU to add to the CLU set |
| String | cluSetId | identifier of the CLU set | |
| Return | StatusInfo | status of the operation (success or failure) | |
| Errors | DoesNotExistException | clu, cluSet not found | |
| InvalidParameterException | invalid cluId, cluSetId | ||
| MissingParameterException | missing cluId, cluSetId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| UnsupportedActionException | CLU set is dynamically determined | ||
| Method | addClusToCluSet | ||
|---|---|---|---|
| Description | Adds a list of CLUs to a CLU set. If any individual one would fail, then an error is returned and none are added. | ||
| Parameters | StringList | cluIdList | ??? |
| String | cluSetId | identifier of the CLU set to be added | |
| Return | StatusInfo | status of the operation (success or failure) | |
| Errors | DoesNotExistException | clu, cluSet not found | |
| InvalidParameterException | invalid cluId, cluSetId | ||
| MissingParameterException | missing cluId, cluSetId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| UnsupportedActionException | CLU set is dynamically determined | ||
| Method | removeCluFromCluSet | ||
|---|---|---|---|
| Description | Remove a CLU from a CLU set | ||
| Parameters | String | cluId | identifier of CLU to remove from the CLU set |
| String | cluSetId | identifier of the CLU set | |
| Return | StatusInfo | status of the operation (success or failure) | |
| Errors | DoesNotExistException | clu, cluSet not found | |
| InvalidParameterException | invalid cluId, cluSetId | ||
| MissingParameterException | missing cluId, cluSetId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| UnsupportedActionException | CLU set is dynamically determined | ||
| Method | validateLui | ||
|---|---|---|---|
| Description | Validates a LUI. 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. If an identifier is present for the LUI (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the LUI can be shifted to the new values. If an identifier is not present or 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. | ||
| Parameters | String | validationType | identifier of the extent of validation |
| LuiInfo | luiInfo | LUI information to be tested. | |
| Return | ValidationResultInfoList | results from performing the validation | |
| Errors | DoesNotExistException | validationTypeKey not found | |
| InvalidParameterException | invalid validationTypeKey, luiInfo | ||
| MissingParameterException | missing validationTypeKey, luiInfo | ||
| OperationFailedException | unable to complete request | ||
| Method | createLui | ||
|---|---|---|---|
| Description | Creates a new LUI | ||
| Parameters | String | cluId | identifier of the CLU for the LUI being created |
| String | atpKey | identifier of the academic time period for the LUI being created | |
| LuiInfo | luiInfo | information about the LUI being created | |
| Return | LuiInfo | the created LUI information | |
| Errors | AlreadyExistsException | LUI already exists | |
| DataValidationErrorException | One or more values invalid for this operation | ||
| DoesNotExistException | clu, atp not found | ||
| InvalidParameterException | invalid cluId, atpKey, luiInfo | ||
| MissingParameterException | missing cluId, atpKey, luiInfo | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | updateLui | ||
|---|---|---|---|
| Description | Updates an existing LUI | ||
| Parameters | String | luiId | identifier for the LUI to be updated |
| LuiInfo | luiInfo | updated information about the LUI | |
| Return | LuiInfo | the updated LUI information | |
| Errors | DataValidationErrorException | One or more values invalid for this operation | |
| DoesNotExistException | lui not found | ||
| InvalidParameterException | invalid luiId, luiInfo | ||
| MissingParameterException | missing luiId, luiInfo | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| VersionMismatchException | The action was attempted on an out of date version. | ||
| Method | deleteLui | ||
|---|---|---|---|
| Description | Deletes a LUI record | ||
| Parameters | String | luiId | identifier for the LUI to be deleted |
| Return | StatusInfo | status of the operation | |
| Errors | DependentObjectsExistException | delete would leave orphaned objects or violate integrity constraints | |
| DoesNotExistException | lui not found | ||
| InvalidParameterException | invalid luiId | ||
| MissingParameterException | missing luiId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | updateLuiState | ||
|---|---|---|---|
| Description | Updates the state of the LUI | ||
| Parameters | String | luiId | identifier for the LUI to be updated |
| String | luState | New state for LUI. Value is expected to be constrained to those in the luState enumeration. | |
| Return | LuiInfo | the updated LUI information | |
| Errors | DataValidationErrorException | New state not valid for existing state of LUI | |
| DoesNotExistException | lui, luState not found | ||
| InvalidParameterException | invalid luiId, luState | ||
| MissingParameterException | missing luiId, luState | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | validateLuiLuiRelation | ||
|---|---|---|---|
| Description | Validates a relationship between LUIs. 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. If an identifier is present for the relationship (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the relationship can be shifted to the new values. If an identifier is not present or 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. | ||
| Parameters | String | validationType | identifier of the extent of validation |
| LuiLuiRelationInfo | luiLuiRelationInfo | LUI to LUI relationship information to be tested. | |
| Return | ValidationResultInfoList | results from performing the validation | |
| Errors | DoesNotExistException | validationTypeKey not found | |
| InvalidParameterException | invalid validationTypeKey, luiLuiRelationInfo | ||
| MissingParameterException | missing validationTypeKey, luiLuiRelationInfo | ||
| OperationFailedException | unable to complete request | ||
| Method | createLuiLuiRelation | ||
|---|---|---|---|
| Description | Create a relationship between two LUIs | ||
| Parameters | String | luiId | identifier of the first LUI in the relationship |
| String | relatedLuiId | identifier of the second LUI in the relationship to be related to | |
| String | luLuRelationType | the LU to LU relationship type of the relationship | |
| LuiLuiRelationInfo | luiLuiRelationInfo | information about the relationship between the two LUIs | |
| Return | LuiLuiRelationInfo | the created LUI to LUI relation information | |
| Errors | AlreadyExistsException | relationship already exists | |
| CircularRelationshipException | luiId equals relatedLuiId | ||
| DataValidationErrorException | One or more values invalid for this operation | ||
| DoesNotExistException | luiId, relatedLuiId, luLuRelationType not found | ||
| InvalidParameterException | invalid luiIds, luluRelationType, luiLuiRelationInfo | ||
| MissingParameterException | missing luiIds, luluRelationType, luiLuiRelationInfo | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | updateLuiLuiRelation | ||
|---|---|---|---|
| Description | Updates a relationship between two LUIs | ||
| Parameters | String | luiLuiRelationId | identifier of the LUI to LUI relation to update |
| LuiLuiRelationInfo | luiLuiRelationInfo | changed information about the relationship between the two LUIs | |
| Return | LuiLuiRelationInfo | the update LUI to LUI relation information | |
| Errors | DataValidationErrorException | One or more values invalid for this operation | |
| DoesNotExistException | luiLuiRelation not found | ||
| InvalidParameterException | invalid luiLuiRelationId, luiLuiRelationInfo | ||
| MissingParameterException | missing luiLuiRelationId, luiLuiRelationInfo | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| VersionMismatchException | The action was attempted on an out of date version. | ||
| Method | deleteLuiLuiRelation | ||
|---|---|---|---|
| Description | Deletes a relationship between two LUIs | ||
| Parameters | String | luiLuiRelationId | identifier of the LUI to LUI relation to delete |
| Return | StatusInfo | status of the operation (success or failure) | |
| Errors | DoesNotExistException | luiLuiRelation not found | |
| InvalidParameterException | invalid luiLuiRelationId | ||
| MissingParameterException | missing luiLuiRelationId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||