Oracle Student Guid

7/29/2019 Oracle Student Guid

1/134

Oracle Student Learning

Programmers Guide

Release 3.1.3

E20666-04

January 2012


2/134

Oracle Student Learning Programmer's Guide, Release 3.1.3

E20666-04

Copyright 2009, 2012, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions onuse and disclosure and are protected by intellectual property laws. Except as expressly permitted in yourlicense agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify,license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.

Reverse engineering, disassembly, or decompilation of this software, unless required by law forinteroperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. Ifyou find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing iton behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical datadelivered to U.S. Government customers are "commercial computer software" or "commercial technicaldata" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplementalregulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to therestrictions and license terms set forth in the applicable Government contract, and, to the extent applicable

by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, CommercialComputer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA94065.

This software or hardware is developed for general use in a variety of information managementapplications. It is not developed or intended for use in any inherently dangerous applications, includingapplications that may create a risk of personal injury. If you use this software or hardware in dangerousapplications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and othermeasures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damagescaused by use of this software or hardware in dangerous applications.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarksof their respective owners.

This software and documentation may provide access to or information on content, products, and servicesfrom third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim allwarranties of any kind with respect to third-party content, products, and services. Oracle Corporation andits affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use ofthird-party content, products, or services.


3/134

iii

Contents

Preface .............................................................................................................................................................. xvii

Audience.................................................................................................................................................... xvii

Documentation Accessibility.................................................................................................................. xvii

Related Documents .................................................................................................................................. xvii

Conventions ............................................................................................................................................. xviii

Part I Data Loading Services

1 Overview

1.1 Creation of Department ............................................................................................................. 1-1

1.2 Security......................................................................................................................................... 1-1

1.2.1 Authentication...................................................................................................................... 1-1

1.2.2 Authorization ....................................................................................................................... 1-2

1.3 Entity Identification Mechanism .............................................................................................. 1-2

1.3.1 oslId ....................................................................................................................................... 1-2

1.3.2 externalId and externalSystemId....................................................................................... 1-2

1.4 Action List and List..................................................................................................................... 1-2

1.5 Entity Operations........................................................................................................................ 1-4

1.5.1 create Operation................................................................................................................... 1-4

1.5.2 createOrUpdate Operation................................................................................................. 1-4

1.5.3 update Operation................................................................................................................. 1-4

1.5.4 remove Operation................................................................................................................ 1-5

1.5.5 get Operation........................................................................................................................ 1-5

1.6 Web Service Exceptions ............................................................................................................. 1-5

1.6.1 CreationException ............................................................................................................... 1-6

1.6.2 DataConstraintException.................................................................................................... 1-6

1.6.3 InvalidParameter ................................................................................................................. 1-6

1.6.4 RemoveException ................................................................................................................ 1-6

1.6.5 UpdateException ................................................................................................................. 1-6

1.6.6 ServiceException .................................................................................................................. 1-6

2 Web Services

2.1 DataLoadingPartyService.......................................................................................................... 2-1

2.1.1 createInstitutions.................................................................................................................. 2-1

2.1.2 createInstitutionGroups...................................................................................................... 2-1


4/134

iv

2.1.3 createOrUpdateInstitutions................................................................................................ 2-2

2.1.4 createOrUpdateInstitutionGroups.................................................................................... 2-2

2.1.5 createOrUpdatePersons...................................................................................................... 2-3

2.1.6 createPersons........................................................................................................................ 2-3

2.1.7 getDepartment ..................................................................................................................... 2-4

2.1.8 getInstitutions....................................................................................................................... 2-4

2.1.9 getInstitutionGroups........................................................................................................... 2-52.1.10 getPersons............................................................................................................................. 2-5

2.1.11 updateInstitutions................................................................................................................ 2-6

2.1.12 updateInstitutionGroups.................................................................................................... 2-6

2.1.13 updatePersons...................................................................................................................... 2-6

2.2 DataLoadingCourseService....................................................................................................... 2-7

2.2.1 createClasses......................................................................................................................... 2-7

2.2.2 createCourses ....................................................................................................................... 2-8

2.2.3 createOfferings..................................................................................................................... 2-8

2.2.4 createOrUpdateClasses....................................................................................................... 2-9

2.2.5 createOrUpdateCourses...................................................................................................... 2-9

2.2.6 createOrUpdateOfferings................................................................................................ 2-102.2.7 createOrUpdateTags......................................................................................................... 2-10

2.2.8 createTags .......................................................................................................................... 2-10

2.2.9 getClasses........................................................................................................................... 2-11

2.2.10 getCourses.......................................................................................................................... 2-11

2.2.11 getOfferings ....................................................................................................................... 2-12

2.2.12 getTags ............................................................................................................................... 2-12

2.2.13 updateClasses.................................................................................................................... 2-13

2.2.14 updateCourses .................................................................................................................. 2-13

2.2.15 updateOfferings................................................................................................................ 2-13

2.2.16 updateTags ........................................................................................................................ 2-14

2.2.17 removeClasses................................................................................................................... 2-14

2.2.18 removeCourses.................................................................................................................. 2-15

2.2.19 removeOfferings............................................................................................................... 2-15

2.2.20 removeTags........................................................................................................................ 2-16

2.3 DataLoadingCalendarService ............................................................................................... 2-16

2.3.1 adoptCalendars................................................................................................................. 2-16

2.3.2 createCalendars................................................................................................................. 2-17

2.3.3 createOrUpdateCalendars............................................................................................... 2-17

2.3.4 getCalendars...................................................................................................................... 2-17

2.3.5 updateCalendars............................................................................................................... 2-18

2.3.6 removeCalendars.............................................................................................................. 2-18

2.4 DataLoadingCurriculumService............................................................................................ 2-19

2.4.1 createBlueprintHieararchies............................................................................................ 2-19

2.4.2 createContexts ................................................................................................................... 2-19

