Difference between revisions of "NATS4 REST API Set Affiliate Admin Settings"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''PATCH /affiliate/setadminsettings''' == '''Description''' *The /affiliate/setadminsettings endpoint is a feature in [...") |
|||
| Line 4: | Line 4: | ||
== '''PATCH /affiliate/setadminsettings''' == | == '''PATCH /affiliate/setadminsettings''' == | ||
'''Description''' | '''Description''' | ||
| − | *The /affiliate/setadminsettings | + | *The /affiliate/setadminsettings action is a feature in [[NATS4]] that allows you to change admin settings for your [[Ct#Affiliate|affiliates]] outside of the [[NATS]] system. The response contains one parameter named result. If the modification was successful then result will be 1. If it was not successful then the result will be 0. |
'''Resource URL''' | '''Resource URL''' | ||
Revision as of 00:50, 18 March 2015
PATCH /affiliate/setadminsettings
Description
- The /affiliate/setadminsettings action is a feature in NATS4 that allows you to change admin settings for your affiliates outside of the NATS system. The response contains one parameter named result. If the modification was successful then result will be 1. If it was not successful then the result will be 0.
Resource URL
- http://domain/api/v1/affiliate/setadminsettings
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded
NOTE: The values for the fields are 0 for off or 1 for on.
- loginid: is the affiliates loginid
- type: string
- required
- select1: is the select1 value
- type: string
- optional
- select2: is the select2 value
- type: string
- optional
- select3: is the select3 value
- type: string
- optional
- select4: is the select4 value
- type: string
- optional
- select5: is the select5 value
- type: string
- optional
- flag1: is the flag1 value
- type: string
- optional
- flag2: is the flag2 value
- type: string
- optional
- flag3: is the flag3 value
- type: string
- optional
- flag4: is the flag4 value
- type: string
- optional
- flag5: is the flag5 value
- type: string
- optional
- reviewed: is the reviewed value
- type: string
- optional
- invoicer: is the invoicer value
- type: string
- optional
- req_docs: is the req_docs value
- type: string
- optional
- w9: is the w9 value
- type: string
- optional
- trust_level: is the trust_level value
- type: string
- optional
Example Request
PATCH
http://domain/api/v1/affiliate/setadminsettings
- Response:
[
{
"result": 1
}
]
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'loginid' => 1,
'w9' => '1',
'reviewed' => '1'
);
$url = 'http://domain/api/affiliate/setadminsettings';
$headers = array(
'api_key: 44b5498dbcb481a0d00b404c0169af62',
'api_username: tmm1phrvezsbu'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);
$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);
?>
Python
- This example requires pip and the request library which can be installed via pip by: 'pip install requests'
import requests
import json
url = 'http://domain/api/affiliate/setadminsettings'
payload = {
'loginid': 1,
'w9': '1',
'reviewed': '1'
}
headers = {
'api_key': '44b5498dbcb481a0d00b404c0169af62',
'api_username': 'tmm1phrvezsbu'
}
res = requests.patch(url, data=payload, headers=headers)
print res.json()
node.js
- This example requires npm and the request module which can be installed via npm by: 'npm install request'
var request = require('request');
data = {
'loginid': 1,
'w9': '1',
'reviewed': '1'
}
var options = {
url: 'http://domain/api/affiliate/setadminsettings',
method: 'PATCH',
form: data,
json: true,
headers: {
'api_key': '44b5498dbcb481a0d00b404c0169af62',
'api_username': 'tmm1phrvezsbu'
}
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
else{
console.log(body);
}
}
request(options, callback);
Curl
curl -X PATCH 'http://domain/api/affiliate/setadminsettings' -H "api_key: 44b5498dbcb481a0d00b404c0169af62" -H "api_username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'loginid=1&w9=1&reviewed=1'
