Search Web Service (20071001) Interface Definition

From Fliqz FAQ

Jump to: navigation, search

Contents

Introduction

A Web service that allows searching by:

  • Upload date (except deleted files)
  • Availability date (uploaded and encoded, but not deleted)
  • Approval date (uploaded, encoded and approved, but not deleted)
  • Number of shares
  • Number of plays
  • Rating

NOTE: The text describing the service contains URIs. These are fully qualified names, identifying an operation or a data type rather than a location. In other words, http://fliqz.com/search/20071001/IVideoSearchService/GetByUploadDate is the fully qualified name of the Get By Upload Date operation, not the location where the operation is exposed.

Locations

Operations

Get By Upload Date

http://fliqz.com/search/20071001/IVideoSearchService/GetByUploadDate

Returns media files in order of upload date. Note that this returns all uploaded media files, including those that have not yet been encoded or approved.

Request

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/accountId 1 1 GUID The ID of your account.
http://fliqz.com/services/search/20071001/oldest 0 1 xs:DateTime The oldest upload date included in the search.
http://fliqz.com/services/search/20071001/mostRecent 0 1 xs:DateTime The most recent upload date included in the search.
http://fliqz.com/services/search/20071001/maxResults 0 1 xs:int The maximum number of videos returned in the response. If this is not specified, all uploaded videos are returned.
http://fliqz.com/services/search/20071001/order 0 1 SortOrder The order of the response. If Asc is specified, results are returned in ascending order (earliest upload date first). If Desc is specified, results are returned in descending order (latest upload date first).
http://fliqz.com/services/search/20071001/pageSize 0 1 xs:int The maximum number of videos returned in a single response page. A default value of 20 is set in the service. See GetNextPage.

Response

http://fliqz.com/search/20071001/IVideoSearchService/GetByUploadDateResponse

Search results are returned in pages whereby the maximum number of pages, and the number of results included in each page, are determined the original search call. The search call returns the first results page. Subsequent pages are retrieved using the GetNextPage web services method. An identifier (the enumeration context ID) returned in the search call must be included in calls to the GetNextPage method.

The response contains a single optional element, http://fliqz.com/search/20071001/IVideoSearchService/GetByUploadDateResult, which contains the following information:

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/group 0 1 media:group Contains zero or more media:content objects, one for each video. The objects include additional, Fliqz-specific information. See below.
http://fliqz.com/services/search/20071001/nextpage 0 1 GUID Contains the enumeration context identifier used to retrieve the next page of videos. This is not included if no further pages are available.

media:content objects returned in the response contain the following Fliqz-specific elements:

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/shares 1 1 xs:int Returns the total number of shares for the video.
http://fliqz.com/services/search/20071001/plays 1 1 xs:int Returns the total number of plays for the video.
http://fliqz.com/services/search/20071001/userRating 0 1 xs:double Returns the user rating for the period--note that this does not include rating data collected prior to the specified period.
http://fliqz.com/services/search/20071001/userRatingCount 1 1 xs:int Returns the number of ratings.
http://fliqz.com/services/search/20071001/status 1 1 VideoStatus Returns the current status of the media item.
http://fliqz.com/services/search/20071001/flags 0 1 FlagReport Returns the flags reported for the media item.
http://fliqz.com/services/search/20071001/embed 0 1 xs:string Returns the embed code for the item.

Faults

A single fault message is returned containing the following parameters:

Element Name Min Max Type Description
detail 1 1 GUID The ID of the fault logged at Fliqz.

Get By Rating

http://fliqz.com/search/20071001/IVideoSearchService/GetByRating

Returns approved media files in order of rating. Rating is chosen, by your users, through the player menu.

Request

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/accountId 1 1 GUID The ID of your account.
http://fliqz.com/services/search/20071001/oldest 0 1 xs:DateTime The oldest upload date included in the search.
http://fliqz.com/services/search/20071001/mostRecent 0 1 xs:DateTime The most recent upload date included in the search.
http://fliqz.com/services/search/20071001/maxResults 0 1 xs:int The maximum number of media files returned in the response. If this is not specified, all approved media files are returned.
http://fliqz.com/services/search/20071001/lowerThreshold 0 1 xs:double The threshold defining the lower limit of values returned. For example, if this is set to 1.0, then only media files with ratings equal to or above 1.0 are eligible to be returned.
http://fliqz.com/services/search/20071001/upperThreshold 0 1 xs:double The threshold defining the upper limit of values returned. For example if this is set to 1.0, then only media files with ratings equal to or below 1.0 are eligible to be returned.
http://fliqz.com/services/search/20071001/order 0 1 SortOrder The order of the response. If Asc is specified, results are returned in ascending order (lowest rating first). If Desc is specified, results are returned in descending order (highest rating first).
http://fliqz.com/services/search/20071001/pageSize 0 1 xs:int The maximum number of videos returned in a single response page. A default value of 20 is set in the service. See GetNextPage.

