This page explains how to read Webtrekk elements.
A collection / array of elements
| Field | Value | Description |
|---|---|---|
| id | string | Object ID |
| title | string | Object title |
| track_id | string | The track ID of the Webtrekk account |
| track_domain | string | The track domain of the Webtrekk account |
| mg | string | The mg parameter of the Webtrekk account |
| default | boolean | 1 if the account is the default. 0 otherwise |
| description | string | The associated description |
| 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) |
curl -i -H "Accept: application/json" -H "access-token: [your-access-token]" -X GET http://API_DOMAIN/rest/v2/webtrekk.json
{
"current_page": 1,
"data": [
{
"id":"2",
"title":"Webtrekk title",
"track_id":"track_id",
"track_domain":"track_domain",
"mg":null,
"description":null,
"default":"1",
"created_at":"2013-02-06 18:12:03"
}],
"first_page_url": "http://API_DOMAIN/rest/v2/webtrekk.json?search_page=1&search_for_page=100",
"from": 1,
"last_page": 1,
"last_page_url": "http://API_DOMAIN/rest/v2/webtrekk.json?search_page=1&search_for_page=100",
"next_page_url": null,
"path": "http://API_DOMAIN/rest/v2/webtrekk.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('webtrekk');
{resource-id}: the object ID
| Field | Value | Description |
|---|---|---|
| id | string | Object ID |
| title | string | Object title |
| track_id | string | The track ID of the Webtrekk account |
| track_domain | string | The track domain of the Webtrekk account |
| mg | string | The mg parameter of the Webtrekk account |
| default | boolean | 1 if the account is the default. 0 otherwise |
| description | string | The associated description |
| 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) |
curl -i -H "Accept: application/json" -H "access-token: [your-access-token]" -X GET http://API_DOMAIN/rest/v2/webtrekk/2.json
{
"id":"2",
"title":"Webtrekk title",
"track_id":"track_id",
"track_domain":"track_domain",
"mg":null,
"description":null,
"default":"1",
"created_at":"2013-02-06 18:12:03"
}
$merideApi = new Meride\Api('[your-auth-code]', 'http://API_DOMAIN/', 'v2');
$response = $merideApi->read('webtrekk', 2);
| Attribute | Value | Mandatory |
|---|---|---|
| search_string | A non-empty string that will be searched for in the title | 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 for all objects starting from the specified date |
NO |
| search_date_max | Format DATETIME aaaa-mm-gg oo:mm:ss. Search for all objects up to the specified date |
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 | Object title |
| track_id | string | The track ID of the Webtrekk account |
| track_domain | string | The track domain of the Webtrekk account |
| mg | string | The mg parameter of the Webtrekk account |
| default | boolean | 1 if the account is the default. 0 otherwise |
| description | string | The associated description |
| 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) |
curl -i -H "Accept: application/json" -H "access-token: [your-access-token]" -X GET "http://API_DOMAIN/rest/v2/webtrekk.json?search_string=title&search_for_page=5"
{
"current_page": 1,
"data": [
{
"id":"2",
"title":"Webtrekk title",
"track_id":"track_id",
"track_domain":"track_domain",
"mg":null,
"description":null,
"default":"1",
"created_at":"2013-02-06 18:12:03"
}],
"first_page_url": "http://API_DOMAIN/rest/v2/webtrekk.json?search_string=title&search_page=1&search_for_page=5",
"from": 1,
"last_page": 1,
"last_page_url": "http://API_DOMAIN/rest/v2/webtrekk.json?search_string=title&search_page=1&search_for_page=5",
"next_page_url": null,
"path": "http://API_DOMAIN/rest/v2/webtrekk.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('webtrekk', array (
'search_string' => 'title',
'search_for_page' => 5,
));