Difference between revisions of "NATS5 REST API Adtool POST field"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Adtool POST field to NATS5 REST API Adtool POST field: Renaming NATS5 API pages) |
|
(No difference)
| |
Revision as of 15:15, 9 August 2019
POST /adtool/field
Description
- Add new adtool type field
Resource URL
- http://domain/api/adtool/field
- Replace domain with the nats domain
- POST
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- adtool_type_id
- type: digit
- required
- shortname
- type: string
- required
- name
- type: string
- required
- type
- type: digit
- required
- check_function
- type: string
- optional
- required
- type: boolean_digit
- optional
- min_display
- type: boolean_digit
- optional
- is_unique
- type: boolean_digit
- optional
- allow_search
- type: boolean_digit
- optional
- min
- type: digit
- optional
- max
- type: digit
- optional
Example Request
Method: POST
URL: http://domain/api/adtool/field
Form Data:
- adtool_type_id: 1
- shortname: mult_choice
- name: Mulitple Choice
- type: 1
Response:
{
"success": true,
"result": "Adtool Type Field Added"
}
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' => 1,
'shortname' => 'mult_choice',
'name' => 'Mulitple Choice',
'type' => 1,
);
$request = Array(
'method' => 'POST',
'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);
?>