Response

http://fliqz.com/search/20071001/IVideoSearchService/GetByRatingResponse

Search results are returned in pages whereby the maximum number of pages, and the number of results included in each page, are determined the original search call. The search call returns the first results page. Subsequent pages are retrieved using the GetNextPage Web services method. An identifier (the enumeration context ID) returned in the search call must be included in calls to the GetNextPage method.

The response contains a single optional element, http://fliqz.com/search/20071001/IVideoSearchService/GetByRatingResult, which contains the following information:

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/group 0 1 media:group Contains zero or more media:content objects, one for each video. The objects include additional, Fliqz specific, information. See below.
http://fliqz.com/services/search/20071001/nextpage 0 1 GUID Contains the enumeration context identifier used to retrieve the next page of videos. This is not included if no further pages are available.

media:content objects returned in the response contain the following Fliqz-specific elements:

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/shares 1 1 xs:int Returns the total number of shares for the video.
http://fliqz.com/services/search/20071001/plays 1 1 xs:int Returns the total number of plays for the video.
http://fliqz.com/services/search/20071001/userRating 0 1 xs:double Returns the user rating for the period--note that this does not include rating data collected prior to the specified period.
http://fliqz.com/services/search/20071001/userRatingCount 1 1 xs:int Returns the number of ratings.
http://fliqz.com/services/search/20071001/status 1 1 VideoStatus Returns the current status of the media item.
http://fliqz.com/services/search/20071001/flags 0 1 FlagReport Returns the flags reported for the media item.
http://fliqz.com/services/search/20071001/embed 0 1 xs:string Returns the embed code for the item.

Faults

A single fault message is returned containing the following parameters:

Element Name Min Max Type Description
detail 1 1 GUID The ID of the fault logged at Fliqz.

Get By Shares

http://fliqz.com/search/20071001/IVideoSearchService/GetByShares

Returns approved media files in order of shares. A media file may be shared, in the form of an e-mail, by your users through the player menu.

Request

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/accountId 1 1 GUID The ID of your account.
http://fliqz.com/services/search/20071001/oldest 0 1 xs:DateTime The oldest upload date included in the search.
http://fliqz.com/services/search/20071001/mostRecent 0 1 xs:DateTime The most recent upload date included in the search.
http://fliqz.com/services/search/20071001/maxResults 0 1 xs:int The maximum number of media files returned in the response. If this is not specified, all approved media files are returned.
http://fliqz.com/services/search/20071001/lowerThreshold 0 1 xs:double The threshold defining the lower limit of values returned. For example, if this is set to 100.0, then only media files that have been shared 100 times or more are eligible to be returned.
http://fliqz.com/services/search/20071001/upperThreshold 0 1 xs:double The threshold defining the upper limit of values returned. For example, if this is set to 100.0, then only media files that have been shared 100 times or less are eligible to be returned.
http://fliqz.com/services/search/20071001/order 0 1 SortOrder The order of the response. If Asc is specified, results are returned in ascending order (least shared first). If Desc is specified, results are returned in descending order (most shared first).
http://fliqz.com/services/search/20071001/pageSize 0 1 xs:int The maximum number of videos returned in a single response page. A default value of 20 is set in the service. See GetNextPage.

Response

http://fliqz.com/search/20071001/IVideoSearchService/GetBySharesResponse

Search results are returned in pages whereby the maximum number of pages, and the number of results included in each page, are determined the original search call. The search call returns the first results page. Subsequent pages are retrieved using the GetNextPage Web services method. An identifier (the enumeration context ID) returned in the search call must be included in calls to the GetNextPage method.