2.4.3 createOrUpdateBlueprintHieararchies.......................................................................... 2-20

2.4.4 createOrUpdateContexts ................................................................................................. 2-20

2.4.5 createorUpdateOutcomeStatementDescriptorType.................................................... 2-21

2.4.6 createOrUpdateOutcomeStatements ............................................................................. 2-21

2.4.7 createOutcomeStatements............................................................................................... 2-22


5/134

v

2.4.8 createOutcomeStatementDescriptorType..................................................................... 2-23

2.4.9 createFrameworks ............................................................................................................ 2-23

2.4.10 createFrameworkItemHieararchies................................................................................ 2-23

2.4.11 createOrUpdateFrameworkItemHieararchies.............................................................. 2-24

2.4.12 createOrUpdateFrameworks........................................................................................... 2-25

2.4.13 createOrUpdateProficiencySets...................................................................................... 2-25

2.4.14 createProficiencySets........................................................................................................ 2-262.4.15 getBlueprintHieararchies................................................................................................. 2-26

2.4.16 getContexts ........................................................................................................................ 2-27

2.4.17 getFrameworks.................................................................................................................. 2-27

2.4.18 getFrameworkItemHieararchies..................................................................................... 2-27

2.4.19 getOutcomeStatements.................................................................................................... 2-28

2.4.20 getOutcomeStatementDescriptorType .......................................................................... 2-28

2.4.21 getProficiencySets............................................................................................................. 2-29

2.4.22 loadFramework................................................................................................................. 2-29

2.4.23 removeBlueprintHieararchies......................................................................................... 2-30

2.4.24 removeContexts ................................................................................................................ 2-31

2.4.25 removeFrameworks.......................................................................................................... 2-312.4.26 removeFrameworkItemHieararchies............................................................................. 2-31

2.4.27 removeOutcomeStatements ............................................................................................ 2-32

2.4.28 removeOutcomeStatementDescriptorType .................................................................. 2-32

2.4.29 removeProficiencySets ..................................................................................................... 2-33

2.4.30 updateBlueprintHieararchies.......................................................................................... 2-33

2.4.31 updateContexts ................................................................................................................. 2-34

2.4.32 updateFrameworks........................................................................................................... 2-34

2.4.33 updateFrameworkItemHieararchies.............................................................................. 2-35

2.4.34 updateProficiencySets ...................................................................................................... 2-35

2.4.35 updateOutcomeStatements ............................................................................................. 2-36

2.4.36 updateOutcomeStatementDescriptorType................................................................... 2-36

2.5 DataLoadingCurriculumAdoptionService........................................................................... 2-37

2.5.1 adoptContexts ................................................................................................................... 2-37

2.5.2 adoptFrameworks............................................................................................................. 2-37

2.5.3 getContextAdoptions ....................................................................................................... 2-38

2.5.4 getFrameworkAdoptions ................................................................................................ 2-38

2.5.5 removeContextAdoptions ............................................................................................... 2-38

2.5.6 removeFrameworkAdoptions ........................................................................................ 2-39

2.6 DataLoadingGradeService...................................................................................................... 2-39

2.6.1 adoptProficiencySets ........................................................................................................ 2-40

2.6.2 createGradedProficiencySets .......................................................................................... 2-40

2.6.3 createOrUpdateGradedProficiencySets......................................................................... 2-41

2.6.4 getGradedProficiencySets................................................................................................ 2-41

2.6.5 updateGradedProficiencySets ........................................................................................ 2-42

2.6.6 removeGradedProficiencySets........................................................................................ 2-42

2.7 DataLoadingLookupValueService ........................................................................................ 2-43

2.7.1 getValueTypes................................................................................................................... 2-43

2.7.2 updateValueTypes............................................................................................................ 2-43

2.8 DataLoadingProfileService..................................................................................................... 2-44


6/134

vi

2.8.1 createProfileOptions......................................................................................................... 2-44

2.8.2 getProfileOptions.............................................................................................................. 2-44

2.8.3 updateProfileOptions....................................................................................................... 2-44

2.8.4 removeProfileOptions...................................................................................................... 2-45

Part II OSL Content Integration

3 Overview

3.1 Content Integration Client Interface ........................................................................................ 3-3

3.2 Content Integration Web Services Interface............................................................................ 3-3

3.3 Security......................................................................................................................................... 3-4

3.4 WSDL and XSD files................................................................................................................... 3-4

4 Web Services

4.1 GeneralContentService............................................................................................................... 4-1

4.1.1 associateContent .................................................................................................................. 4-1

4.1.2 disassociateContent............................................................................................................. 4-24.1.3 getSearchURL....................................................................................................................... 4-2

4.2 OSLContentService..................................................................................................................... 4-3

4.2.1 deleteContent ....................................................................................................................... 4-3

4.2.2 getOSLContent..................................................................................................................... 4-4

4.2.3 saveContent .......................................................................................................................... 4-4

4.3 DeprecatedServices..................................................................................................................... 4-5

4.3.1 deleteTempContent............................................................................................................. 4-5

4.3.2 duplicateContent ................................................................................................................. 4-5

4.3.3 getTempContent .................................................................................................................. 4-5

4.3.4 saveTempContent................................................................................................................ 4-5

4.3.5 uploadTempContent........................................................................................................... 4-6

4.4 PublishLearningItemService ..................................................................................................... 4-6

4.4.1 getMetadataUpdatePage .................................................................................................... 4-6

4.4.2 getPublishedLIContent....................................................................................................... 4-7

4.4.3 publishLearningItem........................................................................................................... 4-7

5 Plugging in an Alternate Implementation

5.1 Plugging in an Alternate Backend Implementation .............................................................. 5-1

5.1.1 Configuring OSL to Connect to Alternate Backend Implementation .......................... 5-1

5.1.2 Configuring Security........................................................................................................... 5-1

5.2 Plugging in with an Alternate ECMS UI ................................................................................. 5-1

A Data Loading Service Objects

