Difference between revisions of "NATS4 REST API Add Member Note"
From TMM Wiki
Jump to navigationJump to search| (5 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
| − | == '''POST /member/ | + | == '''POST /member/note''' == |
'''Description''' | '''Description''' | ||
*[[NATS4]] now supports an [[NATS4_API|API]] action that allows you to add member notes. This lets you insert a note for your members into [[NATS]] through an automated process by running code that calls the add member note API. This function will need to send all relevant data for a member note so NATS can add the note as you would through the NATS admin. | *[[NATS4]] now supports an [[NATS4_API|API]] action that allows you to add member notes. This lets you insert a note for your members into [[NATS]] through an automated process by running code that calls the add member note API. This function will need to send all relevant data for a member note so NATS can add the note as you would through the NATS admin. | ||
'''Resource URL''' | '''Resource URL''' | ||
| − | *<nowiki>http://domain/api | + | *<nowiki>http://domain/api/member/note</nowiki> |
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| Line 35: | Line 35: | ||
'''POST''' | '''POST''' | ||
| − | <nowiki>http://domain/api | + | <nowiki>http://domain/api/member/note</nowiki> |
*Response: | *Response: | ||
| Line 55: | Line 55: | ||
); | ); | ||
| − | $url = 'http://domain/api/member/ | + | $url = 'http://domain/api/member/note'; |
$headers = array( | $headers = array( | ||
| − | ' | + | 'api-key: 44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username: tmm1phrvezsbu' |
); | ); | ||
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); | curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); | ||
| Line 80: | Line 80: | ||
import json | import json | ||
| − | url = 'http://domain/api/member/ | + | url = 'http://domain/api/member/note' |
payload = { | payload = { | ||
| Line 89: | Line 89: | ||
headers = { | headers = { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
| Line 110: | Line 110: | ||
var options = { | var options = { | ||
| − | url: 'http://domain/api/member/ | + | url: 'http://domain/api/member/note', |
method: 'POST', | method: 'POST', | ||
form: data, | form: data, | ||
json: true, | json: true, | ||
headers: { | headers: { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
}; | }; | ||
| Line 137: | Line 137: | ||
'''Curl''' | '''Curl''' | ||
<pre> | <pre> | ||
| − | curl -X POST 'http://domain/api/member/ | + | curl -X POST 'http://domain/api/member/note' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'memberid=3¬e=hello+this+is+a+test' |
</pre> | </pre> | ||
[[Category:NATS4 API Articles]] | [[Category:NATS4 API Articles]] | ||
Latest revision as of 08:29, 21 October 2021
POST /member/note
Description
- NATS4 now supports an API action that allows you to add member notes. This lets you insert a note for your members into NATS through an automated process by running code that calls the add member note API. This function will need to send all relevant data for a member note so NATS can add the note as you would through the NATS admin.
Resource URL
- http://domain/api/member/note
- Replace domain with the nats domain
- POST
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: the memberid of the member you wish to add a note to
- type: integer
- required
- note: the note that you wish to add to your member
- type: string
- required
Example Request
POST
http://domain/api/member/note
- Response:
"Member Note Added"
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'memberid' => '3',
'note' => 'hello, this is a test',
);
$url = 'http://domain/api/member/note';
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
$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/note'
payload = {
'memberid': '3',
'note': 'hello, this is a test',
}
headers = {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'tmm1phrvezsbu'
}
res = requests.post(url, data=payload, headers=headers)
print res.text
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': '3',
'note': 'hello, this is a test',
}
var options = {
url: 'http://domain/api/member/note',
method: 'POST',
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 POST 'http://domain/api/member/note' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'memberid=3¬e=hello+this+is+a+test'