The response contains a single optional element, http://fliqz.com/search/20071001/IVideoSearchService/GetBySharesResult, which contains the following information:

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/group 0 1 media:group Contains zero or more media:content objects, one for each video. The objects include additional, Fliqz-specific information. See below.
http://fliqz.com/services/search/20071001/nextpage 0 1 GUID Contains the enumeration context identifier used to retrieve the next page of videos. This is not included if no further pages are available.

media:content objects returned in the response contain the following Fliqz-specific elements:

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/shares 1 1 xs:int Returns the total number of shares for the video.
http://fliqz.com/services/search/20071001/plays 1 1 xs:int Returns the total number of plays for the video.
http://fliqz.com/services/search/20071001/userRating 0 1 xs:double Returns the user rating for the period--note that this does not include rating data collected prior to the specified period.
http://fliqz.com/services/search/20071001/userRatingCount 1 1 xs:int Returns the number of ratings.
http://fliqz.com/services/search/20071001/status 1 1 VideoStatus Returns the current status of the media item.
http://fliqz.com/services/search/20071001/flags 0 1 FlagReport Returns the flags reported for the media item.
http://fliqz.com/services/search/20071001/embed 0 1 xs:string Returns the embed code for the item.

Faults

A single fault message is returned containing the following parameters:

Element Name Min Max Type Description
detail 1 1 GUID The ID of the fault logged at Fliqz.

Get By Plays

http://fliqz.com/search/20071001/IVideoSearchService/GetByPlays

Returns approved media files in order of number of plays.

Request

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/accountId 1 1 GUID The ID of your account.
http://fliqz.com/services/search/20071001/oldest 0 1 xs:DateTime The oldest upload date included in the search.
http://fliqz.com/services/search/20071001/mostRecent 0 1 xs:DateTime The most recent upload date included in the search.
http://fliqz.com/services/search/20071001/maxResults 0 1 xs:int The maximum number of media files returned in the response. If this is not specified, all approved media files are returned.
http://fliqz.com/services/search/20071001/lowerThreshold 0 1 xs:double The threshold defining the lower limit of values returned. For example, if this is set to 100.0, then only media files that have been played 100 times or more are eligible to be returned.
http://fliqz.com/services/search/20071001/upperThreshold 0 1 xs:double The threshold defining the upper limit of values returned. For example, if this is set to 100.0, then only media files that have been played 100 times or less are eligible to be returned.
http://fliqz.com/services/search/20071001/order 0 1 SortOrder The order of the response. If Asc is specified, results are returned in ascending order (earliest upload date first). If Desc is specified, results are returned in descending order (latest upload date first).
http://fliqz.com/services/search/20071001/pageSize 0 1 xs:int The maximum number of media files returned in a single response page. A default value of 20 is set in the service. See GetNextPage.

Response

http://fliqz.com/search/20071001/IVideoSearchService/GetByPlaysResponse

Search results are returned in pages whereby the maximum number of pages, and the number of results included in each page, are determined the original search call. The search call returns the first results page. Subsequent pages are retrieved using the GetNextPage Web services method. An identifier (the enumeration context ID) returned in the search call must be included in calls to the GetNextPage method.

The response contains a single optional element, http://fliqz.com/search/20071001/IVideoSearchService/GetByPlaysResult, which contains the following information:

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/group 0 1 media:group Contains zero or more media:content objects, one for each video. The objects include additional, Fliqz-specific information. See below.
http://fliqz.com/services/search/20071001/nextpage 0 1 GUID Contains the enumeration context identifier used to retrieve the next page of videos. This is not included if no further pages are available.

media:content objects returned in the response contain the following Fliqz-specific elements:

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/shares 1 1 xs:int Returns the total number of shares for the video.
http://fliqz.com/services/search/20071001/plays 1 1 xs:int Returns the total number of plays for the video.
http://fliqz.com/services/search/20071001/userRating 0 1 xs:double Returns the user rating for the period--note that this does not include rating data collected prior to the specified period.
http://fliqz.com/services/search/20071001/userRatingCount 1 1 xs:int Returns the number of ratings.
http://fliqz.com/services/search/20071001/status 1 1 VideoStatus Returns the current status of the media item.
http://fliqz.com/services/search/20071001/flags 0 1 FlagReport Returns the flags reported for the media item.
http://fliqz.com/services/search/20071001/embed 0 1 xs:string Returns the embed code for the item.

Faults

A single fault message is returned containing the following parameters:

