Difference between revisions of "NATS5 REST API Member PATCH expiration"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS5 Manual | show_api_admin_section = true }} == '''PATCH /member/expiration''' == '''Note''': This is an autogenerated wiki page for the NATS5 API. There may be additiona...") |
|||
| Line 1: | Line 1: | ||
{{NATS5 Manual | {{NATS5 Manual | ||
| − | | | + | | show_api_admin_member_section = true |
}} | }} | ||
== '''PATCH /member/expiration''' == | == '''PATCH /member/expiration''' == | ||
Latest revision as of 15:59, 9 August 2019
PATCH /member/expiration
Note: This is an autogenerated wiki page for the NATS5 API. There may be additional descriptions or examples available on the NATS 4 API wiki for this API.
Description
- Set expiration date for a subscription
Resource URL
- http://domain/api/member/expiration
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- memberid
- optional
- memberidx
- optional
- subscriptionid
- optional
- expire
- type: datetime (A date string to be parsed by php strtotime, or a unix timestamp integer)
- optional
Example Request
Method: PATCH
URL: http://domain/api/member/expiration
Form Data:
- memberid: 3
- expire: 5 June 2020
- memberidx: NATS:3
Response:
{
"result": "SUCCESS",
"return": [
"NATS:3 (3) was updated."
],
"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(
'memberid' => '3',
'expire' => '5 June 2020',
'memberidx' => 'NATS:3',
);
$request = Array(
'method' => 'PATCH',
'path' => 'v1/member/expiration',
'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);
?>
