Difference between revisions of "NATS5 REST API Site GET programs"
From TMM Wiki
Jump to navigationJump to search| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_site_section = true |
}} | }} | ||
== '''GET /site/programs''' == | == '''GET /site/programs''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get site/tour program details | * Get site/tour program details | ||
| 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 25: | Line 26: | ||
** required | ** required | ||
* '''import_programs''' | * '''import_programs''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/site/programs</nowiki><br/> | ||
| + | Query String: <nowiki>siteid=2&import_programs=1</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "programs": [ | ||
| + | { | ||
| + | "programid": "2", | ||
| + | "program": "test", | ||
| + | "hidden": "0", | ||
| + | "type": "0", | ||
| + | "name": "updated program name", | ||
| + | "extended_payout": "", | ||
| + | "max_ratio": "0", | ||
| + | "fallbackid": "0", | ||
| + | "addstr": "", | ||
| + | "deleted": "0", | ||
| + | "abi_paycom_prefix": "", | ||
| + | "abi_paycom_perc": "0", | ||
| + | "deduct_credits": "1", | ||
| + | "deduct_chargebacks": "1", | ||
| + | "deduct_voids": "0", | ||
| + | "deduct_insufficient": "0", | ||
| + | "verify_hash": "0", | ||
| + | "verify_initial": "0", | ||
| + | "retro_payout": "1", | ||
| + | "hide_rebills": "1", | ||
| + | "hide_joins": "1", | ||
| + | "system": "", | ||
| + | "system_key_field": "", | ||
| + | "system_key": "", | ||
| + | "coupon_code": "", | ||
| + | "description": "updated program description", | ||
| + | "thumb": "", | ||
| + | "thumb_ext": "", | ||
| + | "import_program": "0", | ||
| + | "ccbillid": "0", | ||
| + | "enabled": 1 | ||
| + | } | ||
| + | ], | ||
| + | "set_programs": [], | ||
| + | "tours": [ | ||
| + | { | ||
| + | "tourid": 2, | ||
| + | "name": "test tour name", | ||
| + | "programs": { | ||
| + | "2": { | ||
| + | "programid": 2, | ||
| + | "name": "updated program name", | ||
| + | "enabled": 0 | ||
| + | } | ||
| + | }, | ||
| + | "programs_list": [ | ||
| + | { | ||
| + | "programid": 2, | ||
| + | "name": "updated program name", | ||
| + | "enabled": 0 | ||
| + | } | ||
| + | ] | ||
| + | }, | ||
| + | { | ||
| + | "tourid": 4, | ||
| + | "name": "test tour", | ||
| + | "programs": { | ||
| + | "2": { | ||
| + | "programid": 2, | ||
| + | "name": "updated program name", | ||
| + | "enabled": 0 | ||
| + | } | ||
| + | }, | ||
| + | "programs_list": [ | ||
| + | { | ||
| + | "programid": 2, | ||
| + | "name": "updated program name", | ||
| + | "enabled": 0 | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | ], | ||
| + | "success": true | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 41: | Line 130: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'siteid' => '2', | |
| + | 'import_programs' => 1, | ||
); | ); | ||
| Line 84: | Line 174: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_site_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: | + | [[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 16:01, 9 August 2019
GET /site/programs
Description
- Get site/tour program details
Resource URL
- http://domain/api/site/programs
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- siteid
- type: digit
- required
- import_programs
- type: boolean_digit (0 or 1)
- optional
Example Request
Method: GET
URL: http://domain/api/site/programs
Query String: siteid=2&import_programs=1
Response:
{
"programs": [
{
"programid": "2",
"program": "test",
"hidden": "0",
"type": "0",
"name": "updated program name",
"extended_payout": "",
"max_ratio": "0",
"fallbackid": "0",
"addstr": "",
"deleted": "0",
"abi_paycom_prefix": "",
"abi_paycom_perc": "0",
"deduct_credits": "1",
"deduct_chargebacks": "1",
"deduct_voids": "0",
"deduct_insufficient": "0",
"verify_hash": "0",
"verify_initial": "0",
"retro_payout": "1",
"hide_rebills": "1",
"hide_joins": "1",
"system": "",
"system_key_field": "",
"system_key": "",
"coupon_code": "",
"description": "updated program description",
"thumb": "",
"thumb_ext": "",
"import_program": "0",
"ccbillid": "0",
"enabled": 1
}
],
"set_programs": [],
"tours": [
{
"tourid": 2,
"name": "test tour name",
"programs": {
"2": {
"programid": 2,
"name": "updated program name",
"enabled": 0
}
},
"programs_list": [
{
"programid": 2,
"name": "updated program name",
"enabled": 0
}
]
},
{
"tourid": 4,
"name": "test tour",
"programs": {
"2": {
"programid": 2,
"name": "updated program name",
"enabled": 0
}
},
"programs_list": [
{
"programid": 2,
"name": "updated program name",
"enabled": 0
}
]
}
],
"success": true
}
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(
'siteid' => '2',
'import_programs' => 1,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/site/programs',
'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);
?>
