Api event share set disclaimer

From Tygron Support wiki
Jump to navigation Jump to search

API Endpoint: api/event/share/set_disclaimer/

Description: Set disclaimer for given path.

Index Importance Type Description Values
0 REQUIRED (String or multiple values in array ["a", "b", "c"]) Path (e.g. "mydir/myname.tiff", note: viewers and directories end with a slash e.g. "mydir/viewer/")
1 REQUIRED (String or multiple values in array ["a", "b", "c"]) Disclaimer text

Response Codes

Response Code: Description
200 Boolean (Content was updated)
300-600 Codes Overview

Example POST

Curl example POST

curl 'https://devshare.tygron.com/api/event/share/set_disclaimer/' -H 'Content-Type: application/json' -H 'Authorization: Basic <credentials>' -d '[ "Path 1", "Disclaimer text 1" ]'

Curl example multi item POST

curl 'https://devshare.tygron.com/api/event/share/set_disclaimer/' -H 'Content-Type: application/json' -H 'Authorization: Basic <credentials>' -d '[ [ "Path 1", "Path 2", "Path 3" ], [ "Disclaimer text 1", "Disclaimer text 2", "Disclaimer text 3" ] ]'

JavaScript example POST

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Basic <credentials>" },
 body: '[ "Path 1", "Disclaimer text 1" ]'
};
fetch("https://devshare.tygron.com/api/event/share/set_disclaimer/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));

See also