Api session query: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older editNewer edit →
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
44,939 edits
No edit summary
No edit summary
Line 1: Line 1:
API Endpoint: api/session/query/{query}
API Endpoint: api/session/query/


===GET {query}===
===GET {query}===
Line 40: Line 40:


===='''Examples====
===='''Examples====
'''SELECT_NAME_WHERE_CATEGORY_IS_STUDENT''':
'''SELECT_COLOR_WHERE_CATEGORY_IS_AGRICULTURE''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/query/SELECT_NAME_WHERE_CATEGORY_IS_STUDENT?crs=3857&f=JSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/query/SELECT_COLOR_WHERE_CATEGORY_IS_AGRICULTURE?crs=3857&f=JSON&token=API_TOKEN</syntaxhighlight>
 
'''SELECT_NAME_WHERE_CATEGORY_IS_AGRICULTURE''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/query/SELECT_NAME_WHERE_CATEGORY_IS_AGRICULTURE?crs=3857&f=JSON&token=API_TOKEN</syntaxhighlight>
 
'''SELECT_FLOORSIZE_WHERE_CATEGORY_IS_INDUSTRY_AND_MAP_IS_CURRENT''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/query/SELECT_FLOORSIZE_WHERE_CATEGORY_IS_INDUSTRY_AND_MAP_IS_CURRENT?crs=4326&f=JSON&token=API_TOKEN</syntaxhighlight>
 
'''SELECT_FLOORSIZE_WHERE_CATEGORY_IS_GARDEN_AND_MAP_IS_CURRENT''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/query/SELECT_FLOORSIZE_WHERE_CATEGORY_IS_GARDEN_AND_MAP_IS_CURRENT?crs=28992&f=JSON&token=API_TOKEN</syntaxhighlight>
 
'''SELECT_NAME_WHERE_CATEGORY_IS_UNDERGROUND''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/query/SELECT_NAME_WHERE_CATEGORY_IS_UNDERGROUND?crs=LOCAL&f=JSON&token=API_TOKEN</syntaxhighlight>
 
===POST query===
API Endpoint: api/session/query/
 
Content-Type: application/x-www-form-urlencoded
 
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| f
| Query
| [[Format]]
| JSON
|-
| crs
| Query
| String
| EPSG:3857
|}
 
===POST query===
API Endpoint: api/session/query/


'''SELECT_FLOORSIZE_WHERE_CATEGORY_IS_SENIOR_AND_MAP_IS_CURRENT''':
Content-Type: application/json
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/query/SELECT_FLOORSIZE_WHERE_CATEGORY_IS_SENIOR_AND_MAP_IS_CURRENT?crs=3857&f=JSON&token=API_TOKEN</syntaxhighlight>


'''SELECT_NAME_WHERE_CATEGORY_IS_AGRICULTURE''':
'''Parameters:'''
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/query/SELECT_NAME_WHERE_CATEGORY_IS_AGRICULTURE?crs=4326&f=JSON&token=API_TOKEN</syntaxhighlight>
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| f
| Query
| [[Format]]
| JSON
|-
| crs
| Query
| String
| EPSG:3857
|}
 
===='''Examples====
'''Curl example POST''':
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/query/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '"TQL Query 1"'
</syntaxhighlight>


'''SELECT_COLOR_WHERE_CATEGORY_IS_AGRICULTURE''':
'''Curl example multi item POST''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/query/SELECT_COLOR_WHERE_CATEGORY_IS_AGRICULTURE?crs=28992&f=JSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/query/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ "TQL Query 1", "TQL Query 2", "TQL Query 3" ]'
</syntaxhighlight>


'''SELECT_FLOORSIZE_WHERE_CATEGORY_IS_SOCIAL_AND_MAP_IS_MAQUETTE''':
'''JavaScript example POST''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/query/SELECT_FLOORSIZE_WHERE_CATEGORY_IS_SOCIAL_AND_MAP_IS_MAQUETTE?crs=LOCAL&f=JSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '"TQL Query 1"'
};
fetch("https://engine.tygron.com/api/session/query/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>


{{article end
{{article end

Revision as of 13:29, 19 June 2026

API Endpoint: api/session/query/

GET {query}

API Endpoint: api/session/query/{query}

Content-Type: application/json

Parameters:

Name Location Type Default value
query Path String
value Query String 0.0
f Query Format JSON
validate Query boolean false
crs Query String EPSG:3857

Examples

SELECT_COLOR_WHERE_CATEGORY_IS_AGRICULTURE: 

https://engine.tygron.com/api/session/query/SELECT_COLOR_WHERE_CATEGORY_IS_AGRICULTURE?crs=3857&f=JSON&token=API_TOKEN

SELECT_NAME_WHERE_CATEGORY_IS_AGRICULTURE: 

https://engine.tygron.com/api/session/query/SELECT_NAME_WHERE_CATEGORY_IS_AGRICULTURE?crs=3857&f=JSON&token=API_TOKEN

SELECT_FLOORSIZE_WHERE_CATEGORY_IS_INDUSTRY_AND_MAP_IS_CURRENT: 

https://engine.tygron.com/api/session/query/SELECT_FLOORSIZE_WHERE_CATEGORY_IS_INDUSTRY_AND_MAP_IS_CURRENT?crs=4326&f=JSON&token=API_TOKEN

SELECT_FLOORSIZE_WHERE_CATEGORY_IS_GARDEN_AND_MAP_IS_CURRENT: 

https://engine.tygron.com/api/session/query/SELECT_FLOORSIZE_WHERE_CATEGORY_IS_GARDEN_AND_MAP_IS_CURRENT?crs=28992&f=JSON&token=API_TOKEN

SELECT_NAME_WHERE_CATEGORY_IS_UNDERGROUND: 

https://engine.tygron.com/api/session/query/SELECT_NAME_WHERE_CATEGORY_IS_UNDERGROUND?crs=LOCAL&f=JSON&token=API_TOKEN

POST query

API Endpoint: api/session/query/

Content-Type: application/x-www-form-urlencoded

Parameters:

Name Location Type Default value
f Query Format JSON
crs Query String EPSG:3857

POST query

API Endpoint: api/session/query/

Content-Type: application/json

Parameters:

Name Location Type Default value
f Query Format JSON
crs Query String EPSG:3857

Examples

Curl example POST: 

curl 'https://engine.tygron.com/api/session/query/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '"TQL Query 1"'

Curl example multi item POST: 

curl 'https://engine.tygron.com/api/session/query/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ "TQL Query 1", "TQL Query 2", "TQL Query 3" ]'

JavaScript example POST: 

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '"TQL Query 1"'
};
fetch("https://engine.tygron.com/api/session/query/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_query&oldid=87444"