Difference between revisions of "NATS4 REST API Set Member Details"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''PATCH /member/setdetails''' == '''Description''' *The /member/setdetails endpoint is a feature in NATS4 that allo...") |
|||
| Line 25: | Line 25: | ||
*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''' |
*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''''' | ||
| − | **optional | + | **'''optional''' |
*lastname is used to pass in the last name of the member | *lastname is used to pass in the last name of the member | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| − | **optional | + | **'''optional''' |
*email is used to pass in the email address of the member | *email is used to pass in the email address of the member | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| − | **optional | + | **'''optional''' |
*address1 is used to pass in the address of the member | *address1 is used to pass in the address of the member | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| − | **optional | + | **'''optional''' |
*address2 is used to pass in the address of the member | *address2 is used to pass in the address of the member | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| − | **optional | + | **'''optional''' |
*city is used to pass in the city of the member | *city is used to pass in the city of the member | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| − | **optional | + | **'''optional''' |
*state is used to pass in the state of the member | *state is used to pass in the state of the member | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| − | **optional | + | **'''optional''' |
*country is used to pass in the country of the member | *country is used to pass in the country of the member | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| − | **optional | + | **'''optional''' |
*zip is used to pass in the zip code of the member | *zip is used to pass in the zip code of the member | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| − | **optional | + | **'''optional''' |
*custom1 is used to pass in the custom1 field of the member | *custom1 is used to pass in the custom1 field of the member | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| − | **optional | + | **'''optional''' |
*custom2 is used to pass in the custom2 field of the member | *custom2 is used to pass in the custom2 field of the member | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| − | **optional | + | **'''optional''' |
*custom3 is used to pass in the custom3 field of the member | *custom3 is used to pass in the custom3 field of the member | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| − | **optional | + | **'''optional''' |
*custom4 is used to pass in the custom4 field of the member | *custom4 is used to pass in the custom4 field of the member | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| − | **optional | + | **'''optional''' |
*custom5 is used to pass in the custom5 field of the member | *custom5 is used to pass in the custom5 field of the member | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| − | **optional | + | **'''optional''' |
*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 | + | **'''optional''' |
| + | |||
| Line 97: | Line 98: | ||
); | ); | ||
| − | $url = 'http:// | + | $url = 'http://nats.tobias-dev.com/api/member/setdetails'; |
$headers = array( | $headers = array( | ||
| Line 123: | Line 124: | ||
import json | import json | ||
| − | url = 'http:// | + | url = 'http://nats.tobias-dev.com/api/member/setdetails' |
payload = { | payload = { | ||
| Line 155: | Line 156: | ||
var options = { | var options = { | ||
| − | url: 'http:// | + | url: 'http://nats.tobias-dev.com/api/member/setdetails', |
method: 'PATCH', | method: 'PATCH', | ||
form: data, | form: data, | ||
| Line 181: | Line 182: | ||
'''Curl''' | '''Curl''' | ||
<pre> | <pre> | ||
| − | curl -X PATCH 'http:// | + | curl -X PATCH 'http://nats.tobias-dev.com/api/member/setdetails' -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]] | ||
Revision as of 21:42, 15 March 2015
PATCH /member/setdetails
Description
- The /member/setdetails endpoint is a feature in NATS4 that allows you to set the member details for a NATS member.
Resource URL
- http://domain/api/v1/member/setdetails
- 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
- memberid is used to pass in the memberid of the member to modify
- type: string
- required
- 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
Example Request
PATCH
http://domain/api/v1/member/setdetails
- Response:
true
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'memberid' => 191,
'firstname' => 'Test',
'zip' => '66666'
);
$url = 'http://nats.tobias-dev.com/api/member/setdetails';
$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://nats.tobias-dev.com/api/member/setdetails'
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://nats.tobias-dev.com/api/member/setdetails',
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://nats.tobias-dev.com/api/member/setdetails' -H "api_key: 44b5498dbcb481a0d00b404c0169af62" -H "api_username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'memberid=191&firstname=Test&zip=66666'