A.1 AddressActionInfo..................................................................................................................... A-1

A.2 AddressActionInfoArray.......................................................................................................... A-1

A.3 AddressInfo ................................................................................................................................ A-2

A.4 AdoptCalendarInfo.................................................................................................................... A-3

A.5 BlueprintNodeActionInfo......................................................................................................... A-3

A.6 BlueprintNodeActionInfoArray .............................................................................................. A-4


7/134

vii

A.7 BlueprintNodeInfo..................................................................................................................... A-4

A.8 CalendarInfo............................................................................................................................... A-5

A.9 ClassInfo...................................................................................................................................... A-6

A.10 ContactActionInfo...................................................................................................................... A-7

A.11 ContactActionInfoArray ........................................................................................................... A-7

A.12 ContactInfo.................................................................................................................................. A-7

A.13 ContextActionInfo ................................................................................................................... A-10A.14 ContextActionInfoArray ......................................................................................................... A-10

A.15 ContextAdoptionInfo .............................................................................................................. A-10

A.16 ContextInfo ............................................................................................................................... A-11

A.17 CourseInfo................................................................................................................................. A-12

A.18 EnrollmentActionInfo ............................................................................................................. A-12

A.19 EnrollmentActionInfoArray................................................................................................... A-13

A.20 EnrollmentInfo ......................................................................................................................... A-13

A.21 FrameworkAdoptionInfo........................................................................................................ A-14

A.22 FrameworkInfo......................................................................................................................... A-15

A.23 FrameworkItemActionInfo..................................................................................................... A-16

A.24 FrameworkItemActionInfoArray .......................................................................................... A-16A.25 FrameworkItemInfo................................................................................................................. A-17

A.26 FrameworkLoadInfo................................................................................................................ A-18

A.27 IdActionInfo.............................................................................................................................. A-19

A.28 IdInfo ......................................................................................................................................... A-19

A.29 InstitutionGroupInfo............................................................................................................... A-20

A.30 InstitutionInfo........................................................................................................................... A-21

A.31 LanguageActionInfo................................................................................................................ A-22

A.32 LanguageActionInfoArray ..................................................................................................... A-23

A.33 LanguageInfo............................................................................................................................ A-23

A.34 LookupValueActionInfo ......................................................................................................... A-24

A.35 LookupValueActionInfoArray............................................................................................... A-24

A.36 LookupValueInfo ..................................................................................................................... A-24

A.37 LookupTypeInfo ...................................................................................................................... A-25

A.38 OfferingInfo .............................................................................................................................. A-27

A.39 OutcomeStatementDescActionInfo....................................................................................... A-28

A.40 OutcomeStatementDescActionInfoArray ............................................................................ A-29

A.41 OutcomeStatementDescInfo................................................................................................... A-29

A.42 OutcomeStatementDescTypeInfo.......................................................................................... A-30

A.43 OutcomeStatementInfo ........................................................................................................... A-30

A.44 PersonInfo ................................................................................................................................. A-32

A.45 ProficiencyLevelActionInfo.................................................................................................... A-34

A.46 ProficiencyLevelActionInfoArray ......................................................................................... A-34

A.47 ProficiencyLevelInfo................................................................................................................ A-34

A.48 ProficiencySetInfo.................................................................................................................... A-37

A.49 RelationshipActionInfo ........................................................................................................... A-39

A.50 RelationshipActionInfoArray................................................................................................. A-39

A.51 RelationshipInfo....................................................................................................................... A-40

A.52 TagInfo....................................................................................................................................... A-41


8/134

viii

B Content Integration Service Objects

B.1 ContentsAssociationInfo........................................................................................................... B-1

B.2 ContentContextInfo................................................................................................................... B-1

B.3 ContentIdInfo ............................................................................................................................. B-2

B.4 ContentIdsInfo............................................................................................................................ B-2

B.5 ContentInfo................................................................................................................................. B-2

B.6 ContentSearchCriteriaInfo........................................................................................................ B-3

B.7 ContentsUploadInfo.................................................................................................................. B-3

B.8 LearningItemPublishInfo.......................................................................................................... B-4

B.9 UserContextInfo......................................................................................................................... B-4


9/134

ix

List of Tables

21 createInstitutions Parameter Summary .................................................................................. 2-122 createInstitutions Return Summary ........................................................................................ 2-123 createInstitutionGroups Parameter Summary ...................................................................... 2-224 createInstitutionGroups Return Summary............................................................................. 2-225 createOrUpdateInstitutions Parameter Summary ................................................................ 2-2

26 createOrUpdateInstitutions Return Summary ...................................................................... 2-227 createOrUpdateInstitutionGroups Parameter Summary..................................................... 2-328 createOrUpdateInstitutionGroups Return Summary........................................................... 2-329 createOrUpdatePersons Parameter Summary....................................................................... 2-3210 createOrUpdatePersons Return Summary............................................................................. 2-3211 createPersons Parameter Summary......................................................................................... 2-4212 createPersons Return Summary............................................................................................... 2-4213 getDepartment Return Summary............................................................................................ 2-4214 getInstitutions Parameter Summary ....................................................................................... 2-4215 getInstitutions Return Summary ............................................................................................. 2-4216 getInstitutionGroups Parameter Summary............................................................................ 2-5217 getInstitutionGroups Return Summary.................................................................................. 2-5218 getPersons Parameter Summary.............................................................................................. 2-5

219 getPersons Return Summary.................................................................................................... 2-5220 updateInstitutions Parameter Summary ................................................................................ 2-6221 updateInstitutions Return Summary ...................................................................................... 2-6222 updateInstitutionGroups Parameter Summary .................................................................... 2-6223 updateInstitutionGroups Return Summary........................................................................... 2-6224 updatePersons Parameter Summary....................................................................................... 2-7225 updatePersons Return Summary............................................................................................. 2-7226 createClasses Parameter Summary ......................................................................................... 2-7227 createClasses Return Summary ............................................................................................... 2-7228 createCourses Parameter Summary........................................................................................ 2-8229 createCourses Return Summary.............................................................................................. 2-8230 createOfferings Parameter Summary...................................................................................... 2-8231 createOfferings Return Summary............................................................................................ 2-8

