Difference between revisions of "NATS5 REST API Include POST include"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Include POST include to NATS5 REST API Include POST include: Renaming NATS5 API pages) |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
== '''POST /include/include''' == | == '''POST /include/include''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Add new include chain | * Add new 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''']] |
*POST | *POST | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 31: | Line 32: | ||
** optional | ** optional | ||
* '''track''' | * '''track''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''enabled''' | * '''enabled''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
| Line 43: | Line 44: | ||
* name: test include name | * name: test include name | ||
* template: chaininclude_popup | * template: chaininclude_popup | ||
| + | * tourid: 1 | ||
| + | * track: 1 | ||
| + | * enabled: 1 | ||
Response: | Response: | ||
| Line 52: | Line 56: | ||
"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" |
} | } | ||
} | } | ||
| Line 79: | Line 83: | ||
'name' => 'test include name', | 'name' => 'test include name', | ||
'template' => 'chaininclude_popup', | 'template' => 'chaininclude_popup', | ||
| + | 'tourid' => 1, | ||
| + | 'track' => 1, | ||
| + | 'enabled' => 1, | ||
); | ); | ||
| Line 120: | Line 127: | ||
</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 --> | ||
Revision as of 15:44, 9 August 2019
POST /include/include
Description
- Add new include chain
Resource URL
- http://domain/api/include/include
- Replace domain with the nats domain
- POST
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- name
- type: string
- required
- template
- type: string
- required
- tourid
- type: digit
- optional
- track
- type: boolean_digit (0 or 1)
- optional
- enabled
- type: boolean_digit (0 or 1)
- optional
Example Request
Method: POST
URL: http://domain/api/include/include
Form Data:
- name: test include name
- template: chaininclude_popup
- tourid: 1
- track: 1
- enabled: 1
Response:
{
"success": true,
"result": "Include chain added",
"include": {
"include_chain_id": "1",
"name": "test include name",
"switch": "4",
"template": "chaininclude_popup",
"track": "1",
"deleted": "0",
"enabled": "1"
}
}
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(
'name' => 'test include name',
'template' => 'chaininclude_popup',
'tourid' => 1,
'track' => 1,
'enabled' => 1,
);
$request = Array(
'method' => 'POST',
'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);
?>
