APIs

APIs

Register Field Boundary POST

url: <baseUrl>/register-field-boundary

Register a field boundary (polygon) against a Geo Id

• Headers:

Content-Type > application/json

• Request:

JSON body

{"wkt": "POLYGON ((74.39001566644771 31.48473814269933,74.38997275110347 31.484006193481502,74.39048773523433 31.484115986229234,74.39001566644771 31.48473814269933))" }

Polygon is defined using a Well Known Text (wkt) string

• Response:

{ "GEO ID": "25686161443f925abc76093b143b4806352fdf9b4181e4d26f149b9319ebe982", "Message": "Field Boundary registered successfully.", "S2 Cell Tokens": "{\"8\": [\"39191\"], \"13\": [\"391905e4\"], \"15\": [\"391905e3c\"], \"18\": [\"391905e385\", \"391905e38f\", \"391905e391\", \"391905e397\", \"391905e399\", \"391905e39b\"], \"19\": [\"391905e384c\", \"391905e3854\", \"391905e38e4\", \"391905e38fc\", \"391905e3904\", \"391905e390c\", \"391905e3914\", \"391905e391c\", \"391905e3964\", \"391905e396c\", \"391905e3974\", \"391905e397c\", \"391905e3984\", \"391905e398c\", \"391905e3994\", \"391905e399c\", \"391905e39a4\", \"391905e39ac\", \"391905e39b4\", \"391905e39bc\"], \"20\": [\"391905e384d\", \"391905e384f\", \"391905e3851\", \"391905e3853\", \"391905e3855\", \"391905e3857\", \"391905e38e1\", \"391905e38e3\", \"391905e38e5\", \"391905e38e7\", \"391905e38f9\", \"391905e38fb\", \"391905e38fd\", \"391905e38ff\", \"391905e3901\", \"391905e3903\", \"391905e3905\", \"391905e3907\", \"391905e3909\", \"391905e390b\", \"391905e390d\", \"391905e390f\", \"391905e3911\", \"391905e3913\", \"391905e3915\", \"391905e3917\", \"391905e3919\", \"391905e391b\", \"391905e391d\", \"391905e391f\", \"391905e3965\", \"391905e3967\", \"391905e3969\", \"391905e396b\", \"391905e396d\", \"391905e396f\", \"391905e3971\", \"391905e3973\", \"391905e3975\", \"391905e3977\", \"391905e3979\", \"391905e397b\", \"391905e397d\", \"391905e397f\", \"391905e3981\", \"391905e3983\", \"391905e3985\", \"391905e3987\", \"391905e3989\", \"391905e398f\", \"391905e3991\", \"391905e3997\", \"391905e3999\", \"391905e399b\", \"391905e399d\", \"391905e399f\", \"391905e39a1\", \"391905e39a3\", \"391905e39a5\", \"391905e39a7\", \"391905e39a9\", \"391905e39ab\", \"391905e39ad\", \"391905e39af\", \"391905e39b1\", \"391905e39b3\", \"391905e39bb\", \"391905e39bd\"]}" }

Tokens: JSON string, with key as S2 resolution level and values are the S2 cell tokens.

---

S2 Resolution Level / S2 Cell Tokens

---

Fetch Overlapping Fields POST

url: <baseUrl>/fetch-overlapping-fields

Fetch the overlapping fields for a certain threshold, returning the field’s geo json.

• Headers:

Content-Type > application/json

• Request:

JSON body

{"wkt": "POLYGON ((74.35855950604382 31.479723509875665,74.36619843731823 31.473830840390207,74.37044705639782 31.47968691058925,74.35855950604382 31.479723509875665))", "resolution_level": 13, "threshold": 90}

Polygon is defined using a Well Known Text (wkt) string

• Response:

{"GEO Ids": ["da2504ff0e16a77ad5d86d0c4bd6f21fcd33c69ce78cb6c03d0245ab719c22b5"], "Message": "The field Geo Ids with percentage match of the given threshold." }

---

Fetch a Field GET

url: <baseUrl>//fetch-field/<geo_id>

Received in query param a geo_id, fetch the relevant geo JSON

• Headers:

none

• Response:

{ "GEO ID": "25686161443f925abc76093b143b4806352fdf9b4181e4d26f149b9319ebe982", "Message": "Field fetched successfully.", "S2 Cell Tokens": "{\"8\": [\"39191\"], \"13\": [\"391905e4\"], \"15\": [\"391905e3c\"], \"18\": [\"391905e385\", \"391905e38f\", \"391905e391\", \"391905e397\", \"391905e399\", \"391905e39b\"], \"19\": [\"391905e384c\", \"391905e3854\", \"391905e38e4\", \"391905e38fc\", \"391905e3904\", \"391905e390c\", \"391905e3914\", \"391905e391c\", \"391905e3964\", \"391905e396c\", \"391905e3974\", \"391905e397c\", \"391905e3984\", \"391905e398c\", \"391905e3994\", \"391905e399c\", \"391905e39a4\", \"391905e39ac\", \"391905e39b4\", \"391905e39bc\"], \"20\": [\"391905e384d\", \"391905e384f\", \"391905e3851\", \"391905e3853\", \"391905e3855\", \"391905e3857\", \"391905e38e1\", \"391905e38e3\", \"391905e38e5\", \"391905e38e7\", \"391905e38f9\", \"391905e38fb\", \"391905e38fd\", \"391905e38ff\", \"391905e3901\", \"391905e3903\", \"391905e3905\", \"391905e3907\", \"391905e3909\", \"391905e390b\", \"391905e390d\", \"391905e390f\", \"391905e3911\", \"391905e3913\", \"391905e3915\", \"391905e3917\", \"391905e3919\", \"391905e391b\", \"391905e391d\", \"391905e391f\", \"391905e3965\", \"391905e3967\", \"391905e3969\", \"391905e396b\", \"391905e396d\", \"391905e396f\", \"391905e3971\", \"391905e3973\", \"391905e3975\", \"391905e3977\", \"391905e3979\", \"391905e397b\", \"391905e397d\", \"391905e397f\", \"391905e3981\", \"391905e3983\", \"391905e3985\", \"391905e3987\", \"391905e3989\", \"391905e398f\", \"391905e3991\", \"391905e3997\", \"391905e3999\", \"391905e399b\", \"391905e399d\", \"391905e399f\", \"391905e39a1\", \"391905e39a3\", \"391905e39a5\", \"391905e39a7\", \"391905e39a9\", \"391905e39ab\", \"391905e39ad\", \"391905e39af\", \"391905e39b1\", \"391905e39b3\", \"391905e39bb\", \"391905e39bd\"]}" }

---