232 createOrUpdateClasses Parameter Summary ....................................................................... 2-9233 createOrUpdateClasses Return Summary ............................................................................. 2-9234 createOrUpdateCourses Parameter Summary ...................................................................... 2-9235 createOrUpdateCourses Return Summary ............................................................................ 2-9236 createOrUpdateOfferings Parameter Summary................................................................. 2-10237 createOrUpdateOfferings Return Summary....................................................................... 2-10238 createOrUpdateTags Parameter Summary ......................................................................... 2-10239 createOrUpdateTags Return Summary ............................................................................... 2-10240 createTags Parameter Summary........................................................................................... 2-11241 createTags Return Summary................................................................................................. 2-11242 getClasses Parameter Summary ........................................................................................... 2-11243 getClasses Return Summary ................................................................................................. 2-11244 getCourses Parameter Summary .......................................................................................... 2-11245 getCourses Return Summary ................................................................................................ 2-12246 getOfferings Parameter Summary........................................................................................ 2-12247 getOfferings Return Summary.............................................................................................. 2-12248 getTags Parameter Summary................................................................................................ 2-12249 getTags Return Summary...................................................................................................... 2-12250 updateClasses Parameter Summary .................................................................................... 2-13251 updateClasses Return Summary .......................................................................................... 2-13252 updateCourses Parameter Summary................................................................................... 2-13253 updateCourses Return Summary ......................................................................................... 2-13


10/134

x

254 updateOfferings Parameter Summary................................................................................. 2-14255 updateOfferings Return Summary....................................................................................... 2-14256 updateTags Parameter Summary......................................................................................... 2-14257 updateTags Return Summary............................................................................................... 2-14258 removeClasses Parameter Summary ................................................................................... 2-14259 removeClasses Return Summary ......................................................................................... 2-15260 removeCourses Parameter Summary .................................................................................. 2-15

261 removeCourses Return Summary ........................................................................................ 2-15262 removeOfferings Parameter Summary................................................................................ 2-15263 removeOfferings Return Summary...................................................................................... 2-15264 removeTags Parameter Summary........................................................................................ 2-16265 removeTags Return Summary .............................................................................................. 2-16266 adoptCalendars Parameter Summary.................................................................................. 2-16267 adoptCalendars Return Summary........................................................................................ 2-16268 createCalendars Parameter Summary ................................................................................. 2-17269 createCalendars Return Summary ....................................................................................... 2-17270 createOrUpdateCalendars Parameter Summary ............................................................... 2-17271 createOrUpdateCalendars Return Summary...................................................................... 2-17272 getCalendars Parameter Summary ...................................................................................... 2-18273 getCalendars Return Summary ............................................................................................ 2-18274 updateCalendars Parameter Summary ............................................................................... 2-18275 updateCalendars Return Summary ..................................................................................... 2-18276 removeCalendars Parameter Summary .............................................................................. 2-18277 removeCalendars Return Summary..................................................................................... 2-19278 createBlueprintHieararchies Parameter Summary ............................................................ 2-19279 createBlueprintHieararchies Return Summary .................................................................. 2-19280 createContexts Parameter Summary.................................................................................... 2-20281 createContexts Return Summary.......................................................................................... 2-20282 createOrUpdateBlueprintHieararchies Parameter Summary .......................................... 2-20283 createOrUpdateBlueprintHieararchies Return Summary ................................................ 2-20284 createOrUpdateContexts Parameter Summary.................................................................. 2-21285 createOrUpdateContexts Return Summary........................................................................ 2-21

286 createorUpdateOutcomeStatementDescriptorType Parameter Summary..................... 2-21287 createorUpdateOutcomeStatementDescriptorType Return Summary........................... 2-21288 createOrUpdateOutcomeStatements Parameter Summary.............................................. 2-22289 createOrUpdateOutcomeStatements Return Summary.................................................... 2-22290 createOutcomeStatements Parameter Summary................................................................ 2-22291 createOutcomeStatements Return Summary...................................................................... 2-22292 createOutcomeStatementDescriptorType Parameter Summary...................................... 2-23293 createOutcomeStatementDescriptorType Return Summary............................................ 2-23294 createFrameworks Parameter Summary ............................................................................. 2-23295 createFrameworks Return Summary ................................................................................... 2-23296 createFrameworkItemHieararchies Parameter Summary ................................................ 2-24297 createFrameworkItemHieararchies Return Summary ...................................................... 2-24298 createOrUpdateFrameworkItemHieararchies Parameter Summary .............................. 2-24

299 createOrUpdateFrameworkItemHieararchies Return Summary .................................... 2-242100 createOrUpdateFrameworks Parameter Summary ........................................................... 2-252101 createOrUpdateFrameworks Return Summary ................................................................. 2-252102 createOrUpdateProficiencySets Parameter Summary....................................................... 2-252103 createOrUpdateProficiencySets Return Summary............................................................. 2-252104 createProficiencySets Parameter Summary ........................................................................ 2-262105 createProficiencySets Return Summary............................................................................... 2-262106 getBlueprintHieararchies Parameter Summary ................................................................. 2-262107 getBlueprintHieararchies Return Summary ....................................................................... 2-262108 getContexts Parameter Summary......................................................................................... 2-27


11/134

xi

2109 getContexts Return Summary............................................................................................... 2-272110 getFrameworks Parameter Summary .................................................................................. 2-272111 getFrameworks Return Summary ........................................................................................ 2-272112 getFrameworkItemHieararchies Parameter Summary ..................................................... 2-282113 getFrameworkItemHieararchies Return Summary ........................................................... 2-282114 getOutcomeStatements Parameter Summary..................................................................... 2-282115 getOutcomeStatements Return Summary........................................................................... 2-28

