Meride API - Category - Read

This page explains how to read Category elements.

Entity name: category.

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

Attributes

No parameter

Response

A collection / array of elements

Field Value Description
id string Object ID
title string Object title
description string The associated description
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)
father_id int Father category ID

Example of a request

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

Example of a JSON response

{
	"current_page": 1,
	"data": [
	{
		"id":"2",
		"title":"Category title",
		"description":null,
		"created_at":"2013-02-06 17:11:03",
		"father_id": null
	}],
	"first_page_url": "http://API_DOMAIN/rest/v2/category.json?search_page=1&search_for_page=100",
	"from": 1,
	"last_page": 1,
	"last_page_url": "http://API_DOMAIN/rest/v2/category.json?search_page=1&search_for_page=100",
	"next_page_url": null,
	"path": "http://API_DOMAIN/rest/v2/category.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('category');
            

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

{resource-id}: the object ID

Attributes

No parameter

Response

Field Value Description
id string Object ID
title string Object title
description string The associated description
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)
father_id int Father category ID

Example of a request

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

Example of a JSON response

{
	"id":"2",
	"title":"Category title",
	"description":null,
	"created_at":"2013-02-06 17:11:03",
	"father_id": null
}            
PHP SDK documentation
$merideApi = new Meride\Api('[your-auth-code]', 'http://API_DOMAIN/', 'v2');
$response = $merideApi->read('category', 2);