report-sco-views

For a SCO, fetch its name, last viewed time, type of SCO, and so on.

Availability

Breeze 4

Description

Indicates how many times, and how recently, a SCO was viewed.

Request URL

 http://server_name/api/xml 
     ?action=report-sco-views 
     &sco-id=integer 
     &session=BreezeSessionCookieValue

Parameters

Name

Type

Required

Description

sco-id

BIGINT

Y

The unique ID of a SCO to check for views.

session

String

N

The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library.

Filters

Results cannot be filtered or sorted.

Response structure

 <?xml version="1.0" encoding="utf-8" ?>  
 <results>  
     <status code=allowedValue />  
     <report-sco-views sco-id=integer type=allowedValue is-folder=boolean 
             views=integer>  
         <name>string</name>  
         <last-viewed-date>string</last-viewed-date>  
     </report-sco-views>  
 </results>

Response values

Element

Attribute

Type

Description

results  

Container

All results the action returns.

status  

Empty, with attributes

The status of the response.

  code

Allowed value

A code indicating the response status (see status).

report-sco-views  

Container

Information about how many times, and how recently, the presentation was viewed.

  sco-id

BIGINT

The unique ID of the presentation.

  type

Allowed value

The type of content object (SCO). Allowed values are content, curriculum, event, folder, link, meeting, and tree.

  is-folder

Boolean

A value indicating whether the SCO is a folder (if 1) or another type of object (if 0).

  views

Integer

The number of times users have viewed the SCO.

name  

String

The name of the SCO.

last-viewed-date  

Datetime

The date and time the SCO was last viewed.

Sample request

 https://server.com/api/xml?action=report-sco-views&sco-id=2006334909

Sample response

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
     <status code="ok" />  
     <report-sco-views sco-id="2006334909" type="content" is-folder="0" 
             views="3"> 
         <name>Quiz on California</name>  
         <last-viewed-date>2006-05-12T11:55:24.940-07:00</last-viewed-date>  
     </report-sco-views> 
 </results>

Adobe, Inc.

Get help faster and easier

New user?