Difference between revisions of "NATS4 REST API Set Payvia Rule"
From TMM Wiki
Jump to navigationJump to search| Line 21: | Line 21: | ||
== '''Parameters''' == | == '''Parameters''' == | ||
| + | |||
| + | '''Paremeters can be sent as url encoded params or as part of the HTTP request body.''' | ||
*'''loginid''': ''Specifies the login id'' | *'''loginid''': ''Specifies the login id'' | ||
Revision as of 17:36, 11 March 2015
PATCH payviarule
Description
- Sets the payvia rule given the specified parameters.
Resource URL
- http://<domain>/api/v1/payviarule
- Replace <domain> with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Paremeters can be sent as url encoded params or as part of the HTTP request body.
- 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/v1/payviarule
- Response:
{
"result": "TRUE",
"params": {
"payviaid": "1",
"rule_type": 1,
"login": [
"tmm1phrvezsbu"
],
"end_time": "NEVER",
"payvia_rule_id": "51"
}
}
Example Code
*NOTE: Example Code segments below all send url encoded data. If you would like to send data with the request body of the PATCH request, it is done the same way as a POST request. See any POST API endpoint
PHP
<?php
$data = array(
'payvia_type_id' => 1,
'action' => 'add',
'type' => 'enabled',
'loginid' => 1
);
$data_string = http_build_query($data);
$url = 'http://domain/api/v1/payviarule?'.$data_string;
$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_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
url = 'http://domain/api/v1/payviarule'
headers = {
'api_key': '44b5498dbcb481a0d00b404c0169af62',
'api_username': 'tmm1phrvezsbu'
}
params = {
'payvia_type_id': 1,
'action': 'add',
'type': 'enabled',
'loginid': 1
}
res = requests.patch(url, params=params, 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/v1/payviarule',
method: 'PATCH',
json: true,
qs: {
'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);
Curl
curl -X PATCH 'http://domain/api/v1/payviarule?payvia_type_id=1&action=add&type=enabled&loginid=1' -H "api_key: 44b5498dbcb481a0d00b404c0169af62" -H "api_username: tmm1phrvezsbu"
