Difference between revisions of "NATS5 REST API Member GET surfer-actions"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''GET /member/surfer-actions''' == '''Description''' * Get surfer actions for a member '''Resource URL''' *<nowiki>http...") |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_member_section = true |
}} | }} | ||
== '''GET /member/surfer-actions''' == | == '''GET /member/surfer-actions''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get surfer actions for a member | * Get surfer actions 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 30: | Line 31: | ||
** optional (default value: 50) | ** optional (default value: 50) | ||
| − | [[Category: | + | == '''Example Request''' == |
| − | [[Category: | + | Method: '''GET'''<br/> |
| + | URL: <nowiki>http://domain/api/member/surfer-actions</nowiki><br/> | ||
| + | Query String: <nowiki>memberid=3&start=0&count=100</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "actions": [ | ||
| + | { | ||
| + | "surfer_action_id": "3", | ||
| + | "identid": "4", | ||
| + | "loginid": "0", | ||
| + | "networkid": "0", | ||
| + | "session": "4184eb9f9064c7b773c8dfd159505af4", | ||
| + | "time": "1565382563", | ||
| + | "type": "18", | ||
| + | "extra1": "1", | ||
| + | "extra2": "0", | ||
| + | "details": { | ||
| + | "campaignid": { | ||
| + | "campaignid": null, | ||
| + | "loginid": null, | ||
| + | "name": null, | ||
| + | "description": null | ||
| + | }, | ||
| + | "programid": { | ||
| + | "programid": null, | ||
| + | "program": null, | ||
| + | "type": null, | ||
| + | "name": null, | ||
| + | "deleted": null, | ||
| + | "hidden": null | ||
| + | }, | ||
| + | "siteid": { | ||
| + | "siteid": "1", | ||
| + | "site": "member_a", | ||
| + | "name": "Membership Site A", | ||
| + | "type": "0", | ||
| + | "deleted": "0", | ||
| + | "hidden": "0" | ||
| + | }, | ||
| + | "tourid": { | ||
| + | "tourid": "1", | ||
| + | "tour": "MAIN", | ||
| + | "name": "Default Tour", | ||
| + | "siteid": "1", | ||
| + | "url": "https:\/\/www.google.com", | ||
| + | "linkdomain": "root.nats4.com", | ||
| + | "description": "", | ||
| + | "hidden": "0", | ||
| + | "deleted": "0" | ||
| + | } | ||
| + | }, | ||
| + | "campaignid": "0", | ||
| + | "programid": "0", | ||
| + | "siteid": "1", | ||
| + | "tourid": "1", | ||
| + | "optionid": "0", | ||
| + | "adtoolid": "0", | ||
| + | "subid1": "0", | ||
| + | "subid2": "0", | ||
| + | "billerid": "0", | ||
| + | "countryid": "000", | ||
| + | "promotionalid": "0", | ||
| + | "type_nice": "Manual Add", | ||
| + | "description_details": { | ||
| + | "description": "", | ||
| + | "extra": [ | ||
| + | { | ||
| + | "field": "status", | ||
| + | "value": "Active" | ||
| + | }, | ||
| + | { | ||
| + | "field": "trial", | ||
| + | "value": "No" | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | } | ||
| + | ], | ||
| + | "total_count": 1, | ||
| + | "session": "4184eb9f9064c7b773c8dfd159505af4" | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | == '''Example Code''' == | ||
| + | |||
| + | '''PHP''' | ||
| + | <pre> | ||
| + | <?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/surfer-actions', | ||
| + | '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); | ||
| + | ?> | ||
| + | </pre> | ||
| + | |||
| + | [[Category:NATS5_REST_APIs]] | ||
| + | [[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 --> | ||
Latest revision as of 15:59, 9 August 2019
GET /member/surfer-actions
Description
- Get surfer actions for a member
Resource URL
- http://domain/api/member/surfer-actions
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- memberid
- optional
- start
- type: digit
- optional
- count
- type: digit
- optional (default value: 50)
Example Request
Method: GET
URL: http://domain/api/member/surfer-actions
Query String: memberid=3&start=0&count=100
Response:
{
"actions": [
{
"surfer_action_id": "3",
"identid": "4",
"loginid": "0",
"networkid": "0",
"session": "4184eb9f9064c7b773c8dfd159505af4",
"time": "1565382563",
"type": "18",
"extra1": "1",
"extra2": "0",
"details": {
"campaignid": {
"campaignid": null,
"loginid": null,
"name": null,
"description": null
},
"programid": {
"programid": null,
"program": null,
"type": null,
"name": null,
"deleted": null,
"hidden": null
},
"siteid": {
"siteid": "1",
"site": "member_a",
"name": "Membership Site A",
"type": "0",
"deleted": "0",
"hidden": "0"
},
"tourid": {
"tourid": "1",
"tour": "MAIN",
"name": "Default Tour",
"siteid": "1",
"url": "https:\/\/www.google.com",
"linkdomain": "root.nats4.com",
"description": "",
"hidden": "0",
"deleted": "0"
}
},
"campaignid": "0",
"programid": "0",
"siteid": "1",
"tourid": "1",
"optionid": "0",
"adtoolid": "0",
"subid1": "0",
"subid2": "0",
"billerid": "0",
"countryid": "000",
"promotionalid": "0",
"type_nice": "Manual Add",
"description_details": {
"description": "",
"extra": [
{
"field": "status",
"value": "Active"
},
{
"field": "trial",
"value": "No"
}
]
}
}
],
"total_count": 1,
"session": "4184eb9f9064c7b773c8dfd159505af4"
}
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/surfer-actions',
'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);
?>