2116 getOutcomeStatementDescriptorType Parameter Summary........................................... 2-292117 getOutcomeStatementDescriptorType Return Summary................................................. 2-292118 getProficiencySets Parameter Summary.............................................................................. 2-292119 getProficiencySets Return Summary.................................................................................... 2-292120 loadFramework Parameter Summary ................................................................................. 2-302121 loadFramework Return Summary........................................................................................ 2-302122 removeBlueprintHieararchies Parameter Summary ......................................................... 2-302123 removeBlueprintHieararchies Return Summary ............................................................... 2-302124 removeContexts Parameter Summary................................................................................. 2-312125 removeContexts Return Summary....................................................................................... 2-312126 removeFrameworks Parameter Summary .......................................................................... 2-312127 removeFrameworks Return Summary ................................................................................ 2-312128 removeFrameworkItemHieararchies Parameter Summary ............................................. 2-32

2129 removeFrameworkItemHieararchies Return Summary ................................................... 2-322130 removeOutcomeStatements Parameter Summary............................................................. 2-322131 removeOutcomeStatements Return Summary................................................................... 2-322132 removeOutcomeStatementDescriptorType Parameter Summary................................... 2-332133 removeOutcomeStatementDescriptorType Return Summary......................................... 2-332134 removeProficiencySets Parameter Summary...................................................................... 2-332135 removeProficiencySets Return Summary............................................................................ 2-332136 updateBlueprintHieararchies Parameter Summary .......................................................... 2-342137 updateBlueprintHieararchies Return Summary ................................................................ 2-342138 updateContexts Parameter Summary.................................................................................. 2-342139 updateContexts Return Summary........................................................................................ 2-342140 updateFrameworks Parameter Summary ........................................................................... 2-342141 updateFrameworks Return Summary ................................................................................. 2-35

2142 updateFrameworkItemHieararchies Parameter Summary .............................................. 2-352143 updateFrameworkItemHieararchies Return Summary .................................................... 2-352144 updateProficiencySets Parameter Summary ...................................................................... 2-352145 updateProficiencySets Return Summary............................................................................. 2-362146 updateOutcomeStatements Parameter Summary.............................................................. 2-362147 updateOutcomeStatements Return Summary.................................................................... 2-362148 updateOutcomeStatementDescriptorType Parameter Summary.................................... 2-362149 updateOutcomeStatementDescriptorType Return Summary.......................................... 2-362150 adoptContexts Parameter Summary.................................................................................... 2-372151 adoptContexts Return Summary.......................................................................................... 2-372152 adoptFrameworks Parameter Summary ............................................................................. 2-372153 adoptFrameworks Return Summary ................................................................................... 2-372154 getContextAdoptions Parameter Summary........................................................................ 2-382155 getContextAdoptions Return Summary.............................................................................. 2-382156 getFrameworkAdoptions Parameter Summary................................................................. 2-382157 getFrameworkAdoptions Return Summary....................................................................... 2-382158 removeContextAdoptions Parameter Summary................................................................ 2-392159 removeContextAdoptions Return Summary...................................................................... 2-392160 removeFrameworkAdoptions Parameter Summary......................................................... 2-392161 removeFrameworkAdoptions Return Summary ............................................................... 2-392162 adoptProficiencySets Parameter Summary......................................................................... 2-402163 adoptProficiencySets Return Summary............................................................................... 2-40


12/134

xii

2164 createGradedProficiencySets Parameter Summary........................................................... 2-402165 createGradedProficiencySets Return Summary ................................................................. 2-402166 createOrUpdateGradedProficiencySets Parameter Summary ......................................... 2-412167 createOrUpdateGradedProficiencySets Return Summary ............................................... 2-412168 getGradedProficiencySets Parameter Summary................................................................ 2-412169 getGradedProficiencySets Return Summary ...................................................................... 2-412170 updateGradedProficiencySets Parameter Summary......................................................... 2-42

2171 updateGradedProficiencySets Return Summary ............................................................... 2-422172 removeGradedProficiencySets Parameter Summary ........................................................ 2-422173 removeGradedProficiencySets Return Summary .............................................................. 2-422174 getValueTypes Parameter Summary ................................................................................... 2-432175 getValueTypes Return Summary ......................................................................................... 2-432176 updateValueTypes Parameter Summary ............................................................................ 2-432177 updateValueTypes Return Summary .................................................................................. 2-432178 createProfileOption Parameter Summary........................................................................... 2-442179 createProfileOption Return Summary ................................................................................. 2-442180 getProfileOptions Parameter Summary .............................................................................. 2-442181 getProfileOptions Return Summary .................................................................................... 2-442182 updateProfileOptions Parameter Summary ....................................................................... 2-452183 updateProfileOptions Return Summary ............................................................................. 2-452184 removeProfileOptions Parameter Summary ...................................................................... 2-452185 removeProfileOptions Return Summary............................................................................. 2-4531 Definition of Terms.................................................................................................................... 3-232 List of Attributes ........................................................................................................................ 3-341 associateContent Parameter Summary................................................................................... 4-142 disassociateContent Parameter Summary.............................................................................. 4-243 getSearchURL Parameter Summary ....................................................................................... 4-344 getSearchURL Return Summary.............................................................................................. 4-345 duplicateContent Parameter Summary.................................................................................. 4-446 getOSLContent Parameter Summary...................................................................................... 4-447 getOSLContent Return Summary............................................................................................ 4-448 saveContent Parameter Summary........................................................................................... 4-5

