Difference between revisions of "NATS5 REST API Member GET matching"
From TMM Wiki
Jump to navigationJump to search| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_member_section = true |
}} | }} | ||
== '''GET /member/matching''' == | == '''GET /member/matching''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Find matching members for member fields | * Find matching members for member fields | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 31: | Line 32: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/member/matching</nowiki><br/> | URL: <nowiki>http://domain/api/member/matching</nowiki><br/> | ||
| − | Query String: <nowiki>memberid= | + | Query String: <nowiki>memberid=3&fields=username</nowiki><br/> |
Response: | Response: | ||
| Line 73: | Line 74: | ||
$data = Array( | $data = Array( | ||
| − | 'memberid' => ' | + | 'memberid' => '3', |
'fields' => 'username', | 'fields' => 'username', | ||
); | ); | ||
| Line 116: | Line 117: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_member_Collection]] |
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
[[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Latest revision as of 15:59, 9 August 2019
GET /member/matching
Description
- Find matching members for member fields
Resource URL
- http://domain/api/member/matching
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- memberid
- type: digit
- optional
- fields
- type: string_list (Either a comma-separated string of strings, or a JSON array of strings)
- optional
Example Request
Method: GET
URL: http://domain/api/member/matching
Query String: memberid=3&fields=username
Response:
{
"success": true,
"matches": [
{
"field": "username",
"success": true,
"count": "1",
"search": {
"username": "test username"
},
"params": {
"count_only": true,
"no_like_searches": true,
"search": {
"username": "test username"
}
}
}
]
}
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(
'memberid' => '3',
'fields' => 'username',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/member/matching',
'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);
?>
