NATS5 REST API Site GET option-fields
From TMM Wiki
(Redirected from NATS4 REST API Site GET option-fields)
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
GET /site/option-fields
Description
- Get join option fields
Resource URL
- http://domain/api/site/option-fields
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- siteid
- type: digit
- required
- option_type_id
- type: digit
- optional
- special
- type: boolean_digit (0 or 1)
- optional
- no_cost_reg
- type: boolean_digit (0 or 1)
- optional
Example Request
Method: GET
URL: http://domain/api/site/option-fields
Query String: siteid=2&option_type_id=1&special=0&no_cost_reg=1
Response:
{ "success": true, "fields": { "details": { "name": { "name": "name", "display": "Title", "required": 0, "section": "main", "special_design": true }, "initial_days": { "name": "initial_days", "display": "Registration Period", "check": "alnum_number_check", "section": "main", "special_design": true }, "no_old_members": { "name": "no_old_members", "display": "Disallow for Old Members", "type": "checkbox", "section": "misc", "special_design": false }, "hidden": { "name": "hidden", "display": "Hide on Join Form", "type": "checkbox", "section": "misc", "special_design": false }, "active_all": { "name": "active_all", "display": "Active by Default", "type": "checkbox", "section": "misc", "special_design": false } }, "no_cost_details": { "name": { "name": "name", "display": "Join Form Text", "required": true, "section": "main", "special_design": true }, "initial_days": { "name": "initial_days", "display": "Registration Period", "check": "alnum_number_check", "section": "main", "special_design": true }, "no_old_members": { "name": "no_old_members", "display": "Disallow for Old Members", "type": "checkbox", "section": "misc", "special_design": false }, "hidden": { "name": "hidden", "display": "Hide on Join Form", "type": "checkbox", "section": "misc", "special_design": false }, "active_all": { "name": "active_all", "display": "Active by Default", "type": "checkbox", "section": "misc", "special_design": false } }, "xsell_gateway_fields": null, "extra_outgoing_sale_gateway_fields": { "disable_ssl_verify": { "name": "disable_ssl_verify", "display": "Disable SSL Verify", "type": "checkbox", "required": false } }, "details_list": [ { "name": "name", "display": "Title", "required": 0, "section": "main", "special_design": true }, { "name": "initial_days", "display": "Registration Period", "check": "alnum_number_check", "section": "main", "special_design": true }, { "name": "no_old_members", "display": "Disallow for Old Members", "type": "checkbox", "section": "misc", "special_design": false }, { "name": "hidden", "display": "Hide on Join Form", "type": "checkbox", "section": "misc", "special_design": false }, { "name": "active_all", "display": "Active by Default", "type": "checkbox", "section": "misc", "special_design": false } ] } }
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( 'siteid' => '2', 'option_type_id' => 1, 'special' => 0, 'no_cost_reg' => 1, ); $request = Array( 'method' => 'GET', 'path' => 'v1/site/option-fields', '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); ?>