Difference between revisions of "NATS5 REST API Site GET sites"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Site GET sites to NATS5 REST API Site GET sites: Renaming NATS5 API pages) |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
== '''GET /site/sites''' == | == '''GET /site/sites''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get list of sites | * Get list of sites | ||
| 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: | ||
** optional | ** optional | ||
* '''deleted''' | * '''deleted''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''programid''' | * '''programid''' | ||
| Line 34: | Line 35: | ||
** optional | ** optional | ||
* '''limited''' | * '''limited''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
| Line 155: | Line 156: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[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 --> | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Revision as of 15:47, 9 August 2019
GET /site/sites
Description
- Get list of sites
Resource URL
- http://domain/api/site/sites
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- site_types
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- deleted
- type: boolean_digit (0 or 1)
- optional
- programid
- type: digit
- optional
- linkdomain
- type: string
- optional
- limited
- type: boolean_digit (0 or 1)
- optional
Example Request
Method: GET
URL: http://domain/api/site/sites
Query String: site_types=0%2C1%2C2&deleted=1&programid=2&limited=1
Response:
{
"success": true,
"sites": [
{
"siteid": "1",
"site": "member_a",
"deleted": "0",
"name": "Membership Site A",
"type": "0",
"hidden": "0",
"mobile_tour": "0",
"info": {
"tourid": "1",
"tour": "MAIN",
"siteid": "1",
"name": "Default Tour",
"url": "https:\/\/www.google.com",
"linkdomain": "root.nats4.com",
"description": "",
"hidden": "0",
"deleted": "0",
"tour_type": "0"
},
"nats_default": "MC4wLjEuMS4wLjAuMC4wLjA",
"type_nice": "Membership",
"tours": [
{
"tourid": 1,
"name": "Default Tour"
}
],
"tour_details": [
{
"tourid": "1",
"tour": "MAIN",
"siteid": "1",
"name": "Default Tour",
"url": "https:\/\/www.google.com",
"linkdomain": "root.nats4.com",
"description": "",
"hidden": "0",
"deleted": "0",
"tour_type": "0"
}
]
}
]
}
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(
'site_types' => '0,1,2',
'deleted' => 1,
'programid' => 2,
'limited' => 1,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/site/sites',
'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);
?>
