Difference between revisions of "NATS5 REST API Report PATCH focus-enabled"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Report PATCH focus-enabled to NATS5 REST API Report PATCH focus-enabled: Renaming NATS5 API pages) |
|
(No difference)
| |
Revision as of 15:20, 9 August 2019
PATCH /report/focus-enabled
Description
- Change report focus to enabled or disabled
Resource URL
- http://domain/api/report/focus-enabled
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- report_focus_id
- type: digit
- required
- report
- type: string
- required
- enabled
- type: boolean_digit
- required
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(
// Add API parameters here
);
$request = Array(
'method' => 'PATCH',
'path' => 'v1/report/focus-enabled',
'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);
?>
