Difference between revisions of "NATS5 REST API Member GET notes"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Member GET notes to NATS5 REST API Member GET notes: Renaming NATS5 API pages) |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
== '''GET /member/notes''' == | == '''GET /member/notes''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get notes for a member | * Get notes for a member | ||
| 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 34: | Line 35: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/member/notes</nowiki><br/> | URL: <nowiki>http://domain/api/member/notes</nowiki><br/> | ||
| − | Query String: <nowiki>memberid= | + | Query String: <nowiki>memberid=3&start=0&count=100</nowiki><br/> |
Response: | Response: | ||
<pre> | <pre> | ||
{ | { | ||
| − | "total_count": " | + | "total_count": "5", |
"notes": [ | "notes": [ | ||
{ | { | ||
| − | "member_note_id": " | + | "member_note_id": "2", |
"note_type_id": "2", | "note_type_id": "2", | ||
| − | "memberid": " | + | "memberid": "3", |
"loginid": "1", | "loginid": "1", | ||
| − | "stamp": " | + | "stamp": "1565382564", |
"parentid": "0", | "parentid": "0", | ||
"note": "this is a test note", | "note": "this is a test note", | ||
| Line 53: | Line 54: | ||
}, | }, | ||
{ | { | ||
| − | "member_note_id": "2", | + | "member_note_id": "3", |
| + | "note_type_id": "2", | ||
| + | "memberid": "3", | ||
| + | "loginid": "1", | ||
| + | "stamp": "1565382564", | ||
| + | "parentid": "0", | ||
| + | "note": "productsupport (1) updated the member through the API with the following changes:<br \/>address1 changed from (blank) to 123 address street<br \/>city changed from (blank) to testCity<br \/>state changed from (blank) to NJ<br \/>country changed from (blank) to USA<br \/>zip changed from (blank) to 12345", | ||
| + | "loginid_nice": "productsupport", | ||
| + | "note_type": "User" | ||
| + | }, | ||
| + | { | ||
| + | "member_note_id": "4", | ||
| + | "note_type_id": "2", | ||
| + | "memberid": "3", | ||
| + | "loginid": "1", | ||
| + | "stamp": "1565382564", | ||
| + | "parentid": "0", | ||
| + | "note": "productsupport (1) changed the expiration date via the API. <br \/>NATS:3 (3) was changed from 2020-06-10 00:00:00 to 2020-06-05 00:00:00<br \/>", | ||
| + | "loginid_nice": "productsupport", | ||
| + | "note_type": "User" | ||
| + | }, | ||
| + | { | ||
| + | "member_note_id": "5", | ||
"note_type_id": "2", | "note_type_id": "2", | ||
| − | "memberid": " | + | "memberid": "3", |
"loginid": "1", | "loginid": "1", | ||
| − | "stamp": " | + | "stamp": "1565382564", |
"parentid": "0", | "parentid": "0", | ||
| − | "note": " | + | "note": "Member Locked", |
"loginid_nice": "productsupport", | "loginid_nice": "productsupport", | ||
"note_type": "User" | "note_type": "User" | ||
}, | }, | ||
{ | { | ||
| − | "member_note_id": " | + | "member_note_id": "6", |
"note_type_id": "2", | "note_type_id": "2", | ||
| − | "memberid": " | + | "memberid": "3", |
"loginid": "1", | "loginid": "1", | ||
| − | "stamp": " | + | "stamp": "1565382564", |
"parentid": "0", | "parentid": "0", | ||
| − | "note": " | + | "note": "Member Unlocked", |
"loginid_nice": "productsupport", | "loginid_nice": "productsupport", | ||
"note_type": "User" | "note_type": "User" | ||
| Line 105: | Line 128: | ||
$data = Array( | $data = Array( | ||
| − | 'memberid' => ' | + | 'memberid' => '3', |
| + | 'start' => 0, | ||
| + | 'count' => 100, | ||
); | ); | ||
| Line 147: | Line 172: | ||
</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 --> | ||
Revision as of 15:45, 9 August 2019
GET /member/notes
Description
- Get notes for a member
Resource URL
- http://domain/api/member/notes
- 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
- start
- type: digit
- optional
- count
- type: digit
- optional (default value: 50)
Example Request
Method: GET
URL: http://domain/api/member/notes
Query String: memberid=3&start=0&count=100
Response:
{
"total_count": "5",
"notes": [
{
"member_note_id": "2",
"note_type_id": "2",
"memberid": "3",
"loginid": "1",
"stamp": "1565382564",
"parentid": "0",
"note": "this is a test note",
"loginid_nice": "productsupport",
"note_type": "User"
},
{
"member_note_id": "3",
"note_type_id": "2",
"memberid": "3",
"loginid": "1",
"stamp": "1565382564",
"parentid": "0",
"note": "productsupport (1) updated the member through the API with the following changes:<br \/>address1 changed from (blank) to 123 address street<br \/>city changed from (blank) to testCity<br \/>state changed from (blank) to NJ<br \/>country changed from (blank) to USA<br \/>zip changed from (blank) to 12345",
"loginid_nice": "productsupport",
"note_type": "User"
},
{
"member_note_id": "4",
"note_type_id": "2",
"memberid": "3",
"loginid": "1",
"stamp": "1565382564",
"parentid": "0",
"note": "productsupport (1) changed the expiration date via the API. <br \/>NATS:3 (3) was changed from 2020-06-10 00:00:00 to 2020-06-05 00:00:00<br \/>",
"loginid_nice": "productsupport",
"note_type": "User"
},
{
"member_note_id": "5",
"note_type_id": "2",
"memberid": "3",
"loginid": "1",
"stamp": "1565382564",
"parentid": "0",
"note": "Member Locked",
"loginid_nice": "productsupport",
"note_type": "User"
},
{
"member_note_id": "6",
"note_type_id": "2",
"memberid": "3",
"loginid": "1",
"stamp": "1565382564",
"parentid": "0",
"note": "Member Unlocked",
"loginid_nice": "productsupport",
"note_type": "User"
}
],
"note_types": [
{
"note_type_id": 1,
"type": "System"
},
{
"note_type_id": 2,
"type": "User"
}
],
"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(
'memberid' => '3',
'start' => 0,
'count' => 100,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/member/notes',
'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);
?>
