Update File Selection
Uri: https://api.finerworks.com/v3/update_file_selection
Method: PUT
Updates a list of a users current selected image files based on the selection key.
Body
Name | Description | Type | Additional information |
---|---|---|---|
guids |
A list of file guids that were selected. |
array (globally unique identifier) |
Required |
guid |
Master key (guid) assigned to all files that are selected. |
globally unique identifier |
Required |
Example JSON Body
application/json, text/json
{ "guids": [ "bfd38827-59fc-4da6-94ed-1043670f0226", "182c69d4-b25f-4609-bd4b-372ca1d71068" ], "guid": "38351461-1901-4b86-836a-f59424f0e2ab" }
Sample Code Library
curl --location --request sample_method 'https://api.finerworks.comsample_endpoint' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
"guids": [
"bfd38827-59fc-4da6-94ed-1043670f0226",
"182c69d4-b25f-4609-bd4b-372ca1d71068"
],
"guid": "38351461-1901-4b86-836a-f59424f0e2ab"
}'
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://api.finerworks.comsample_endpoint');
$request->setMethod(HTTP_Request2::METHOD_sample_method);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'web_api_key' => 'my-web-api-key-goes-here',
'app_key' => 'my-app-key-goes-here'
));
$request->setBody('{
'guids': [
'bfd38827-59fc-4da6-94ed-1043670f0226',
'182c69d4-b25f-4609-bd4b-372ca1d71068'
],
'guid': '38351461-1901-4b86-836a-f59424f0e2ab'
}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
var client = new RestClient("https://api.finerworks.comsample_endpoint");
client.Timeout = -1;
var request = new RestRequest(Method.sample_method);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("web_api_key", "my-web-api-key-goes-here");
request.AddHeader("app_key", "my-app-key-goes-here");
request.AddParameter("application/json", "{
'guids': [
'bfd38827-59fc-4da6-94ed-1043670f0226',
'182c69d4-b25f-4609-bd4b-372ca1d71068'
],
'guid': '38351461-1901-4b86-836a-f59424f0e2ab'
}, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
var settings = {
"url": "https://api.finerworks.comsample_endpoint",
"method": "sample_method",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"web_api_key": "my-web-api-key-goes-here",
"app_key": "my-app-key-goes-here"
},
"data": JSON.stringify({
'guids': [
'bfd38827-59fc-4da6-94ed-1043670f0226',
'182c69d4-b25f-4609-bd4b-372ca1d71068'
],
'guid': '38351461-1901-4b86-836a-f59424f0e2ab'
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var https = require('follow-redirects').https;
var fs = require('fs');
var options = {
'method': 'sample_method',
'hostname': 'api.finerworks.com',
'path': 'sample_endpoint',
'headers': {
'Content-Type': 'application/json',
'web_api_key': 'my-web-api-key-goes-here',
'app_key': 'my-app-key-goes-here'
},
'maxRedirects': 20
};
var req = https.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
var postData = JSON.stringify({
"guids": [
"bfd38827-59fc-4da6-94ed-1043670f0226",
"182c69d4-b25f-4609-bd4b-372ca1d71068"
],
"guid": "38351461-1901-4b86-836a-f59424f0e2ab"
});
req.write(postData);
req.end();
require "uri"
require "net/http"
url = URI("https://api.finerworks.comsample_endpoint")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::sample_method.new(url)
request["Content-Type"] = "application/json"
request["web_api_key"] = "my-web-api-key-goes-here"
request["app_key"] = "my-app-key-goes-here"
request.body = "{
'guids': [
'bfd38827-59fc-4da6-94ed-1043670f0226',
'182c69d4-b25f-4609-bd4b-372ca1d71068'
],
'guid': '38351461-1901-4b86-836a-f59424f0e2ab'
}"
response = https.request(request)
puts response.read_body
Name | Description | Type | Additional information |
---|---|---|---|
guids |
A list of file guids that were selected. |
array (globally unique identifier) |
Required |
status |
Response status details |
response_status |
None. |
Example JSON Response
application/json, text/json
{ "guids": [ "ac889b73-8474-48e7-9bac-5f8bf355ca90", "a7b2add2-e452-4728-be97-b718a2a8f344" ], "status": { "success": true, "status_code": 100, "message": "sample string 2", "debug": {} } }