Skip Headers

Oracle® Student Learning Programmer's Guide Release 3.1.3 Part Number E20666-04 |
Home | Book List | Contents | Contact Us

Previous | Next
| PDF · Mobi · ePub

# 2 Web Services

This chapter describes the available web services and their descriptions.

## 2.1 DataLoadingPartyService

The DataLoadingPartyService is used to load party information. This includes institutions, institution groups, people and their relationships.

### 2.1.1 createInstitutions

This method creates new institutions. Note that the new institutions are created according to the order in which they are provided. For example, the first institution in the list is created followed by the second institution in the list.

All new institutions must have a parent institution. This parent institution must be an existing institution or created before it. In addition, under the same parent institution, the names of child institutions must be unique.

An institution should have only one primary address, email contact, and phone contact.

Parameter:

Table 2-1 createInstitutions Parameter Summary

Type | Description
--- | ---
InstitutionInfo[] | List of institutions to create

Return:

Table 2-2 createInstitutions Return Summary

Type | Description
--- | ---
InstitutionInfo[] | List of created institutions

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.1.2 createInstitutionGroups

This method creates new institution groups. The institution group name must be unique.

Parameter:

Table 2-3 createInstitutionGroups Parameter Summary

Type | Description
--- | ---
InstitutionGroupInfo[] | List of institution groups to create

Return:

Table 2-4 createInstitutionGroups Return Summary

Type | Description
--- | ---
InstitutionGroupInfo[] | List of created institution groups

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.1.3 createOrUpdateInstitutions

This method searches for the institutions using the IdInfo in the input InstitutionInfo and if the institution is found, it is updated; Otherwise, it is created. Note that the parent institution attribute cannot be updated.

Parameter:

Table 2-5 createOrUpdateInstitutions Parameter Summary

Type | Description
--- | ---
InstitutionInfo[] | List of institutions to create or update

Return:

Table 2-6 createOrUpdateInstitutions Return Summary

Type | Description
--- | ---
InstitutionInfo[] | List of institutions created or updated

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.1.4 createOrUpdateInstitutionGroups

This method searches for the institution groups using the IdInfo in the input InstitutionGroupInfo and if the institution group is found, it is updated; Otherwise, it is created.

Note:

Only Create and Delete actions are allowed in the IdInfoActionInfo.

Parameter:

Table 2-7 createOrUpdateInstitutionGroups Parameter Summary

Type | Description
--- | ---
InstitutionGroupInfo[] | List of institution groups to create or update

Return:

Table 2-8 createOrUpdateInstitutionGroups Return Summary

Type | Description
--- | ---
InstitutionGroupInfo[] | List of institution groups created or updated

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.1.5 createOrUpdatePersons

This method searches for the persons using the IdInfo in the input PersonInfo and if the person is found, it is updated; Otherwise, it is created.

Parameter:

Table 2-9 createOrUpdatePersons Parameter Summary

Type | Description
--- | ---
PersonInfo[] | List of persons to create or update

Return:

Table 2-10 createOrUpdatePersons Return Summary

Type | Description
--- | ---
PersonInfo[] | List of persons created or updated

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.1.6 createPersons

This method creates new persons. A person should have only one primary address, email contact, and phone contact.

Parameter:

Table 2-11 createPersons Parameter Summary

Type | Description
--- | ---
PersonInfo[] | List of persons to create

Return:

Table 2-12 createPersons Return Summary

Type | Description
--- | ---
PersonInfo[] | List of created persons

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.1.7 getDepartment

This method returns the department.

Parameter:

None.

Return:

Table 2-13 getDepartment Return Summary

Type | Description
--- | ---
InstitutionInfo | Department

Exception:

ServiceException

### 2.1.8 getInstitutions

This method finds all the institutions using the IdInfo in the input InstitutionInfo and returns the complete InstitutionInfo including the ContactInfos and AddressInfos.

If the specified institution is not found in the system, no record is returned.

Parameter:

Table 2-14 getInstitutions Parameter Summary

Type | Description
--- | ---
InstitutionInfo[] | List of institutions to retrieve

Return:

Table 2-15 getInstitutions Return Summary

Type | Description
--- | ---
InstitutionInfo[] | List of institutions retrieved

Exception:

InvalidParameters, ServiceException

### 2.1.9 getInstitutionGroups

This method finds all the institution groups using the IdInfo in the input InstitutionGroupInfo and returns the complete InstitutionGroupInfo.

If the specified institution group is not found in the system, no record is returned.

Parameter:

Table 2-16 getInstitutionGroups Parameter Summary

Type | Description
--- | ---
InstitutionGroupInfo[] | List of institution groups to retrieve

Return:

Table 2-17 getInstitutionGroups Return Summary

Type | Description
--- | ---
InstitutionGroupInfo[] | List of institution groups retrieved

Exception:

InvalidParameters, ServiceException

### 2.1.10 getPersons

This method finds all the persons using the IdInfo in the input PersonInfo and returns the complete PersonInfo including the LanguageInfos, ContactInfos, and AddressInfos.

If the specified person is not found in the system, no record is returned.

Parameter:

Table 2-18 getPersons Parameter Summary

Type | Description
--- | ---
PersonInfo[] | List of persons to retrieve

Return:

Table 2-19 getPersons Return Summary

Type | Description
--- | ---
PersonInfo[] | List of persons retrieved

Exception:

InvalidParameters, ServiceException

### 2.1.11 updateInstitutions

This method searches for the institutions using the IdInfo in the input InstitutionInfo and updates the institutions with the specified attributes. Note that the parent institution cannot be updated.

Parameter:

Table 2-20 updateInstitutions Parameter Summary

Type | Description
--- | ---
InstitutionInfo[] | List of institutions to update

Return:

Table 2-21 updateInstitutions Return Summary

Type | Description
--- | ---
InstitutionInfo[] | List of updated institutions

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.1.12 updateInstitutionGroups

This method searches for the institution groups using the IdInfo in the input InstitutionGroupInfo and updates the institution groups with the specified attributes.

Note:

Only Create and Delete actions are allowed in the IdInfoActionInfo.

Parameter:

Table 2-22 updateInstitutionGroups Parameter Summary

Type | Description
--- | ---
InstitutionGroupInfo[] | List of institution groups to update

Return:

Table 2-23 updateInstitutionGroups Return Summary

Type | Description
--- | ---
InstitutionGroupInfo[] | List of updated institution groups

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.1.13 updatePersons

This method searches for the persons using the IdInfo in the input PersonInfo and updates the persons with the specified attributes.

Parameter:

Table 2-24 updatePersons Parameter Summary

Type | Description
--- | ---
PersonInfo[] | List of persons to update

Return:

Table 2-25 updatePersons Return Summary