Element Name Min Max Type Description
detail 1 1 GUID The ID of the fault logged at Fliqz.

Get By Approval Date

http://fliqz.com/search/20071001/IVideoSearchService/GetByApprovalDate

Returns available media files in order of approval date (this implies that the media files have been uploaded and encoded).

Request

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/accountId 1 1 GUID The ID of your account.
http://fliqz.com/services/search/20071001/oldest 0 1 xs:DateTime The oldest upload date included in the search.
http://fliqz.com/services/search/20071001/maxResults 0 1 xs:int The maximum number of videos returned in the response. If this is not specified, all uploaded videos are returned.
http://fliqz.com/services/search/20071001/pageSize 0 1 xs:int The maximum number of videos returned in a single response page. A default value of 20 is set in the service. See GetNextPage.

Response

http://fliqz.com/search/20071001/IVideoSearchService/GetByApprovalDateResponse

Search results are returned in pages whereby the maximum number of pages, and the number of results included in each page, are determined the original search call. The search call returns the first results page. Subsequent pages are retrieved using the GetNextPage web services method. An identifier (the enumeration context ID) returned in the search call must be included in calls to the GetNextPage method.

The response contains a single optional element, http://fliqz.com/search/20071001/IVideoSearchService/GetByApprovalDateResult, which contains the following information:

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/group 0 1 media:group Contains zero or more media:content objects, one for each video. The objects include additional, Fliqz-specific information. See below.
http://fliqz.com/services/search/20071001/nextpage 0 1 GUID Contains the enumeration context identifier used to retrieve the next page of videos. This is not included if no further pages are available.

media:content objects returned in the response contain the following Fliqz-specific elements:

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/shares 1 1 xs:int Returns the total number of shares for the video.
http://fliqz.com/services/search/20071001/plays 1 1 xs:int Returns the total number of plays for the video.
http://fliqz.com/services/search/20071001/userRating 0 1 xs:double Returns the user rating for the period--note that this does not include rating data collected prior to the specified period.
http://fliqz.com/services/search/20071001/userRatingCount 1 1 xs:int Returns the number of ratings.
http://fliqz.com/services/search/20071001/status 1 1 VideoStatus Returns the current status of the media item.
http://fliqz.com/services/search/20071001/flags 0 1 FlagReport Returns the flags reported for the media item.
http://fliqz.com/services/search/20071001/embed 0 1 xs:string Returns the embed code for the item.

Faults

A single fault message is returned containing the following parameters:

Element Name Min Max Type Description
detail 1 1 GUID The ID of the fault logged at Fliqz.

Get By Availability Date

http://fliqz.com/search/20071001/IVideoSearchService/GetByAvailabilityDate

Returns available videos in order of availability date--that is, the date when the video was encoded.

Only available videos are returned--those that have been successfully encoded and not deleted. Note that this ignores the approval state.

Request

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/accountId 1 1 GUID The ID of your account.
http://fliqz.com/services/search/20071001/oldest 0 1 xs:DateTime The oldest upload date included in the search.
http://fliqz.com/services/search/20071001/maxResults 0 1 xs:int The maximum number of videos returned in the response. If this is not specified then all available (uploaded and encoded) videos are returned.
http://fliqz.com/services/search/20071001/pageSize 0 1 xs:int The maximum number of videos returned in a single response page. A default value of 20 is set in the service. See GetNextPage.

Response

http://fliqz.com/search/20071001/IVideoSearchService/GetByAvailabilityDateResponse

Search results are returned in pages whereby the maximum number of pages, and the number of results included in each page, are determined the original search call. The search call returns the first results page. Subsequent pages are retrieved using the GetNextPage web services method. An identifier (the enumeration context ID) returned in the search call must be included in calls to the GetNextPage method.

The response contains a single optional element, http://fliqz.com/search/20071001/IVideoSearchService/GetByAvailabilityDateResult, which contains the following information:

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/group 0 1 media:group Contains zero or more media:content objects, one for each video. The objects include additional, Fliqz-specific information. See below.
http://fliqz.com/services/search/20071001/nextpage 0 1 GUID Contains the enumeration context identifier used to retrieve the next page of videos. This is not included if no further pages are available.

