Difference between revisions of "NATS5 REST API Site PATCH option"
From TMM Wiki
Jump to navigationJump to search| (5 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_site_section = true |
}} | }} | ||
== '''PATCH /site/option''' == | == '''PATCH /site/option''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Edit join option | * Edit join option | ||
| 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''']] |
*PATCH | *PATCH | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 31: | Line 32: | ||
** optional | ** optional | ||
| + | == '''Example Request''' == | ||
| + | Method: '''PATCH'''<br/> | ||
| + | URL: <nowiki>http://domain/api/site/option</nowiki><br/> | ||
| + | Form Data:<br/> | ||
| + | * optionid: 2 | ||
| + | * details: {"name":"package_upgrade_allowed","value":"1"} | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "optionid": 2, | ||
| + | "result": "option updated" | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 44: | Line 63: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'optionid' => 2, | |
| + | 'details' => json_encode(array (array ( 'name' => 'package_upgrade_allowed', 'value' => '1',))), | ||
); | ); | ||
| Line 87: | 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 --> | ||
Latest revision as of 14:00, 16 March 2023
PATCH /site/option
Description
- Edit join option
Resource URL
- http://domain/api/site/option
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- optionid
- type: digit
- required
- details
- type: json (JSON Object)
- optional
- biller
- type: json (JSON Object)
- optional
Example Request
Method: PATCH
URL: http://domain/api/site/option
Form Data:
- optionid: 2
- details: {"name":"package_upgrade_allowed","value":"1"}
Response:
{
"success": true,
"optionid": 2,
"result": "option updated"
}
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(
'optionid' => 2,
'details' => json_encode(array (array ( 'name' => 'package_upgrade_allowed', 'value' => '1',))),
);
$request = Array(
'method' => 'PATCH',
'path' => 'v1/site/option',
'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);
?>
