This page explains how to read Video elements.
A collection / array of elements
| Field | Value | Description |
|---|---|---|
| id | string | Object ID |
| title | string | The title of the video |
| short_description | string | The associated short description |
| description | string | The associated complete description |
| tags | string | List of tags separated by commas |
| duration | float | Video duration in seconds |
| available_video | 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 |
| created_at | string | The create date that follows the format Y-m-d H:i:sY(year) m(month) d(day) H(hours) i(minutes) s(seconds) |
| preview_image | string | URL of the associated preview image |
curl -i -H "Accept: application/json" -H "access-token: [your-access-token]" -X GET http://API_DOMAIN/rest/v2/video.json
{
"current_page": 1,
"data": [
{
"id":"2",
"title":"Video title",
"short_description":"",
"description":"",
"tags":"",
"duration":306.32,
"available_video":"0",
"invalid_video":"0",
"created_at":"2012-09-25 17:55:47",
"preview_image":"http:\/\/example.com\/meride\/video\/images\/test_image.jpg"
}],
"first_page_url": "http://API_DOMAIN/rest/v2/video.json?search_page=1&search_for_page=100",
"from": 1,
"last_page": 1,
"last_page_url": "http://API_DOMAIN/rest/v2/video.json?search_page=1&search_for_page=100",
"next_page_url": null,
"path": "http://API_DOMAIN/rest/v2/video.json",
"per_page": 100,
"prev_page_url": null,
"to": 1,
"total": 1
}
$merideApi = new Meride\Api('[your-auth-code]', 'http://API_DOMAIN/', 'v2');
$response = $merideApi->all('video');
{resource-id}: the object ID
| Field | Value | Description |
|---|---|---|
| id | string | Object ID |
| title | string | The title of the video |
| short_description | string | The associated short description |
| description | string | The associated complete description |
| tags | string | List of tags separated by commas |
| duration | float | Video duration in seconds |
| available_video | 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 |
| created_at | string | The create date that follows the format Y-m-d H:i:sY(year) m(month) d(day) H(hours) i(minutes) s(seconds) |
| preview_image | string | URL of the associated preview image |
curl -i -H "Accept: application/json" -H "access-token: [your-access-token]" -X GET http://API_DOMAIN/rest/v2/video/2.json
{
"id":"2",
"title":"Video title",
"short_description":"",
"description":"",
"tags":"",
"duration":306.32,
"available_video":"0",
"invalid_video":"0",
"created_at":"2012-09-25 17:55:47",
"preview_image":"http:\/\/example.com\/meride\/video\/images\/test_image.jpg"
}
$merideApi = new Meride\Api('[your-auth-code]', 'http://API_DOMAIN/', 'v2');
$response = $merideApi->read('video', 2);
| 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 oo:mm:ss. Search all videos starting from the specified date |
NO |
| search_date_max | Format DATETIME aaaa-mm-gg oo:mm:ss. 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_page | Integer greater than 0. | NO |
| search_for_page | Integer greater than 0. Number of objects to return per page. | NO |
| search_order_by | Parameter against which to order the output. Allowed values: id,title,created_at |
NO |
| search_asc_desc | If the search_order_by parameter is used to sort the output, it is possible to specify the ascending or descending order. Allowed values: ASC,DESC |
NO |
A collection / array of elements
| Field | Value | Description |
|---|---|---|
| id | string | Object ID |
| title | string | The title of the video |
| short_description | string | The associated short description |
| description | string | The associated complete description |
| tags | string | List of tags separated by commas |
| duration | float | Video duration in seconds |
| available_video | 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 |
| created_at | string | The create date that follows the format Y-m-d H:i:sY(year) m(month) d(day) H(hours) i(minutes) s(seconds) |
| preview_image | string | URL of the associated preview image |
curl -i -H "Accept: application/json" -H "access-token: [your-access-token]" -X GET "http://API_DOMAIN/rest/v2/video.json?search_string=title&search_for_page=5"
{
"current_page": 1,
"data": [
{
"id":"2",
"title":"Video title",
"short_description":"",
"description":"",
"tags":"",
"duration":306.32,
"available_video":"0",
"invalid_video":"0",
"created_at":"2012-09-25 17:55:47",
"preview_image":"http:\/\/example.com\/meride\/video\/images\/test_image.jpg"
}],
"first_page_url": "http://API_DOMAIN/rest/v2/video.json?search_string=title&search_page=1&search_for_page=5",
"from": 1,
"last_page": 1,
"last_page_url": "http://API_DOMAIN/rest/v2/video.json?search_string=title&search_page=1&search_for_page=5",
"next_page_url": null,
"path": "http://API_DOMAIN/rest/v2/video.json",
"per_page": 5,
"prev_page_url": null,
"to": 1,
"total": 1
}
$merideApi = new Meride\Api('[your-auth-code]', 'http://API_DOMAIN/', 'v2');
$response = $merideApi->search('video', array (
'search_string' => 'title',
'search_for_page' => 5,
));