NATS4 REST API Set Member Expiration
From TMM Wiki
Revision as of 19:12, 26 March 2015 by Tmmtobias0185 (talk | contribs)
PATCH /member/setexpiration
Description
- The /member/setexpiration action is a feature in NATS4 that allows you to set the member expiration date
Resource URL
- http://domain/api/v1/member/setexpiration
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded
At least one optional parameter must be supplied.
- memberid: - Member ID to grab all subscriptions for
- type: integer
- optional
- memberidx: - Memberidx field to expire 1 subscription for
- type: string
- optional
- subscriptionid: - subscription ID to expire 1 subscription for
- type: integer
- optional
- expire: - Date time field to set the expiration date to.
- type: string
- required'
Example Request
PATCH
http://domain/api/v1/member/setexpiration
- Response:
{
"result": "SUCCESS",
"return": [
"NETBILLING:112075379434 (219) was updated.",
"NATS:191 (237) was updated."
]
}
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'expire' => 'NEVER',
'memberid' => '191',
);
$url = 'http://domain/api/member/setexpiration';
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);
$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);
?>
Python
- This example requires pip and the request library which can be installed via pip by: 'pip install requests'
import requests
import json
url = 'http://domain/api/member/setexpiration'
payload = {
'expire': 'NEVER',
'memberid': 191
}
headers = {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'tmm1phrvezsbu'
}
res = requests.patch(url, data=payload, headers=headers)
print res.json()
node.js
- This example requires npm and the request module which can be installed via npm by: 'npm install request'
var request = require('request');
data = {
'expire': 'NEVER',
'memberid': 191
}
var options = {
url: 'http://domain/api/member/setexpiration',
method: 'PATCH',
form: data,
json: true,
headers: {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'tmm1phrvezsbu'
}
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
else{
console.log(body);
}
}
request(options, callback);
Curl
curl -X PATCH 'http://domain/api/member/setexpiration' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'expire=NEVER&memberid=191'
