Api session event editor geotiff add url: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Add new [[GeoTIFF]] Item from Web URL.
API Endpoint: api/session/event/editorgeotiff/add_url/
 
Description: Add a new [[GeoTIFF]] from a Web URL
 
{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(String or multiple values in array ["a", "b", "c"])
| (String or multiple values in array ["a", "b", "c"])
|[[GeoTIFF]] Name
| [[GeoTIFF]] Names
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(String or multiple values in array ["a", "b", "c"])
| (String or multiple values in array ["a", "b", "c"])
|Web URL
| Web URLs
|
|  
|-
|-
|2
| 2
|REQUIRED
| REQUIRED
|(String or multiple values in array ["a", "b", "c"])
| (String or multiple values in array ["a", "b", "c"])
|Uploader
| Uploaders
|
|  
|-
|-
|3
| 3
|OPTIONAL
| OPTIONAL
|(String or multiple values in array ["a", "b", "c"])
| (String or multiple values in array ["a", "b", "c"])
|CRS Override (optional)
| Override CRSs
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 36: Line 39:
!Description
!Description
|-
|-
|200
| 200
|Integer[] (GeoTIFF IDs)
| Integer[] (GeoTIFF IDs)
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editorgeotiff/add_url/?f=HTML&token=API_TOKEN
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorgeotiff/add_url/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ "GeoTIFF Name 1", "Web URL 1", "Uploader 1" ]'
with content:
</syntaxhighlight>
<pre>[ [ "GeoTIFF Name 1", "GeoTIFF Name 2", "GeoTIFF Name 3" ], [ "Web URL 1", "Web URL 2", "Web URL 3" ], [ "Uploader 1", "Uploader 2", "Uploader 3" ], "" ]
Curl example multi item POST
</pre>
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorgeotiff/add_url/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ "GeoTIFF Name 1", "GeoTIFF Name 2", "GeoTIFF Name 3" ], [ "Web URL 1", "Web URL 2", "Web URL 3" ], [ "Uploader 1", "Uploader 2", "Uploader 3" ] ]'
{{article end|seealso=*[[api session event editor geotiff]]}}
</syntaxhighlight>
JavaScript example POST
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ "GeoTIFF Name 1", "Web URL 1", "Uploader 1" ]'
};
fetch("https://engine.tygron.com/api/session/event/editorgeotiff/add_url/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor geotiff]]
*[[Api session items geotiffs]]
}}


[[Category:API]]
[[Category:API]]

Latest revision as of 14:51, 11 November 2026

API Endpoint: api/session/event/editorgeotiff/add_url/

Description: Add a new GeoTIFF from a Web URL

Index Importance Type Description Values
0 REQUIRED (String or multiple values in array ["a", "b", "c"]) GeoTIFF Names
1 REQUIRED (String or multiple values in array ["a", "b", "c"]) Web URLs
2 REQUIRED (String or multiple values in array ["a", "b", "c"]) Uploaders
3 OPTIONAL (String or multiple values in array ["a", "b", "c"]) Override CRSs

Response Codes

Response Code: Description
200 Integer[] (GeoTIFF IDs)
300-600 Codes Overview

Example POST

Curl example POST

curl 'https://engine.tygron.com/api/session/event/editorgeotiff/add_url/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ "GeoTIFF Name 1", "Web URL 1", "Uploader 1" ]'

Curl example multi item POST

curl 'https://engine.tygron.com/api/session/event/editorgeotiff/add_url/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ "GeoTIFF Name 1", "GeoTIFF Name 2", "GeoTIFF Name 3" ], [ "Web URL 1", "Web URL 2", "Web URL 3" ], [ "Uploader 1", "Uploader 2", "Uploader 3" ] ]'

JavaScript example POST

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ "GeoTIFF Name 1", "Web URL 1", "Uploader 1" ]'
};
fetch("https://engine.tygron.com/api/session/event/editorgeotiff/add_url/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));