Difference between revisions of "NATS4 REST API Set Member Details"
From TMM Wiki
Jump to navigationJump to search| (17 intermediate revisions by 6 users not shown) | |||
| Line 2: | Line 2: | ||
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
| − | == '''PATCH /member/ | + | == '''PATCH /member/details''' == |
'''Description''' | '''Description''' | ||
| − | *The /member/ | + | *The api/member/details action is a feature in [[NATS4]] that allows you to set the member details for a NATS member. |
'''Resource URL''' | '''Resource URL''' | ||
| − | *<nowiki>http://domain/api | + | *<nowiki>http://domain/api/member/details</nowiki> |
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| Line 20: | Line 20: | ||
== '''Parameters''' == | == '''Parameters''' == | ||
| − | ''' | + | '''Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded''' |
| − | Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded''' | + | |
| + | '''If you want to remove a field you can pass in the string REMOVE and the field will be removed. All additional parameters have this option other then 'password'.''' '''At least one optional parameter must be passed in.''' | ||
| − | |||
*memberid is used to pass in the memberid of the member to modify | *memberid is used to pass in the memberid of the member to modify | ||
**'''''type: string''''' | **'''''type: string''''' | ||
**'''required''' | **'''required''' | ||
| + | *memberidx is used to pass in the memberidx of the member subscription to modify | ||
| + | **'''''type: string''''' | ||
| + | **'''optional''' | ||
| + | *subscriptionid is used to pass in the NATS ID of the member subscription to modify | ||
| + | **'''''type: string''''' | ||
| + | **'''optional''' | ||
| + | *expire is used to set the subscription's expiration date. If set in the future, NATS will set the subscription to active | ||
| + | **'''''type: string''''' | ||
| + | **'''optional''' | ||
*firstname is used to pass in the first name of the member | *firstname is used to pass in the first name of the member | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| Line 72: | Line 81: | ||
*password is used to pass in the new password of the member | *password is used to pass in the new password of the member | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| + | **'''optional''' | ||
| + | *username is used to pass in the new username of the member | ||
| + | **'''''type: string''''' | ||
| + | **'''optional''' | ||
| + | *mailok is used to update the member's 'Allowed Mailing' flag | ||
| + | **'''''type: boolean''''' | ||
**'''optional''' | **'''optional''' | ||
| Line 78: | Line 93: | ||
'''PATCH''' | '''PATCH''' | ||
| − | <nowiki>http://domain/api | + | <nowiki>http://domain/api/member/details</nowiki> |
*Response: | *Response: | ||
| Line 98: | Line 113: | ||
); | ); | ||
| − | $url = 'http:// | + | $url = 'http://domain/api/member/details'; |
$headers = array( | $headers = array( | ||
| − | ' | + | 'api-key: 44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username: tmm1phrvezsbu' |
); | ); | ||
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH"); | curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH"); | ||
| Line 124: | Line 139: | ||
import json | import json | ||
| − | url = 'http:// | + | url = 'http://domain/api/member/details' |
payload = { | payload = { | ||
| Line 134: | Line 149: | ||
headers = { | headers = { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
| Line 156: | Line 171: | ||
var options = { | var options = { | ||
| − | url: 'http:// | + | url: 'http://domain/api/member/details', |
method: 'PATCH', | method: 'PATCH', | ||
form: data, | form: data, | ||
json: true, | json: true, | ||
headers: { | headers: { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
}; | }; | ||
| Line 182: | Line 197: | ||
'''Curl''' | '''Curl''' | ||
<pre> | <pre> | ||
| − | curl -X PATCH 'http:// | + | curl -X PATCH 'http://domain/api/member/details' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'memberid=191&firstname=Test&zip=66666' |
</pre> | </pre> | ||
[[Category:NATS4 API Articles]] | [[Category:NATS4 API Articles]] | ||
Latest revision as of 16:52, 17 December 2018
PATCH /member/details
Description
- The api/member/details action is a feature in NATS4 that allows you to set the member details for a NATS member.
Resource URL
- http://domain/api/member/details
- 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 you want to remove a field you can pass in the string REMOVE and the field will be removed. All additional parameters have this option other then 'password'. At least one optional parameter must be passed in.
- memberid is used to pass in the memberid of the member to modify
- type: string
- required
- memberidx is used to pass in the memberidx of the member subscription to modify
- type: string
- optional
- subscriptionid is used to pass in the NATS ID of the member subscription to modify
- type: string
- optional
- expire is used to set the subscription's expiration date. If set in the future, NATS will set the subscription to active
- type: string
- optional
- firstname is used to pass in the first name of the member
- type: string
- optional
- lastname is used to pass in the last name of the member
- type: string
- optional
- email is used to pass in the email address of the member
- type: string
- optional
- address1 is used to pass in the address of the member
- type: string
- optional
- address2 is used to pass in the address of the member
- type: string
- optional
- city is used to pass in the city of the member
- type: string
- optional
- state is used to pass in the state of the member
- type: string
- optional
- country is used to pass in the country of the member
- type: string
- optional
- zip is used to pass in the zip code of the member
- type: string
- optional
- custom1 is used to pass in the custom1 field of the member
- type: string
- optional
- custom2 is used to pass in the custom2 field of the member
- type: string
- optional
- custom3 is used to pass in the custom3 field of the member
- type: string
- optional
- custom4 is used to pass in the custom4 field of the member
- type: string
- optional
- custom5 is used to pass in the custom5 field of the member
- type: string
- optional
- password is used to pass in the new password of the member
- type: string
- optional
- username is used to pass in the new username of the member
- type: string
- optional
- mailok is used to update the member's 'Allowed Mailing' flag
- type: boolean
- optional
Example Request
PATCH
http://domain/api/member/details
- Response:
true
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'memberid' => 191,
'firstname' => 'Test',
'zip' => '66666'
);
$url = 'http://domain/api/member/details';
$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/details'
payload = {
'memberid': 191,
'firstname': 'Test',
'zip': '66666'
}
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': 191,
'firstname': 'Test',
'zip': '66666'
}
var options = {
url: 'http://domain/api/member/details',
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/details' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'memberid=191&firstname=Test&zip=66666'
