Meride API - Roll - Read

This page explains how to read Roll elements.

Entity name: advideo.

GET http://API_DOMAIN/rest/v2/advideo.{format}

Attributes

No parameter

Response

A collection / array of elements

Field Value Description
adv_type string Ad type
id string Object ID
title string The title of the video
destination_url string Destination URL at the user's click on the preroll
destination_url_title string Destination URL title
short_description string The associated short description
description string The associated complete description
tags string List of tags separated by commas
available_video boolean If the video is available for playback, the value will be set 1, otherwise it will have the value 0
created_at 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 request

curl -i -H "Accept: application/json" -H "access-token: [your-access-token]" -X GET  http://API_DOMAIN/rest/v2/advideo.json
            

Example of a JSON response

{
	"current_page": 1,
	"data": [
	{
		"adv_type": "video",
		"id":"2",
		"title":"Roll title",
		"destination_url": "http://meride.tv",
		"destination_url_title": "Meride",
		"short_description":"",
		"description":"",
		"tags":"",
		"available_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/advideo.json?search_page=1&search_for_page=100",
	"from": 1,
	"last_page": 1,
	"last_page_url": "http://API_DOMAIN/rest/v2/advideo.json?search_page=1&search_for_page=100",
	"next_page_url": null,
	"path": "http://API_DOMAIN/rest/v2/advideo.json",
	"per_page": 100,
	"prev_page_url": null,
	"to": 1,
	"total": 1
}            
PHP SDK documentation
$merideApi = new Meride\Api('[your-auth-code]', 'http://API_DOMAIN/', 'v2');
$response = $merideApi->all('advideo');
            

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

{resource-id}: the object ID

Attributes

No parameter

Response

Field Value Description
adv_type string Ad type
id string Object ID
title string The title of the video
destination_url string Destination URL at the user's click on the preroll
destination_url_title string Destination URL title
short_description string The associated short description
description string The associated complete description
tags string List of tags separated by commas
available_video boolean If the video is available for playback, the value will be set 1, otherwise it will have the value 0
created_at 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 request

curl -i -H "Accept: application/json" -H "access-token: [your-access-token]" -X GET  http://API_DOMAIN/rest/v2/advideo/2.json
            

Example of a JSON response

{
	"adv_type": "video",
	"id":"2",
	"title":"Roll title",
	"destination_url": "http://meride.tv",
	"destination_url_title": "Meride",
	"short_description":"",
	"description":"",
	"tags":"",
	"available_video":"0",
	"created_at":"2012-09-25 17:55:47",
	"preview_image":"http:\/\/example.com\/meride\/video\/images\/test_image.jpg"
}            
PHP SDK documentation
$merideApi = new Meride\Api('[your-auth-code]', 'http://API_DOMAIN/', 'v2');
$response = $merideApi->read('advideo', 2);