Contents

List of Figures

List of Tables

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

Part I Data Loading Services

1 Overview

• 1.1 Creation of Department
• 1.2 Security
  • 1.2.1 Authentication
  • 1.2.2 Authorization
• 1.3 Entity Identification Mechanism
  • 1.3.1 oslId
  • 1.3.2 externalId and externalSystemId
• 1.4 Action List and List
• 1.5 Entity Operations
  • 1.5.1 create Operation
  • 1.5.2 createOrUpdate Operation
  • 1.5.3 update Operation
  • 1.5.4 remove Operation
  • 1.5.5 get Operation
• 1.6 Web Service Exceptions
  • 1.6.1 CreationException
  • 1.6.2 DataConstraintException
  • 1.6.3 InvalidParameter
  • 1.6.4 RemoveException
  • 1.6.5 UpdateException
  • 1.6.6 ServiceException

2 Web Services

• 2.1 DataLoadingPartyService
  • 2.1.1 createInstitutions
  • 2.1.2 createInstitutionGroups
  • 2.1.3 createOrUpdateInstitutions
  • 2.1.4 createOrUpdateInstitutionGroups
  • 2.1.5 createOrUpdatePersons
  • 2.1.6 createPersons
  • 2.1.7 getDepartment
  • 2.1.8 getInstitutions
  • 2.1.9 getInstitutionGroups
  • 2.1.10 getPersons
  • 2.1.11 updateInstitutions
  • 2.1.12 updateInstitutionGroups
  • 2.1.13 updatePersons
• 2.2 DataLoadingCourseService
  • 2.2.1 createClasses
  • 2.2.2 createCourses
  • 2.2.3 createOfferings
  • 2.2.4 createOrUpdateClasses
  • 2.2.5 createOrUpdateCourses
  • 2.2.6 createOrUpdateOfferings
  • 2.2.7 createOrUpdateTags
  • 2.2.8 createTags
  • 2.2.9 getClasses
  • 2.2.10 getCourses
  • 2.2.11 getOfferings
  • 2.2.12 getTags
  • 2.2.13 updateClasses
  • 2.2.14 updateCourses
  • 2.2.15 updateOfferings
  • 2.2.16 updateTags
  • 2.2.17 removeClasses
  • 2.2.18 removeCourses
  • 2.2.19 removeOfferings
  • 2.2.20 removeTags
• 2.3 DataLoadingCalendarService
  • 2.3.1 adoptCalendars
  • 2.3.2 createCalendars
  • 2.3.3 createOrUpdateCalendars
  • 2.3.4 getCalendars
  • 2.3.5 updateCalendars
  • 2.3.6 removeCalendars
• 2.4 DataLoadingCurriculumService
  • 2.4.1 createBlueprintHieararchies
  • 2.4.2 createContexts
  • 2.4.3 createOrUpdateBlueprintHieararchies
  • 2.4.4 createOrUpdateContexts
  • 2.4.5 createorUpdateOutcomeStatementDescriptorType
  • 2.4.6 createOrUpdateOutcomeStatements
  • 2.4.7 createOutcomeStatements
  • 2.4.8 createOutcomeStatementDescriptorType
  • 2.4.9 createFrameworks
  • 2.4.10 createFrameworkItemHieararchies
  • 2.4.11 createOrUpdateFrameworkItemHieararchies
  • 2.4.12 createOrUpdateFrameworks
  • 2.4.13 createOrUpdateProficiencySets
  • 2.4.14 createProficiencySets
  • 2.4.15 getBlueprintHieararchies
  • 2.4.16 getContexts
  • 2.4.17 getFrameworks
  • 2.4.18 getFrameworkItemHieararchies
  • 2.4.19 getOutcomeStatements
  • 2.4.20 getOutcomeStatementDescriptorType
  • 2.4.21 getProficiencySets
  • 2.4.22 loadFramework
  • 2.4.23 removeBlueprintHieararchies
  • 2.4.24 removeContexts
  • 2.4.25 removeFrameworks
  • 2.4.26 removeFrameworkItemHieararchies
  • 2.4.27 removeOutcomeStatements
  • 2.4.28 removeOutcomeStatementDescriptorType
  • 2.4.29 removeProficiencySets
  • 2.4.30 updateBlueprintHieararchies
  • 2.4.31 updateContexts
  • 2.4.32 updateFrameworks
  • 2.4.33 updateFrameworkItemHieararchies
  • 2.4.34 updateProficiencySets
  • 2.4.35 updateOutcomeStatements
  • 2.4.36 updateOutcomeStatementDescriptorType
