Difference between revisions of "NATS5 REST API Program PATCH payout-change"
From TMM Wiki
Jump to navigationJump to search| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_program_section = true |
}} | }} | ||
== '''PATCH /program/payout-change''' == | == '''PATCH /program/payout-change''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Edit program payout change | * Edit program payout change | ||
| 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''']] |
*PATCH | *PATCH | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 88: | Line 89: | ||
** optional | ** optional | ||
| + | == '''Example Request''' == | ||
| + | Method: '''PATCH'''<br/> | ||
| + | URL: <nowiki>http://domain/api/program/payout-change</nowiki><br/> | ||
| + | Form Data:<br/> | ||
| + | * programid: 1 | ||
| + | * change_order: 1 | ||
| + | * start_time: 2019-06-11 | ||
| + | * end_time: 2030-06-11 | ||
| + | * field_0: 0 | ||
| + | * field_1: 0 | ||
| + | * field_2: 0 | ||
| + | * field_3: 0 | ||
| + | * field_4: 10 | ||
| + | * field_5: 15 | ||
| + | * field_6: 5 | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "result": "Payout change updated", | ||
| + | "payout_change": { | ||
| + | "payouts": [ | ||
| + | { | ||
| + | "id": 0, | ||
| + | "field": "Raw", | ||
| + | "pre": "$", | ||
| + | "post": "", | ||
| + | "value": "0.00", | ||
| + | "max": "0.00", | ||
| + | "min": "0.00", | ||
| + | "change": "decrease", | ||
| + | "default": "5.00" | ||
| + | }, | ||
| + | { | ||
| + | "id": 1, | ||
| + | "field": "Unq", | ||
| + | "pre": "$", | ||
| + | "post": "", | ||
| + | "value": "0.00", | ||
| + | "max": "0.00", | ||
| + | "min": "0.00", | ||
| + | "change": "decrease", | ||
| + | "default": "5.00" | ||
| + | }, | ||
| + | { | ||
| + | "id": 2, | ||
| + | "field": "Qual", | ||
| + | "pre": "$", | ||
| + | "post": "", | ||
| + | "value": "0.00", | ||
| + | "max": "0.00", | ||
| + | "min": "0.00", | ||
| + | "change": "decrease", | ||
| + | "default": "5.00" | ||
| + | }, | ||
| + | { | ||
| + | "id": 3, | ||
| + | "field": "$ Join", | ||
| + | "pre": "$", | ||
| + | "post": "", | ||
| + | "value": "0.00", | ||
| + | "max": "0.00", | ||
| + | "min": "0.00", | ||
| + | "change": "decrease", | ||
| + | "default": "5.00" | ||
| + | }, | ||
| + | { | ||
| + | "id": 4, | ||
| + | "field": "$ Rebill", | ||
| + | "pre": "$", | ||
| + | "post": "", | ||
| + | "value": "10.00", | ||
| + | "max": "10.00", | ||
| + | "min": "10.00", | ||
| + | "change": "none", | ||
| + | "default": "10.00" | ||
| + | }, | ||
| + | { | ||
| + | "id": 5, | ||
| + | "field": "$ Active", | ||
| + | "pre": "$", | ||
| + | "post": "", | ||
| + | "value": "15.00", | ||
| + | "max": "15.00", | ||
| + | "min": "15.00", | ||
| + | "change": "increase", | ||
| + | "default": "5.00" | ||
| + | }, | ||
| + | { | ||
| + | "id": 6, | ||
| + | "field": "% Join", | ||
| + | "pre": "", | ||
| + | "post": "%", | ||
| + | "value": "5.00", | ||
| + | "max": "5.00", | ||
| + | "min": "5.00", | ||
| + | "change": "increase", | ||
| + | "default": "2.00" | ||
| + | }, | ||
| + | { | ||
| + | "id": 7, | ||
| + | "field": "% Rebill", | ||
| + | "pre": "", | ||
| + | "post": "%", | ||
| + | "value": "1.00", | ||
| + | "max": "1.00", | ||
| + | "min": "1.00", | ||
| + | "change": "none", | ||
| + | "default": "1.00" | ||
| + | }, | ||
| + | { | ||
| + | "id": 8, | ||
| + | "field": "% Dialer", | ||
| + | "pre": "", | ||
| + | "post": "%", | ||
| + | "value": "0.00", | ||
| + | "max": "0.00", | ||
| + | "min": "0.00", | ||
| + | "change": "none", | ||
| + | "default": "0.00" | ||
| + | }, | ||
| + | { | ||
| + | "id": 9, | ||
| + | "field": "NCR", | ||
| + | "pre": "$", | ||
| + | "post": "", | ||
| + | "value": "0.00", | ||
| + | "max": "0.00", | ||
| + | "min": "0.00", | ||
| + | "change": "none", | ||
| + | "default": "0.00" | ||
| + | }, | ||
| + | { | ||
| + | "id": 10, | ||
| + | "field": "Third Reg", | ||
| + | "pre": "$", | ||
| + | "post": "", | ||
| + | "value": "0.00", | ||
| + | "max": "0.00", | ||
| + | "min": "0.00", | ||
| + | "change": "none", | ||
| + | "default": "0.00" | ||
| + | }, | ||
| + | { | ||
| + | "id": 11, | ||
| + | "field": "% Active", | ||
| + | "pre": "", | ||
| + | "post": "%", | ||
| + | "value": "0.00", | ||
| + | "max": "0.00", | ||
| + | "min": "0.00", | ||
| + | "change": "none", | ||
| + | "default": "0.00" | ||
| + | } | ||
| + | ], | ||
| + | "start_time": "1565382570", | ||
| + | "change_type": "1", | ||
| + | "change_type_nice": "Standard Change", | ||
| + | "start_time_nice": "2019-08-09 16:29:30", | ||
| + | "end_time_nice": "Never", | ||
| + | "end_time": "0", | ||
| + | "additionalPayoutChanges": { | ||
| + | "Processing Type(s)": { | ||
| + | "-1": "All" | ||
| + | } | ||
| + | }, | ||
| + | "change_order": 1, | ||
| + | "targets": { | ||
| + | "affiliates": [ | ||
| + | { | ||
| + | "id": 0, | ||
| + | "name": "All" | ||
| + | } | ||
| + | ], | ||
| + | "sites": [ | ||
| + | { | ||
| + | "id": 0, | ||
| + | "name": "All" | ||
| + | } | ||
| + | ], | ||
| + | "programs": [ | ||
| + | { | ||
| + | "id": 1, | ||
| + | "name": { | ||
| + | "programid": "1", | ||
| + | "program": "50rev", | ||
| + | "hidden": "0", | ||
| + | "type": "0", | ||
| + | "name": "50% Revshare", | ||
| + | "extended_payout": "", | ||
| + | "max_ratio": "0", | ||
| + | "fallbackid": "0", | ||
| + | "addstr": "", | ||
| + | "deleted": "0", | ||
| + | "abi_paycom_prefix": "", | ||
| + | "abi_paycom_perc": "0", | ||
| + | "deduct_credits": "0", | ||
| + | "deduct_chargebacks": "0", | ||
| + | "deduct_voids": "0", | ||
| + | "deduct_insufficient": "0", | ||
| + | "verify_hash": "0", | ||
| + | "verify_initial": "0", | ||
| + | "retro_payout": "0", | ||
| + | "hide_rebills": "0", | ||
| + | "hide_joins": "0", | ||
| + | "system": "", | ||
| + | "system_key_field": "", | ||
| + | "system_key": "", | ||
| + | "coupon_code": "", | ||
| + | "description": "", | ||
| + | "thumb": "", | ||
| + | "thumb_ext": "", | ||
| + | "import_program": "0", | ||
| + | "ccbillid": "0", | ||
| + | "enabled": 1 | ||
| + | } | ||
| + | } | ||
| + | ], | ||
| + | "tours": [ | ||
| + | { | ||
| + | "id": 0, | ||
| + | "name": "All" | ||
| + | } | ||
| + | ], | ||
| + | "options": [ | ||
| + | { | ||
| + | "id": 0, | ||
| + | "name": "All" | ||
| + | } | ||
| + | ], | ||
| + | "billers": [ | ||
| + | { | ||
| + | "id": 0, | ||
| + | "name": "All", | ||
| + | "nice_name": "All" | ||
| + | } | ||
| + | ], | ||
| + | "countries": [ | ||
| + | { | ||
| + | "id": 0, | ||
| + | "name": "All" | ||
| + | } | ||
| + | ] | ||
| + | }, | ||
| + | "additional_targets": [ | ||
| + | { | ||
| + | "target": "process_type", | ||
| + | "name": "Processing Type(s)", | ||
| + | "values": [ | ||
| + | { | ||
| + | "id": -1, | ||
| + | "name": "All" | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | ], | ||
| + | "status": "active" | ||
| + | } | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 101: | Line 366: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'programid' => 1, | |
| + | 'change_order' => 1, | ||
| + | 'start_time' => '2019-06-11', | ||
| + | 'end_time' => '2030-06-11', | ||
| + | 'field_0' => 0, | ||
| + | 'field_1' => 0, | ||
| + | 'field_2' => 0, | ||
| + | 'field_3' => 0, | ||
| + | 'field_4' => 10, | ||
| + | 'field_5' => 15, | ||
| + | 'field_6' => 5, | ||
); | ); | ||
| Line 144: | Line 419: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_program_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 --> | ||
Latest revision as of 16:00, 9 August 2019
PATCH /program/payout-change
Description
- Edit program payout change
Resource URL
- http://domain/api/program/payout-change
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- programid
- type: digit
- required
- change_order
- type: digit
- required
- recur_type
- type: digit
- optional
- recur_frequency
- type: digit
- optional
- start_time
- type: datetime (A date string to be parsed by php strtotime, or a unix timestamp integer)
- optional
- end_time
- type: datetime (A date string to be parsed by php strtotime, or a unix timestamp integer)
- optional
- field_0
- type: numeric
- optional
- field_1
- type: numeric
- optional
- field_2
- type: numeric
- optional
- field_3
- type: numeric
- optional
- field_4
- type: numeric
- optional
- field_5
- type: numeric
- optional
- field_6
- type: numeric
- optional
- field_7
- type: numeric
- optional
- field_8
- type: numeric
- optional
- field_9
- type: numeric
- optional
- field_10
- type: numeric
- optional
- field_11
- type: numeric
- optional
- field_12
- type: numeric
- optional
- field_13
- type: numeric
- optional
- field_14
- type: numeric
- optional
- field_15
- type: numeric
- optional
Example Request
Method: PATCH
URL: http://domain/api/program/payout-change
Form Data:
- programid: 1
- change_order: 1
- start_time: 2019-06-11
- end_time: 2030-06-11
- field_0: 0
- field_1: 0
- field_2: 0
- field_3: 0
- field_4: 10
- field_5: 15
- field_6: 5
Response:
{
"success": true,
"result": "Payout change updated",
"payout_change": {
"payouts": [
{
"id": 0,
"field": "Raw",
"pre": "$",
"post": "",
"value": "0.00",
"max": "0.00",
"min": "0.00",
"change": "decrease",
"default": "5.00"
},
{
"id": 1,
"field": "Unq",
"pre": "$",
"post": "",
"value": "0.00",
"max": "0.00",
"min": "0.00",
"change": "decrease",
"default": "5.00"
},
{
"id": 2,
"field": "Qual",
"pre": "$",
"post": "",
"value": "0.00",
"max": "0.00",
"min": "0.00",
"change": "decrease",
"default": "5.00"
},
{
"id": 3,
"field": "$ Join",
"pre": "$",
"post": "",
"value": "0.00",
"max": "0.00",
"min": "0.00",
"change": "decrease",
"default": "5.00"
},
{
"id": 4,
"field": "$ Rebill",
"pre": "$",
"post": "",
"value": "10.00",
"max": "10.00",
"min": "10.00",
"change": "none",
"default": "10.00"
},
{
"id": 5,
"field": "$ Active",
"pre": "$",
"post": "",
"value": "15.00",
"max": "15.00",
"min": "15.00",
"change": "increase",
"default": "5.00"
},
{
"id": 6,
"field": "% Join",
"pre": "",
"post": "%",
"value": "5.00",
"max": "5.00",
"min": "5.00",
"change": "increase",
"default": "2.00"
},
{
"id": 7,
"field": "% Rebill",
"pre": "",
"post": "%",
"value": "1.00",
"max": "1.00",
"min": "1.00",
"change": "none",
"default": "1.00"
},
{
"id": 8,
"field": "% Dialer",
"pre": "",
"post": "%",
"value": "0.00",
"max": "0.00",
"min": "0.00",
"change": "none",
"default": "0.00"
},
{
"id": 9,
"field": "NCR",
"pre": "$",
"post": "",
"value": "0.00",
"max": "0.00",
"min": "0.00",
"change": "none",
"default": "0.00"
},
{
"id": 10,
"field": "Third Reg",
"pre": "$",
"post": "",
"value": "0.00",
"max": "0.00",
"min": "0.00",
"change": "none",
"default": "0.00"
},
{
"id": 11,
"field": "% Active",
"pre": "",
"post": "%",
"value": "0.00",
"max": "0.00",
"min": "0.00",
"change": "none",
"default": "0.00"
}
],
"start_time": "1565382570",
"change_type": "1",
"change_type_nice": "Standard Change",
"start_time_nice": "2019-08-09 16:29:30",
"end_time_nice": "Never",
"end_time": "0",
"additionalPayoutChanges": {
"Processing Type(s)": {
"-1": "All"
}
},
"change_order": 1,
"targets": {
"affiliates": [
{
"id": 0,
"name": "All"
}
],
"sites": [
{
"id": 0,
"name": "All"
}
],
"programs": [
{
"id": 1,
"name": {
"programid": "1",
"program": "50rev",
"hidden": "0",
"type": "0",
"name": "50% Revshare",
"extended_payout": "",
"max_ratio": "0",
"fallbackid": "0",
"addstr": "",
"deleted": "0",
"abi_paycom_prefix": "",
"abi_paycom_perc": "0",
"deduct_credits": "0",
"deduct_chargebacks": "0",
"deduct_voids": "0",
"deduct_insufficient": "0",
"verify_hash": "0",
"verify_initial": "0",
"retro_payout": "0",
"hide_rebills": "0",
"hide_joins": "0",
"system": "",
"system_key_field": "",
"system_key": "",
"coupon_code": "",
"description": "",
"thumb": "",
"thumb_ext": "",
"import_program": "0",
"ccbillid": "0",
"enabled": 1
}
}
],
"tours": [
{
"id": 0,
"name": "All"
}
],
"options": [
{
"id": 0,
"name": "All"
}
],
"billers": [
{
"id": 0,
"name": "All",
"nice_name": "All"
}
],
"countries": [
{
"id": 0,
"name": "All"
}
]
},
"additional_targets": [
{
"target": "process_type",
"name": "Processing Type(s)",
"values": [
{
"id": -1,
"name": "All"
}
]
}
],
"status": "active"
}
}
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(
'programid' => 1,
'change_order' => 1,
'start_time' => '2019-06-11',
'end_time' => '2030-06-11',
'field_0' => 0,
'field_1' => 0,
'field_2' => 0,
'field_3' => 0,
'field_4' => 10,
'field_5' => 15,
'field_6' => 5,
);
$request = Array(
'method' => 'PATCH',
'path' => 'v1/program/payout-change',
'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);
?>
