Difference between revisions of "NATS5 REST API Include GET include"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Include GET include to NATS5 REST API Include GET include: Renaming NATS5 API pages) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_include_section = true |
}} | }} | ||
== '''GET /include/include''' == | == '''GET /include/include''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get details for an include chain | * Get details for an include chain | ||
| 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 37: | Line 38: | ||
"include_chain_id": "1", | "include_chain_id": "1", | ||
"name": "test include name", | "name": "test include name", | ||
| − | "switch": " | + | "switch": "4", |
"template": "chaininclude_popup", | "template": "chaininclude_popup", | ||
| − | "track": " | + | "track": "1", |
"deleted": "0", | "deleted": "0", | ||
| − | "enabled": " | + | "enabled": "1", |
| + | "switch_details": { | ||
| + | "siteid": { | ||
| + | "siteid": "1", | ||
| + | "name": "Membership Site A" | ||
| + | }, | ||
| + | "tourid": { | ||
| + | "tourid": "1", | ||
| + | "name": "Default Tour" | ||
| + | } | ||
| + | }, | ||
"steps": [ | "steps": [ | ||
{ | { | ||
| Line 49: | Line 60: | ||
"include_chain_id": "1", | "include_chain_id": "1", | ||
"deleted": "0", | "deleted": "0", | ||
| + | "switch": "4", | ||
| + | "template": "chaininclude_popup", | ||
| + | "switch_details": { | ||
| + | "siteid": { | ||
| + | "siteid": "1", | ||
| + | "name": "Membership Site A" | ||
| + | }, | ||
| + | "tourid": { | ||
| + | "tourid": "1", | ||
| + | "name": "Default Tour" | ||
| + | } | ||
| + | }, | ||
"track": 2 | "track": 2 | ||
} | } | ||
| Line 114: | Line 137: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_include_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 --> | ||
Latest revision as of 15:59, 9 August 2019
GET /include/include
Description
- Get details for an include chain
Resource URL
- http://domain/api/include/include
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- include_chain_id
- type: digit
- required
Example Request
Method: GET
URL: http://domain/api/include/include
Query String: include_chain_id=1
Response:
{
"success": true,
"chain": {
"include_chain_id": "1",
"name": "test include name",
"switch": "4",
"template": "chaininclude_popup",
"track": "1",
"deleted": "0",
"enabled": "1",
"switch_details": {
"siteid": {
"siteid": "1",
"name": "Membership Site A"
},
"tourid": {
"tourid": "1",
"name": "Default Tour"
}
},
"steps": [
{
"include_chain_step_id": "1",
"name": "test include step",
"orderid": "1",
"include_chain_id": "1",
"deleted": "0",
"switch": "4",
"template": "chaininclude_popup",
"switch_details": {
"siteid": {
"siteid": "1",
"name": "Membership Site A"
},
"tourid": {
"tourid": "1",
"name": "Default Tour"
}
},
"track": 2
}
]
}
}
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(
'include_chain_id' => '1',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/include/include',
'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);
?>
