Use this method to update an existing review record.
PUT https://gambio-shop.de/shop1/api.php/v2/reviews/{review_id}
Parameter name | Value | Description | Additional |
---|---|---|---|
review_id | int64 | The review ID |
Required |
Read-only parameters such as a resource's ID field are to be omitted.
The request body takes a GXReview resource, containing the following writable properties:
{
"customer": {
"customerId": 1,
"customerName": "Ester Tester"
},
"dateAdded": "2016-01-03 12:07:30",
"languageId": 2,
"lastModified": "2016-05-18 15:20:03",
"productId": 4,
"rating": 5,
"readCount": 8,
"text": "This is an example review text!"
}
{
"customer": {
"customerName": "string"
},
"dateAdded": "string",
"languageId": "int64",
"lastModified": "string",
"productid": "int64",
"rating": "int64",
"readCount": "int64",
"text": "string"
}
Name | Type | Description | Additional |
---|---|---|---|
customer | object | GXReviewCustomer | Required |
customer.customerName | string | Required | |
dateAdded | string | Required | |
languageId | int64 | Required | |
lastModified | string | Required | |
productid | int64 | Optional | |
rating | int64 | Required | |
readCount | int64 | Required | |
text | string | Required |
In order to provide the authentication, you must insert the Basic Auth inside the HTTP header. The Basic Auth
is an encrypted base64 string that holds the following content: admin@example.org:12345
where the structure is
as follows: username:password
.
An example header would look as follows:
Authorization: Basic YWRtaW5Ac2hvcC5kZToxMjM0NQ==
This request requires the use of one of following authorisation methods:
BASIC
.
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
201 | Created Upon success, returns the updated review |
GXReview |
400 | Bad Request (Empty request body / Review record ID was not provided or is invalid) |
defaultErrorResponse |
Here are some example implementations for this operation.
MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"id\":0,\"productid\":0,\"rating\":0,\"readCount\":0,\"dateAdded\":\"\",\"lastModified\":\"\",\"languageId\":0,\"text\":\"\",\"customer\":{\"customerId\":0,\"customerName\":\"\"}}"); Request request = new Request.Builder() .url("https://gambio-shop.de/shop1/api.php/v2/reviews/{review_id}") .put(body) .addHeader("accept", "application/json") .addHeader("content-type", "application/json") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build();
Response response = client.newCall(request).execute();
const options = { "method": "PUT", "hostname": "gambio-shop.de", "port": null, "path": "/shop1/api.php/v2/reviews/{review_id}", "headers": {
"accept": "application/json",
"content-type": "application/json",
"Authorization": "Basic REPLACE_BASIC_AUTH"
} };
const req = http.request(options, function (res) { const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
}); });
req.write(JSON.stringify({ id: 0, productid: 0, rating: 0, readCount: 0, dateAdded: '', lastModified: '', languageId: 0, text: '', customer: {customerId: 0, customerName: ''} })); req.end();
const options = { method: 'PUT', url: 'https://gambio-shop.de/shop1/api.php/v2/reviews/{review_id}', headers: {
accept: 'application/json',
'content-type': 'application/json',
Authorization: 'Basic REPLACE_BASIC_AUTH'
}, body: {
id: 0,
productid: 0,
rating: 0,
readCount: 0,
dateAdded: '<ADD STRING VALUE>',
lastModified: '<ADD STRING VALUE>',
languageId: 0,
text: '<ADD STRING VALUE>',
customer: {customerId: 0, customerName: '<ADD STRING VALUE>'}
}, json: true };
request(options, function (error, response, body) { if (error) throw new Error(error);
console.log(body); });
const req = unirest("PUT", "https://gambio-shop.de/shop1/api.php/v2/reviews/{review_id}");
req.headers({ "accept": "application/json", "content-type": "application/json", "Authorization": "Basic REPLACE_BASIC_AUTH" });
req.type("json"); req.send({ "id": 0, "productid": 0, "rating": 0, "readCount": 0, "dateAdded": "", "lastModified": "", "languageId": 0, "text": "", "customer": {
"customerId": 0,
"customerName": "<ADD STRING VALUE>"
} });
req.end(function (res) { if (res.error) throw new Error(res.error);
console.log(res.body); });
"customerId": 0,
"customerName": "<ADD STRING VALUE>"
} });
const xhr = new XMLHttpRequest(); xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () { if (this.readyState === this.DONE) {
console.log(this.responseText);
} });
xhr.open("PUT", "https://gambio-shop.de/shop1/api.php/v2/reviews/{review_id}"); xhr.setRequestHeader("accept", "application/json"); xhr.setRequestHeader("content-type", "application/json"); xhr.setRequestHeader("Authorization", "Basic REPLACE_BASIC_AUTH");
xhr.send(data);
"accept": "application/json",
"content-type": "application/json",
"Authorization": "Basic REPLACE_BASIC_AUTH"
}, "processData": false, "data": "{\"id\":0,\"productid\":0,\"rating\":0,\"readCount\":0,\"dateAdded\":\"\",\"lastModified\":\"\",\"languageId\":0,\"text\":\"\",\"customer\":{\"customerId\":0,\"customerName\":\"\"}}" };
$.ajax(settings).done(function (response) { console.log(response); });
$curl = curl_init();
curl_setopt_array($curl, [ CURLOPT_URL => "https://gambio-shop.de/shop1/api.php/v2/reviews/{review_id}", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"id\":0,\"productid\":0,\"rating\":0,\"readCount\":0,\"dateAdded\":\"\",\"lastModified\":\"\",\"languageId\":0,\"text\":\"\",\"customer\":{\"customerId\":0,\"customerName\":\"\"}}", CURLOPT_HTTPHEADER => [
"Authorization: Basic REPLACE_BASIC_AUTH",
"accept: application/json",
"content-type: application/json"
], ]);
$response = curl_exec($curl); $err = curl_error($curl);
curl_close($curl);
if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
$request = new HttpRequest(); $request->setUrl('https://gambio-shop.de/shop1/api.php/v2/reviews/{review_id}'); $request->setMethod(HTTP_METH_PUT);
$request->setHeaders([ 'accept' => 'application/json', 'content-type' => 'application/json', 'Authorization' => 'Basic REPLACE_BASIC_AUTH' ]);
$request->setBody('{"id":0,"productid":0,"rating":0,"readCount":0,"dateAdded":"","lastModified":"","languageId":0,"text":"","customer":{"customerId":0,"customerName":""}}');
try { $response = $request->send();
echo $response->getBody(); } catch (HttpException $ex) { echo $ex; }
$client = new http\Client; $request = new http\Client\Request;
$body = new http\Message\Body; $body->append('{"id":0,"productid":0,"rating":0,"readCount":0,"dateAdded":"","lastModified":"","languageId":0,"text":"","customer":{"customerId":0,"customerName":""}}');
$request->setRequestUrl('https://gambio-shop.de/shop1/api.php/v2/reviews/{review_id}'); $request->setRequestMethod('PUT'); $request->setBody($body);
$request->setHeaders([ 'accept' => 'application/json', 'content-type' => 'application/json', 'Authorization' => 'Basic REPLACE_BASIC_AUTH' ]);
$client->enqueue($request)->send(); $response = $client->getResponse();
echo $response->getBody();
conn = http.client.HTTPSConnection("gambio-shop.de")
payload = "{\"id\":0,\"productid\":0,\"rating\":0,\"readCount\":0,\"dateAdded\":\"\",\"lastModified\":\"\",\"languageId\":0,\"text\":\"\",\"customer\":{\"customerId\":0,\"customerName\":\"\"}}"
headers = {
'accept': "application/json",
'content-type': "application/json",
'Authorization': "Basic REPLACE_BASIC_AUTH"
}
conn.request("PUT", "/shop1/api.php/v2/reviews/{review_id}", payload, headers)
res = conn.getresponse() data = res.read()
print(data.decode("utf-8"))
url = "https://gambio-shop.de/shop1/api.php/v2/reviews/{review_id}"
payload = {
"id": 0,
"productid": 0,
"rating": 0,
"readCount": 0,
"dateAdded": "<ADD STRING VALUE>",
"lastModified": "<ADD STRING VALUE>",
"languageId": 0,
"text": "<ADD STRING VALUE>",
"customer": {
"customerId": 0,
"customerName": "<ADD STRING VALUE>"
}
} headers = {
"accept": "application/json",
"content-type": "application/json",
"Authorization": "Basic REPLACE_BASIC_AUTH"
}
response = requests.request("PUT", url, json=payload, headers=headers)
print(response.text)
url = URI("https://gambio-shop.de/shop1/api.php/v2/reviews/{review_id}")
http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Put.new(url) request["accept"] = 'application/json' request["content-type"] = 'application/json' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"id\":0,\"productid\":0,\"rating\":0,\"readCount\":0,\"dateAdded\":\"\",\"lastModified\":\"\",\"languageId\":0,\"text\":\"\",\"customer\":{\"customerId\":0,\"customerName\":\"\"}}"
response = http.request(request) puts response.read_body
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT"); curl_easy_setopt(hnd, CURLOPT_URL, "https://gambio-shop.de/shop1/api.php/v2/reviews/{review_id}");
struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "accept: application/json"); headers = curl_slist_append(headers, "content-type: application/json"); headers = curl_slist_append(headers, "Authorization: Basic REPLACE_BASIC_AUTH"); curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"id\":0,\"productid\":0,\"rating\":0,\"readCount\":0,\"dateAdded\":\"\",\"lastModified\":\"\",\"languageId\":0,\"text\":\"\",\"customer\":{\"customerId\":0,\"customerName\":\"\"}}");
CURLcode ret = curl_easy_perform(hnd);
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://gambio-shop.de/shop1/api.php/v2/reviews/{review_id}"
payload := strings.NewReader("{\"id\":0,\"productid\":0,\"rating\":0,\"readCount\":0,\"dateAdded\":\"<ADD STRING VALUE>\",\"lastModified\":\"<ADD STRING VALUE>\",\"languageId\":0,\"text\":\"<ADD STRING VALUE>\",\"customer\":{\"customerId\":0,\"customerName\":\"<ADD STRING VALUE>\"}}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("accept", "application/json")
req.Header.Add("content-type", "application/json")
req.Header.Add("Authorization", "Basic REPLACE_BASIC_AUTH")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
NSDictionary *headers = @{ @"accept": @"application/json",
@"content-type": @"application/json",
@"Authorization": @"Basic REPLACE_BASIC_AUTH" };
NSDictionary *parameters = @{ @"id": @0,
@"productid": @0,
@"rating": @0,
@"readCount": @0,
@"dateAdded": @"<ADD STRING VALUE>",
@"lastModified": @"<ADD STRING VALUE>",
@"languageId": @0,
@"text": @"<ADD STRING VALUE>",
@"customer": @{ @"customerId": @0, @"customerName": @"<ADD STRING VALUE>" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://gambio-shop.de/shop1/api.php/v2/reviews/{review_id}"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"]; [request setAllHTTPHeaderFields:headers]; [request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession]; NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
let headers = [ "accept": "application/json", "content-type": "application/json", "Authorization": "Basic REPLACE_BASIC_AUTH" ] let parameters = [ "id": 0, "productid": 0, "rating": 0, "readCount": 0, "dateAdded": "", "lastModified": "", "languageId": 0, "text": "", "customer": [
"customerId": 0,
"customerName": "<ADD STRING VALUE>"
] ] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "https://gambio-shop.de/shop1/api.php/v2/reviews/{review_id}")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT" request.allHTTPHeaderFields = headers request.httpBody = postData as Data
let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) {
print(error)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
} })
dataTask.resume()
let uri = Uri.of_string "https://gambio-shop.de/shop1/api.php/v2/reviews/{review_id}" in let headers = Header.add_list (Header.init ()) [ ("accept", "application/json"); ("content-type", "application/json"); ("Authorization", "Basic REPLACE_BASIC_AUTH"); ] in let body = Cohttp_lwt_body.of_string "{\"id\":0,\"productid\":0,\"rating\":0,\"readCount\":0,\"dateAdded\":\"\",\"lastModified\":\"\",\"languageId\":0,\"text\":\"\",\"customer\":{\"customerId\":0,\"customerName\":\"\"}}" in
Client.call ~headers ~body `PUT uri
= fun (res, body_stream) -> (* Do stuff with the result *)