NATS5 REST API Program POST payout-change
From TMM Wiki
(Redirected from NATS4 REST API Program POST payout-change)
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
POST /program/payout-change
Description
- Add new program payout change
Resource URL
- http://domain/api/program/payout-change
- Replace domain with the nats domain
- POST
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- programid
- type: digit
- required
- type
- type: digit
- required
- login
- optional
- countries
- type: string_list (Either a comma-separated string of strings, or a JSON array of strings)
- optional
- sites
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- tours
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- options
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- billers
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- process_type
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- 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: POST
URL: http://domain/api/program/payout-change
Form Data:
- programid: 1
- type: 1
- countries: USA
- start_time: 2019-06-11
- end_time: 2030-06-11
- field_0: 10
- field_1: 10
- field_2: 10
- field_3: 10
- field_4: 20
- field_5: 5
- field_6: 2
- field_7: 1
Response:
{ "success": true, "result": "Payout change added 1", "change_order": 1 }
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, 'type' => 1, 'countries' => 'USA', 'start_time' => '2019-06-11', 'end_time' => '2030-06-11', 'field_0' => 10, 'field_1' => 10, 'field_2' => 10, 'field_3' => 10, 'field_4' => 20, 'field_5' => 5, 'field_6' => 2, 'field_7' => 1, ); $request = Array( 'method' => 'POST', '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); ?>