49 saveContent Return Summary................................................................................................. 4-5410 getMetadataUpdate Parameter Summary ............................................................................. 4-6411 getMetadataUpdate Return Summary.................................................................................... 4-6412 getPublishedLIContent Parameter Summary........................................................................ 4-7413 getPublishedLIContent Return Summary.............................................................................. 4-7414 publishLearningItem Parameter Summary ........................................................................... 4-8415 publishLearningItem Return Summary ................................................................................. 4-8A1 AddressActionInfo Attributes................................................................................................. A-1A2 action........................................................................................................................................... A-1A3 AddressActionInfoArray Attributes...................................................................................... A-1A4 AddressInfo Attributes ............................................................................................................ A-2A5 contactType................................................................................................................................ A-3A6 AdoptCalendarInfo Attributes................................................................................................ A-3

A7 BlueprintNodeActionInfo Attributes..................................................................................... A-3A8 action........................................................................................................................................... A-4A9 BlueprintNodeActionInfoArray Attributes .......................................................................... A-4A10 BlueprintNodeInfo Attributes................................................................................................. A-4A11 CalendarInfo Attributes........................................................................................................... A-5A12 ClassInfo Attributes.................................................................................................................. A-6A13 ContactActionInfo Attributes.................................................................................................. A-7A14 action........................................................................................................................................... A-7A15 ContactActionInfoArray Attributes ....................................................................................... A-7A16 ContactInfo Attributes.............................................................................................................. A-8


13/134

xiii

A17 contactType................................................................................................................................ A-9A18 yesNoType ................................................................................................................................. A-9A19 ContextActionInfo Attributes ............................................................................................... A-10A20 action......................................................................................................................................... A-10A21 ContextActionInfoArray Attributes..................................................................................... A-10A22 contextAdoptionInfo Attributes ........................................................................................... A-11A23 ContextInfo Attributes ........................................................................................................... A-11

A24 CourseInfo Attributes............................................................................................................. A-12A25 EnrollmentActionInfo Attributes ......................................................................................... A-13A26 action......................................................................................................................................... A-13A27 EnrollmentActionInfoArray Attributes............................................................................... A-13A28 EnrollmentInfo Attributes ..................................................................................................... A-13A29 enrollmentType....................................................................................................................... A-14A30 FrameworkAdoptionInfo Attributes.................................................................................... A-14A31 yesNoType............................................................................................................................... A-15A32 FrameworkInfo Attributes..................................................................................................... A-15A33 FrameworkItemActionInfo Attributes................................................................................. A-16A34 action......................................................................................................................................... A-16A35 FrameworkItemActionInfoArray Attributes ...................................................................... A-17A36 FrameworkItemInfo Attributes............................................................................................. A-17

A37 yesNoType............................................................................................................................... A-18A38 FrameworkLoadInfoAttributes............................................................................................. A-18A39 yesNoType............................................................................................................................... A-19A40 IdActionInfo Attributes.......................................................................................................... A-19A41 action......................................................................................................................................... A-19A42 IdInfo Attributes ..................................................................................................................... A-20A43 InstitutionGroupInfo Attributes ........................................................................................... A-20A44 institutionInfo Attributes....................................................................................................... A-21A45 LanguageActionInfo Attributes............................................................................................ A-22A46 action......................................................................................................................................... A-23A47 LanguageActionInfoArray Attributes ................................................................................. A-23A48 LanguageInfo Attributes........................................................................................................ A-23A49 yesNoType ............................................................................................................................... A-24

A50 LookupValueActionInfo Attributes ..................................................................................... A-24A51 action......................................................................................................................................... A-24A52 LookupValueActionInfoArray Attributes........................................................................... A-24A53 LookupValueInfo Attributes................................................................................................. A-25A54 customizationLevel................................................................................................................. A-25A55 LookupTypeInfo Attributes .................................................................................................. A-25A56 customizationLevel................................................................................................................. A-26A57 lookupType.............................................................................................................................. A-26A58 OfferingInfo Attributes .......................................................................................................... A-28A59 OutcomeStatementDescActionInfo Attributes................................................................... A-28A60 action......................................................................................................................................... A-29A61 OutcomeStatementDescActionInfoArray Attributes ........................................................ A-29A62 OutcomeStatementDescInfo Attributes............................................................................... A-29A63 OutcomeStatementDescTypeInfo Attributes...................................................................... A-30A64 OutcomeStatementInfo Attributes ....................................................................................... A-31A65 outcomeStatementType ......................................................................................................... A-31A66 PersonInfo Attributes ............................................................................................................. A-32A67 gender....................................................................................................................................... A-34A68 ProficiencyLevelActionInfo Attributes................................................................................ A-34A69 action......................................................................................................................................... A-34A70 ProficiencyLevelActionInfoArray Attributes ..................................................................... A-34A71 ProficiencyLevelInfo Attributes............................................................................................ A-35


14/134

xiv

A72 yesNoType ............................................................................................................................... A-37A73 ProficiencySetInfo Attributes ................................................................................................ A-38A74 proficiencySetType ................................................................................................................. A-39A75 RelationshipActionInfo Attributes ....................................................................................... A-39A76 action......................................................................................................................................... A-39A77 RelationshipActionInfoArray Attributes............................................................................. A-40A78 RelationshipInfo Attributes................................................................................................... A-40

A79 relationshipType ..................................................................................................................... A-40A80 TagInfo Attributes................................................................................................................... A-41B1 ContentsAssociationInfo Attributes....................................................................................... B-1B2 ContentContextInfo Attributes ............................................................................................... B-1B3 context......................................................................................................................................... B-1B4 contextType................................................................................................................................ B-2B5 ContentIdInfo Attributes ......................................................................................................... B-2B6 ContentIdsInfo Attributes........................................................................................................ B-2B7 ContentInfo Attributes ............................................................................................................. B-3B8 ContentSearchCriteriaInfo Attributes.................................................................................... B-3B9 searchFilter................................................................................................................................. B-3B10 ContentsUploadInfo Attributes .............................................................................................. B-4B11 uploadInfo.................................................................................................................................. B-4B12 LearningItemPublishInfo Attributes...................................................................................... B-4B13 UserContextInfo Attributes..................................................................................................... B-4


15/134

xv


16/134

xvi

