Api session event editor address set point: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(27 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Set the point of an address
API Endpoint: api/session/event/editoraddress/set_point/
 
Description: Set the [[Point]] of an [[Address]]
 
{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(ADDRESSE Integer ID or multiple values in array [1, 2, 3])
| (ADDRESSE Integer ID or multiple integer values in array [1, 2, 3])
|Address ID
| [[Address]] ID
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(Point with crs: EPSG:3857 or multiple values in array [a, b, c])
| (Point with crs: EPSG:3857 or multiple values in array [a, b, c])
|Point
| [[Point]]
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 24: Line 27:
!Description
!Description
|-
|-
|204
| 204
|No Content
| No Content
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Example POST: https://power.tygron.com/api/session/event/editoraddress/set_point/?crs=3857&f=HTML&token=API_TOKEN
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoraddress/set_point/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
with content:  
[ 1, {
<pre>[ [ 1, 2, 3 ], [ {
"type" : "Point",
"coordinates" : [ 658793.9554875104, 6799417.057431265 ]
} ]
'
</syntaxhighlight>
Curl example multi item POST
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoraddress/set_point/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ [ 1, 2, 3 ], [ {
  "type" : "Point",
  "type" : "Point",
  "coordinates" : [ 657430.5588004664, 6801277.179050349 ]
  "coordinates" : [ 658727.4617316923, 6799332.031576055 ]
}, {
}, {
  "type" : "Point",
  "type" : "Point",
  "coordinates" : [ 657461.1305738769, 6801325.512954953 ]
  "coordinates" : [ 658792.0617448251, 6799455.583441816 ]
}, {
}, {
  "type" : "Point",
  "type" : "Point",
  "coordinates" : [ 657495.658044628, 6801215.024279368 ]
  "coordinates" : [ 658681.5717663605, 6799307.559523016 ]
} ] ]
} ] ]
</pre>
'
{{article end|seealso=*[[api session event editor address]]}}
</syntaxhighlight>
JavaScript example POST
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, { "type" : "Point", "coordinates" : [ 658793.9554875104, 6799417.057431265 ]} ]'
};
fetch("https://engine.tygron.com/api/session/event/editoraddress/set_point/?crs=3857", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor address]]
*[[Api session items addresses]]
}}


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

Latest revision as of 13:00, 19 June 2026

API Endpoint: api/session/event/editoraddress/set_point/

Description: Set the Point of an Address

Index Importance Type Description Values
0 REQUIRED (ADDRESSE Integer ID or multiple integer values in array [1, 2, 3]) Address ID
1 REQUIRED (Point with crs: EPSG:3857 or multiple values in array [a, b, c]) Point

Response Codes

Response Code: Description
204 No Content
300-600 Codes Overview

Example POST

Curl example POST

curl 'https://engine.tygron.com/api/session/event/editoraddress/set_point/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, {
 "type" : "Point",
 "coordinates" : [ 658793.9554875104, 6799417.057431265 ]
} ]
'

Curl example multi item POST

curl 'https://engine.tygron.com/api/session/event/editoraddress/set_point/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ [ 1, 2, 3 ], [ {
 "type" : "Point",
 "coordinates" : [ 658727.4617316923, 6799332.031576055 ]
}, {
 "type" : "Point",
 "coordinates" : [ 658792.0617448251, 6799455.583441816 ]
}, {
 "type" : "Point",
 "coordinates" : [ 658681.5717663605, 6799307.559523016 ]
} ] ]
'

JavaScript example POST

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, { "type" : "Point", "coordinates" : [ 658793.9554875104, 6799417.057431265 ]} ]'
};
fetch("https://engine.tygron.com/api/session/event/editoraddress/set_point/?crs=3857", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));