• 2.5 DataLoadingCurriculumAdoptionService
  • 2.5.1 adoptContexts
  • 2.5.2 adoptFrameworks
  • 2.5.3 getContextAdoptions
  • 2.5.4 getFrameworkAdoptions
  • 2.5.5 removeContextAdoptions
  • 2.5.6 removeFrameworkAdoptions
• 2.6 DataLoadingGradeService
  • 2.6.1 adoptProficiencySets
  • 2.6.2 createGradedProficiencySets
  • 2.6.3 createOrUpdateGradedProficiencySets
  • 2.6.4 getGradedProficiencySets
  • 2.6.5 updateGradedProficiencySets
  • 2.6.6 removeGradedProficiencySets
• 2.7 DataLoadingLookupValueService
  • 2.7.1 getValueTypes
  • 2.7.2 updateValueTypes
• 2.8 DataLoadingProfileService
  • 2.8.1 createProfileOptions
  • 2.8.2 getProfileOptions
  • 2.8.3 updateProfileOptions
  • 2.8.4 removeProfileOptions

Part II OSL Content Integration

3 Overview

• 3.1 Content Integration Client Interface
• 3.2 Content Integration Web Services Interface
• 3.3 Security
• 3.4 WSDL and XSD files

4 Web Services

• 4.1 GeneralContentService
  • 4.1.1 associateContent
  • 4.1.2 disassociateContent
  • 4.1.3 getSearchURL
• 4.2 OSLContentService
  • 4.2.1 deleteContent
  • 4.2.2 getOSLContent
  • 4.2.3 saveContent
• 4.3 DeprecatedServices
  • 4.3.1 deleteTempContent
  • 4.3.2 duplicateContent
  • 4.3.3 getTempContent
  • 4.3.4 saveTempContent
  • 4.3.5 uploadTempContent
• 4.4 PublishLearningItemService
  • 4.4.1 getMetadataUpdatePage
  • 4.4.2 getPublishedLIContent
  • 4.4.3 publishLearningItem

5 Plugging in an Alternate Implementation

• 5.1 Plugging in an Alternate Backend Implementation
  • 5.1.1 Configuring OSL to Connect to Alternate Backend Implementation
  • 5.1.2 Configuring Security
• 5.2 Plugging in with an Alternate ECMS UI

A Data Loading Service Objects

• A.1 AddressActionInfo
• A.2 AddressActionInfoArray
• A.3 AddressInfo
• A.4 AdoptCalendarInfo
• A.5 BlueprintNodeActionInfo
• A.6 BlueprintNodeActionInfoArray
• A.7 BlueprintNodeInfo
• A.8 CalendarInfo
• A.9 ClassInfo
• A.10 ContactActionInfo
• A.11 ContactActionInfoArray
• A.12 ContactInfo
• A.13 ContextActionInfo
• A.14 ContextActionInfoArray
• A.15 ContextAdoptionInfo
• A.16 ContextInfo
• A.17 CourseInfo
• A.18 EnrollmentActionInfo
• A.19 EnrollmentActionInfoArray
• A.20 EnrollmentInfo
• A.21 FrameworkAdoptionInfo
• A.22 FrameworkInfo
• A.23 FrameworkItemActionInfo
• A.24 FrameworkItemActionInfoArray
• A.25 FrameworkItemInfo
• A.26 FrameworkLoadInfo
• A.27 IdActionInfo
• A.28 IdInfo
• A.29 InstitutionGroupInfo
• A.30 InstitutionInfo
• A.31 LanguageActionInfo
• A.32 LanguageActionInfoArray
• A.33 LanguageInfo
• A.34 LookupValueActionInfo
• A.35 LookupValueActionInfoArray
• A.36 LookupValueInfo
• A.37 LookupTypeInfo
• A.38 OfferingInfo
• A.39 OutcomeStatementDescActionInfo
• A.40 OutcomeStatementDescActionInfoArray
• A.41 OutcomeStatementDescInfo
• A.42 OutcomeStatementDescTypeInfo
• A.43 OutcomeStatementInfo
• A.44 PersonInfo
• A.45 ProficiencyLevelActionInfo
• A.46 ProficiencyLevelActionInfoArray
• A.47 ProficiencyLevelInfo
• A.48 ProficiencySetInfo
• A.49 RelationshipActionInfo
• A.50 RelationshipActionInfoArray
• A.51 RelationshipInfo
• A.52 TagInfo

B Content Integration Service Objects

• B.1 ContentsAssociationInfo
• B.2 ContentContextInfo
• B.3 ContentIdInfo
• B.4 ContentIdsInfo
• B.5 ContentInfo
• B.6 ContentSearchCriteriaInfo
• B.7 ContentsUploadInfo
• B.8 LearningItemPublishInfo
• B.9 UserContextInfo