Skip Headers

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

Previous
| PDF · Mobi · ePub

# B Content Integration Service Objects

This appendix contains OSL content integration service object references.

## B.1 ContentsAssociationInfo

Represents Information about General Content references being associated with Rich Data.

Table B-1 list the attributes of ContentsAssociationInfo object.

Table B-1 ContentsAssociationInfo Attributes

Name | Type | Mandatory | Description
--- | --- | --- | ---
contentIds | ContentIdsInfo | Yes | General Content Identifiers.
context | ContentContextInfo | Yes | OSL Context.
userContext | UserContextInfo | Yes | OSL user making the CIWSI invocation.

## B.2 ContentContextInfo

Represents List of OSL Context.

Table B-2 list the attributes of ContentContextInfo object.

Table B-2 ContentContextInfo Attributes

Name | Type | Mandatory | Description
--- | --- | --- | ---
contexts | context[] | Yes | List of OSL Context

Table B-3 lists the context type.

Table B-3 context

Name | Type | Mandatory | Description
--- | --- | --- | ---
contextType | contextType | Yes | Type of OSL Context
contextValue | string | Yes | Value of OSL Context

Table B-4 lists the contextType type.

Table B-4 contextType

Name | Type | Mandatory | Description
--- | --- | --- | ---
Enumeration | string | Yes | Legal Values are: UserName, UserId, SchoolName, SchoolId, CourseName, CourseId, ClassName, ClassId, LearningItemName, LearningItemId, CourseTagName, CourseTagId, FrameworkItemName, FrameworkItemId, OutcomeStatementName, OutcomeStatementId, StudentName, StudentId, SubmissionGroupName, SubmissionGroupId

## B.3 ContentIdInfo

Represents Identity Information for Content in ECMS.

Table B-5 list the attributes of ContentIdInfo object.

Table B-5 ContentIdInfo Attributes

Name | Type | Mandatory | Description
--- | --- | --- | ---
contentId | string | Yes | Identifier of Content in ECMS.
contentVersionId | string | No | Version Identifier of Content in ECMS. If version identifier is not specified, then information contained in this structure represents the latest version.

## B.4 ContentIdsInfo

Represents a list of Identity Informations for Content in ECMS.

Table B-6 list the attributes of ContentIdsInfo object.

Table B-6 ContentIdsInfo Attributes

Name | Type | Mandatory | Description
--- | --- | --- | ---
contentIds | ContentIdInfo[] | Yes | List of Identifiers of Contents in ECMS.
userContext | UserContextInfo | Yes | OSL user making the CIWSI invocation.

## B.5 ContentInfo

Represents Content Information for Content in ECMS.

Table B-7 list the attributes of ContentInfo object.

Table B-7 ContentInfo Attributes

Name | Type | Mandatory | Description
--- | --- | --- | ---
contentId | ContentIdInfo | Yes | Identifier of Content in ECMS. If version identifier is not specified, then the content information should represent the latest version. Otherwise, it should be version specific.
contentURL | string | No | For ECMS supporting URL, this field should specify the URL of Content. If contentId specifies identifier for the latest version, then the URL should be for the latest version. Otherwise, the URL should point to the specific version.
contentTitle | string | Yes | Title of the Content.
contentFileName | string | No | File name of the Content in ECMS.
data | string | Yes | Raw data of Content.

## B.6 ContentSearchCriteriaInfo

Represents Informations that corresponds search criteria to List General Content.

Table B-8 list the attributes of ContentSearchCriteriaInfo object.

Table B-8 ContentSearchCriteriaInfo Attributes

Name | Type | Mandatory | Description
--- | --- | --- | ---
filters | searchFilter[] | Yes | Filter.
context | ContentContextInfo | Yes | OSL Context.

Table B-9 list the searchFilter type.

Table B-9 searchFilter

Name | Type | Mandatory | Description
--- | --- | --- | ---
Enumeration | string | Yes | Legal Values are: Images, LearningItems, or any

## B.7 ContentsUploadInfo

Represents Information to upload OSL Content.

Table B-10 list the attributes of ContentsUploadInfo object.

Table B-10 ContentsUploadInfo Attributes

Name | Type | Mandatory | Description
--- | --- | --- | ---
uploadInfos | uploadInfo[] | Yes | OSL Content Upload information.
userContext | UserContextInfo | Yes | OSL user making the CIWSI invocation.

Table B-11 lists the uploadInfo type.

Table B-11 uploadInfo

Name | Type | Mandatory | Description
--- | --- | --- | ---
data | base64Binary | Yes | Raw data of OSL Content to be uploaded.
title | string | Yes | Title of OSL Content.
fileName | string | Yes | File name of OSL Content.

## B.8 LearningItemPublishInfo

Represents Information to upload Exported Learning Item. Inherits from ContentsUploadInfo.

Table B-12 list the attributes of LearningItemPublishInfo object.

Table B-12 LearningItemPublishInfo Attributes

Name | Type | Mandatory | Description
--- | --- | --- | ---
contextInfo | ContentContextInfo | Yes | OSL Context.

## B.9 UserContextInfo

Represents OSL user making the CIWSI invocation.

Table B-13 list the attributes of UserContextInfo object.

Table B-13 UserContextInfo Attributes

Name | Type | Mandatory | Description
--- | --- | --- | ---
UserId | string | Yes | User Identifier (SSO user name) of OSL user making the invocation to CIWSI.