NATS4 REST API Edit Option Text
From TMM Wiki
Revision as of 19:09, 26 March 2015 by Tmmtobias0185 (talk | contribs)
PUT /option/edittext
Description
- The /option/edittext endpoint allows you to edit option text for your NATS join options using an API call.
Resource URL
- http://domain/api/v1/option/edittext
- Replace domain with the nats domain
- PUT
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/v1/option/edittext
- Response:
{
"result": "TRUE"
}
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'optionid' => 12,
'text' => 'This is a test',
);
$url = 'http://domain/api/option/edittext';
$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/edittext'
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/edittext',
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/edittext -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'optionid=12&text=This+is+a+test'
