Fetch basic information about slides in a presentation, such as how many times it has been viewed and the name of the slide.

Availability

Breeze 4

Description

Returns information about the slides in a presentation. The information includes how many times, and how recently, each slide has been viewed.

Request URL

 http://server_name/api/xml 
     ?action=report-sco-slides 
     &sco-id=integer 
     &asset-id=integer 
     &sort-definition=value 
     &session=BreezeSessionCookieValue

Parameters

Name

Type

Required

Description

sco-id

BIGINT

Y

The unique ID of a presentation.

asset-id

Integer

N

The version number of a presentation, incremented each time a presentation is uploaded.

sort-definition

Sort definition

N

A sort to return results in a certain sequence.

session

String

N

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

Filters

You can sort the response on any element or attribute it contains.

Response structure

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
     <status code=allowedValue />  
     <report-sco-slides> 
         <row slide=integer name=integer asset-id=integer views=integer> 
             <date-created>datetime</date-created>  
         </row> 
         ... 
     </report-sco-slides> 
 </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-slides  

Container

Information about all of the slides in a presentation, indicating how many times and how recently a slide has been viewed.

row  

Container

Information about one slide in the presentation.

  slide

Integer

The number of the slide within the presentation.

  name

Integer

The name of the slide in the presentation.

  asset-id

BIGINT

The version number of the presentation. Each time a presentation is published, it has a new asset-id.

  views

Integer

The number of times the slide has been viewed.

date-created  

Datetime

The date and time the slide was last viewed.

Sample request

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

Sample response

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
     <status code="ok" />  
     <report-sco-slides> 
         <row slide="1" name="1" views="4"> 
             <date-created>2006-05-16T11:14:54.453-07:00</date-created>  
         </row> 
         <row slide="2" name="2" views="4"> 
             <date-created>2006-05-16T11:14:59.593-07:00</date-created>  
         </row> 
         <row slide="3" name="3" views="3"> 
             <date-created>2006-05-12T11:55:52.330-07:00</date-created>  
         </row> 
         <row slide="4" name="4" views="3"> 
             <date-created>2006-05-12T11:55:55.487-07:00</date-created>  
         </row> 
         <row slide="5" name="5" views="3"> 
             <date-created>2006-05-12T11:56:00.233-07:00</date-created>  
         </row> 
     </report-sco-slides> 
 </results>

See also

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy