Difference between revisions of "NATS5 REST API Member GET notes"
From TMM Wiki
Jump to navigationJump to search| Line 31: | Line 31: | ||
** optional (default value: 50) | ** optional (default value: 50) | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/member/notes</nowiki><br/> | ||
| + | Query String: <nowiki>memberid=2</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "total_count": "3", | ||
| + | "notes": [ | ||
| + | { | ||
| + | "member_note_id": "1", | ||
| + | "note_type_id": "2", | ||
| + | "memberid": "2", | ||
| + | "loginid": "1", | ||
| + | "stamp": "1559929898", | ||
| + | "parentid": "0", | ||
| + | "note": "this is a test note", | ||
| + | "loginid_nice": "productsupport", | ||
| + | "note_type": "User" | ||
| + | }, | ||
| + | { | ||
| + | "member_note_id": "2", | ||
| + | "note_type_id": "2", | ||
| + | "memberid": "2", | ||
| + | "loginid": "1", | ||
| + | "stamp": "1559929898", | ||
| + | "parentid": "0", | ||
| + | "note": "productsupport (1) updated the member through the API with the following changes:<br \/>firstname changed from (blank) to testFirstname<br \/>lastname changed from (blank) to testLastname", | ||
| + | "loginid_nice": "productsupport", | ||
| + | "note_type": "User" | ||
| + | }, | ||
| + | { | ||
| + | "member_note_id": "3", | ||
| + | "note_type_id": "2", | ||
| + | "memberid": "2", | ||
| + | "loginid": "1", | ||
| + | "stamp": "1559929898", | ||
| + | "parentid": "0", | ||
| + | "note": "productsupport (1) changed the expiration date via the API. <br \/>NATS:2 (2) was changed from NEVER to NEVER<br \/>", | ||
| + | "loginid_nice": "productsupport", | ||
| + | "note_type": "User" | ||
| + | } | ||
| + | ], | ||
| + | "note_types": [ | ||
| + | { | ||
| + | "note_type_id": 1, | ||
| + | "type": "System" | ||
| + | }, | ||
| + | { | ||
| + | "note_type_id": 2, | ||
| + | "type": "User" | ||
| + | } | ||
| + | ], | ||
| + | "success": true | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 44: | Line 104: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'memberid' => '2', | |
); | ); | ||
| Line 90: | Line 150: | ||
[[Category:NATS4_REST_member_Collection]] | [[Category:NATS4_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 --> | ||
Revision as of 13:27, 7 June 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=2
Response:
{
"total_count": "3",
"notes": [
{
"member_note_id": "1",
"note_type_id": "2",
"memberid": "2",
"loginid": "1",
"stamp": "1559929898",
"parentid": "0",
"note": "this is a test note",
"loginid_nice": "productsupport",
"note_type": "User"
},
{
"member_note_id": "2",
"note_type_id": "2",
"memberid": "2",
"loginid": "1",
"stamp": "1559929898",
"parentid": "0",
"note": "productsupport (1) updated the member through the API with the following changes:<br \/>firstname changed from (blank) to testFirstname<br \/>lastname changed from (blank) to testLastname",
"loginid_nice": "productsupport",
"note_type": "User"
},
{
"member_note_id": "3",
"note_type_id": "2",
"memberid": "2",
"loginid": "1",
"stamp": "1559929898",
"parentid": "0",
"note": "productsupport (1) changed the expiration date via the API. <br \/>NATS:2 (2) was changed from NEVER to NEVER<br \/>",
"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' => '2',
);
$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);
?>
