Difference between revisions of "NATS4 REST API Get Payvia Rule"
From TMM Wiki
Jump to navigationJump to searchm (Tmmtobias0185 moved page NATS4 REST API Get Payvia Rule to NATS4 REST API GET Payvia Rule) |
Tmm vincent (talk | contribs) m (Undo revision 23105 by Tmm vincent (talk)) |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
| − | == '''GET payviarule''' == | + | == '''GET /payviarule''' == |
| − | + | '''Description''' | |
| − | Returns all payvia rules with the specified parameters. | + | *Returns all payvia rules with 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''']] | ||
| + | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| + | '''[[NATS4_REST_API_Overview#Authentication|Authentication]]''' | ||
| + | *HTTP headers | ||
| − | ''' | + | == '''Parameters''' == |
| − | |||
| + | '''Paremeters can be sent as url encoded params. See examples below.''' | ||
| − | |||
| − | |||
*'''payvia_type_id''': ''Specifies the payvia type id'' | *'''payvia_type_id''': ''Specifies the payvia type id'' | ||
| + | **'''''type: integer''''' | ||
**'''''required''''' | **'''''required''''' | ||
*'''rule_type''': ''The rule type (enabled, disabled, ignored)'' | *'''rule_type''': ''The rule type (enabled, disabled, ignored)'' | ||
| + | **'''''type: string''''' | ||
**'''''required''''' | **'''''required''''' | ||
| − | |||
| − | |||
| − | |||
| − | |||
== '''Example Request''' == | == '''Example Request''' == | ||
| − | GET | + | '''GET''' |
| − | <nowiki>http://domain/api | + | <nowiki>http://domain/api/payviarule</nowiki> |
*Response: | *Response: | ||
| − | <pre>{ result: 'TRUE', | + | <pre> |
| − | + | { | |
| − | + | result: 'TRUE', | |
| − | + | params: [ | |
| − | + | { | |
| − | + | payvia_rule_id: '38', | |
| − | + | payvia_type_id: '1', | |
| − | + | rule_type: 'enabled', | |
| − | + | identid: '21', | |
| − | + | start_time: '2006-06-06 00:00:00', | |
| − | + | end_time: '2016-06-06 00:00:00', | |
| − | + | login: '1', | |
| − | + | country: 'All' | |
| − | + | }, | |
| − | + | { | |
| − | + | payvia_rule_id: '7', | |
| − | + | payvia_type_id: '1', | |
| − | + | rule_type: 'enabled', | |
| − | + | identid: '22', | |
| − | + | start_time: '2006-06-06 00:00:00', | |
| − | + | end_time: '2016-06-06 00:00:00', | |
| − | + | login: '1', | |
| − | + | country: 'AX' | |
| − | + | }, | |
| − | + | { | |
| − | + | payvia_rule_id: '8', | |
| − | + | payvia_type_id: '1', | |
| − | + | rule_type: 'enabled', | |
| − | + | identid: '23', | |
| − | + | start_time: '2006-06-06 00:00:00', | |
| − | + | end_time: '2016-06-06 00:00:00', | |
| − | + | login: '1', | |
| − | + | country: 'AF' | |
| − | + | }, | |
| + | { | ||
| + | payvia_rule_id: '9', | ||
| + | payvia_type_id: '1', | ||
| + | rule_type: 'enabled', | ||
| + | identid: '24', | ||
| + | start_time: '2006-06-06 00:00:00', | ||
| + | end_time: '2016-06-06 00:00:00', | ||
| + | login: '1', | ||
| + | country: 'AL' | ||
| + | } | ||
| + | ] | ||
| + | } | ||
</pre> | </pre> | ||
| Line 85: | Line 96: | ||
); | ); | ||
$data_string = http_build_query($data); | $data_string = http_build_query($data); | ||
| − | $url = 'http://domain/api | + | $url = 'http://domain/api/payviarule?'.$data_string; |
$curl = curl_init(); | $curl = curl_init(); | ||
$headers = array( | $headers = array( | ||
| − | ' | + | 'api-key: 44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username: tmm1phrvezsbu' |
); | ); | ||
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); | curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); | ||
| Line 109: | Line 120: | ||
import requests | import requests | ||
| − | url = 'http://domain/api | + | url = 'http://domain/api/payviarule' |
headers = { | headers = { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
params = { | params = { | ||
| Line 129: | Line 140: | ||
var options = { | var options = { | ||
| − | url: 'http://domain/api | + | url: 'http://domain/api/payviarule', |
method: 'GET', | method: 'GET', | ||
json: true, | json: true, | ||
| Line 137: | Line 148: | ||
}, | }, | ||
headers: { | headers: { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
}; | }; | ||
| Line 157: | Line 168: | ||
'''Curl''' | '''Curl''' | ||
<pre> | <pre> | ||
| − | curl -X GET 'http://domain/api | + | curl -X GET 'http://domain/api/payviarule?payvia_type_id=1&rule_type=enabled' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" |
</pre> | </pre> | ||
[[Category:NATS4 API Articles]] | [[Category:NATS4 API Articles]] | ||
Latest revision as of 20:57, 14 January 2017
GET /payviarule
Description
- Returns all payvia rules with the specified parameters.
Resource URL
- http://domain/api/payviarule
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Paremeters can be sent as url encoded params. See examples below.
- payvia_type_id: Specifies the payvia type id
- type: integer
- required
- rule_type: The rule type (enabled, disabled, ignored)
- type: string
- required
Example Request
GET
http://domain/api/payviarule
- Response:
{
result: 'TRUE',
params: [
{
payvia_rule_id: '38',
payvia_type_id: '1',
rule_type: 'enabled',
identid: '21',
start_time: '2006-06-06 00:00:00',
end_time: '2016-06-06 00:00:00',
login: '1',
country: 'All'
},
{
payvia_rule_id: '7',
payvia_type_id: '1',
rule_type: 'enabled',
identid: '22',
start_time: '2006-06-06 00:00:00',
end_time: '2016-06-06 00:00:00',
login: '1',
country: 'AX'
},
{
payvia_rule_id: '8',
payvia_type_id: '1',
rule_type: 'enabled',
identid: '23',
start_time: '2006-06-06 00:00:00',
end_time: '2016-06-06 00:00:00',
login: '1',
country: 'AF'
},
{
payvia_rule_id: '9',
payvia_type_id: '1',
rule_type: 'enabled',
identid: '24',
start_time: '2006-06-06 00:00:00',
end_time: '2016-06-06 00:00:00',
login: '1',
country: 'AL'
}
]
}
Example Code
PHP
<?php
$data = array(
'payvia_type_id' => '1',
'rule_type' => 'enabled'
);
$data_string = http_build_query($data);
$url = 'http://domain/api/payviarule?'.$data_string;
$curl = curl_init();
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
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/payviarule'
headers = {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'tmm1phrvezsbu'
}
params = {
'payvia_type_id': 1,
'rule_type': 'enabled'
}
res = requests.get(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/payviarule',
method: 'GET',
json: true,
qs: {
'payvia_type_id': 1,
'rule_type': 'enabled'
},
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 GET 'http://domain/api/payviarule?payvia_type_id=1&rule_type=enabled' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu"