Type | Description
--- | ---
PersonInfo[] | List of updated persons

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

## 2.2 DataLoadingCourseService

The DataLoadingCourseService is used to load course, course tags, offerings, and class information.

### 2.2.1 createClasses

This method creates new classes unique within the context of the associated offering. In addition, note the following:

- The students and teachers enrolled in the class must come from the same school as the class

- The start date of both the student enrollments and teacher enrollments must be on or after the start date of the class

- The end date of both the student enrollments and teacher enrollments must be on or before the end date of the class

- The start and end dates of the class must be within the start and end dates of the offering.

- The offering must belong to the school of the class.

Parameter:

Table 2-26 createClasses Parameter Summary

Type | Description
--- | ---
ClassInfo[] | List of classes to create

Return:

Table 2-27 createClasses Return Summary

Type | Description
--- | ---
ClassInfo[] | List of created classes

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.2.2 createCourses

This method creates new courses. Within a school, the course name and code must be unique. The tags attached to the course must also come from the same school.

Parameter:

Table 2-28 createCourses Parameter Summary

Type | Description
--- | ---
CourseInfo[] | List of courses to create

Return:

Table 2-29 createCourses Return Summary

Type | Description
--- | ---
CourseInfo[] | List of created courses

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.2.3 createOfferings

This method creates new offerings. Within a school, the offering name and code must be unique within the calendar. In addition, note the following:

- The framework specified must be adopted by the school.

- The course specified must belong to the same school as the offering.

- The calendar of the offering must be the calendar of the adopted framework or one of its sub-calendars.

- The start and end dates of the offering must be between the start and end dates of the calendar.

- There can only be one offering for a course, framework, and calendar combination and if the class is found.

- The calendar must be one of the adopted calendars of the school, or one of their sub-calendars.

Parameter:

Table 2-30 createOfferings Parameter Summary

Type | Description
--- | ---
OfferingInfo[] | List of offerings to create

Return:

Table 2-31 createOfferings Return Summary

Type | Description
--- | ---
OfferingInfo[] | List of created offerings

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.2.4 createOrUpdateClasses

This method searches for the classes using the IdInfo in the input ClassInfo and if class is found, it is updated; Otherwise, it is created. The restrictions in createClasses and updateClasses are also applicable here.

Parameter:

Table 2-32 createOrUpdateClasses Parameter Summary

Type | Description
--- | ---
ClassInfo[] | List of classes to create or update

Return:

Table 2-33 createOrUpdateClasses Return Summary

Type | Description
--- | ---
ClassInfo[] | List of classes created or updated

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.2.5 createOrUpdateCourses

This method searches for the courses using the IdInfo in the input CourseInfo and if the course is found, it is updated; Otherwise, it is created. Note that the institution of the course cannot be updated.

Parameter:

Table 2-34 createOrUpdateCourses Parameter Summary

Type | Description
--- | ---
CourseInfo[] | List of courses to create or update

Return:

Table 2-35 createOrUpdateCourses Return Summary

Type | Description
--- | ---
CourseInfo[] | List of courses created or updated

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.2.6 createOrUpdateOfferings

This method searches for the offerings using the IdInfo in the input OfferingInfo and if the offering is found, it is updated; Otherwise, it is created. The restrictions for createOfferings and updateOfferings are also applicable here.

Parameter:

Table 2-36 createOrUpdateOfferings Parameter Summary

Type | Description
--- | ---
OfferingInfo[] | List of offerings to create or update

Return:

Table 2-37 createOrUpdateOfferings Return Summary

Type | Description
--- | ---
OfferingInfo[] | List of offerings created or updated

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.2.7 createOrUpdateTags

This method searches for the tags using the IdInfo in the input TagInfo and if the tag is found, it is updated; Otherwise, it is created.

Parameter:

Table 2-38 createOrUpdateTags Parameter Summary

Type | Description
--- | ---
TagInfo[] | List of tags to create or update

Return:

Table 2-39 createOrUpdateTags Return Summary

Type | Description
--- | ---
TagInfo[] | List of tags created or updated

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.2.8 createTags

This method creates new tags. Within a school, the tag name must be unique.

Parameter:

Table 2-40 createTags Parameter Summary

Type | Description
--- | ---
TagInfo[] | List of tags to create

Return:

Table 2-41 createTags Return Summary

Type | Description
--- | ---
TagInfo[] | List of created tags

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.2.9 getClasses

This method finds all the classes using the IdInfo in the input ClassInfo and returns the complete ClassInfo.

If the specified class is not found in the system, no record is returned.

Parameter:

Table 2-42 getClasses Parameter Summary

Type | Description
--- | ---
ClassInfo[] | List of classes to retrieve

Return:

Table 2-43 getClasses Return Summary

Type | Description
--- | ---
ClassInfo[] | List of classes retrieved

Exception:

InvalidParameters, ServiceException

### 2.2.10 getCourses

This method finds all the courses using the IdInfo in the input CourseInfo and returns the complete CourseInfo.

If the specified course is not found in the system, no record is returned.

Parameter:

Table 2-44 getCourses Parameter Summary

Type | Description
--- | ---
CourseInfo[] | List of courses to retrieve

Return:

Table 2-45 getCourses Return Summary

Type | Description
--- | ---
CourseInfo[] | List of courses retrieved

Exception:

InvalidParameters, ServiceException

### 2.2.11 getOfferings

This method finds all the offerings using the IdInfo in the input OfferingInfo and returns the complete OfferingInfo.

If the specified offering is not found in the system, no record is returned.

Parameter:

Table 2-46 getOfferings Parameter Summary

Type | Description
--- | ---
OfferingInfo[] | List of offerings to retrieve

Return:

Table 2-47 getOfferings Return Summary

Type | Description
--- | ---
OfferingInfo[] | List of offerings retrieved

Exception:

InvalidParameters, ServiceException

### 2.2.12 getTags

This method finds all the tags using the IdInfo in the input TagInfo and returns the complete TagInfo.

If the specified tag is not found in the system, no record is returned.

Parameter:

Table 2-48 getTags Parameter Summary

Type | Description
--- | ---
TagInfo[] | List of tags to retrieve

Return:

Table 2-49 getTags Return Summary

Type | Description
--- | ---
TagInfo[] | List of tags retrieved

Exception:

InvalidParameters, ServiceException

### 2.2.13 updateClasses

This method searches for the classes using the IdInfo in the input ClassInfo and updates the classes with the specified attributes. The offering and school of the class cannot be updated. In addition, enrollments cannot be changed if the class is end-dated. Removing teacher enrollments and student enrollments are also prohibited if there is one or more learning items created in the class lesson plan.

Parameter:

Table 2-50 updateClasses Parameter Summary