List of Figures

31 OSL Interactions with ECMS..................................................................................................... 3-1


17/134

xvii

Preface

This preface includes the following topics:

Audience

Documentation Accessibility

Related Documents

Conventions

AudienceThe Oracle Student Learning Programmers Guide is intended for applicationdevelopers who are interested in developing applications that interface with OracleStudent Learning (OSL).

Documentation AccessibilityFor information about Oracle's commitment to accessibility, visit the OracleAccessibility Program website athttp://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc .

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. Forinformation, visithttp://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visithttp://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you arehearing impaired.

Related DocumentsFor more information, see the following documents in the Oracle Student Learningdocumentation set:

Oracle Student Learning (OSL) Installation and Deployment Guide

Oracle Student Learning (OSL) Implementation Guide

Oracle Student Learning (OSL) Learning Tool Admin Users Guide

Oracle Student Learning (OSL) Learning Tool Customization Guide

Oracle Student Learning (OSL) Learning Tool Users Guide

Oracle Student Learning (OSL) Release Notes


18/134

xviii

ConventionsThe following text conventions are used in this document:

Convention Meaning

boldface Boldface type indicates graphical user interface elements associatedwith an action, or terms defined in text or the glossary.

italic Italic type indicates book titles, emphasis, or placeholder variables forwhich you supply particular values.

monospace Monospace type indicates commands within a paragraph, URLs, codein examples, text that appears on the screen, or text that you enter.


19/134

Part IPart I Data Loading Services

This part contains chapters about data loading services.

Chapter 1, "Overview"

Chapter 2, "Web Services"


20/134


21/134

1

Overview 1-1

1Overview

This chapter describes an overview of the data loading service.

The Data Loading Services are a collection of web services that provide operations tomanage certain entities within OSL. These entities represent data that are typicallyloaded from external systems and can be broadly classified under the followingcategories:

Calendar

Classes & Enrollment

Courses & Tags

Framework

Institution

Offerings

People & Relationship

1.1 Creation of DepartmentThe Data Loading Services do not provide a service to create the Department. TheDepartment is created during installation of OSL. The Data Loading Services provide aservice to update the Department attributes.

1.2 SecurityThe Data Loading Services are secured services that are protected by the WebLogicSecurity mechanism. The default security policy configuration is defined byoracle/wss_username_token_service_policy . Any client access to theseservices is authenticated and authorized. The default security configuration can beoverridden post deployment of the application.

1.2.1 Authentication

The oracle/wss_username_token_service_policy requires the client to passin the credentials in the SOAP Header.

Below is an example of a SOAP message containing the credentials in the SOAPHeader.


22/134

Entity Identification Mechanism

1-2 Oracle Student Learning Programmer's Guide

ext-1.0.xsd">

dataloading

xxxxxxxxxxx

---

1.2.2 Authorization

All the services that are part of Data Loading are accessible to users that belong to the"DataLoadingGroup". The Data Loading Services expect a user with uid "dataloading"to be part of the "DataLoadingGroup". The authenticated user's uid should be"dataloading" and the user should be part of the "DataLoadingGroup".

1.3 Entity Identification MechanismAt any point, a record in OSL can be uniquely identified either through the OSL Id orthe combination of External Id and External System Id.

1.3.1 oslId

The oslId is the identifier generated by OSL for internal representation of data loadedthrough the Data Loading Services. The oslId is contained in the response to anysuccessful create operation.

1.3.2 externalId and externalSystemId

OSL external systems require a mechanism to cross-reference individual records. Therecommendation is to use an externalId and an externalSystemId to uniquely identifyindividual records. Any external system loading data into OSL can optionally providethese identifiers. When provided, OSL keeps track of them and external systems cancross-reference these records based on the externalId and externalSystemId.

1.4 Action List and ListTo explain this concept, the PersonInfo data structure is used.


23/134

Action List and List

Overview 1-3

maxOccurs="unbounded"/>

In the PersonInfo structure, phoneContactActions and relationshipActions are ActionLists. In the same structure, addresses, emailContacts, languages, phoneContacts andrelationships are Lists.

Lists are returned by the service in response to certain operation and Lists are neversent in any request message. In other words, Lists are always constructed by theservice and clients typically read the Lists.

The data structure of the Action Lists is similar to that of Lists except that an actionflag on individual element indicates the action that is being performed on them. Aclient always sends an Action List to the service during create, createOrUpdate andupdate operation. The action flag can have the following permissible values:

During a create operation, the service assumes an implicit value of "Create" for theaction flag. During an update and createOrUpdate operation, any of the permissiblevalues can be specified and the service processes accordingly.

For instance, if a new address is to be added to a PersonInfo object, an action flag of"Create" should be passed in for that element during the updatePersons operation.

Similarly, if an existing address is to be deleted from a PersonInfo object, an action flagof "Delete" should be passed in for the element during the updatePersons operation, inaddition to passing the identifiers that can uniquely identify the element.


24/134

Entity Operations


If an action flag of "CreateOrUpdate" is provided for the address element during theupdatePersons operation, if the address exists, it shall be updated. If it does not exist, itwill be created and appended to the existing list of addresses.

1.5 Entity OperationsThe Data Loading web services provide CRUD (Create, Read, Update, and Delete)operations on most of the entities. Delete operations are not supported on Person andInstitution entities. This is to preserve data consistency as deleting a Person or anInstitution could have adverse effect. The semantics of the various operationssupported by Data Loading Services are summarized in the following sections.

1.5.1 create Operation

This operation supports the creation of an array of homogeneous entities as an atomicunit of work. The entire transaction is rolled back if any failure occurs during thecreation process.

On successful creation, the response includes the oslId of each entity that has beencreated.

1.5.2 createOrUpdate Operation

This operation supports creating or updating an array of homogeneous entities as anatomic unit of work. The entire transaction is rolled back if any failure occurs duringthe create or update process.

