API field glossary
Understand the types and meanings of identity, pagination, editing and error fields.
Last updated:
On this page
Preserve field namesIdentity and scopeReading and paginationWriting and operation resultsError fieldsPreserve field names
Turkish API field names are stable throughout the version. The names below are JSON keys. Do not translate or alter a displayed interface label to construct a request field. Check the object path too: a field with the same name may have different meanings in different locations.
Identity and scope
| Field | Type | Meaning |
|---|---|---|
user.id |
Integer | User identifier of the key owner. |
user.org_id |
Integer | Organisation to which the user belongs. |
anahtar.id |
Integer | Identifier of the key record in use; not a secret. |
anahtar.ad |
String | Name used to distinguish the key. |
kapsam |
String array | oku, or oku and yaz; does not extend user permissions. |
proje_ids |
Integer array or null |
Selected projects; null means general scope restricted by current user access. An empty array grants no project access. |
bitis_at |
Date-time or null |
Key expiry instant, if specified. |
erisim |
String | Organisation or membership-based project access setting. |
Reading and pagination
| Field | Type | Meaning |
|---|---|---|
features |
Array | GeoJSON features. |
features[].id |
String | Feature identifier assigned by the server. |
geometry |
Object | GeoJSON geometry; WGS 84 in v1. |
properties |
Object | Feature attributes, including type and version. |
properties.type |
String | Technical key of the feature type. |
properties.v |
Integer | Record version of the map feature. |
items |
Array | Rows in a page of technical records or changes. |
next |
String, integer or null |
Identifier to send as after in the next request; its type depends on the endpoint contract. |
cursor |
Integer | Project change identifier captured before reading features. |
counts |
Object | Breakdown by type in project details: count n and length len. |
gizli |
Boolean | true when change details cannot be shown within the current module scope. |
before and after in a change row contain the old and new record bodies. The query parameter after is a pagination cursor; the same name has different meanings in these locations. Record bodies are absent when gizli: true.
Writing and operation results
| Field | Type | Meaning |
|---|---|---|
request_id |
String | Client operation identifier used to recognise a retry of the same work. |
ops |
Array | Edits to apply in order. |
op |
String | create, update or delete. |
entity |
String | Entity class of the operation, such as feature. |
version |
Integer | Last-read record version for an update or deletion. |
ok |
Boolean | true for a successful edit. Also check the HTTP status. |
batch |
String | Operation group identifier assigned by the server. |
ids |
Array | Identifiers from operation results. |
tmp |
Object | Maps client temporary identifiers to permanent identifiers. |
replayed |
Boolean | Indicates that a saved result was returned for the same operation; may be absent from the first response. |
uyarilar |
Array | Warnings to review for a record that was successfully written. |
Error fields
| Field | Type | Meaning |
|---|---|---|
detail |
String or array | Human-readable error description or validation details. |
kod |
String | Machine-readable error category; not every general rejection has a specific code. |
alan |
String, number or null |
Field or operation position associated with the error; depends on the endpoint rejection. |
Do not confuse a uyarilar array with an error envelope; it can be present in a successful edit. For additional endpoint-specific fields, see the v1 API reference; for rejections, see Error codes.