media:content objects returned in the response contain the following Fliqz-specific elements:

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/shares 1 1 xs:int Returns the total number of shares for the video.
http://fliqz.com/services/search/20071001/plays 1 1 xs:int Returns the total number of plays for the video.
http://fliqz.com/services/search/20071001/userRating 0 1 xs:double Returns the user rating for the period--note that this does not include rating data collected prior to the specified period.
http://fliqz.com/services/search/20071001/userRatingCount 1 1 xs:int Returns the number of ratings.
http://fliqz.com/services/search/20071001/status 1 1 VideoStatus Returns the current status of the media item.
http://fliqz.com/services/search/20071001/flags 0 1 FlagReport Returns the flags reported for the media item.
http://fliqz.com/services/search/20071001/embed 0 1 xs:string Returns the embed code for the item.

Faults

A single fault message is returned containing the following parameters:

Element Name Min Max Type Description
detail 1 1 GUID The ID of the fault logged at Fliqz.

Get Next Page

http://fliqz.com/search/20071001/IVideoSearchService/GetNextPage

Returns the next page of search results.

Results from all search methods are returned in pages whereby the maximum number of pages, and the number of results included in each page, are determined the original search call. The search call returns the first results page. Subsequent pages are retrieved using this Web services method. An identifier (the enumeration context ID) returned in the search call must be included in calls to this method.

Request

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/accountId 1 1 GUID The ID of the enumeration context returned by the search call.

Response

http://fliqz.com/search/20071001/IVideoSearchService/GetNextPageResponse<nowiki> Search results are returned in pages whereby the maximum number of pages, and the number of results included in each page, are determined the original search call. The search call returns the first results page. Subsequent pages are retrieved using the [[#Get_Next_Page|GetNextPage]] web services method. An identifier (the enumeration context ID) returned in the search call must be included in calls to the [[#Get_Next_Page|GetNextPage]] method. The response contains a single optional element, <nowiki>http://fliqz.com/search/20071001/IVideoSearchService/GetNextPageResult, which contains the following information:

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/group 0 1 media:group Contains zero or more media:content objects, one for each video. The objects include additional, Fliqz-specific information. See below.
http://fliqz.com/services/search/20071001/nextpage 0 1 GUID Contains the enumeration context identifier used to retrieve the next page of videos. This is not included if no further pages are available.

media:content objects returned in the response contain the following Fliqz-specific elements:

Element Name Min Max Type Description
http://fliqz.com/services/search/20071001/shares 1 1 xs:int Returns the total number of shares for the video.
http://fliqz.com/services/search/20071001/plays 1 1 xs:int Returns the total number of plays for the video.
http://fliqz.com/services/search/20071001/userRating 0 1 xs:double Returns the user rating for the period--note that this does not include rating data collected prior to the specified period.
http://fliqz.com/services/search/20071001/userRatingCount 1 1 xs:int Returns the number of ratings.
http://fliqz.com/services/search/20071001/status 1 1 VideoStatus Returns the current status of the media item.
http://fliqz.com/services/search/20071001/flags 0 1 FlagReport Returns the flags reported for the media item.
http://fliqz.com/services/search/20071001/embed 0 1 xs:string Returns the embed code for the item.

Faults

A single fault message is returned containing the following parameters:

Element Name Min Max Type Description
detail 1 1 GUID The ID of the fault logged at Fliqz.

Data Types

Sort Order (http://fliqz.com/services/search/20071001/SortOrder)

An enumeration containing the order in which results returned by a search request are sorted.

Enumeration Value State Description
Asc Ascending The media files are listed in ascending order.
Desc Descending The media files are listed in descending order.

GUID (http://schemas.microsoft.com/2003/10/Serialization/guid)

A 32-character hexadecimal string in the following form:

[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Video Status (http://fliqz.com/services/search/20071001/VideoStatus)

An enumeration defining the acceptable status values for a media file.

Enumeration Value State Description
Encoding Encoding The media file is in the queue to be created.
Available Available The media file is available.
Broken Broken The media file could not be created.
Deleted Deleted The media file has been deleted as a result of user action.

Flag Report (http://fliqz.com/services/080107/flagReport)

An element used to contain the reports of offensive content in the media file.

Element Name Min Max Type Description
Pornography 1 1 xs:int Report of pornographic content.
Violence 1 1 xs:int Report of violent content.
Racial 1 1 xs:int Report of racially offensive content.
Language 1 1 xs:int Report of offensive language.
Other 1 1 xs:int Report of other types of offensive content.
Personal tools