If an oslId is specified, the service tries to locate the entity to update based on theoslId. If found, the entity is updated.

If no entity is retrieved for the specified oslId, the services check if the combination ofexternalId and externalSystemId is specified. If specified, the service tries to locate theentity based on the externalId & externalSystemId. If the entity is found, it is updated.

If the identification mechanism does not fetch an entity, a new record is created andthe oslId pertaining to the record is returned to the caller in the response.

1.5.3 update Operation

This operation supports updating an array of homogeneous entities as an atomic unitof work. The entire transaction is rolled back if any failure occurs during the updateprocess.

If an oslId is specified, the service tries to locate the entity to update based on theoslId. If found, the entity is updated.

If no entity is retrieved for the specified oslId, the service checks if the combination ofexternalId and externalSystemId is specified. If specified, the service tries to locate the

entity based on the externalId & externalSystemId. If the entity is found, it is updated.

If the identification mechanism does not fetch an entity, an error is raised.

In an update operation, it is not required to send the entire object structure. In additionto the identification of the entity, it is sufficient to specify only the elements to bemodified. The service updates the entity with only the modified elements. Forinstance, if the preferredName of a person with oslId 100 is modified to "John", it issufficient to send the following information to the service.


25/134

Web Service Exceptions

Overview 1-5

xmlns:dat="http://www.oracle.com/osl/lt/service/dataloading"

xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-sec

ext-1.0.xsd">

dataloading

welcome1

100

John

1.5.4 remove Operation

This operation supports deleting an array of homogeneous entities as an atomic unit ofwork. The entire transaction is rolled back if any failure occurs during the deletionprocess.

If an oslId is specified, the service tries to locate the entity to delete based on the oslId.If found, the entity is deleted.

If no entity is retrieved for the specified oslId, the service checks if the combination ofexternalId and externalSystemId is specified. If specified, the service tries to locate theentity based on the externalId & externalSystemId. If the entity is found, it is deleted.

Only the object identification mechanism must be specified for the remove operation.If other elements are specified, those are ignored by the service.

1.5.5 get Operation

This operation supports querying entities based on the identifiers.

If an oslId is specified, the service tries to locate the entity based on the oslId. If found,the entity is returned.

If no entity is retrieved for the specified oslId, the service checks if the combination ofexternalId and externalSystemId is specified. If specified, the service tries to locate theentity based on the externalId & externalSystemId. If the entity is found, it is returned.

Only the object identification mechanism must be specified for the get operation, ifother elements are specified, those are ignored by the service.

1.6 Web Service ExceptionsDuring Data Loading Service operations, Web Service Exceptions might beencountered. These exceptions indicate possible errors or business rule violations inthe input parameters. To help locate the root cause, error codes and error messages arecontained within the exceptions. A summary of the Web Service Exceptions areprovided below.


26/134

Web Service Exceptions


1.6.1 CreationException

A CreationException is thrown when the system cannot create the specified entitywhen attempting to save the data into the database.

1.6.2 DataConstraintException

A DataConstraintException is thrown when the modified data is in violation of thebusiness rules. Common situations include updating the start date of a frameworksuch that the start date is later than the end date or creating a framework with anon-unique name.

1.6.3 InvalidParameter

An InvalidParameter exception is thrown when the input parameters are invalid orrequired fields are missing.

1.6.4 RemoveException

A RemoveException is thrown when an entity cannot be removed. This occurs when

an attempt is made to remove an entity that is in use. For example, an attempt is madeto remove a context adoption when the adopted context is referenced in a learningitem demonstration.

1.6.5 UpdateException

An UpdateException is thrown when the system cannot update the specified entitywhen attempting to save the data into the database.

1.6.6 ServiceException

A ServiceException is a general service exception that is thrown for an unspecifiedcondition.


27/134

2

Web Services 2-1

2Web Services

This chapter describes the available web services and their descriptions.

2.1 DataLoadingPartyServiceThe DataLoadingPartyService is used to load party information. This includesinstitutions, institution groups, people and their relationships.

2.1.1 createInstitutions

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

All new institutions must have a parent institution. This parent institution must be anexisting 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 phonecontact.

Parameter:

Return:

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

2.1.2 createInstitutionGroups

This method creates new institution groups. The institution group name must beunique.

Table 21 createInstitutions Parameter Summary

Type Description

InstitutionInfo[] List of institutions to create

Table 22 createInstitutions Return Summary

Type Description

InstitutionInfo[] List of created institutions


28/134

DataLoadingPartyService


Parameter:

Return:

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException

2.1.3 createOrUpdateInstitutionsThis method searches for the institutions using the IdInfo in the input InstitutionInfoand if the institution is found, it is updated; Otherwise, it is created. Note that theparent institution attribute cannot be updated.

Parameter:

Return:

Exception:

CreationException, DataConstraintException, InvalidParameters, ServiceException,UpdateException

2.1.4 createOrUpdateInstitutionGroups

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

Table 23 createInstitutionGroups Parameter Summary

Type Description

InstitutionGroupInfo[] List of institution groups tocreate

Table 24 createInstitutionGroups Return Summary

Type Description

InstitutionGroupInfo[] List of created institutiongroups

Table 25 createOrUpdateInstitutions Parameter Summary

Type Description

InstitutionInfo[] List of institutions to create orupdate

Table 26 createOrUpdateInstitutions Return Summary

Type Description

InstitutionInfo[] List of institutions created orupdated

Note: Only Create and Delete actions are allowed in theIdInfoActionInfo.


29/134

DataLoadingPartyService

Web Services 2-3

Parameter:

Return:

Exception:


2.1.5 createOrUpdatePersons

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

Parameter:

Return:

Exception:


2.1.6 createPersons

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

Parameter:

Table 27 createOrUpdateInstitutionGroups Parameter Summary

Type Description

InstitutionGroupInfo[] List of institution groups tocreate or updat

Oracle Student Guid

Documents

Transcript of Oracle Student Guid