Fetch the SCOs of Adobe Connect content that matches text to be searched.

Availability

Breeze 4

Description

Provides a list of all SCOs that have content matching the search text.

The sco-search action searches the content of some types of SCOs for the query string. The types of SCOs searched include presentation archives, meeting archives, and the presentation components of a course or curriculum. A presentation that is included in a course returns two sets of results, one for the actual presentation and one for the course. The search does not include the SCO name or any metadata about the SCO stored in the database.

The query is not case-sensitive and allows wildcards at the end of a query string. The allowed wildcards are:

  • An asterisk (*) to match any character or characters

  • A question mark (?) to match any one character

For example, you can use the query strings quiz, qu*, or qui? . However, you cannot use a wildcard at the beginning or within a query string.

You can also use the operators and and or to return multiple matches, with spaces separating the operator and the search terms, like this:

 https://example.com/api/xml?action=sco-search&query=quiz or test

If you search on quizortest, for example, the server interprets it as a literal string and returns only exact matches.

Request URL

 http://server_name/api/xml 
     ?action=sco-search 
     &query=querystring 
     &filter-definition=value 
     &sort-definition=value 
     &session=BreezeSessionCookieValue

Parameters

Name

Type

Required

Description

query

Query string

Y

A string to search for. To use any of these special characters in the query string, escape them with a backslash before the character:

+ - && || ! ( ) { } [ ] ^ " ~ *

? : \

The query string is not case-sensitive and allows wildcard characters * and ? at the end of the query string.

filter-definition

Filter definition

N

A filter to reduce the volume of the response.

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 filter the response on any element or attribute it contains.

Response structure

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
     <status code=allowedValue />  
     <sco-search-info> 
         <sco sco-id=integer folder-id=integer type=allowedValue  
                     icon=allowedValue byte-count=integer tree-type=integer> 
             <name>string</name>  
             <url-path>string</url-path>  
             <date-created>datetime</date-created>  
             <date-modified>datetime</date-modified>  
             <hit>integer</hit>  
             <hit-type>allowedValue</hit-type>  
             <thumbnail-path>string</thumbnail-path>  
         </sco> 
     </sco-search-info> 
 </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).

sco-search-info  

Container

The list of objects (SCOs) that match the search query.

sco  

Container

Details about one object that matches the search.

  sco-id

BIGINT

The unique ID of the SCO.

  folder-id

BIGINT

The ID of the folder in which the SCO is stored.

  type

Allowed value

The content type assigned to the SCO (see type for values).

  icon

Allowed value

The icon that visually identifies the SCO in a user interface.

  byte-count

Integer

The size of the SCO, in bytes.

  tree-type

Integer

The tree type.

name  

String

The file name of the SCO.

url-path  

String

The unique identifier that comes after the domain name in the SCO URL.

date-created  

Datetime

The date the SCO was created.

date-modified  

Datetime

The date the SCO was modified.

hit  

Integer

The sequence number of this occurrence of the query string in the SCO.

hit-type  

Allowed value

The type of content in which the search term was found. Allowed values are metadata and slide.

hit-url  

String

A relative URL to the position where the search term was found in the content, for example, to a specific slide. Must be appended to the url-path.

thumbnail-path  

String

A relative URL to an image of the SCO that contains the search term.

Sample request

 https://example.com/api/xml?action=sco-search&query=quiz

Sample response

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
     <status code="ok" />  
     <sco-search-info> 
         <sco sco-id="5677964" folder-id="2562850" type="content"  
                 icon="producer" byte-count="5985" tree-type="13"> 
             <name>Final Quiz</name>  
             <url-path>/p46125962/</url-path>  
             <date-created>2005-05-09T14:24:36.390-07:00</date-created>  
             <date-modified>2005-05-09T14:24:36.390-07:00</date-modified>  
             <hit>0</hit>  
             <hit-type>metadata</hit-type>  
         </sco> 
         <sco sco-id="5677964" folder-id="2562850" type="content"  
                 icon="producer" byte-count="5985"> 
             <name>Final Quiz</name>  
             <url-path>/p46125962/</url-path>  
             <date-created>2005-05-09T14:24:36.390-07:00</date-created>  
             <date-modified>2005-05-09T14:24:36.390-07:00</date-modified>  
             <hit>7</hit>  
             <hit-type>slide</hit-type>  
             <hit-url>slide=7</hit-url>  
         </sco> 
         ... 
     </sco-search-info> 
 </results>

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