Difference between revisions of "NATS4 REST API Forget Member"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} =For NATS 4.1.19.1+= == '''PATCH /member/forget''' == '''Description''' *The /member/forget action is a feature in NATS4...") |
|||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 2: | Line 2: | ||
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
| + | |||
=For NATS 4.1.19.1+= | =For NATS 4.1.19.1+= | ||
== '''PATCH /member/forget''' == | == '''PATCH /member/forget''' == | ||
'''Description''' | '''Description''' | ||
| − | *The /member/forget action is a feature in [[NATS4]] that allows you to . | + | *The /member/forget action is a feature in [[NATS4]] that allows you to remove personal data from a member record. |
| + | *Please be aware that changing username and password may affect member authentication. | ||
| + | *NATS has no mechanism to 'reverse' forgetting a member. | ||
'''Resource URL''' | '''Resource URL''' | ||
| Line 31: | Line 34: | ||
**'''''type: string''''' | **'''''type: string''''' | ||
**'''optional''' | **'''optional''' | ||
| − | **'''''possible | + | **'''''possible value names:''''' |
***username | ***username | ||
***email | ***email | ||
| Line 56: | Line 59: | ||
***shipping_country | ***shipping_country | ||
***phone | ***phone | ||
| − | **'''''possible table names:''''' | + | **'''''possible table names to keep data:''''' |
***member_auth | ***member_auth | ||
***member_note | ***member_note | ||
| + | ***member_openid_access_token | ||
| + | ***member_openid_auth_token | ||
***member_temp | ***member_temp | ||
***live_member_loginlog | ***live_member_loginlog | ||
Latest revision as of 10:48, 12 October 2020
For NATS 4.1.19.1+
PATCH /member/forget
Description
- The /member/forget action is a feature in NATS4 that allows you to remove personal data from a member record.
- Please be aware that changing username and password may affect member authentication.
- NATS has no mechanism to 'reverse' forgetting a member.
Resource URL
- https://domain/api/member/forget
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded
- memberid: - ID of the member record to forget
- type: integer
- required
- keep: - Comma separated list of fields to preserve
- type: string
- optional
- possible value names:
- username
- token_hash
- original_username
- password
- cryptpass
- session
- firstname
- lastname
- address1
- address2
- city
- state
- zip
- country
- shipping_firstname
- shipping_lastname
- shipping_address1
- shipping_address2
- shipping_zip
- shipping_city
- shipping_state
- shipping_country
- phone
- possible table names to keep data:
- member_auth
- member_note
- member_openid_access_token
- member_openid_auth_token
- member_temp
- live_member_loginlog
- historical_member_loginlog
- member_autocascade
- member_verification_atvod
- live_surfer_action
- historical_surfer_action
- member_autocascade_nextra
- EpochTransStats
- MemberCancelStats
- payze_event
- payze_transaction
Example Request
PATCH
https://domain/api/member/forget
- Response:
{
"result": true,
}
Example Code
PHP
<?php $curl = curl_init(); $data = array( 'memberid' => '39', 'keep' => 'email,session' ); $url = 'https://domain/api/member/forget'; $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 = 'https://domain/api/member/forget'
payload = {
'memberid': 39,
'keep': 'email,session'
}
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': 39,
'keep': 'email,session'
}
var options = {
url: 'https://domain/api/member/forget',
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 'https://domain/api/member/forget' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'memberid=39&keep=email,session'
