Difference between revisions of "NATS5 REST API Site GET site-type"
From TMM Wiki
Jump to navigationJump to search(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | {{NATS5 Manual |
− | | | + | | show_api_admin_site_section = true |
}} | }} | ||
== '''GET /site/site-type''' == | == '''GET /site/site-type''' == | ||
+ | |||
'''Description''' | '''Description''' | ||
* Get site type | * Get site type | ||
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 | ||
+ | == '''Example Request''' == | ||
+ | Method: '''GET'''<br/> | ||
+ | URL: <nowiki>http://domain/api/site/site-type</nowiki><br/> | ||
+ | Query String: <nowiki>siteid=2</nowiki><br/> | ||
+ | |||
+ | Response: | ||
+ | <pre> | ||
+ | { | ||
+ | "success": true, | ||
+ | "site_type": { | ||
+ | "type": "0", | ||
+ | "name": "Membership", | ||
+ | "description": "<b>Membership<\/b><br>Pass-Protected Recurring and\/or Non-Recurring Sites", | ||
+ | "url": { | ||
+ | "hidden": 0 | ||
+ | }, | ||
+ | "third": false, | ||
+ | "billers": true, | ||
+ | "linkdomain": { | ||
+ | "hidden": 0 | ||
+ | }, | ||
+ | "options": true, | ||
+ | "cascades": true, | ||
+ | "members": true, | ||
+ | "partners": true, | ||
+ | "nosite_fields": { | ||
+ | "name": { | ||
+ | "name": "name", | ||
+ | "display": "Title", | ||
+ | "required": true | ||
+ | }, | ||
+ | "description": { | ||
+ | "name": "description", | ||
+ | "display": "Description", | ||
+ | "required": false | ||
+ | }, | ||
+ | "disclaimer": { | ||
+ | "name": "disclaimer", | ||
+ | "display": "Disclaimer", | ||
+ | "required": false | ||
+ | }, | ||
+ | "active_all": { | ||
+ | "name": "active_all", | ||
+ | "display": "Active by Default", | ||
+ | "type": "checkbox" | ||
+ | } | ||
+ | }, | ||
+ | "extra_outgoing_sale_gateway_fields": { | ||
+ | "disable_ssl_verify": { | ||
+ | "name": "disable_ssl_verify", | ||
+ | "display": "Disable SSL Verify", | ||
+ | "type": "checkbox", | ||
+ | "required": false | ||
+ | } | ||
+ | }, | ||
+ | "incoming_sale_fields": [ | ||
+ | "name", | ||
+ | "initial", | ||
+ | "initial_days", | ||
+ | "rebill", | ||
+ | "rebill_days", | ||
+ | "packageid" | ||
+ | ], | ||
+ | "extra_incoming_sale_fields": { | ||
+ | "package_excluded_optionid": { | ||
+ | "name": "package_excluded_optionid", | ||
+ | "display": "Equivalant Join Option", | ||
+ | "type": "select", | ||
+ | "required": false | ||
+ | } | ||
+ | }, | ||
+ | "tour_overview_pages": { | ||
+ | "details": true, | ||
+ | "pages_steps": true, | ||
+ | "billers": true, | ||
+ | "email": true, | ||
+ | "posts": true, | ||
+ | "templates": true, | ||
+ | "linkcodes": true, | ||
+ | "members": true | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | |||
+ | |||
== '''Example Code''' == | == '''Example Code''' == | ||
Line 38: | Line 126: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
− | $data = | + | $data = Array( |
− | + | 'siteid' => '2', | |
); | ); | ||
Line 81: | Line 169: | ||
</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: | + | [[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 17:01, 9 August 2019
GET /site/site-type
Description
- Get site type
Resource URL
- http://domain/api/site/site-type
- 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
Example Request
Method: GET
URL: http://domain/api/site/site-type
Query String: siteid=2
Response:
{ "success": true, "site_type": { "type": "0", "name": "Membership", "description": "<b>Membership<\/b><br>Pass-Protected Recurring and\/or Non-Recurring Sites", "url": { "hidden": 0 }, "third": false, "billers": true, "linkdomain": { "hidden": 0 }, "options": true, "cascades": true, "members": true, "partners": true, "nosite_fields": { "name": { "name": "name", "display": "Title", "required": true }, "description": { "name": "description", "display": "Description", "required": false }, "disclaimer": { "name": "disclaimer", "display": "Disclaimer", "required": false }, "active_all": { "name": "active_all", "display": "Active by Default", "type": "checkbox" } }, "extra_outgoing_sale_gateway_fields": { "disable_ssl_verify": { "name": "disable_ssl_verify", "display": "Disable SSL Verify", "type": "checkbox", "required": false } }, "incoming_sale_fields": [ "name", "initial", "initial_days", "rebill", "rebill_days", "packageid" ], "extra_incoming_sale_fields": { "package_excluded_optionid": { "name": "package_excluded_optionid", "display": "Equivalant Join Option", "type": "select", "required": false } }, "tour_overview_pages": { "details": true, "pages_steps": true, "billers": true, "email": true, "posts": true, "templates": true, "linkcodes": true, "members": true } } }
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', ); $request = Array( 'method' => 'GET', 'path' => 'v1/site/site-type', '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); ?>