Difference between revisions of "NATS4 REST API Edit Option Text"
From TMM Wiki
Jump to navigationJump to searchTmm vincent (talk | contribs) (Correcting Resource URL & HTTP method) |
|||
| Line 2: | Line 2: | ||
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
| − | == '''PUT /option/ | + | == '''PUT /option/text''' == |
'''Description''' | '''Description''' | ||
| − | *The /option/ | + | *The /option/text endpoint allows you to edit option text for your NATS join options using an API call. |
'''Resource URL''' | '''Resource URL''' | ||
| − | *<nowiki>http://domain/api/option/ | + | *<nowiki>http://domain/api/option/text</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 35: | Line 35: | ||
'''PUT''' | '''PUT''' | ||
| − | <nowiki>http://domain/api/option/ | + | <nowiki>http://domain/api/option/text</nowiki> |
*Response: | *Response: | ||
| Line 56: | Line 56: | ||
); | ); | ||
| − | $url = 'http://domain/api/option/ | + | $url = 'http://domain/api/option/text'; |
$headers = array( | $headers = array( | ||
| Line 82: | Line 82: | ||
import json | import json | ||
| − | url = 'http://domain/api/option/ | + | url = 'http://domain/api/option/text' |
payload = { | payload = { | ||
| Line 111: | Line 111: | ||
var options = { | var options = { | ||
| − | url: 'http://domain/api/option/ | + | url: 'http://domain/api/option/text', |
method: 'PUT', | method: 'PUT', | ||
form: data, | form: data, | ||
| Line 137: | Line 137: | ||
'''Curl''' | '''Curl''' | ||
<pre> | <pre> | ||
| − | curl -X PUT 'http://domain/api/option/ | + | curl -X PUT 'http://domain/api/option/text -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'optionid=12&text=This+is+a+test' |
</pre> | </pre> | ||
[[Category:NATS4 API Articles]] | [[Category:NATS4 API Articles]] | ||
Latest revision as of 22:55, 8 December 2017
PUT /option/text
Description
- The /option/text endpoint allows you to edit option text for your NATS join options using an API call.
Resource URL
- http://domain/api/option/text
- 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.
- optionid: The option id to edit
- type: int
- required
- text: The new option text
- type: string
- required
Example Request
PUT
http://domain/api/option/text
- Response:
{
"result": "TRUE"
}
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'optionid' => 12,
'text' => 'This is a test',
);
$url = 'http://domain/api/option/text';
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PUT");
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/option/text'
payload = {
'optionid': 12,
'text': 'This is a test'
}
headers = {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'tmm1phrvezsbu'
}
res = requests.put(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 = {
'optionid': 12,
'text': 'This is a test'
}
var options = {
url: 'http://domain/api/option/text',
method: 'PUT',
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 PUT 'http://domain/api/option/text -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'optionid=12&text=This+is+a+test'
