Difference between revisions of "NATS5 REST API Program DELETE payout-change"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Program DELETE payout-change to NATS5 REST API Program DELETE payout-change: Renaming NATS5 API pages) |
|||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | {{NATS5 Manual |
− | | | + | | show_api_admin_program_section = true |
}} | }} | ||
== '''DELETE /program/payout-change''' == | == '''DELETE /program/payout-change''' == | ||
+ | |||
'''Description''' | '''Description''' | ||
* Delete payout change | * Delete 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''']] |
*DELETE | *DELETE | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
− | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
Line 102: | Line 103: | ||
</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 --> | [[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
DELETE /program/payout-change
Description
- Delete payout change
Resource URL
- http://domain/api/program/payout-change
- Replace domain with the nats domain
- DELETE
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- programid
- type: digit
- required
- change_order
- type: digit
- required
Example Request
Method: DELETE
URL: http://domain/api/program/payout-change
Form Data:
- programid: 1
- change_order: 2
Response:
{ "success": true, "result": "payout change deleted" }
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' => 2, ); $request = Array( 'method' => 'DELETE', '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); ?>