Difference between revisions of "NATS5 REST API Program PATCH details"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Program PATCH details to NATS5 REST API Program PATCH details: Renaming NATS5 API pages) |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
== '''PATCH /program/details''' == | == '''PATCH /program/details''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Edit program | * Edit program | ||
| 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 34: | Line 35: | ||
** optional | ** optional | ||
* '''enabled''' | * '''enabled''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''hidden''' | * '''hidden''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''deduct_credits''' | * '''deduct_credits''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''deduct_chargebacks''' | * '''deduct_chargebacks''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''deduct_voids''' | * '''deduct_voids''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''deduct_insufficient''' | * '''deduct_insufficient''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''hide_rebills''' | * '''hide_rebills''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''hide_joins''' | * '''hide_joins''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''retro_payout''' | * '''retro_payout''' | ||
| Line 156: | Line 157: | ||
</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 --> | ||
Revision as of 15:46, 9 August 2019
PATCH /program/details
Description
- Edit program
Resource URL
- http://domain/api/program/details
- 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
- name
- type: string
- optional
- description
- type: string
- optional
- extended_payout
- type: string
- optional
- enabled
- type: boolean_digit (0 or 1)
- optional
- hidden
- type: boolean_digit (0 or 1)
- optional
- deduct_credits
- type: boolean_digit (0 or 1)
- optional
- deduct_chargebacks
- type: boolean_digit (0 or 1)
- optional
- deduct_voids
- type: boolean_digit (0 or 1)
- optional
- deduct_insufficient
- type: boolean_digit (0 or 1)
- optional
- hide_rebills
- type: boolean_digit (0 or 1)
- optional
- hide_joins
- type: boolean_digit (0 or 1)
- optional
- retro_payout
- type: trinary_digit (0, 1, or 2)
- optional
- ccbillid
- type: digit
- optional
Example Request
Method: PATCH
URL: http://domain/api/program/details
Form Data:
- programid: 2
- name: updated program name
- description: updated program description
- enabled: 1
- hidden: 0
- deduct_credits: 1
- deduct_chargebacks: 1
- deduct_insufficient: 0
- hide_rebills: 1
- hide_joins: 1
- retro_payout: 1
Response:
{
"success": true,
"result": "program updated"
}
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' => 2,
'name' => 'updated program name',
'description' => 'updated program description',
'enabled' => 1,
'hidden' => 0,
'deduct_credits' => 1,
'deduct_chargebacks' => 1,
'deduct_insufficient' => 0,
'hide_rebills' => 1,
'hide_joins' => 1,
'retro_payout' => 1,
);
$request = Array(
'method' => 'PATCH',
'path' => 'v1/program/details',
'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);
?>
