Difference between revisions of "NATS5 REST API Site GET tours"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''GET /site/tours''' == '''Description''' * Get tours '''Resource URL''' *<nowiki>http://domain/api/site/tours</nowiki>...") |
|||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_site_section = true |
}} | }} | ||
== '''GET /site/tours''' == | == '''GET /site/tours''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get tours | * Get tours | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 25: | Line 26: | ||
** required | ** required | ||
* '''deleted''' | * '''deleted''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''limited''' | * '''limited''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''populate_default''' | * '''populate_default''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''mobile''' | * '''mobile''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
| − | [[Category: | + | == '''Example Request''' == |
| − | [[Category: | + | Method: '''GET'''<br/> |
| + | URL: <nowiki>http://domain/api/site/tours</nowiki><br/> | ||
| + | Query String: <nowiki>siteid=2&deleted=1&limited=1&populate_default=0&mobile=0</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "tours": [ | ||
| + | { | ||
| + | "tourid": "2", | ||
| + | "tour": "testTour", | ||
| + | "siteid": "2", | ||
| + | "name": "test tour name", | ||
| + | "url": "http:\/\/toomuchmedia.com", | ||
| + | "linkdomain": "democash.com", | ||
| + | "description": "test tour description", | ||
| + | "hidden": "0", | ||
| + | "tour_type": "0", | ||
| + | "deleted": "0", | ||
| + | "default": 1 | ||
| + | }, | ||
| + | { | ||
| + | "tourid": "4", | ||
| + | "tour": "testTour2", | ||
| + | "siteid": "2", | ||
| + | "name": "test tour", | ||
| + | "url": "http:\/\/toomuchmedia.com", | ||
| + | "linkdomain": "democash.com", | ||
| + | "description": "this is a test tour description", | ||
| + | "hidden": "0", | ||
| + | "tour_type": "1", | ||
| + | "deleted": "0", | ||
| + | "default": 0 | ||
| + | } | ||
| + | ], | ||
| + | "site": { | ||
| + | "siteid": "2", | ||
| + | "name": "test site name" | ||
| + | } | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | == '''Example Code''' == | ||
| + | |||
| + | '''PHP''' | ||
| + | <pre> | ||
| + | <?php | ||
| + | |||
| + | $headers = array( //set your username and API key here | ||
| + | 'api-key: 44b5498dbcb481a0d00b404c0169af62', | ||
| + | 'api-username: tmm1phrvezsbu' | ||
| + | ); | ||
| + | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| + | |||
| + | $data = Array( | ||
| + | 'siteid' => '2', | ||
| + | 'deleted' => 1, | ||
| + | 'limited' => 1, | ||
| + | 'populate_default' => 0, | ||
| + | 'mobile' => 0, | ||
| + | ); | ||
| + | |||
| + | $request = Array( | ||
| + | 'method' => 'GET', | ||
| + | 'path' => 'v1/site/tours', | ||
| + | 'data' => $data | ||
| + | ); | ||
| + | |||
| + | /*code below is the same for (almost) every API call */ | ||
| + | |||
| + | $curl = curl_init(); | ||
| + | |||
| + | $url = $url.'/api/'.$request['path']; | ||
| + | |||
| + | $query = http_build_query($request['data']); | ||
| + | |||
| + | if($request['method'] == 'GET'){ | ||
| + | //add query string parameters to the end of the url | ||
| + | $url = $url.'?'.$query; | ||
| + | }else{ | ||
| + | //send parameters as POST fields | ||
| + | curl_setopt($curl, CURLOPT_POST, 1); | ||
| + | curl_setopt($curl, CURLOPT_POSTFIELDS, $query); | ||
| + | |||
| + | if($request['method'] != 'POST'){ | ||
| + | $headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method | ||
| + | } | ||
| + | } | ||
| + | curl_setopt($curl, CURLOPT_URL, $url); | ||
| + | curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); | ||
| + | curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); | ||
| + | |||
| + | |||
| + | $resp = curl_exec($curl); | ||
| + | //dumps an associative array representation of the json | ||
| + | var_dump(json_decode($resp, true)); | ||
| + | // Close request to clear up some resources | ||
| + | curl_close($curl); | ||
| + | ?> | ||
| + | </pre> | ||
| + | |||
| + | [[Category:NATS5_REST_APIs]] | ||
| + | [[Category:NATS5_REST_site_Collection]] | ||
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
| + | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Latest revision as of 16:01, 9 August 2019
GET /site/tours
Description
- Get tours
Resource URL
- http://domain/api/site/tours
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- siteid
- type: digit
- required
- deleted
- type: boolean_digit (0 or 1)
- optional
- limited
- type: boolean_digit (0 or 1)
- optional
- populate_default
- type: boolean_digit (0 or 1)
- optional
- mobile
- type: boolean_digit (0 or 1)
- optional
Example Request
Method: GET
URL: http://domain/api/site/tours
Query String: siteid=2&deleted=1&limited=1&populate_default=0&mobile=0
Response:
{
"tours": [
{
"tourid": "2",
"tour": "testTour",
"siteid": "2",
"name": "test tour name",
"url": "http:\/\/toomuchmedia.com",
"linkdomain": "democash.com",
"description": "test tour description",
"hidden": "0",
"tour_type": "0",
"deleted": "0",
"default": 1
},
{
"tourid": "4",
"tour": "testTour2",
"siteid": "2",
"name": "test tour",
"url": "http:\/\/toomuchmedia.com",
"linkdomain": "democash.com",
"description": "this is a test tour description",
"hidden": "0",
"tour_type": "1",
"deleted": "0",
"default": 0
}
],
"site": {
"siteid": "2",
"name": "test site name"
}
}
Example Code
PHP
<?php
$headers = array( //set your username and API key here
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$url = 'http://yourdomain.com'; //set your NATS URL here
$data = Array(
'siteid' => '2',
'deleted' => 1,
'limited' => 1,
'populate_default' => 0,
'mobile' => 0,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/site/tours',
'data' => $data
);
/*code below is the same for (almost) every API call */
$curl = curl_init();
$url = $url.'/api/'.$request['path'];
$query = http_build_query($request['data']);
if($request['method'] == 'GET'){
//add query string parameters to the end of the url
$url = $url.'?'.$query;
}else{
//send parameters as POST fields
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $query);
if($request['method'] != 'POST'){
$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
