Meride API - Video - Read

This page explains how to read the content Video.

Entity name: video.

GET http://API_DOMAIN/rest/video.{format}

Attributes

No parameter

Response

A collection / array of elements

Field	Value	Description
id	string	Object ID
titolo	string	The title of the video
descrizione_breve	string	The associated short description
descrizione	string	The associated complete description
tags	string	List of tags separated by commas
video_disponibile	boolean	If the video is available for playback, the value will be set `1`, otherwise it will have the value `0`
invalid_video	boolean	`1` If the video was not converted correctly, `0` otherwise
data_inserimento	string	The create date that follows the format Y-m-d H:i:s `Y(year)` `m(month)` `d(day)` `H(hours)` `i(minutes)` `s(seconds)`
preview_image	string	URL of the associated preview image

Example of a curl request

curl -i -H "Accept: application/json" -H "access-token: Fun94nBf4YiaL20hG5np2Ki8mHtm9OCn4R6lPamNM8mNn7YFDRUvZveSbB0n6T" -X GET http://API_DOMAIN/rest/video.json

Note Una singola chiamata GET può restituire al massimo 250 record. Utilizza i parametri di ricerca search_limit e search_offset per scaricare tutti i record se necessario. Puoi eventualmente utilizzare il parametro search_count per conoscere il numero di record generati da una singola query di ricerca.

Example of a JSON response

[
    ...
{
    "id":"2",
    "titolo":"Video title",
    "descrizione_breve":"",
    "descrizione":"",
    "tags":"",
    "video_disponibile":"1",
    "invalid_video":"0",
    "data_inserimento":"2012-09-25 17:55:47",
    "preview_image":"http:\/\/example.com\/meride\/video\/images\/test_image.jpg"
}
    ...
]

GET http://API_DOMAIN/rest/video/{resource-id}.{format}

{resource-id}: the object ID

Attributes

No parameter

Response

Field	Value	Description
id	string	Object ID
titolo	string	The title of the video
descrizione_breve	string	The associated short description
descrizione	string	The associated complete description
tags	string	List of tags separated by commas
video_disponibile	boolean	If the video is available for playback, the value will be set `1`, otherwise it will have the value `0`
invalid_video	boolean	`1` If the video was not converted correctly, `0` otherwise
data_inserimento	string	The create date that follows the format Y-m-d H:i:s `Y(year)` `m(month)` `d(day)` `H(hours)` `i(minutes)` `s(seconds)`
preview_image	string	URL of the associated preview image

Example of a curl request

curl -i -H "Accept: application/json" -H "access-token: Fun94nBf4YiaL20hG5np2Ki8mHtm9OCn4R6lPamNM8mNn7YFDRUvZveSbB0n6T" -X GET http://API_DOMAIN/rest/video/2.json

Example of a JSON response

{
    "id":"2",
    "titolo":"Video title",
    "descrizione_breve":"",
    "descrizione":"",
    "tags":"",
    "video_disponibile":"1",
    "invalid_video":"0",
    "data_inserimento":"2012-09-25 17:55:47",
    "preview_image":"http:\/\/example.com\/meride\/video\/images\/test_image.jpg"
}

GET http://API_DOMAIN/rest/video.{format}

Note The option must be specified -G in the call with the curl command so that the search parameters are passed correctly

Attributes

Attribute	Value	Mandatory
search_string	A non-empty string that will be searched for in the title	NO
search_in_tags	`1` if you want to also search in tags. `0` otherwise	NO
search_in_description	`1` if you want to also search in the description. `0` otherwise	NO
search_date_min	Format DATETIME `aaaa-mm-gg`. Search all videos starting from the specified date	NO
search_date_max	Format DATETIME `aaaa-mm-gg`. Search all videos up to the specified date	NO
search_video_available	`1` if you want to search only among the videos already available. `0` if you want to search among the videos not yet available.	NO
search_limit	Intero maggiore di 0. Restituisce n video per la ricerca specificata.	NO
search_offset	Intero maggiore di 0. Restituisce i video a partire dal numero specificato.	NO
search_count	`1` se si vuole recuperare il dato sul numero di record trovati per la query effettuata. `0` otherwise	NO

Response

A collection / array of elements

Field	Value	Description
id	string	Object ID
titolo	string	The title of the video
descrizione_breve	string	The associated short description
descrizione	string	The associated complete description
tags	string	List of tags separated by commas
video_disponibile	boolean	Se il video è disponibile per la riproduzione sarà settato il valore `1`, otherwise it will have the value `0`
invalid_video	boolean	`1` If the video was not converted correctly, `0` otherwise
data_inserimento	string	The create date that follows the format Y-m-d H:i:s `Y(year)` `m(month)` `d(day)` `H(hours)` `i(minutes)` `s(seconds)`
preview_image	string	URL of the associated preview image

Example of a curl request

curl -i -G -H "Accept: application/json" -H "access-token: Fun94nBf4YiaL20hG5np2Ki8mHtm9OCn4R6lPamNM8mNn7YFDRUvZveSbB0n6T" -X GET -d "search_string=title&search_limit=5" http://API_DOMAIN/rest/video.json

Example of a JSON response

[
    ...
{
    "id":"2",
    "titolo":"Video title",
    "descrizione_breve":"",
    "descrizione":"",
    "tags":"",
    "video_disponibile":"1",
    "invalid_video":"0",
    "data_inserimento":"2012-09-25 17:55:47",
    "preview_image":"http:\/\/example.com\/meride\/video\/images\/test_image.jpg"
}
    ...
]