Type | Description
--- | ---
ClassInfo[] | List of classes to update

Return:

Table 2-51 updateClasses Return Summary

Type | Description
--- | ---
ClassInfo[] | List of updated classes

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.2.14 updateCourses

This method searches for the courses using the IdInfo in the input CourseInfo and updates the course with the specified attributes. Note that the institution of the course cannot be updated.

Parameter:

Table 2-52 updateCourses Parameter Summary

Type | Description
--- | ---
CourseInfo[] | List of courses to update

Return:

Table 2-53 updateCourses Return Summary

Type | Description
--- | ---
CourseInfo[] | List of updated courses

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.2.15 updateOfferings

This method searches for the offerings using the IdInfo in the input OfferingInfo and updates the offering with the specified attributes. Note that the calendar, course, framework, and school cannot be updated.

Parameter:

Table 2-54 updateOfferings Parameter Summary

Type | Description
--- | ---
OfferingInfo[] | List of offerings to update

Return:

Table 2-55 updateOfferings Return Summary

Type | Description
--- | ---
OfferingInfo[] | List of updated offerings

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.2.16 updateTags

This method searches for the tags using the IdInfo in the input TagInfo and updates the tag with the specified attributes.

Parameter:

Table 2-56 updateTags Parameter Summary

Type | Description
--- | ---
TagInfo[] | List of tags to update

Return:

Table 2-57 updateTags Return Summary

Type | Description
--- | ---
TagInfo[] | List of updated tags

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.2.17 removeClasses

This method finds all the classes using the IdInfo in the input ClassInfo and removes it. A class cannot be removed if there are enrollments in the class.

Parameter:

Table 2-58 removeClasses Parameter Summary

Type | Description
--- | ---
ClassInfo[] | List of classes to remove

Return:

Table 2-59 removeClasses Return Summary

Type | Description
--- | ---
ClassInfo[] | List of removed classes

Exception:

DataConstraintException, InvalidParameters, RemoveException, ServiceException

### 2.2.18 removeCourses

This method finds all the courses using the IdInfo in the input CourseInfo and removes them. If a course is referenced by an offering, then it cannot be removed.

Parameter:

Table 2-60 removeCourses Parameter Summary

Type | Description
--- | ---
CourseInfo[] | List of courses to remove

Return:

Table 2-61 removeCourses Return Summary

Type | Description
--- | ---
CourseInfo[] | List of removed courses

Exception:

DataConstraintException, InvalidParameters, RemoveException, ServiceException

### 2.2.19 removeOfferings

This method finds all the offerings using the IdInfo in the input OfferingInfo and removes them. An offering cannot be removed if there are any classes referencing it.

Parameter:

Table 2-62 removeOfferings Parameter Summary

Type | Description
--- | ---
OfferingInfo[] | List of offerings to remove

Return:

Table 2-63 removeOfferings Return Summary

Type | Description
--- | ---
OfferingInfo[] | List of removed offerings

Exception:

DataConstraintException, InvalidParameters, RemoveException, ServiceException

### 2.2.20 removeTags

This method finds all the tags using the IdInfo in the input TagInfo and removes them. If a tag is used in any course, it cannot be removed.

Parameter:

Table 2-64 removeTags Parameter Summary

Type | Description
--- | ---
TagInfo[] | List of tags to remove

Return:

Table 2-65 removeTags Return Summary

Type | Description
--- | ---
TagInfo[] | List of removed tags

Exception:

DataConstraintException, InvalidParameters, RemoveException, ServiceException

## 2.3 DataLoadingCalendarService

The DataLoadingCalendarService is used to load calendar information and also to adopt department calendars.

### 2.3.1 adoptCalendars

This method adopts a department calendar for use at a school. Only department calendars can be adopted. A calendar can only be adopted by a school once. Note that the parent calendar has to be adopted before the sub-calendars can be adopted.

Parameter:

Table 2-66 adoptCalendars Parameter Summary

Type | Description
--- | ---
AdoptCalendarInfo[] | List of department calendars to adopt

Return:

Table 2-67 adoptCalendars Return Summary

Type | Description
--- | ---
CalendarInfo[] | List of school calendars

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.3.2 createCalendars

This method creates new calendars. The calendar name must be unique within an institution. For a sub-calendar, the sub-calendar name must be unique under the parent calendar. Note that the start and end date of a sub-calendar must not exceed the start and end date of the parent calendar.

Parameter:

Table 2-68 createCalendars Parameter Summary

Type | Description
--- | ---
CalendarInfo[] | List of calendars to create

Return:

Table 2-69 createCalendars Return Summary

Type | Description
--- | ---
CalendarInfo[] | List of created calendars

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.3.3 createOrUpdateCalendars

This method searches for the calendars using the IdInfo in the input CalendarInfo and if a calendar is found, it is updated; Otherwise, it is created. The restrictions in createCalendars and updateCalendars are also applicable here.

Parameter:

Table 2-70 createOrUpdateCalendars Parameter Summary

Type | Description
--- | ---
CalendarInfo[] | List of calendars to create or update

Return:

Table 2-71 createOrUpdateCalendars Return Summary

Type | Description
--- | ---
CalendarInfo[] | List of calendars created or updated

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.3.4 getCalendars

This method finds all the calendars using the IdInfo in the input CalendarInfo and returns the complete CalendarInfo.

If the specified calendar is not found in the system, no record is returned.

Parameter:

Table 2-72 getCalendars Parameter Summary

Type | Description
--- | ---
CalendarInfo[] | List of calendars to retrieve

Return:

Table 2-73 getCalendars Return Summary

Type | Description
--- | ---
CalendarInfo[] | List of calendars retrieved

Exception:

InvalidParameters, ServiceException

### 2.3.5 updateCalendars

This method searches for the calendars using the IdInfo in the input CalendarInfo and updates the calendars with the specified attributes.

Note that the parent calendar association cannot be updated.

Parameter:

Table 2-74 updateCalendars Parameter Summary

Type | Description
--- | ---
CalendarInfo[] | List of calendars to update

Return:

Table 2-75 updateCalendars Return Summary

Type | Description
--- | ---
CalendarInfo[] | List of updated calendars

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.3.6 removeCalendars

This method finds all the calendars using the IdInfo in the input CalendarInfo and removes them. When a calendar is removed, all the sub-calendars under it are also removed. However, a school calendar cannot be removed if it is referenced in a framework adoption or an offering.

Parameter:

Table 2-76 removeCalendars Parameter Summary

Type | Description
--- | ---
CalendarInfo[] | List of calendars to remove

Return:

Table 2-77 removeCalendars Return Summary

Type | Description
--- | ---
CalendarInfo[] | List of removed calendars

Exception:

DataConstraintException, InvalidParameters, RemoveException, ServiceException

## 2.4 DataLoadingCurriculumService

The DataLoadingCurriculumService is used to load framework and framework-related information such as framework items, blueprint nodes, and proficiency sets.

### 2.4.1 createBlueprintHieararchies

This method creates a new blueprint node hierarchy. A blueprint node with no parent blueprint node is created as the root blueprint node. There can only be one root blueprint node for a framework. Framework node names must be unique within a framework. Framework node start and end dates must be between the start and end dates of both the parent framework node and the framework.

Note:

All blueprint nodes directly or indirectly under the root blueprint node are created in the same framework as specified in the framework of the root blueprint node.

Parameter:

Table 2-78 createBlueprintHieararchies Parameter Summary

Type | Description
--- | ---
BlueprintNodeInfo[] | List of blueprint nodes to create

Return:

Table 2-79 createBlueprintHieararchies Return Summary

Type | Description
--- | ---
BlueprintNodeInfo[] | List of created blueprint nodes

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.4.2 createContexts

This method creates new contexts. Contexts with no parent context specified are created as department contexts. Contexts with parent context specified are created as school contexts. School contexts cannot have child contexts.

Parameter:

Table 2-80 createContexts Parameter Summary

Type | Description
--- | ---
ContextInfo[] | List of contexts to create

Return:

Table 2-81 createContexts Return Summary

Type | Description
--- | ---
ContextInfo[] | List of created contexts

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.4.3 createOrUpdateBlueprintHieararchies

This method searches for the blueprint nodes using the IdInfo in the input BlueprintNodeInfo and if the blueprint node is found, it is updated; Otherwise, it is created. The restrictions in createBlueprintHierarchies and updateBlueprintHierarchies are also applicable here.

Parameter:

Table 2-82 createOrUpdateBlueprintHieararchies Parameter Summary

Type | Description
--- | ---
BlueprintNodeInfo[] | List of blueprint nodes to create or update

Return:

Table 2-83 createOrUpdateBlueprintHieararchies Return Summary

Type | Description
--- | ---
BlueprintNodeInfo[] | List of blueprint nodes created or updated

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.4.4 createOrUpdateContexts

This method searches for the contexts using the IdInfo in the input ContextInfo and if a context is found, it is updated; Otherwise, it is created.

The restrictions in createContexts and updateContexts are applicable here.

Parameter:

Table 2-84 createOrUpdateContexts Parameter Summary

Type | Description
--- | ---
ContextInfo[] | List of contexts to create or update

Return:

Table 2-85 createOrUpdateContexts Return Summary

Type | Description
--- | ---
ContextInfo[] | List of contexts created or updated

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.4.5 createorUpdateOutcomeStatementDescriptorType

This method searches for the outcome statement descriptor types using the IdInfo in the input OutcomeStatementDescTypeInfo and if an outcome statement descriptor type is found, it is updated; Otherwise, it is created.

The restrictions in createOutcomeStatementDescTypes and updateOutcomeStatementDescTypes are applicable here.

Parameter:

Table 2-86 createorUpdateOutcomeStatementDescriptorType Parameter Summary

Type | Description
--- | ---
OutcomeStatementDescTypeInfo[] | List of outcome statement descriptor types to create or update

Return:

Table 2-87 createorUpdateOutcomeStatementDescriptorType Return Summary

Type | Description
--- | ---
OutcomeStatementDescTypeInfo[] | List of outcome statement descriptor types created or updated

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.4.6 createOrUpdateOutcomeStatements

This method searches for the outcome statements using the IdInfo in the input OutcomeStatementInfo and if the outcome statement is found, it is updated; Otherwise, it is created.

The restrictions in createOutcomeStatements and updateOutcomeStatements are also applicable here.

Parameter:

Table 2-88 createOrUpdateOutcomeStatements Parameter Summary

Type | Description
--- | ---
OutcomeStatementInfo[] | List of outcome statements to create or update

Return:

Table 2-89 createOrUpdateOutcomeStatements Return Summary

Type | Description
--- | ---
OutcomeStatementInfo[] | List of outcome statements created or updated

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.4.7 createOutcomeStatements

This method creates new outcome statements. The proficiency level specified must be from the outcome proficiency set associated with the specified framework item. Also, this proficiency level must not be a proficiency sub-level (For example, a proficiency level with a parent proficiency level).

Outcome statement names must be unique within a framework item. Demonstrable outcome statements must have an associated proficiency level. Indicative outcome statements must not have an associated proficiency level. The start and end dates of the outcome statement must be between those of the framework item.

Parameter:

Table 2-90 createOutcomeStatements Parameter Summary

Type | Description
--- | ---
OutcomeStatementInfo[] | List of outcome statements to create

Return:

Table 2-91 createOutcomeStatements Return Summary

Type | Description
--- | ---
OutcomeStatementInfo[] | List of created outcome statements

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.4.8 createOutcomeStatementDescriptorType

This method creates new outcome statement descriptor types. Within a framework, the outcome statement descriptor type name must be unique.

Parameter:

Table 2-92 createOutcomeStatementDescriptorType Parameter Summary

Type | Description
--- | ---
OutcomeStatementDescTypeInfo[] | List of outcome statement descriptor types to create

Return:

Table 2-93 createOutcomeStatementDescriptorType Return Summary

Type | Description
--- | ---
OutcomeStatementDescTypeInfo[] | List of created outcome statement descriptor types

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.4.9 createFrameworks

This method creates new Frameworks. The name of each framework must be unique in the system.

Parameter:

Table 2-94 createFrameworks Parameter Summary

Type | Description
--- | ---
FrameworkInfo[] | List of frameworks to create

Return:

Table 2-95 createFrameworks Return Summary

Type | Description
--- | ---
FrameworkInfo[] | List of created frameworks

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.4.10 createFrameworkItemHieararchies

This method creates new Framework Item Hierarchies. A framework item with no parent framework item is created as the top level framework item. The blueprint node of top level framework item is set to the root blueprint node.

Note the following:

- The outcome proficiency set, if specified, must belong to the same framework as the framework item

- The specified blueprint node must belong to the same framework as the framework item

- The framework item must be aligned to the specified blueprint node. (For example, the specified blueprint node must be the child of the blueprint node of the parent framework item)

- Framework item codes must be unique within a framework.

- If a framework item's "Confirming Level" flag is set, then a proficiency set must be specified.

- A framework item's start and end dates must be between those of the blueprint node and the parent framework item.

Parameter:

Table 2-96 createFrameworkItemHieararchies Parameter Summary

Type | Description
--- | ---
FrameworkItemInfo[] | List of framework items to create

Return:

Table 2-97 createFrameworkItemHieararchies Return Summary

