Difference between revisions of "NATS5 REST API Adtool GET field-types"
From TMM Wiki
Jump to navigationJump to searchLine 25: | Line 25: | ||
** required | ** required | ||
+ | == '''Example Request''' == | ||
+ | Method: '''GET'''<br/> | ||
+ | URL: <nowiki>http://domain/api/adtool/field-types</nowiki><br/> | ||
+ | Query String: <nowiki>adtool_type_id=1</nowiki><br/> | ||
+ | |||
+ | Response: | ||
+ | <pre> | ||
+ | { | ||
+ | "success": true, | ||
+ | "field_types": [ | ||
+ | { | ||
+ | "field_type_id": 0, | ||
+ | "derived": 0, | ||
+ | "field_type": "Text Field" | ||
+ | }, | ||
+ | { | ||
+ | "field_type_id": 1, | ||
+ | "derived": 0, | ||
+ | "field_type": "Multiple Choice" | ||
+ | }, | ||
+ | { | ||
+ | "field_type_id": 2, | ||
+ | "derived": 0, | ||
+ | "field_type": "Image Upload" | ||
+ | }, | ||
+ | { | ||
+ | "field_type_id": 3, | ||
+ | "derived": 0, | ||
+ | "field_type": "Zip Upload" | ||
+ | }, | ||
+ | { | ||
+ | "field_type_id": 4, | ||
+ | "derived": 0, | ||
+ | "field_type": "Text Box" | ||
+ | }, | ||
+ | { | ||
+ | "field_type_id": 5, | ||
+ | "derived": 0, | ||
+ | "field_type": "Flash Upload" | ||
+ | }, | ||
+ | { | ||
+ | "field_type_id": 6, | ||
+ | "derived": 0, | ||
+ | "field_type": "Video Upload" | ||
+ | }, | ||
+ | { | ||
+ | "field_type_id": 7, | ||
+ | "derived": 0, | ||
+ | "field_type": "Color Selector" | ||
+ | }, | ||
+ | { | ||
+ | "field_type_id": 100, | ||
+ | "derived": 1, | ||
+ | "check_function": "name", | ||
+ | "field_type": "Banner Derived Height" | ||
+ | }, | ||
+ | { | ||
+ | "field_type_id": 101, | ||
+ | "derived": 1, | ||
+ | "check_function": "name", | ||
+ | "field_type": "Banner Derived Width" | ||
+ | }, | ||
+ | { | ||
+ | "field_type_id": 102, | ||
+ | "derived": 1, | ||
+ | "check_function": "name", | ||
+ | "field_type": "Banner Derived File Size" | ||
+ | }, | ||
+ | { | ||
+ | "field_type_id": 103, | ||
+ | "derived": 1, | ||
+ | "check_function": "name", | ||
+ | "field_type": "Banner Derived Extension" | ||
+ | }, | ||
+ | { | ||
+ | "field_type_id": 105, | ||
+ | "derived": 1, | ||
+ | "check_function": "name", | ||
+ | "field_type": "Banner Derived File Name" | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | |||
+ | |||
== '''Example Code''' == | == '''Example Code''' == | ||
Line 38: | Line 124: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
− | $data = | + | $data = Array( |
− | + | 'adtool_type_id' => 1, | |
); | ); | ||
Revision as of 17:07, 19 April 2019
GET /adtool/field-types
Description
- Get available field types for adtool fields
Resource URL
- http://domain/api/adtool/field-types
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- adtool_type_id
- type: digit
- required
Example Request
Method: GET
URL: http://domain/api/adtool/field-types
Query String: adtool_type_id=1
Response:
{ "success": true, "field_types": [ { "field_type_id": 0, "derived": 0, "field_type": "Text Field" }, { "field_type_id": 1, "derived": 0, "field_type": "Multiple Choice" }, { "field_type_id": 2, "derived": 0, "field_type": "Image Upload" }, { "field_type_id": 3, "derived": 0, "field_type": "Zip Upload" }, { "field_type_id": 4, "derived": 0, "field_type": "Text Box" }, { "field_type_id": 5, "derived": 0, "field_type": "Flash Upload" }, { "field_type_id": 6, "derived": 0, "field_type": "Video Upload" }, { "field_type_id": 7, "derived": 0, "field_type": "Color Selector" }, { "field_type_id": 100, "derived": 1, "check_function": "name", "field_type": "Banner Derived Height" }, { "field_type_id": 101, "derived": 1, "check_function": "name", "field_type": "Banner Derived Width" }, { "field_type_id": 102, "derived": 1, "check_function": "name", "field_type": "Banner Derived File Size" }, { "field_type_id": 103, "derived": 1, "check_function": "name", "field_type": "Banner Derived Extension" }, { "field_type_id": 105, "derived": 1, "check_function": "name", "field_type": "Banner Derived File Name" } ] }
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, ); $request = Array( 'method' => 'GET', 'path' => 'v1/adtool/field-types', '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); ?>