Generating a Geodi Token is needed.
(!) QueryHandler.GetKeywords is a simplified service. With the geyKeywords api, you can take advantage of more features.
GetKeywords |
---|
Definition | Searches in documents in the Workspace and searched words. |
---|
Request | [GEODIURL]/QueryHandler?op=GetKeywords&wsName=[WSNAME]&q=[SearchString]&startIndex=[StartIndex]&endIndex=[EndIndex]&options=[OptionsJSON]&UserSession=[TOKEN] - wsName(string): Name of the workspace to search inside
- q(string): Query text
- StartIndex(int - Optional): The Index which the query results will start.(limit 0)
- EndIndex(int - Optional): The Index which the query results will end.(limit 0)
- options(Opsiyonel): Additional parameters to change the query result
- ContentIDFilter(int[] - Optional): Filters the content from which to query.
- Envelope([LonMin(int),LatMin(int),LonMax(int),LatMax(int)] - Optional): Returns the words within the boundaries of the given BBOX geometry.
- LayerIdFilter(int[] - Optional): Filters the words according to the IDs of the recognizers that recognize these words.
- KeywordIdFilter(int[] - Optional): Filters words by IDs
- CalculateCounts(true/false - Optional): If true, the NumberOfOccurences field is calculated in the result returned from the query.
- GetRelatedKeywords(true/false - Optional): If true, it returns related keywords information in the results returned from the query. True by default
|
---|
HttpMethod | GET, POST |
---|
Expected Errors | 401 Unauthorized access / Access denied 403 Forbidden 511 Network Authentication Required 501 Server Error |
---|
Returning Value |
[
{
"KeywordID": 1,
"Keyword": "",
"Keyword_Extra": "",
"RecognizerID": 0,
"NumberOfOccurences": 1,
"GeoType": 0
}
]
KeywordID: Keyword's ID - Keyword: Keyword text
- Keyword_Extra: Keyword extra info
- RecognizerID: The ID of the identifier that found the keyword, if any.
- NumberOfOccurences: Number of occurrences of the keyword
- GeoType: The value returned by the geometry type of the word found. Value provisions are as follows:
- 0: Unknown
- 1: NonSpatial
- 2: Point
- 4: LineString
- 8: Polygon
- 16: MultiPoint
- 32: MultiLineString
- 64: MultiPolygon
- 128: GeometryCollection
- 254: AllSpatial
|
---|
Examples |
[GEODIURL]/QueryHandler?op=GetKeywords&wsName=PROJE&q=ankara&startIndex=0&endIndex=1
[
{
"KeywordID": 1,
"Keyword": "Ankara",
"Keyword_Extra": "",
"RecognizerID": -987,
"GeoType": 1
}
]
[GEODIURL]/QueryHandler?op=GetKeywords&wsName=PROJE&q=ankara&startIndex=0&endIndex=3&options={"LayerIDFilter":[-456]}
[
{
"KeywordID": 2,
"Keyword": "Ankara",
"Keyword_Extra": "",
"RecognizerID": -456,
"GeoType": 1
},
{
"KeywordID": 3,
"Keyword": "Ankara",
"Keyword_Extra": "",
"RecognizerID": -456,
"GeoType": 1
}, {
"KeywordID": 4,
"Keyword": "Ankara",
"Keyword_Extra": "",
"RecognizerID": -456,
"GeoType": 1
}
]
|
---|
Example Applications
| |
---|