Type | Description
--- | ---
FrameworkItemInfo[] | List of created framework items

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.4.11 createOrUpdateFrameworkItemHieararchies

This method searches for the Framework item nodes using the IdInfo in the input FrameworkItemInfo and if a framework item is found, it is updated; Otherwise, it is created. The restrictions in createFrameworkItemHierarchies and updateFrameworkItemHierarchies are also applicable here.

Parameter:

Table 2-98 createOrUpdateFrameworkItemHieararchies Parameter Summary

Type | Description
--- | ---
FrameworkItemInfo[] | List of framework items to create or update

Return:

Table 2-99 createOrUpdateFrameworkItemHieararchies Return Summary

Type | Description
--- | ---
FrameworkItemInfo[] | List of framework items created or updated

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.4.12 createOrUpdateFrameworks

This method searches for the frameworks using the IdInfo in the input FrameworkInfo and if a framework is found, it is updated; Otherwise, it is created.

Parameter:

Table 2-100 createOrUpdateFrameworks Parameter Summary

Type | Description
--- | ---
FrameworkInfo[] | List of frameworks to create or update

Return:

Table 2-101 createOrUpdateFrameworks Return Summary

Type | Description
--- | ---
FrameworkInfo[] | List of frameworks created or updated

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.4.13 createOrUpdateProficiencySets

This method searches for the proficiency sets using the IdInfo in the input ProficiencySetInfo and if a proficiency set is found, it is updated; Otherwise, it is created. The restrictions in createProficiencySets and updateProficiencySets are also applicable here.

Parameter:

Table 2-102 createOrUpdateProficiencySets Parameter Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of proficiency sets to create or update

Return:

Table 2-103 createOrUpdateProficiencySets Return Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of proficiency sets created or updated

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.4.14 createProficiencySets

This method creates new outcome proficiency sets. Note that the outcome proficiency levels can have at most only one level of parent/child relationship. For example, an outcome proficiency level can have one or more proficiency sub-levels as its child, but the proficiency sub-levels cannot have subordinate proficiency levels.

In addition, within an outcome proficiency set, all proficiency level names must be unique. Every proficiency set with a framework must have a unique name. The start and end dates of a proficiency set must be between those of the framework.

Parameter:

Table 2-104 createProficiencySets Parameter Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of outcome proficiency sets to create

Return:

Table 2-105 createProficiencySets Return Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of created outcome proficiency sets

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.4.15 getBlueprintHieararchies

This method finds all the blueprint nodes using the IdInfo in the input BlueprintNodeInfo and returns the complete BlueprintNodeInfo including the child blueprint nodes.If the specified blueprint node is not found in the system, no record is returned.

Parameter:

Table 2-106 getBlueprintHieararchies Parameter Summary

Type | Description
--- | ---
BlueprintNodeInfo[] | List of blueprint nodes to retrieve

Return:

Table 2-107 getBlueprintHieararchies Return Summary

Type | Description
--- | ---
BlueprintNodeInfo[] | List of blueprint nodes retrieved

Exception:

InvalidParameters, ServiceException

### 2.4.16 getContexts

This method finds all the contexts using the IdInfo in the input ContextInfo and returns the complete ContextInfo.

If the specified context is not found in the system, no record is returned.

Parameter:

Table 2-108 getContexts Parameter Summary

Type | Description
--- | ---
ContextInfo[] | List of contexts to retrieve

Return:

Table 2-109 getContexts Return Summary

Type | Description
--- | ---
ContextInfo[] | List of contexts retrieved

Exception:

InvalidParameters, ServiceException

### 2.4.17 getFrameworks

This method finds all the frameworks using the IdInfo in the input FrameworkInfo and returns the complete FrameworkInfo.

If the specified framework is not found in the system, no record is returned.

Parameter:

Table 2-110 getFrameworks Parameter Summary

Type | Description
--- | ---
FrameworkInfo[] | List of frameworks to retrieve

Return:

Table 2-111 getFrameworks Return Summary

Type | Description
--- | ---
FrameworkInfo[] | List of frameworks retrieved

Exception:

InvalidParameters, ServiceException

### 2.4.18 getFrameworkItemHieararchies

This method finds all the framework item nodes using the IdInfo in the input FrameworkItemInfo and returns the complete FrameworkItemInfo including child framework items.If the specified framework item is not found in the system, no record is returned.

Parameter:

Table 2-112 getFrameworkItemHieararchies Parameter Summary

Type | Description
--- | ---
FrameworkItemInfo[] | List of framework items to retrieve

Return:

Table 2-113 getFrameworkItemHieararchies Return Summary

Type | Description
--- | ---
FrameworkItemInfo[] | List of framework items retrieved

Exception:

InvalidParameters, ServiceException

### 2.4.19 getOutcomeStatements

This method finds all the outcome statements using the IdInfo in the input OutcomeStatementInfo and returns the complete OutcomeStatementInfo.

If the specified outcome statement is not found in the system, no record is returned.

Parameter:

Table 2-114 getOutcomeStatements Parameter Summary

Type | Description
--- | ---
OutcomeStatementInfo[] | List of outcome statements to retrieve

Return:

Table 2-115 getOutcomeStatements Return Summary

Type | Description
--- | ---
OutcomeStatementInfo[] | List of outcome statements retrieved

Exception:

InvalidParameters, ServiceException

### 2.4.20 getOutcomeStatementDescriptorType

This method finds all the outcome statement descriptor types using the IdInfo in the input OutcomeStatementDescTypeInfo and returns the OutcomeStatementDescTypeInfo.

If the specified outcome statement descriptor type is not found in the system, no record is returned.

Parameter:

Table 2-116 getOutcomeStatementDescriptorType Parameter Summary

Type | Description
--- | ---
OutcomeStatementDescTypeInfo[] | List of outcome statement descriptor types to retrieve

Return:

Table 2-117 getOutcomeStatementDescriptorType Return Summary

Type | Description
--- | ---
OutcomeStatementDescTypeInfo[] | List of outcome statement descriptor types retrieved

Exception:

InvalidParameters, ServiceException

### 2.4.21 getProficiencySets

This method finds all the outcome proficiency sets using the IdInfo in the input ProficiencySetInfo and returns the complete ProficiencySetInfo.

If the specified outcome proficiency set is not found in the system, no record is returned.

Parameter:

Table 2-118 getProficiencySets Parameter Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of proficiency sets to retrieve

Return:

Table 2-119 getProficiencySets Return Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of proficiency sets retrieved

Exception:

InvalidParameters, ServiceException

### 2.4.22 loadFramework

This method loads the entire framework data. This includes:

- Create the framework and set up the institution and group availability

- Create the blueprint node hieararchy

- Create the proficiency sets

- Create the outcome statement descriptor types

