Difference between revisions of "NATS5 REST API Affiliate GET notes"
From TMM Wiki
Jump to navigationJump to search| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_affiliate_section = true |
}} | }} | ||
== '''GET /affiliate/notes''' == | == '''GET /affiliate/notes''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Got notes for a specific affiliate | * Got notes for a specific affiliate | ||
| 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 29: | Line 30: | ||
** optional | ** optional | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/affiliate/notes</nowiki><br/> | ||
| + | Query String: <nowiki>loginid=3&start=0&count=1000</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "total_count": "1", | ||
| + | "notes": [ | ||
| + | { | ||
| + | "login_note_id": "1", | ||
| + | "note_type_id": "1", | ||
| + | "note_type": "System", | ||
| + | "loginid": "1", | ||
| + | "stamp": "1565382535", | ||
| + | "parentid": "0", | ||
| + | "note": "test", | ||
| + | "name": "System", | ||
| + | "accountid": "1", | ||
| + | "username": "productsupport", | ||
| + | "loginid_nice": "productsupport" | ||
| + | } | ||
| + | ], | ||
| + | "success": true | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 42: | Line 73: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'loginid' => '3', | |
| + | 'start' => 0, | ||
| + | 'count' => 1000, | ||
); | ); | ||
| Line 85: | Line 118: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_affiliate_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 --> | ||
Latest revision as of 15:58, 9 August 2019
GET /affiliate/notes
Description
- Got notes for a specific affiliate
Resource URL
- http://domain/api/affiliate/notes
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- loginid
- type: digit
- required
- start
- optional
- count
- optional
Example Request
Method: GET
URL: http://domain/api/affiliate/notes
Query String: loginid=3&start=0&count=1000
Response:
{
"total_count": "1",
"notes": [
{
"login_note_id": "1",
"note_type_id": "1",
"note_type": "System",
"loginid": "1",
"stamp": "1565382535",
"parentid": "0",
"note": "test",
"name": "System",
"accountid": "1",
"username": "productsupport",
"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(
'loginid' => '3',
'start' => 0,
'count' => 1000,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/affiliate/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);
?>
