NATS5 REST API Member GET restricted-values
From TMM Wiki
Revision as of 15:18, 9 August 2019 by TMMJoe (talk | contribs) (TMMJoe moved page NATS4 REST API Member GET restricted-values to NATS5 REST API Member GET restricted-values: Renaming NATS5 API pages)
GET /member/restricted-values
Description
- Get restricted values for members
Resource URL
- http://domain/api/member/restricted-values
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- start
- type: digit
- optional
- count
- type: digit
- optional (default value: 25)
- loginid
- type: digit
- optional
- restricted_value_id
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- value
- type: string
- optional
- deleted
- type: trinary_digit (0, 1, or 2)
- optional
Example Request
Method: GET
URL: http://domain/api/member/restricted-values
Response:
{
"total_count": "1",
"restricted_values": [
{
"restricted_value_id": "1",
"value": "testValue",
"last_modified_date": "1559929898",
"last_modified_loginid": "1",
"deleted": "0",
"last_modified_datetime": "2019-06-07 13:51:38",
"last_modified_loginid_nice": "productsupport"
}
],
"success": true
}
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(
// Add API parameters here
);
$request = Array(
'method' => 'GET',
'path' => 'v1/member/restricted-values',
'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);
?>