- Create the framework item hieararchy

- Create the outcome statements

- Create the contexts

- If the framework is to be published, it is pubslihed

The restrictions in createFrameworks, createBlueprintHierarchies, createProficiencySets, createOutcomeStatementDescTypes, createFrameworkItemHierarchies, createOutcomeStatements, createContexts, and publishFrameworks are still applicable.

Parameter:

Table 2-120 loadFramework Parameter Summary

Type | Description
--- | ---
FrameworkLoadInfo | Framework to create

Return:

Table 2-121 loadFramework Return Summary

Type | Description
--- | ---
FrameworkLoadInfo | Created framework

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.4.23 removeBlueprintHieararchies

This method finds all the blueprint nodes using the IdInfo in the input BlueprintNodeInfo and removes them. Any subordinate nodes are also deleted. If the blueprint node is associated with a framework item, then it is not allowed to be deleted.

Parameter:

Table 2-122 removeBlueprintHieararchies Parameter Summary

Type | Description
--- | ---
BlueprintNodeInfo[] | List of blueprint nodes to remove

Return:

Table 2-123 removeBlueprintHieararchies Return Summary

Type | Description
--- | ---
BlueprintNodeInfo[] | List of removed blueprint nodes

Exception:

DataConstraintException, InvalidParameters, RemoveException, ServiceException

### 2.4.24 removeContexts

This method finds all the contexts using the IdInfo in the input ContextInfo and removes them. Any subordinate context are also deleted. However, a context cannot be deleted if the context has been adopted by any school.

Parameter:

Table 2-124 removeContexts Parameter Summary

Type | Description
--- | ---
ContextInfo[] | List of contexts to remove

Return:

Table 2-125 removeContexts Return Summary

Type | Description
--- | ---
ContextInfo[] | List of removed contexts

Exception:

DataConstraintException, InvalidParameters, RemoveException, ServiceException

### 2.4.25 removeFrameworks

This method finds all the frameworks using the IdInfo in the input FrameworkInfo and removes them and all framework-related entities such as outcome proficiency sets, blueprint nodes, framework items, outcome statements and contexts. A framework cannot be removed if it has been adopted by a school.

All restrictions in removeFrameworkItemHierarchies, removeBlueprintHierarchies, removeOutcomeStatementDescTypes, removeProficiencySets, removeOutcomeStatements, and removeContexts are still applicable.

Parameter:

Table 2-126 removeFrameworks Parameter Summary

Type | Description
--- | ---
FrameworkInfo[] | List of frameworks to remove

Return:

Table 2-127 removeFrameworks Return Summary

Type | Description
--- | ---
FrameworkInfo[] | List of removed frameworks

Exception:

DataConstraintException, InvalidParameters, RemoveException, ServiceException

### 2.4.26 removeFrameworkItemHieararchies

This method finds all the Framework item nodes using the IdInfo in the input FrameworkItemInfo and removes them. All subordinate framework items are also deleted. A framework item cannot be deleted if it is associated with any learning item, demonstration or confirmation.

Parameter:

Table 2-128 removeFrameworkItemHieararchies Parameter Summary

Type | Description
--- | ---
FrameworkItemInfo[] | List of framework items to remove

Return:

Table 2-129 removeFrameworkItemHieararchies Return Summary

Type | Description
--- | ---
FrameworkItemInfo[] | List of removed framework items

Exception:

DataConstraintException, InvalidParameters, RemoveException, ServiceException

### 2.4.27 removeOutcomeStatements

This method finds all the outcome statements using the IdInfo in the input OutcomeStatementInfo and removes them. Any associated outcome statement descriptors are also deleted. If the outcome statement is associated with any learning item or assessments (confirmations or demonstrations), it cannot be deleted.

Parameter:

Table 2-130 removeOutcomeStatements Parameter Summary

Type | Description
--- | ---
OutcomeStatementInfo[] | List of outcome statements to remove

Return:

Table 2-131 removeOutcomeStatements Return Summary

Type | Description
--- | ---
OutcomeStatementInfo[] | List of removed outcome statements

Exception:

DataConstraintException, InvalidParameters, RemoveException, ServiceException

### 2.4.28 removeOutcomeStatementDescriptorType

This method finds all the outcome statements descriptor types using the IdInfo in the input OutcomeStatementDescTypeInfo and removes them. An outcome statement descriptor type cannot be deleted if it is being used in an outcome statement descriptor.

Parameter:

Table 2-132 removeOutcomeStatementDescriptorType Parameter Summary

Type | Description
--- | ---
OutcomeStatementDescTypeInfo[] | List of outcome statement descriptor types to remove

Return:

Table 2-133 removeOutcomeStatementDescriptorType Return Summary

Type | Description
--- | ---
OutcomeStatementDescTypeInfo[] | List of removed outcome statement descriptor types

Exception:

DataConstraintException, InvalidParameters, RemoveException, ServiceException

### 2.4.29 removeProficiencySets

This method finds all the proficiency sets using the IdInfo in the input ProficiencySetInfo and removes them. Any associated proficiency levels are also deleted. If the proficiency set is associated with a framework item, then it is not allowed to be deleted.

Parameter:

Table 2-134 removeProficiencySets Parameter Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of outcome proficiency sets to remove

Return:

Table 2-135 removeProficiencySets Return Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of removed outcome proficiency sets

Exception:

DataConstraintException, InvalidParameters, RemoveException, ServiceException

### 2.4.30 updateBlueprintHieararchies

This method searches for the blueprint nodes using the IdInfo in the input BlueprintNodeInfo and updates the blueprint nodes with the specified attributes. Note that the parent/child relationship of a blueprint node cannot be updated. In addition, the framework of a blueprint node cannot be updated.

Parameter:

Table 2-136 updateBlueprintHieararchies Parameter Summary

Type | Description
--- | ---
BlueprintNodeInfo[] | List of blueprint nodes to update

Return:

Table 2-137 updateBlueprintHieararchies Return Summary

Type | Description
--- | ---
BlueprintNodeInfo[] | List of updated blueprint nodes

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.4.31 updateContexts

This method searches for the contexts using the IdInfo in the input ContextInfo and updates the contexts with the specified attributes. Note that the framework item cannot be updated.

Parameter:

Table 2-138 updateContexts Parameter Summary

Type | Description
--- | ---
ContextInfo[] | List of contexts to update

Return:

Table 2-139 updateContexts Return Summary

Type | Description
--- | ---
ContextInfo[] | List of updated contexts

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.4.32 updateFrameworks

This method searches for the frameworks using the IdInfo in the input FrameworkInfo and updates the frameworks with the specified attributes.

Parameter:

Table 2-140 updateFrameworks Parameter Summary

