Difference between revisions of "NATS5 REST API Adtool PATCH field"
From TMM Wiki
Jump to navigationJump to search| Line 1: | Line 1: | ||
{{NATS5 Manual | {{NATS5 Manual | ||
| − | | | + | | show_api_admin_adtool_section = true |
}} | }} | ||
== '''PATCH /adtool/field''' == | == '''PATCH /adtool/field''' == | ||
Latest revision as of 15:57, 9 August 2019
PATCH /adtool/field
Description
- Edit adtool type field
Resource URL
- http://domain/api/adtool/field
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- adtool_type_id
- type: digit
- required
- adtool_field_id
- type: digit
- required
- name
- type: string
- optional
- type
- type: digit
- optional
- check_function
- type: string
- optional
- required
- type: boolean_digit (0 or 1)
- optional
- min_display
- type: boolean_digit (0 or 1)
- optional
- is_unique
- type: boolean_digit (0 or 1)
- optional
- allow_search
- type: boolean_digit (0 or 1)
- optional
- min
- type: digit
- optional
- max
- type: digit
- optional
Example Request
Method: PATCH
URL: http://domain/api/adtool/field
Form Data:
- adtool_type_id: 2
- adtool_field_id: 1
- name: test field
- type: 1
- check_function: name
- required: 1
- min_display: 0
- is_unique: 1
- allow_search: 1
- min: 0
- max: 0
Response:
{
"success": true,
"result": "Adtool Type Field 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(
'adtool_type_id' => 2,
'adtool_field_id' => 1,
'name' => 'test field',
'type' => 1,
'check_function' => 'name',
'required' => 1,
'min_display' => 0,
'is_unique' => 1,
'allow_search' => 1,
'min' => 0,
'max' => 0,
);
$request = Array(
'method' => 'PATCH',
'path' => 'v1/adtool/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);
?>
