Api session event participant map buy land: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
API Endpoint: api/session/event/participant/map_buy_land/
API Endpoint: api/session/event/participant/map_buy_land/


Description: Buy the land defined by the [[Polygon]] for a given price.
Description: [[Stakeholder]] plans a land purchase with in the [[MultiPolygon]] for a given price.


{|class=wikitable
{|class=wikitable
Line 13: Line 13:
| REQUIRED
| REQUIRED
| (STAKEHOLDER Integer ID)
| (STAKEHOLDER Integer ID)
| [[Stakeholder]] ID
| [[Stakeholder]]
|  
|  
|-
|-
Line 19: Line 19:
| REQUIRED
| REQUIRED
| (MultiPolygon with crs: EPSG:3857)
| (MultiPolygon with crs: EPSG:3857)
| [[MultiPolygon]] describing the [[Area]] to be bought
| [[MultiPolygon]]
|  
|  
|-
|-
Line 45: Line 45:
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
  "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
}, 11 ]
}, 76 ]
'
'
</syntaxhighlight>
</syntaxhighlight>
Line 53: Line 53:
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
  "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
}, 44 ]
}, 86 ]
'
'
</syntaxhighlight>
</syntaxhighlight>
Line 60: Line 60:
 method: "POST",
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]}, 11 ]'
 body: '[ 1, { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]}, 76 ]'
};
};
fetch("https://engine.tygron.com/api/session/event/participant/map_buy_land/?crs=3857", options)
fetch("https://engine.tygron.com/api/session/event/participant/map_buy_land/?crs=3857", options)

Revision as of 15:33, 10 November 2026

API Endpoint: api/session/event/participant/map_buy_land/

Description: Stakeholder plans a land purchase with in the MultiPolygon for a given price.

Index Importance Type Description Values
0 REQUIRED (STAKEHOLDER Integer ID) Stakeholder
1 REQUIRED (MultiPolygon with crs: EPSG:3857) MultiPolygon
2 REQUIRED (Floating point number) Price per square meter

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/participant/map_buy_land/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
}, 76 ]
'

Curl example multi item POST

curl 'https://engine.tygron.com/api/session/event/participant/map_buy_land/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
}, 86 ]
'

JavaScript example POST

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]}, 76 ]'
};
fetch("https://engine.tygron.com/api/session/event/participant/map_buy_land/?crs=3857", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));