Difference between revisions of "NATS5 REST API Affiliate PATCH permissions"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''PATCH /affiliate/permissions''' == '''Description''' * Update affiliate permissions '''Resource URL''' *<nowiki>http:...") |
|||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_affiliate_section = true |
}} | }} | ||
== '''PATCH /affiliate/permissions''' == | == '''PATCH /affiliate/permissions''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Update affiliate permissions | * Update affiliate permissions | ||
| 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''']] |
*PATCH | *PATCH | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 31: | Line 32: | ||
** required | ** required | ||
| − | [[Category: | + | == '''Example Request''' == |
| − | [[Category: | + | Method: '''PATCH'''<br/> |
| + | URL: <nowiki>http://domain/api/affiliate/permissions</nowiki><br/> | ||
| + | Form Data:<br/> | ||
| + | * loginid: 1 | ||
| + | * section: overview | ||
| + | * permissions: {"display":true,"all_views":true,"all_actions":true,"view":[{"key":"default","name":"Default Admin Overview","value":true},{"key":"mobile_affiliates","name":"Mobile Affiliates","value":true},{"key":"mobile_all","name":"Mobile All","value":true},{"key":"mobile_new_affiliates","name":"Mobile New Affiliates","value":true},{"key":"mobile_new_members","name":"Mobile New Members","value":true},{"key":"mobile_programs","name":"Mobile Programs","value":true},{"key":"mobile_sites","name":"Mobile Sites","value":true},{"key":"mobile_summary","name":"Mobile Summary","value":true},{"key":"original","name":"Original v4 View","value":true}]} | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "result": "permissions updated" | ||
| + | } | ||
| + | </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( | ||
| + | 'loginid' => 1, | ||
| + | 'section' => 'overview', | ||
| + | 'permissions' => json_encode(array ( 'display' => true, 'all_views' => true, 'all_actions' => true, 'view' => array ( 0 => array ( 'key' => 'default', 'name' => 'Default Admin Overview', 'value' => true, ), 1 => array ( 'key' => 'mobile_affiliates', 'name' => 'Mobile Affiliates', 'value' => true, ), 2 => array ( 'key' => 'mobile_all', 'name' => 'Mobile All', 'value' => true, ), 3 => array ( 'key' => 'mobile_new_affiliates', 'name' => 'Mobile New Affiliates', 'value' => true, ), 4 => array ( 'key' => 'mobile_new_members', 'name' => 'Mobile New Members', 'value' => true, ), 5 => array ( 'key' => 'mobile_programs', 'name' => 'Mobile Programs', 'value' => true, ), 6 => array ( 'key' => 'mobile_sites', 'name' => 'Mobile Sites', 'value' => true, ), 7 => array ( 'key' => 'mobile_summary', 'name' => 'Mobile Summary', 'value' => true, ), 8 => array ( 'key' => 'original', 'name' => 'Original v4 View', 'value' => true, ), ),)), | ||
| + | ); | ||
| + | |||
| + | $request = Array( | ||
| + | 'method' => 'PATCH', | ||
| + | 'path' => 'v1/affiliate/permissions', | ||
| + | '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_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
PATCH /affiliate/permissions
Description
- Update affiliate permissions
Resource URL
- http://domain/api/affiliate/permissions
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- loginid
- type: digit
- required
- section
- type: string
- required
- permissions
- type: json (JSON Object)
- required
Example Request
Method: PATCH
URL: http://domain/api/affiliate/permissions
Form Data:
- loginid: 1
- section: overview
- permissions: {"display":true,"all_views":true,"all_actions":true,"view":[{"key":"default","name":"Default Admin Overview","value":true},{"key":"mobile_affiliates","name":"Mobile Affiliates","value":true},{"key":"mobile_all","name":"Mobile All","value":true},{"key":"mobile_new_affiliates","name":"Mobile New Affiliates","value":true},{"key":"mobile_new_members","name":"Mobile New Members","value":true},{"key":"mobile_programs","name":"Mobile Programs","value":true},{"key":"mobile_sites","name":"Mobile Sites","value":true},{"key":"mobile_summary","name":"Mobile Summary","value":true},{"key":"original","name":"Original v4 View","value":true}]}
Response:
{
"success": true,
"result": "permissions updated"
}
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' => 1,
'section' => 'overview',
'permissions' => json_encode(array ( 'display' => true, 'all_views' => true, 'all_actions' => true, 'view' => array ( 0 => array ( 'key' => 'default', 'name' => 'Default Admin Overview', 'value' => true, ), 1 => array ( 'key' => 'mobile_affiliates', 'name' => 'Mobile Affiliates', 'value' => true, ), 2 => array ( 'key' => 'mobile_all', 'name' => 'Mobile All', 'value' => true, ), 3 => array ( 'key' => 'mobile_new_affiliates', 'name' => 'Mobile New Affiliates', 'value' => true, ), 4 => array ( 'key' => 'mobile_new_members', 'name' => 'Mobile New Members', 'value' => true, ), 5 => array ( 'key' => 'mobile_programs', 'name' => 'Mobile Programs', 'value' => true, ), 6 => array ( 'key' => 'mobile_sites', 'name' => 'Mobile Sites', 'value' => true, ), 7 => array ( 'key' => 'mobile_summary', 'name' => 'Mobile Summary', 'value' => true, ), 8 => array ( 'key' => 'original', 'name' => 'Original v4 View', 'value' => true, ), ),)),
);
$request = Array(
'method' => 'PATCH',
'path' => 'v1/affiliate/permissions',
'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);
?>
