NATS4 REST API Set Payvia Rule
From TMM Wiki
Revision as of 19:05, 26 March 2015 by Tmmtobias0185 (talk | contribs)
PATCH /payviarule
Description
- Sets the payvia rule given the specified parameters.
Resource URL
- http://<domain>/api/payviarule
- 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.
- loginid: Specifies the login id
- type: integer
- required
- action: Can be "add", "update", or "remove"
- type: string
- required
- type: Can be "ignored", "enabled", or "disabled"
- type: string
- required
- payvia_type_id: Specifies the numeric payvia type id
- type: integer
- optional
- payvia_rule_id: Specifies the numeric payvia rule id
- type: integer
- optional
Example Request
PATCH
http://domain/api/payviarule
- Response:
{
"result": "TRUE",
"params": {
"payviaid": "1",
"rule_type": 1,
"login": [
"tmm1phrvezsbu"
],
"end_time": "NEVER",
"payvia_rule_id": "61"
}
}
Example Code
PHP
<?php
$data = array(
'payvia_type_id' => 1,
'action' => 'add',
'type' => 'enabled',
'loginid' => 1
);
$url = 'http://domain.com/api/payviarule';
$curl = curl_init();
$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);
var_dump($resp);
//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
url = 'http://domain/api/payviarule'
headers = {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'tmm1phrvezsbu'
}
data = {
'payvia_type_id': 1,
'action': 'add',
'type': 'enabled',
'loginid': 1
}
res = requests.patch(url, data=data, 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');
var options = {
url: 'http://domain/api/payviarule',
method: 'PATCH',
json: true,
form: {
'payvia_type_id': 1,
'action': 'add',
'type': 'enabled',
'loginid': 1
},
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);