Type | Description
--- | ---
FrameworkInfo[] | List of frameworks to update

Return:

Table 2-141 updateFrameworks Return Summary

Type | Description
--- | ---
FrameworkInfo[] | List of updated frameworks

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.4.33 updateFrameworkItemHieararchies

This method searches for the nodes using the IdInfo in the input FrameworkItemInfo and updates the objects with the specified attributes. The framework, parent framework item, and blueprint node cannot be updated. When deleting a framework item, all subordinate framework items are also deleted. However, a framework item cannot be deleted if it is associated with any learning item.

Parameter:

Table 2-142 updateFrameworkItemHieararchies Parameter Summary

Type | Description
--- | ---
FrameworkItemInfo[] | List of framework items to update

Return:

Table 2-143 updateFrameworkItemHieararchies Return Summary

Type | Description
--- | ---
FrameworkItemInfo[] | List of updated framework items

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.4.34 updateProficiencySets

This method searches for the outcome proficiency sets using the IdInfo in the input ProficiencySetInfo and updates the outcome proficiency sets with the specified attributes.

Parameter:

Table 2-144 updateProficiencySets Parameter Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of outcome proficiency sets to update

Return:

Table 2-145 updateProficiencySets Return Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of updated outcome proficiency sets

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.4.35 updateOutcomeStatements

This method searches for the statements using the IdInfo in the input OutcomeStatementInfo and updates the outcome statements with the specified attributes. The framework item cannot be updated.

Parameter:

Table 2-146 updateOutcomeStatements Parameter Summary

Type | Description
--- | ---
OutcomeStatementInfo[] | List of outcome statements to update

Return:

Table 2-147 updateOutcomeStatements Return Summary

Type | Description
--- | ---
OutcomeStatementInfo[] | List of updated outcome statements

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.4.36 updateOutcomeStatementDescriptorType

This method searches for the outcome statement descriptor types using the IdInfo in the input OutcomeStatementDescTypeInfo and updates the outcome statement descriptor types. The framework cannot be updated.

Parameter:

Table 2-148 updateOutcomeStatementDescriptorType Parameter Summary

Type | Description
--- | ---
OutcomeStatementDescTypeInfo[] | List of outcome statement descriptor types to update

Return:

Table 2-149 updateOutcomeStatementDescriptorType Return Summary

Type | Description
--- | ---
OutcomeStatementDescTypeInfo[] | List of updated outcome statement descriptor types

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

## 2.5 DataLoadingCurriculumAdoptionService

The DataLoadingCurriculumAdoptionService is used to adopt frameworks and contexts by schools.

### 2.5.1 adoptContexts

This method adopts contexts as part of the larger curriculum framework adoptions. The framework with which the context is associated must be adopted by the school.

Parameter:

Table 2-150 adoptContexts Parameter Summary

Type | Description
--- | ---
ContextAdoptionInfo[] | List of contexts to adopt

Return:

Table 2-151 adoptContexts Return Summary

Type | Description
--- | ---
ContextAdoptionInfo[] | List of adopted contexts

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.5.2 adoptFrameworks

This method adopts frameworks by schools for a school calendar. Before the framework can be adopted, it must be published. A school can only adopt a framework once and can only do so if the framework is made available to the school for adoption. Note that the specified calendar must belong to the school adopting the framework.

Parameter:

Table 2-152 adoptFrameworks Parameter Summary

Type | Description
--- | ---
FrameworkAdoptionInfo[] | List of frameworks to adopt

Return:

Table 2-153 adoptFrameworks Return Summary

Type | Description
--- | ---
FrameworkAdoptionInfo[] | List of adopted frameworks

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.5.3 getContextAdoptions

This method finds all the context adoptions using the IdInfo in the input ContextAdoptionInfo and returns the complete ContextAdoptionInfo.

If the specified context adoption is not found in the system, no record is returned.

Parameter:

Table 2-154 getContextAdoptions Parameter Summary

Type | Description
--- | ---
ContextAdoptionInfo[] | List of context adoptions to retrieve

Return:

Table 2-155 getContextAdoptions Return Summary

Type | Description
--- | ---
ContextAdoptionInfo[] | List of context adoptions retrieved

Exception:

InvalidParameters, ServiceException

### 2.5.4 getFrameworkAdoptions

This method finds all the framework adoptions using the IdInfo in the input FrameworkAdoptionInfo and returns the complete FrameworkAdoptionInfo.

If the specified framework adoption is not found in the system, no record is returned.

Parameter:

Table 2-156 getFrameworkAdoptions Parameter Summary

Type | Description
--- | ---
FrameworkAdoptionInfo[] | List of framework adoptions to retrieve

Return:

Table 2-157 getFrameworkAdoptions Return Summary

Type | Description
--- | ---
FrameworkAdoptionInfo[] | List of framework adoptions retrieved

Exception:

InvalidParameters, ServiceException

### 2.5.5 removeContextAdoptions

This method finds all the context adoption using the IdInfo in the input ContextAdoptionInfo and removes them. If a context adoption is removed, all subordinate context adoptions are also removed. Note that a context adoption cannot be removed if the adopted context is used in any learning items, confirmations or demonstrations.

Parameter:

Table 2-158 removeContextAdoptions Parameter Summary

Type | Description
--- | ---
ContextAdoptionInfo[] | List of context adoptions to remove

Return:

Table 2-159 removeContextAdoptions Return Summary

Type | Description
--- | ---
ContextAdoptionInfo[] | List of removed context adoptions

Exception:

DataConstraintException, InvalidParameters, RemoveException, ServiceException

### 2.5.6 removeFrameworkAdoptions

This method finds all the framework adoptions using the IdInfo in the input FrameworkAdoptionInfo and removes them. A framework adoption can only be removed if there are no offerings created for the adopted framework.

Parameter:

Table 2-160 removeFrameworkAdoptions Parameter Summary

Type | Description
--- | ---
FrameworkAdoptionInfo[] | List of framework adoptions to remove

Return:

Table 2-161 removeFrameworkAdoptions Return Summary

Type | Description
--- | ---
FrameworkAdoptionInfo[] | List of removed framework adoptions

Exception:

DataConstraintException, InvalidParameters, RemoveException, ServiceException

## 2.6 DataLoadingGradeService

The DataLoadingGradeService is used to load graded proficiency set information. Adoption of department graded proficiency sets is also done through this service.

### 2.6.1 adoptProficiencySets

This method adopts a department graded proficiency set for use in a school. A school can only adopt a department graded proficiency set once.

Parameter:

Table 2-162 adoptProficiencySets Parameter Summary

Type | Description
--- | ---
AdoptProficiencySetInfo[] | List of graded proficiency sets to adopt

Return:

Table 2-163 adoptProficiencySets Return Summary

