Difference between revisions of "NATS5 REST API Adtool DELETE type"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Adtool DELETE type to NATS5 REST API Adtool DELETE type: Renaming NATS5 API pages) |
|
(No difference)
|
Revision as of 16:16, 9 August 2019
DELETE /adtool/type
Description
- Delete adtool type
Resource URL
- http://domain/api/adtool/type
- Replace domain with the nats domain
- DELETE
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- adtool_type_id
- type: digit
- required
Example Request
Method: DELETE
URL: http://domain/api/adtool/type
Form Data:
- adtool_type_id: 2
Response:
{ "success": true, "result": "Type deleted" }
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( 'adtool_type_id' => 2, ); $request = Array( 'method' => 'DELETE', 'path' => 'v1/adtool/type', '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); ?>