Difference between revisions of "NATS5 REST API Biller GET cascades-available"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Biller GET cascades-available to NATS5 REST API Biller GET cascades-available: Renaming NATS5 API pages) |
Tag: Undo |
||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_biller_section = true |
}} | }} | ||
== '''GET /biller/cascades-available''' == | == '''GET /biller/cascades-available''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get cascades | * Get cascades | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 21: | Line 22: | ||
'''''Parameters can be sent as url encoded params | '''''Parameters can be sent as url encoded params | ||
| + | * '''ip''' | ||
| + | ** optional (ipv4, ipv6) | ||
* '''country''' | * '''country''' | ||
** optional | ** optional | ||
| Line 38: | Line 41: | ||
** type: digit | ** type: digit | ||
** required | ** required | ||
| + | |||
| + | |||
| + | <pre> NATS will prefer country derived from ip. But, you can force a default by specifying country/countryid when requesting via ip </pre> | ||
== '''Example Request''' == | == '''Example Request''' == | ||
| Line 119: | Line 125: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_biller_Collection]] |
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
[[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Latest revision as of 13:46, 18 November 2023
GET /biller/cascades-available
Description
- Get cascades
Resource URL
- http://domain/api/biller/cascades-available
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- ip
- optional (ipv4, ipv6)
- country
- optional
- countryid
- type: digit
- optional
- loginid
- type: digit
- required
- programid
- type: digit
- required
- siteid
- type: digit
- required
- tourid
- type: digit
- required
NATS will prefer country derived from ip. But, you can force a default by specifying country/countryid when requesting via ip
Example Request
Method: GET
URL: http://domain/api/biller/cascades-available
Query String: loginid=0&programid=0&siteid=0&tourid=0&country=USA
Response:
{
"success": true,
"cascades": [
{
"cascadeid": 1,
"name": "Join by Credit Card"
}
]
}
Example Code
PHP
<?php
$headers = array( //set your username and API key here
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$url = 'http://yourdomain.com'; //set your NATS URL here
$data = Array(
'loginid' => 0,
'programid' => 0,
'siteid' => 0,
'tourid' => 0,
'country' => 'USA',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/biller/cascades-available',
'data' => $data
);
/*code below is the same for (almost) every API call */
$curl = curl_init();
$url = $url.'/api/'.$request['path'];
$query = http_build_query($request['data']);
if($request['method'] == 'GET'){
//add query string parameters to the end of the url
$url = $url.'?'.$query;
}else{
//send parameters as POST fields
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $query);
if($request['method'] != 'POST'){
$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$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);
?>
