Difference between revisions of "NATS5 REST API Include POST step"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Include POST step to NATS5 REST API Include POST step: 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 |
}} | }} | ||
== '''POST /include/step''' == | == '''POST /include/step''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Add new include step | * Add new include step | ||
| 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 46: | Line 47: | ||
* include_chain_id: 1 | * include_chain_id: 1 | ||
* name: test include step | * name: test include step | ||
| + | * template: chaininclude_popup | ||
| + | * tourid: 1 | ||
| + | * track: 2 | ||
Response: | Response: | ||
| Line 73: | Line 77: | ||
'include_chain_id' => '1', | 'include_chain_id' => '1', | ||
'name' => 'test include step', | 'name' => 'test include step', | ||
| + | 'template' => 'chaininclude_popup', | ||
| + | 'tourid' => 1, | ||
| + | 'track' => 2, | ||
); | ); | ||
| Line 114: | Line 121: | ||
</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
POST /include/step
Description
- Add new include step
Resource URL
- http://domain/api/include/step
- Replace domain with the nats domain
- POST
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- include_chain_id
- type: digit
- required
- name
- type: string
- required
- template
- type: string
- optional
- tourid
- type: digit
- optional
- track
- type: trinary_digit (0, 1, or 2)
- optional (default value: 2)
- url
- type: string
- optional
Example Request
Method: POST
URL: http://domain/api/include/step
Form Data:
- include_chain_id: 1
- name: test include step
- template: chaininclude_popup
- tourid: 1
- track: 2
Response:
{
"success": true,
"result": "Include chain step added"
}
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',
'name' => 'test include step',
'template' => 'chaininclude_popup',
'tourid' => 1,
'track' => 2,
);
$request = Array(
'method' => 'POST',
'path' => 'v1/include/step',
'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);
?>
