Difference between revisions of "NATS4 REST API Expire Manual Member"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''PUT /member/expiremanual''' == '''Description''' *The /member/expiremanual endpoint allows you to expire manual membe...") |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
| − | == ''' | + | == '''PATCH /member/expiremanual''' == |
'''Description''' | '''Description''' | ||
| − | *The /member/expiremanual | + | *The /member/expiremanual action allows you to expire manual members. This lets you mark your Manually created members as expired in [[NATS]] through an automated process by running code that calls the expire manual member API. This function will need to send all relevant data for a manual member so NATS can expire the manual member as you would through the NATS admin. |
'''Resource URL''' | '''Resource URL''' | ||
| − | *<nowiki>http://domain/api | + | *<nowiki>http://domain/api/member/expiremanual</nowiki> |
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
'''[[NATS4_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] | '''[[NATS4_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] | ||
| − | * | + | *PATCH |
'''Response Format''' | '''Response Format''' | ||
| Line 24: | Line 24: | ||
*'''memberid''': The Memberid to be expired | *'''memberid''': The Memberid to be expired | ||
| − | + | **'''''type: int''''' | |
**'''optional ''' | **'''optional ''' | ||
*'''username''': The username of the member who should expire | *'''username''': The username of the member who should expire | ||
| − | + | **'''''type: string''''' | |
**'''optional ''' | **'''optional ''' | ||
*'''siteid''': The site id the member belongs to | *'''siteid''': The site id the member belongs to | ||
| − | + | **'''''type: int''''' | |
**'''optional ''' | **'''optional ''' | ||
| − | |||
== '''Example Request''' == | == '''Example Request''' == | ||
| − | ''' | + | '''PATCH''' |
| − | <nowiki>http://domain/api | + | <nowiki>http://domain/api/member/expiremanual</nowiki> |
*Response: | *Response: | ||
| Line 61: | Line 60: | ||
$headers = array( | $headers = array( | ||
| − | ' | + | 'api-key: 44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username: tmm1phrvezsbu' |
); | ); | ||
| − | curl_setopt($curl, CURLOPT_CUSTOMREQUEST, " | + | curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH"); |
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); | curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); | ||
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); | curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); | ||
| Line 91: | Line 90: | ||
headers = { | headers = { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
| − | res = requests. | + | res = requests.patch(url, data=payload, headers=headers) |
print res.json() | print res.json() | ||
| Line 112: | Line 111: | ||
var options = { | var options = { | ||
url: 'http://domain/api/member/expiremanual', | url: 'http://domain/api/member/expiremanual', | ||
| − | method: ' | + | method: 'PATCH', |
form: data, | form: data, | ||
json: true, | json: true, | ||
headers: { | headers: { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
}; | }; | ||
| Line 137: | Line 136: | ||
'''Curl''' | '''Curl''' | ||
<pre> | <pre> | ||
| − | curl -X | + | curl -X PATCH 'http://domain/api/member/expiremanual' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'memberid=162' |
</pre> | </pre> | ||
[[Category:NATS4 API Articles]] | [[Category:NATS4 API Articles]] | ||
Latest revision as of 13:24, 9 July 2019
PATCH /member/expiremanual
Description
- The /member/expiremanual action allows you to expire manual members. This lets you mark your Manually created members as expired in NATS through an automated process by running code that calls the expire manual member API. This function will need to send all relevant data for a manual member so NATS can expire the manual member as you would through the NATS admin.
Resource URL
- http://domain/api/member/expiremanual
- 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. If a memberid is entered, the member with this id will expire. Otherwise a username/site id must be supplied
- memberid: The Memberid to be expired
- type: int
- optional
- username: The username of the member who should expire
- type: string
- optional
- siteid: The site id the member belongs to
- type: int
- optional
Example Request
PATCH
http://domain/api/member/expiremanual
- Response:
"Expired member: 162"
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'memberid' => '162',
);
$url = 'http://domain/api/member/expiremanual';
$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/expiremanual'
payload = {
'memberid': '162',
}
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 = {
'memberid': '162',
}
var options = {
url: 'http://domain/api/member/expiremanual',
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/expiremanual' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'memberid=162'
