Difference between revisions of "NATS4 REST API Set Payvia Rule"
From TMM Wiki
Jump to navigationJump to searchm (Tmmtobias0185 moved page NATS4 REST API Set Payvia Rule to NATS4 REST API PATCH Payvia Rule) |
|||
| (23 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
| − | |||
| − | |||
| − | |||
| + | == '''PATCH /payviarule''' == | ||
| + | '''Description''' | ||
| + | *Sets the payvia rule given the specified parameters. | ||
'''Resource URL''' | '''Resource URL''' | ||
| − | *<nowiki>http://domain/api | + | *<nowiki>http://<domain>/api/payviarule</nowiki> |
| − | *Replace domain with the nats domain | + | *Replace <domain> with the nats domain |
| + | '''[[NATS4_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] | ||
| + | *PATCH | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | + | '''[[NATS4_REST_API_Overview#Authentication|Authentication]]''' | |
| − | '''Authentication''' | ||
*HTTP headers | *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 | + | *'''loginid''': ''Specifies the login id'' |
| + | **'''''type: integer''''' | ||
**'''''required''''' | **'''''required''''' | ||
*'''action''': ''Can be "add", "update", or "remove"'' | *'''action''': ''Can be "add", "update", or "remove"'' | ||
| + | **'''''type: string''''' | ||
**'''''required''''' | **'''''required''''' | ||
*'''type''': ''Can be "ignored", "enabled", or "disabled"'' | *'''type''': ''Can be "ignored", "enabled", or "disabled"'' | ||
| + | **'''''type: string''''' | ||
**'''''required''''' | **'''''required''''' | ||
*'''payvia_type_id''': ''Specifies the numeric payvia type id'' | *'''payvia_type_id''': ''Specifies the numeric payvia type id'' | ||
| + | **'''''type: integer''''' | ||
**'''''optional''''' | **'''''optional''''' | ||
*'''payvia_rule_id''': ''Specifies the numeric payvia rule id'' | *'''payvia_rule_id''': ''Specifies the numeric payvia rule id'' | ||
| + | **'''''type: integer''''' | ||
**'''''optional''''' | **'''''optional''''' | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== '''Example Request''' == | == '''Example Request''' == | ||
| − | PATCH | + | '''PATCH''' |
| − | <nowiki>http://domain/api | + | <nowiki>http://domain/api/payviarule</nowiki> |
*Response: | *Response: | ||
<pre> | <pre> | ||
{ | { | ||
| − | + | "result": "TRUE", | |
| − | + | "params": { | |
| − | + | "payviaid": "1", | |
| − | + | "rule_type": 1, | |
| − | + | "login": [ | |
| − | + | "tmm1phrvezsbu" | |
| − | + | ], | |
| − | + | "end_time": "NEVER", | |
| − | + | "payvia_rule_id": "61" | |
| − | + | } | |
} | } | ||
</pre> | </pre> | ||
== '''Example Code''' == | == '''Example Code''' == | ||
| − | |||
| − | |||
'''PHP''' | '''PHP''' | ||
<pre> | <pre> | ||
| − | <?php | + | <?php |
| + | |||
$data = array( | $data = array( | ||
'payvia_type_id' => 1, | 'payvia_type_id' => 1, | ||
| Line 80: | Line 79: | ||
'loginid' => 1 | 'loginid' => 1 | ||
); | ); | ||
| − | + | ||
| − | $url = 'http://domain/api | + | $url = 'http://domain.com/api/payviarule'; |
$curl = curl_init(); | $curl = curl_init(); | ||
| − | + | ||
$headers = array( | $headers = array( | ||
| − | ' | + | 'api-key: 44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username: tmm1phrvezsbu' |
); | ); | ||
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH"); | curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH"); | ||
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); | curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); | ||
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); | curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); | ||
| + | curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data)); | ||
curl_setopt($curl, CURLOPT_URL, $url); | curl_setopt($curl, CURLOPT_URL, $url); | ||
| − | + | ||
$resp = curl_exec($curl); | $resp = curl_exec($curl); | ||
| + | var_dump($resp); | ||
//dumps an associative array representation of the json | //dumps an associative array representation of the json | ||
var_dump(json_decode($resp, true)); | var_dump(json_decode($resp, true)); | ||
// Close request to clear up some resources | // Close request to clear up some resources | ||
curl_close($curl); | curl_close($curl); | ||
| − | ?> | + | ?> |
| + | |||
</pre> | </pre> | ||
| Line 106: | Line 108: | ||
import requests | import requests | ||
| − | url = 'http://domain/api | + | url = 'http://domain/api/payviarule' |
headers = { | headers = { | ||
| − | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', | |
| − | + | 'api-username': 'tmm1phrvezsbu' | |
} | } | ||
| − | + | data = { | |
| − | + | 'payvia_type_id': 1, | |
| − | + | 'action': 'add', | |
| − | + | 'type': 'enabled', | |
| − | + | 'loginid': 1 | |
| − | + | } | |
| − | + | ||
| − | res = requests.patch(url, | + | res = requests.patch(url, data=data, headers=headers) |
print res.json() | print res.json() | ||
| + | |||
</pre> | </pre> | ||
| Line 126: | Line 129: | ||
<pre> | <pre> | ||
var request = require('request'); | var request = require('request'); | ||
| − | + | ||
| − | var options = { | + | var options = { |
| − | url: 'http://domain/api | + | url: 'http://domain/api/payviarule', |
method: 'PATCH', | method: 'PATCH', | ||
| − | json: true, | + | json: true, |
| − | + | form: { | |
'payvia_type_id': 1, | 'payvia_type_id': 1, | ||
'action': 'add', | 'action': 'add', | ||
'type': 'enabled', | 'type': 'enabled', | ||
'loginid': 1 | 'loginid': 1 | ||
| − | }, | + | }, |
| − | headers: { | + | headers: { |
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
| − | } | + | } |
| − | }; | + | }; |
| − | + | ||
function callback(error, response, body) { | function callback(error, response, body) { | ||
if (!error && response.statusCode == 200) { | if (!error && response.statusCode == 200) { | ||
console.log(body); | console.log(body); | ||
| − | } | + | } |
| − | else{ | + | else{ |
console.log(body); | console.log(body); | ||
| − | } | + | } |
| − | + | ||
| − | } | + | } |
| − | + | ||
| − | request(options, callback); | + | request(options, callback); |
| − | |||
| − | |||
| − | |||
| − | |||
</pre> | </pre> | ||
[[Category:NATS4 API Articles]] | [[Category:NATS4 API Articles]] | ||
Latest revision as of 19:05, 26 March 2015
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);