Type | Description
--- | ---
AdoptProficiencySetInfo[] | List of adopted graded proficiency sets

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.6.2 createGradedProficiencySets

This method creates new graded proficiency sets. A graded proficiency set must have a unique name within the school and have at least one proficiency level. Within a graded proficiency set, the proficiency levels must have unique names and codes and cannot have proficiency sub-levels. Collectively, the proficiency levels must cover the entire numeric range 0-100 and there must be no overlapping numeric ranges between the proficiency levels.

Parameter:

Table 2-164 createGradedProficiencySets Parameter Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of graded proficiency sets to retrieve

Return:

Table 2-165 createGradedProficiencySets Return Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of graded proficiency sets retrieved

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.6.3 createOrUpdateGradedProficiencySets

This method searches for the graded proficiency sets using the IdInfo in the input ProficiencySetInfo and if a graded proficiency set is found, it updates it; Otherwise, it creates it.

The restrictions in createGradedProficiencySets and updateGradedProficiencySets are applicable here.

Parameter:

Table 2-166 createOrUpdateGradedProficiencySets Parameter Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of graded proficiency sets to create or update

Return:

Table 2-167 createOrUpdateGradedProficiencySets Return Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of graded proficiency sets created or updated

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.6.4 getGradedProficiencySets

This method finds all the proficiency sets using the IdInfo in the input ProficiencySetInfo and returns the complete ProficiencySetInfo including the proficiency levels.

If the specified graded proficiency set is not found in the system, no record is returned

Parameter:

Table 2-168 getGradedProficiencySets Parameter Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of graded proficiency sets to retrieve

Return:

Table 2-169 getGradedProficiencySets Return Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of graded proficiency sets retrieved

Exception:

InvalidParameters, ServiceException

### 2.6.5 updateGradedProficiencySets

This method searches for the proficiency sets using the IdInfo in the input ProficiencySetInfo and updates the objects with the specified attributes. Note that the proficiency levels referenced in learning item assessments cannot be deleted.

Parameter:

Table 2-170 updateGradedProficiencySets Parameter Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of graded proficiency sets to update

Return:

Table 2-171 updateGradedProficiencySets Return Summary

Type | Description
--- | ---
ProficiencySetInfo[] | List of updated graded proficiency sets

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

### 2.6.6 removeGradedProficiencySets

This method finds all the graded proficiency sets using the IdInfo in the input ProficiencySetInfo and removes them. The proficiency levels within the graded proficiency sets are also deleted. A department graded proficiency set cannot be deleted if a school has adopted it. Furthermore, a graded proficiency set cannot be deleted if it is referenced in a learning item.

Parameter:

Table 2-172 removeGradedProficiencySets Parameter Summary

Type | Description
--- | ---
ContextAdoptionInfo[] | List of context adoptions to remove

Return:

Table 2-173 removeGradedProficiencySets Return Summary

Type | Description
--- | ---
ContextAdoptionInfo[] | List of removed context adoptions

Exception:

DataConstraintException, InvalidParameters, RemoveException, ServiceException

## 2.7 DataLoadingLookupValueService

The DataLoadingLookupValueService is used to update list of values information.

### 2.7.1 getValueTypes

This method finds all the value types using the IdInfo in the input LookupTypeInfo and returns the complete LookupTypeInfo.

If the specified list of values is not found in the system, no record is returned.

Parameter:

Table 2-174 getValueTypes Parameter Summary

Type | Description
--- | ---
LookupTypeInfo[] | List of value types to retrieve

Return:

Table 2-175 getValueTypes Return Summary

Type | Description
--- | ---
LookupTypeInfo[] | List of value types retrieved

Exception:

InvalidParameters, ServiceException

### 2.7.2 updateValueTypes

This method searches for the value types using the IdInfo in the input LookupTypeInfo and updates the objects with the specified attributes. Within the list of values, the value names must be unique.

Note that for values provisioned by OSL, only the external id, external system id, meaning, and description can be updated. Some of these OSL-provisioned values cannot be removed or end-dated.

Parameter:

Table 2-176 updateValueTypes Parameter Summary

Type | Description
--- | ---
LookupTypeInfo[] | List of value types to update

Return:

Table 2-177 updateValueTypes Return Summary

Type | Description
--- | ---
LookupTypeInfo[] | List of updated value types

Exception:

DataConstraintException, InvalidParameters, ServiceException, UpdateException

## 2.8 DataLoadingProfileService

The DataLoadingProfileService is used to load preference information.

### 2.8.1 createProfileOptions

This method creates new profileOptionValues. A profileOptionValue must have a PersonId and profileCode in the input ProfileOptionInfo.

Parameter:

Table 2-178 createProfileOption Parameter Summary

Type | Description
--- | ---
ProfileOptionInfo[] | List of profile options to create

Return:

Table 2-179 createProfileOption Return Summary

Type | Description
--- | ---
ProfileOptionInfo[] | List of created profile options

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

### 2.8.2 getProfileOptions

This method finds the profileOptionValue using the PersonId and profileCode in the input ProfileOptionInfo. If the PersonId is not specified or no profileOptionValue can be located for the specified PersonId and profileCode, the site-wide profileOptionValue for the specified profileCode is returned.

Parameter:

Table 2-180 getProfileOptions Parameter Summary

Type | Description
--- | ---
ProfileOptionInfo[] | List of profile options to retrieve

Return:

Table 2-181 getProfileOptions Return Summary

Type | Description
--- | ---
ProfileOptionInfo[] | List of profile options retrieved

Exception:

InvalidParameters, ServiceException

### 2.8.3 updateProfileOptions

This method searches for profileOptionValues using the PersonId and profileCode in the input ProfileOptionInfo and updates the profileOptionValue with the specified attribute. If the PersonId is not specified, the site-wide profileOptionValue for the specified profileCode is updated.

Parameter:

Table 2-182 updateProfileOptions Parameter Summary

Type | Description
--- | ---
ProfileOptionInfo[] | List of profile options to update

Return:

Table 2-183 updateProfileOptions Return Summary

Type | Description
--- | ---
ProfileOptionInfo[] | List of updated profile options

Exception:

UpdateException, DataConstraintException, InvalidParameters, ServiceException

### 2.8.4 removeProfileOptions

This method finds profileOptionValue using the PersonId and profileCode in the input ProfileOptionInfo and removes them.

Parameter:

Table 2-184 removeProfileOptions Parameter Summary

Type | Description
--- | ---
ProfileOptionInfo[] | List of profile options to remove

Return:

Table 2-185 removeProfileOptions Return Summary

Type | Description
--- | ---
ProfileOptionInfo[] | List of removed profile options

Exception:

DataConstraintException, InvalidParameters, RemoveException, ServiceException