| Name | Atp | |
|---|---|---|
| Version | 1.0 (Dev) | |
| Included Services | StateService, TypeService, DataDictionaryService | |
|
Academic Time Period Service Description and Assumptions. This service supports the management of Academic Time Periods and their associated Milestones. The intent is to provide a flexible but structured way to define the various time frames that are used throughout the definition, offering and scheduling of Learning Units. This is a catalogue service with basic operations. |
|---|
| Method | getAtp | ||
|---|---|---|---|
| Description | Retrieves the details of a single Academic Time Period by atpKey. | ||
| Parameters | String | atpKey | Unique key of the Academic Time Period to be retrieved |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | AtpInfo | Details of the Academic Time Period requested | |
| Errors | DoesNotExistException | atpKey not found | |
| InvalidParameterException | invalid atpKey | ||
| MissingParameterException | invalid atpKey | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getAtpsByDate | ||
|---|---|---|---|
| Description | Retrieves the list of Academic Time Periods that the supplied date falls within. |
||
| Parameters | Date | searchDate | Timestamp to be matched |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | AtpInfoList | List of Academic Time Periods that contain the supplied searchDate | |
| Errors | InvalidParameterException | invalid searchDate | |
| MissingParameterException | invalid searchDate | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getAtpsByDates | ||
|---|---|---|---|
| Description | Retrieves the list of Academic Time Periods that are totally contained within the supplied dates. The entire Atp falls within the supplied dates. |
||
| Parameters | Date | startDate | Earliest Timestamp |
| Date | endDate | Latest Timestamp | |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | AtpInfoList | List of Academic Time Periods that contain the supplied searchDate | |
| Errors | InvalidParameterException | invalid searchDate | |
| MissingParameterException | invalid searchDate | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getAtpsByKeyList | ||
|---|---|---|---|
| Description | Retrieves a list of Academic Time Periods corresponding to the given list of ATP keys. |
||
| Parameters | StringList | atpKeyList | list of ATPs to be retrieved |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | AtpInfoList | List of Academic Time Period keys of the given type | |
| Errors | DoesNotExistException | an atpKey in list not found | |
| InvalidParameterException | invalid atpKey | ||
| MissingParameterException | invalid atpKey | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getAtpKeysByType | ||
|---|---|---|---|
| Description | Retrieves a list of Academic Time Periods of the specified type. | ||
| Parameters | String | atpTypeKey | ATP type to be retrieved |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | StringList | a list of Academic Time Period keys | |
| Errors | InvalidParameterException | invalid atpTypeKey | |
| MissingParameterException | invalid atpTypeKey | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getMilestone | ||
|---|---|---|---|
| Description | Retrieves the details of the specified milestone. | ||
| Parameters | String | milestoneKey | Unique id of the milestone to be retrieved |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | MilestoneInfo | Details of requested milestone | |
| Errors | DoesNotExistException | milestoneKey not found | |
| InvalidParameterException | invalid milestoneKey | ||
| MissingParameterException | invalid milestoneKey | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getMilestonesByKeyList | ||
|---|---|---|---|
| Description | Retrieves a list of Milestones corresponding to the given list of Milestone keys. |
||
| Parameters | StringList | milestoneKeyList | list of Milestones to be retrieved |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | AtpInfoList | the list of milestone keys | |
| Errors | DoesNotExistException | a milestoneKey in list not found | |
| InvalidParameterException | invalid milestoneKey | ||
| MissingParameterException | invalid milestibeKey | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getMilestonesByAtp | ||
|---|---|---|---|
| Description | Retrieves the list of milestones for a specified Academic Time Period. |
||
| Parameters | String | atpKey | Unique key of the Academic Time Period to be retieved |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | MilestoneInfoList | List of milestones for this Academic Time Period | |
| Errors | InvalidParameterException | invalid atpKey | |
| MissingParameterException | invalid atpKey | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getMilestonesByDates | ||
|---|---|---|---|
| Description | Retrieves the list of milestones that fall within a specified set of dates. |
||
| Parameters | Date | startDate | Start Date for date span |
| Date | endDate | End Date for date span | |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | MilestoneInfoList | List of milestones that fall within this set of dates | |
| Errors | InvalidParameterException | One or more parameters invalid | |
| MissingParameterException | One or more parameter(s) missing | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getMilestonesByDatesAndType | ||
|---|---|---|---|
| Description | Retrieves a list of milestones of a specified type that fall within a specified set of dates. |
||
| Parameters | String | milestoneTypeKey | Milestone type to be retrieved |
| Date | startDate | Start Date for date range | |
| Date | endDate | End Date for date range | |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | MilestoneInfoList | List of milestones of this milestone type within this set of dates | |
| Errors | InvalidParameterException | One or more parameters invalid | |
| MissingParameterException | One or more parameters missing | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | validateAtp | ||
|---|---|---|---|
| Description | Validates an academic time period. 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 time period and a record is found for that identifier, the validation checks if the academic time period 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 |
| AtpInfo | atpInfo | The academic time period information to be tested. | |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | ValidationResultInfoList | Results from performing the validation | |
| Errors | DoesNotExistException | validationTypeKey not found | |
| InvalidParameterException | invalid validationTypeKey, atpInfo | ||
| MissingParameterException | missing validationTypeKey, atpInfo | ||
| OperationFailedException | unable to complete request | ||
| Method | createAtp | ||
|---|---|---|---|
| Description | Creates a new Academic Time Period. | ||
| Parameters | String | atpKey | Key of ATP to be created |
| AtpInfo | atpInfo | Details of ATP to be created | |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | AtpInfo | Details of ATP just created | |
| Errors | AlreadyExistsException | ATP being created already exists | |
| DataValidationErrorException | One or more values invalid for this operation | ||
| InvalidParameterException | One or more parameters invalid | ||
| MissingParameterException | One or more parameters missing | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | updateAtp | ||
|---|---|---|---|
| Description | Updates an existing Academic Time Period. | ||
| Parameters | String | atpKey | Key of ATP to be updated |
| AtpInfo | atpInfo | Details of updates to ATP being updated | |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | AtpInfo | Details of ATP just updated | |
| Errors | DataValidationErrorException | One or more values invalid for this operation |
|
| DoesNotExistException | ATP being updated does not exist | ||
| 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 | deleteAtp | ||
|---|---|---|---|
| Description | Deletes an existing Academic Time Period. | ||
| Parameters | String | atpKey | the key of the ATP to be deleted |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | StatusInfo | status of the operation (success, failed) | |
| Errors | DoesNotExistException | ATP being deleted does not exist | |
| InvalidParameterException | One or more parameters invalid | ||
| MissingParameterException | One or more parameters missing | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | validateMilestone | ||
|---|---|---|---|
| Description | Validates a milestone. 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 milestone and a record is found for that identifier, the validation checks if the milestone 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 |
| MilestoneInfo | milestoneInfo | The milestone information to be tested. | |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | ValidationResultInfoList | Results from performing the validation | |
| Errors | DoesNotExistException | validationTypeKey not found | |
| InvalidParameterException | invalid validationTypeKey, milestoneInfo | ||
| MissingParameterException | missing validationTypeKey, milestoneInfo | ||
| OperationFailedException | unable to complete request | ||
| Method | createMilestone | ||
|---|---|---|---|
| Description | Create a new milestone. | ||
| Parameters | String | milestoneKey | the Id of milestone to be added |
| MilestoneInfo | milestoneInfo | Details of milestone to be added | |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | MilestoneInfo | Details of the newly created milestone | |
| Errors | AlreadyExistsException | Milestone already exists | |
| DataValidationErrorException | One or more values invalid for this operation |
||
| InvalidParameterException | One or more parameters invalid | ||
| MissingParameterException | One or more parameters missing | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | updateMilestone | ||
|---|---|---|---|
| Description | Updates an existing milestone. | ||
| Parameters | String | milestoneKey | the Id of milestone to be updated |
| MilestoneInfo | milestoneInfo | Details of milestone to be updated | |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | MilestoneInfo | Details of the updated milestone | |
| Errors | DataValidationErrorException | One or more values invalid for this operation |
|
| DoesNotExistException | Milestone being updated does not exist | ||
| 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.date |
||
| Method | deleteMilestone | ||
|---|---|---|---|
| Description | Deletes an existing milestone from all ATPs. | ||
| Parameters | String | milestoneKey | the Id of milestone to be removed |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | StatusInfo | status of the operation (success, failed) | |
| Errors | DoesNotExistException | Milestone being removed does not exist | |
| InvalidParameterException | One or more parameters invalid | ||
| MissingParameterException | One or more parameters missing | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getAtpMilestoneRelation | ||
|---|---|---|---|
| Description | Retrieves an ATP Milestone Relationship. | ||
| Parameters | String | atpMilestoneRelationId | Unique id of the atp milestone relation to be retrieved |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | AtpMilestoneRelationInfo | Details of requested Atp milestone relation | |
| Errors | DoesNotExistException | atpMilestoneRelationId not found | |
| InvalidParameterException | invalid atpMilestonerelationId | ||
| MissingParameterException | invalid atpMilestoneRelationId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getAtpMilestoneRelationsByAtp | ||
|---|---|---|---|
| Description | Retrieves all ATP Milestone Relationships by ATP. | ||
| Parameters | String | atpKey | Unique key of an ATP |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | AtpMilestoneRelationInfoList | a list of Atp milestone relationships | |
| Errors | DoesNotExistException | atpKey not found | |
| InvalidParameterException | invalid atpKey | ||
| MissingParameterException | invalid atpKey | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getAtpMilestoneRelationsByMilestone | ||
|---|---|---|---|
| Description | Retrieves all ATP Milestone Relationships by Milestone. | ||
| Parameters | String | milestoneKey | Unique key of a Milestone |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | AtpMilestoneRelationInfoList | a list of Atp milestone relationships | |
| Errors | DoesNotExistException | atpKey not found | |
| InvalidParameterException | invalid milestoneKey | ||
| MissingParameterException | invalid milestoneKey | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | validateAtpMilestoneRelation | ||
|---|---|---|---|
| Description | Validates an ATP/Milestone relationship. 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 relationship and a record is found for that identifier, the validation checks if the relationship 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 |
| AtpMilestoneRelationInfo | atpMilestoneRelationInfo | ??? | |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | ValidationResultInfoList | Results from performing the validation | |
| Errors | DoesNotExistException | validationTypeKey not found | |
| InvalidParameterException | invalid validationTypeKey, atpInfo | ||
| MissingParameterException | missing validationTypeKey, atpInfo | ||
| OperationFailedException | unable to complete request | ||
| Method | createAtpMilestoneRelation | ||
|---|---|---|---|
| Description | Adds a Milestone to an ATP by creating a relationship. | ||
| Parameters | AtpMilestoneRelationInfo | atpMilestoneRelationInfo | ??? |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | AtpMilestoneRelationInfo | status | |
| Errors | AlreadyExistsException | Milestone being added already exists | |
| InvalidParameterException | One or more parameters invalid | ||
| MissingParameterException | One or more parameters missing | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | updateAtpMilestoneRelation | ||
|---|---|---|---|
| Description | Updates an ATP Mielstone Relationship. | ||
| Parameters | String | atpMilestoneRelationId | the Id of the ATP Milestone Relation to be updated |
| AtpMilestoneRelationInfo | atpMilestoneRelationInfo | the ATP Milstone relation to be updated | |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | AtpMilestoneRelationInfo | status | |
| Errors | DataValidationErrorException | One or more values invalid for this operation |
|
| DoesNotExistException | Milestone does not exist | ||
| 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.date |
||
| Method | deleteAtpMilestoneRelation | ||
|---|---|---|---|
| Description | Removes an existing milestone from an ATP by deleting the relationship. | ||
| Parameters | String | atpMilestoneRelationId | ??? |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation |
|
| Return | StatusInfo | status of the operation (success, failed) | |
| Errors | DoesNotExistException | Milestone being removed does not exist | |
| InvalidParameterException | One or more parameters invalid | ||
| MissingParameterException | One or more parameters missing | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||