Difference between revisions of "NATS5 REST API Site DELETE tour-field"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Site DELETE tour-field to NATS5 REST API Site DELETE tour-field: Renaming NATS5 API pages) |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
== '''DELETE /site/tour-field''' == | == '''DELETE /site/tour-field''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Revert tour field | * Revert tour field | ||
| 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''']] |
*DELETE | *DELETE | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 35: | Line 36: | ||
URL: <nowiki>http://domain/api/site/tour-field</nowiki><br/> | URL: <nowiki>http://domain/api/site/tour-field</nowiki><br/> | ||
Form Data:<br/> | Form Data:<br/> | ||
| − | * tourid: | + | * tourid: 4 |
* field: admin_change_email | * field: admin_change_email | ||
| Line 42: | Line 43: | ||
{ | { | ||
"success": true, | "success": true, | ||
| − | "tourid": | + | "tourid": 4, |
"message": "Tour field reverted" | "message": "Tour field reverted" | ||
} | } | ||
| Line 63: | Line 64: | ||
$data = Array( | $data = Array( | ||
| − | 'tourid' => | + | 'tourid' => 4, |
'field' => 'admin_change_email', | 'field' => 'admin_change_email', | ||
); | ); | ||
| Line 106: | Line 107: | ||
</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
DELETE /site/tour-field
Description
- Revert tour field
Resource URL
- http://domain/api/site/tour-field
- Replace domain with the nats domain
- DELETE
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- tourid
- type: digit
- required
- field
- type: string
- required
- billerid
- type: digit
- optional
Example Request
Method: DELETE
URL: http://domain/api/site/tour-field
Form Data:
- tourid: 4
- field: admin_change_email
Response:
{
"success": true,
"tourid": 4,
"message": "Tour field reverted"
}
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(
'tourid' => 4,
'field' => 'admin_change_email',
);
$request = Array(
'method' => 'DELETE',
'path' => 'v1/site/tour-field',
'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);
?>
