{ "openapi": "3.0.3", "info": { "title": "Sovereign Solutions API", "version": "1.0.0", "description": "Every endpoint on this page is live. Fill in your credentials once, pick an operation, edit the example request, and send it against a real tenant.\n\n## Before your first call\n\n**1. Point at your tenant.** Every call goes to `https://api-gw.sovereignsolutions.com/gateway`. Tenant APIs start with `/{tenant}` - set the `tenant` path parameter to your own tenant code. The default `demo` is a shared demo tenant, so treat anything you create there as public.\n\n**2. Get a token.** `POST /authen/oauth/token` needs only your API key. It returns an `access_token` and a `refresh_token`.\n\n**3. Authenticate.** Paste the token into **Authentication**. From then on every call carries two credentials: `Authorization: Bearer ` identifies the caller, and the `api-key` query parameter identifies the tenant. Both are required, including on the token call itself.\n\n**Exception - location, routing, elevation and map-style APIs** (geocode, reverse geocode, DigiPin, route, distance, matrix, optimal routes, snap to road, isochrone, elevation, base map styles) need **only** the `api-key` query parameter - no bearer token and no tenant in the URL.\n\nTokens are short-lived - `expires_in` is in seconds. Refresh with the refresh token rather than sending the password again. This page keeps credentials in the browser only, and forgets them when you reload.\n\n## How this reference is organised\n\nSections follow the same solution areas as the rest of the site - workforce, search and location, geofencing, routing, map visualization, integrations - so an API sits in the same place here as in the documentation.\n\nEach section opens with what the API does, whether it works with an API key alone or needs a provisioned tenant, and a link to the field definitions of the objects it reads and writes. Where a request accepts more than one shape, the alternatives are in the examples dropdown rather than buried in prose.\n\nNot everything is callable yet. Capabilities still on the roadmap are documented inside their own section under **Coming soon**, together with what to use instead today.\n\n## Status markers\n\n- **planned** - the contract is agreed, the endpoint is not built yet\n- **deferred** - exists internally, external exposure still being decided\n- **pending** - internal path, external availability unconfirmed", "contact": { "name": "Sovereign Solutions API Team" } }, "servers": [ { "url": "https://api-gw.sovereignsolutions.com/gateway", "description": "API gateway" } ], "tags": [ { "name": "Authentication", "description": "### Authentication (OAuth2 Token)\n\n_Authentication · API key only_\n\nIssues the OAuth2 access token used by every other endpoint. Send the token as `Authorization: Bearer ` together with your tenant API key as the `api-key` query parameter on all subsequent calls." }, { "name": "Location and Address Intelligence APIs", "description": "### Geocode API\n\n_Location and Address Intelligence APIs · API key only_\n\nConverts an address, landmark or place name into latitude/longitude. The optional `bounds` object restricts results to a map viewport.\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/geocode)\n\n### Reverse Geocode API\n\n_Location and Address Intelligence APIs · API key only_\n\nConverts a coordinate pair into a structured address - state, district, tehsil, village, road and postal code.\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/reverse-geocode)\n\n### Geocode Suggest API\n\n_Location and Address Intelligence APIs · API key only_\n\nPredicts places as the user types - send the partial text and show the returned suggestions.\n\n### Batch Reverse Geocoding API\n\n_Location and Address Intelligence APIs · API key only_\n\nConverts many coordinate pairs into addresses in a single request.\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/batch-reverse-geocoding)\n\n### DigiPin API\n\n_Location and Address Intelligence APIs · API key only_\n\nEncodes coordinates into India's 10-character digital postal index (DIGIPIN), and decodes a DIGIPIN back to the cell it identifies.\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/digipin)\n\n---\n\n## Coming soon in Location and Address Intelligence APIs\n\nDocumented here, not callable yet - no endpoint contract published.\n\n### Batch Geocoding API\n\n_Location and Address Intelligence APIs · API key only_\n\n**Coming soon** - planned, endpoint contract not published yet.\n\nConvert many addresses into coordinates in a single request.\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/batch-geocoding)\n\n**Notes**\n\n**Coming soon.** High-throughput forward batch geocoding is on the roadmap." }, { "name": "Map Visualization", "description": "### Map Base Tiles API\n\n_Map Visualization · API key only_\n\nServes ready-made base map styles. Point a MapLibre-compatible map at the style URL to render the base map.\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/map-base-tiles)\n\n**Notes**\n\nAvailable styles: `basic`, `bright`, `dark`, `fiord`, `liberty`, `positron`, `terrain`, `toner`, `3d`.\n\nThe style URL carries the API key as a query parameter, e.g. `https://map-cdn.sovereignsolutions.tech/styles/basic/basic.json?api-key=`.\n\n### Elevation API\n\n_Map Visualization · API key only_\n\nReturns ground elevation (30 m resolution) for one or many coordinates, as JSON or GeoJSON.\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/elevation)\n\n**Notes**\n\nCoordinates are WGS-84 (EPSG:4326). Note the order: the `locations` argument is `latitude,longitude`, while GeoJSON output is `[longitude, latitude, elevation]`." }, { "name": "Route and Journey Intelligence APIs", "description": "### Route API\n\n_Route and Journey Intelligence APIs · API key only_\n\nReturns the travelable path between two or more stops, in the order given: geometry, turn-by-turn instructions, and time and length per leg.\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/distance-route)\n\n**See also**\n\n- [Distance API - distance and duration without instructions](https://sdk.intelomatic.ai/docs/api/distance-route)\n- [Optimal Routes API - let the service choose the stop order](https://sdk.intelomatic.ai/docs/api/optimal-routes)\n\n### Distance API\n\n_Route and Journey Intelligence APIs · API key only_\n\nReturns distance (metres) and estimated duration (seconds) between waypoints. Lighter than the Route API when you only need the numbers.\n\n### Route Matrix API\n\n_Route and Journey Intelligence APIs · API key only_\n\nComputes a full distance and travel-time matrix between a set of origins and a set of destinations in a single request.\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/route-matrix)\n\n### Optimal Routes API\n\n_Route and Journey Intelligence APIs · API key only_\n\nGiven an unordered list of stops, returns them reordered into an efficient visiting sequence together with the route through them. Each returned stop carries `original_index` so you can map it back to your input.\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/optimal-routes)\n\n**Notes**\n\nThe example response is shortened to the first leg; a real response has one leg between each pair of consecutive stops.\n\n### Isochrone API\n\n_Route and Journey Intelligence APIs · API key only_\n\nReturns the area reachable from a point within a given travel distance or time, as GeoJSON polygons.\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/isochrone)\n\n### Snap to Road API\n\n_Route and Journey Intelligence APIs · API key only_\n\nSnaps a GPS point to the nearest road, or returns the road attributes (name, access, speed limit, classification) at a point.\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/snap-to-road)" }, { "name": "Field Force Mobility Execution APIs", "description": "### Employee Management API\n\n_Field Force Mobility Execution APIs · Requires Intelomatic tenant_\n\nManages workforce accounts: creation, lookup, and lifecycle state (enable/disable). Employees are attached to a team in the organization hierarchy.\n\nField definitions: [Employee](https://sdk.intelomatic.ai/docs/models/employee)\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/employee-management)\n\n**Notes**\n\n`employee_organization_id`, `employee_team_id` and `employee_reporting_manager` are all specific to your workspace - you receive them when your demo or tenant account is provisioned. The values below are placeholders.\n\n`POST /employee/search` without a query parameter searches every employee your key can see; add `hierarchyPath` to scope the same search to one team's hierarchy path.\n\n`employee_status` is set by the platform: `1` new, `2` inactive, `3` active, `4` disabled. The enable and disable calls move a record between `3` and `4`.\n\n### Tracking API\n\n_Field Force Mobility Execution APIs · Requires Intelomatic tenant_\n\nIngests GPS telemetry from field devices and reads it back, either as the latest known position or as a historical track over a time range.\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/tracking)\n\n### PJP (Permanent Journey Plan) API\n\n_Field Force Mobility Execution APIs · Requires Intelomatic tenant_\n\nManages Permanent Journey Plans: recurring field-visit schedules. A **plan** groups **visits**; visits can be created inline with the plan or managed independently. Visit searches can denormalize customer details via `searchConfig.includeCustomer`.\n\nField definitions: [Plan](https://sdk.intelomatic.ai/docs/models/plan), [Visit](https://sdk.intelomatic.ai/docs/models/visit)\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/pjp)\n\n### Events API\n\n_Field Force Mobility Execution APIs · Requires Intelomatic tenant_\n\nRecords and queries operational events raised by field apps, such as duty status changes and check-ins. Events can optionally be linked to a specific data-layer record.\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/events)\n\n**Notes**\n\nObserved `typeCode`/`actionCode` pairs: `DUTY`/`on_duty`, `DUTY`/`off_duty`.\n\n This is an event **ingestion** endpoint: your devices and apps push events here. Outbound delivery (webhooks to your own systems) is a separate integration to design with the team if you need it.\n\n**Accepted events:**\n\n- Turn off duty to on duty (Type ID: 1, Type Code: `DUTY`, Action Code: `on_duty`)\n- Turn on duty to off duty (Type ID: 1, Type Code: `DUTY`, Action Code: `off_duty`)\n- Login (Type ID: 4, Type Code: `AUTHENTICATION`, Action Code: `login`)\n- Log out (Type ID: 4, Type Code: `AUTHENTICATION`, Action Code: `logout`)\n- Create a local record (Type ID: 2, Type Code: `COLLECTOR`, Action Code: `create_local_record`)\n- Edit a local record (Type ID: 2, Type Code: `COLLECTOR`, Action Code: `edit_local_record`)\n- Remove local record (Type ID: 2, Type Code: `COLLECTOR`, Action Code: `remove_local_record`)\n- Publish a new record (Type ID: 2, Type Code: `COLLECTOR`, Action Code: `publish_new_record`)\n- Edit an online record (Type ID: 2, Type Code: `COLLECTOR`, Action Code: `edit_online_record`)\n- Publish an edited version of an online record (Type ID: 2, Type Code: `COLLECTOR`, Action Code: `publish_replacement_record`)\n- Remove an online record (Type ID: 2, Type Code: `COLLECTOR`, Action Code: `remove_online_record`)\n- Launch app (Type ID: 3, Type Code: `APP_EVENT`, Action Code: `launch_app`)\n- Resume app (Type ID: 3, Type Code: `APP_EVENT`, Action Code: `resume_app`)\n- Have bad app setting (Type ID: 6, Type Code: `APP_SETTING`, Action Code: `bad_setting`)\n- Submit evidence when setting up the app (Type ID: 7, Type Code: `EVIDENCE`, Action Code: `initial_setup`)\n- Submit evidence when providing missing permission (Type ID: 7, Type Code: `EVIDENCE`, Action Code: `missing_permissions`)\n- Check in a visit (Type ID: 9, Type Code: `VISIT`, Action Code: `check_in`)\n- Check out a visit (Type ID: 9, Type Code: `VISIT`, Action Code: `check_out`)\n- Cancel a visit (Type ID: 9, Type Code: `VISIT`, Action Code: `cancel`)\n- Create order (Type ID: 10, Type Code: `ORDER`, Action Code: `create_order`)\n- Create customer (Type ID: 11, Type Code: `CUSTOMER`, Action Code: `create_customer`)\n- Expense submitted (Type ID: 12, Type Code: `EXPENSE`, Action Code: `submitted_expense`)\n\nThis list is not fixed - new event types and action codes can be declared through the Intelomatic User interface.\n\n### Customer API\n\n_Field Force Mobility Execution APIs · Requires Intelomatic tenant_\n\nManages the customer records your field teams visit and report against: create them, search them, and read or update their details.\n\nField definitions: [Customer](https://sdk.intelomatic.ai/docs/models/customer)\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/customer)\n\n**Notes**\n\nThe `customer_*` fields shown here are the ones observed across tenants; the exact field set is tenant-specific. Call the schema endpoint first to discover what your tenant's customer records actually define.\n\nSearch responses use the standard `{ \"data\": [...], \"total\": N }` envelope, and every record carries the usual system fields (`Id`, `CreatedDate`, `ModifiedDate`, `Title`) alongside its `customer_*` values." }, { "name": "Custom Integrations", "description": "### Custom Data Layers API\n\n_Custom Integrations · Requires Intelomatic tenant_\n\nA universal CRUD interface over any custom data layer. Every layer your tenant defines - `CUSTOMER`, `PRODUCT`, `INVENTORY`, `DEALER_*`, `MC_TERRITORY_VILLAGES` and so on - is exposed through the same endpoint shape, including a boundary/polygon layer such as `MC_TERRITORY_VILLAGES` (there is no separate Custom Boundary endpoint - a boundary is just a data layer with a `*_shape` field). This single API also covers reading a layer's field definitions and reading one record's full detail.\n\nField definitions: [Field data types](https://sdk.intelomatic.ai/docs/models/data-types)\n\n[Use cases and business context](https://sdk.intelomatic.ai/docs/api/custom-data-layers)\n\n**Notes**\n\n**Conventions that hold for every layer:**\n\n- Search responses are always wrapped as `{ \"data\": [...], \"total\": N }`.\n- Every record carries a fixed set of system fields alongside its typed properties:\n\n- `Id`: Record identifier (UUID)\n- `Layer`: The layer this record belongs to\n- `Path` / `ParentPath`: Internal storage location\n- `CreatedDate` / `CreatedUser`: When and by whom it was created\n- `ModifiedDate` / `ModifiedUser`: When and by whom it was last changed\n- `Title`: Display label for the record\n\n These appear on every layer, including each entry inside the search envelope's `data[]`.\n\n**Schema vs. detail - do not confuse these two read operations:** `layer-detail` returns the layer's **schema** (field definitions, no record ID in the path); `{id}/detail` returns one **record's data** (record ID in the path).\n\n**Integration datasets, folded in:** market centre, village and dealer-territory datasets (e.g. `MC_TERRITORY_VILLAGES`, `DEALER_WISE_TEHSIL_WISE_IND`, `DEALER_LONGITUDE_LATITUDE`, `DEALER_MAPPING`) are just data layers like any other, queried through this same interface - there is no separate integration endpoint. Layer names are tenant-specific by design." } ], "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "paths": { "/authen/oauth/token": { "post": { "tags": [ "Authentication" ], "summary": "Issue an access token", "operationId": "issueAnAccessToken", "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "grant_type", "username", "password" ], "properties": { "grant_type": { "type": "string", "example": "password" }, "username": { "type": "string", "example": "" }, "password": { "type": "string", "example": "" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string", "example": "" }, "token_type": { "type": "string", "example": "bearer" }, "expires_in": { "type": "integer", "example": 3600 }, "refresh_token": { "type": "string", "example": "" } } }, "example": { "access_token": "", "token_type": "bearer", "expires_in": 3600, "refresh_token": "" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-server": "identity" } }, "/authen/oauth/token#refresh-an-access-token": { "post": { "tags": [ "Authentication" ], "summary": "Refresh an access token", "description": "Same endpoint as the password grant; `grant_type=refresh_token` swaps a refresh token for a new access token without re-sending the username and password.", "operationId": "refreshAnAccessToken", "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "grant_type", "refresh_token" ], "properties": { "grant_type": { "type": "string", "example": "refresh_token", "description": "Always `refresh_token` for this call." }, "refresh_token": { "type": "string", "example": "", "description": "The `refresh_token` returned by the previous token call." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string", "example": "" }, "token_type": { "type": "string", "example": "bearer" }, "expires_in": { "type": "integer", "example": 86399 }, "refresh_token": { "type": "string", "example": "" } } }, "example": { "access_token": "", "token_type": "bearer", "expires_in": 86399, "refresh_token": "" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-server": "identity" } }, "/geocode/search": { "post": { "tags": [ "Location and Address Intelligence APIs" ], "summary": "Geolocation Place Search", "operationId": "geolocationPlaceSearch", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "searchKey": { "type": "string", "example": "coffee", "description": "Search text - an address, landmark or place name. A `\"lat, lon\"` string instead returns the administrative area at that point." }, "skip": { "type": "integer", "example": 0, "description": "Number of results to skip." }, "take": { "type": "integer", "example": 10, "description": "Maximum number of results to return." } }, "required": [ "searchKey", "skip", "take" ] }, "example": { "searchKey": "coffee", "skip": 0, "take": 10 } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Fitness Cafe", "description": "Place name." }, "location_llt": { "type": "string", "example": "12.9418354,77.625556", "description": "`\"lat,lon\"` string - the same position as `latitude` / `longitude`." }, "subcategorye": { "type": "string", "example": "Fitness Clubs & Centers", "description": "Sub-category name." }, "categorye": { "type": "string", "example": "Sports Center", "description": "Category name." }, "province": { "type": "string", "example": "KARNATAKA", "description": "State." }, "_version_": { "type": "integer", "example": 1852549247623233500, "description": "Internal index version. Ignore it." }, "district": { "type": "string", "example": "Bangalore", "description": "District." }, "groupe": { "type": "string", "example": "Sport", "description": "Group name." }, "id": { "type": "string", "example": "df6490db-0bc1-40fa-a2a4-51c919d836d8", "description": "Result ID." }, "groupCode": { "type": "integer", "example": 9, "description": "Numeric group code." }, "categoryCode": { "type": "integer", "example": 7320, "description": "Numeric category code." }, "subCategoryCode": { "type": "integer", "example": 7320002, "description": "Numeric sub-category code." }, "longitude": { "type": "number", "example": 77.625556, "description": "Longitude of the point, decimal degrees." }, "latitude": { "type": "number", "example": 12.9418354, "description": "Latitude of the point, decimal degrees." }, "resultType": { "type": "integer", "example": 2, "description": "Kind of match. `2` = place / POI match; `3` = coordinate lookup (see the coordinate example)." } } }, "description": "Matches, best first." } } }, "example": { "docs": [ { "name": "Fitness Cafe", "location_llt": "12.9418354,77.625556", "subcategorye": "Fitness Clubs & Centers", "categorye": "Sports Center", "province": "KARNATAKA", "_version_": 1852549247623233500, "district": "Bangalore", "groupe": "Sport", "id": "df6490db-0bc1-40fa-a2a4-51c919d836d8", "groupCode": 9, "categoryCode": 7320, "subCategoryCode": 7320002, "longitude": 77.625556, "latitude": 12.9418354, "resultType": 2 }, { "name": "Fitness Cafe", "location_llt": "12.9925717,77.6834013", "subcategorye": "Fitness Clubs & Centers", "categorye": "Sports Center", "province": "KARNATAKA", "_version_": 1852549245644570600, "district": "Bangalore", "groupe": "Sport", "id": "e51e5c14-f87a-415c-83ae-d92cdc32092e", "groupCode": 9, "categoryCode": 7320, "subCategoryCode": 7320002, "longitude": 77.6834013, "latitude": 12.9925717, "resultType": 2 } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "1", "x-server": "core" } }, "/geocode/search#geocode-api-in-bounds": { "post": { "tags": [ "Location and Address Intelligence APIs" ], "summary": "Geocode API - in bounds", "description": "`bounds` restricts results to a rectangle: `lx`/`ly` are the west longitude / south latitude, `rx`/`ry` the east longitude / north latitude.", "operationId": "geocodeAPIInBounds", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "searchKey": { "type": "string", "example": "Mumbai", "description": "Search text - an address, landmark or place name. A `\"lat, lon\"` string instead returns the administrative area at that point." }, "bounds": { "type": "object", "properties": { "lx": { "type": "number", "example": 72.7, "description": "West edge, longitude." }, "ly": { "type": "number", "example": 18.8, "description": "South edge, latitude." }, "rx": { "type": "number", "example": 73.1, "description": "East edge, longitude." }, "ry": { "type": "number", "example": 19.3, "description": "North edge, latitude." } }, "description": "Rectangle to search in." } }, "required": [ "searchKey", "bounds" ] }, "example": { "searchKey": "Mumbai", "bounds": { "lx": 72.7, "ly": 18.8, "rx": 73.1, "ry": 19.3 } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Mumbai Central", "description": "Place name." }, "location_llt": { "type": "string", "example": "18.9696305,72.8193674", "description": "`\"lat,lon\"` string - the same position as `latitude` / `longitude`." }, "subcategorye": { "type": "string", "example": "Unspecified", "description": "Sub-category name." }, "categorye": { "type": "string", "example": "Railway Station", "description": "Category name." }, "province": { "type": "string", "example": "MAHARASHTRA", "description": "State." }, "_version_": { "type": "integer", "example": 1852552040196079600, "description": "Internal index version. Ignore it." }, "district": { "type": "string", "example": "Mumbai", "description": "District." }, "groupe": { "type": "string", "example": "Transport", "description": "Group name." }, "id": { "type": "string", "example": "862104a3-1b8c-41fd-b5b1-deae4ed5de08", "description": "Result ID." }, "groupCode": { "type": "integer", "example": 11, "description": "Numeric group code." }, "categoryCode": { "type": "integer", "example": 7380, "description": "Numeric category code." }, "subCategoryCode": { "type": "integer", "example": 7380001, "description": "Numeric sub-category code." }, "longitude": { "type": "number", "example": 72.8193674, "description": "Longitude of the point, decimal degrees." }, "latitude": { "type": "number", "example": 18.9696305, "description": "Latitude of the point, decimal degrees." }, "resultType": { "type": "integer", "example": 2, "description": "Kind of match. `2` = place / POI match; `3` = coordinate lookup (see the coordinate example)." } } }, "description": "Matches, best first." } } }, "example": { "docs": [ { "name": "Mumbai Central", "location_llt": "18.9696305,72.8193674", "subcategorye": "Unspecified", "categorye": "Railway Station", "province": "MAHARASHTRA", "_version_": 1852552040196079600, "district": "Mumbai", "groupe": "Transport", "id": "862104a3-1b8c-41fd-b5b1-deae4ed5de08", "groupCode": 11, "categoryCode": 7380, "subCategoryCode": 7380001, "longitude": 72.8193674, "latitude": 18.9696305, "resultType": 2 }, { "name": "Mumbai Central", "location_llt": "18.9696305,72.8193674", "subcategorye": "Unspecified", "categorye": "Railway Station", "province": "MAHARASHTRA", "_version_": 1852552036590026800, "district": "Mumbai", "groupe": "Transport", "id": "bf557f5f-4280-4158-a765-c7d0721ecb21", "groupCode": 11, "categoryCode": 7380, "subCategoryCode": 7380001, "longitude": 72.8193674, "latitude": 18.9696305, "resultType": 2 } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "1", "x-server": "core" } }, "/geocode/search#geocode-api-by-coordinates": { "post": { "tags": [ "Location and Address Intelligence APIs" ], "summary": "Geocode API - by coordinates", "description": "Sending a `\"lat, lon\"` string as `searchKey` returns one `resultType: 3` document describing the administrative area at that point.", "operationId": "geocodeAPIByCoordinates", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "searchKey": { "type": "string", "example": "28.7074634, 77.1751171", "description": "`\"lat, lon\"` string, e.g. `\"28.7074634, 77.1751171\"`." } }, "required": [ "searchKey" ] }, "example": { "searchKey": "28.7074634, 77.1751171" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "string", "example": "28.7074634", "description": "Latitude you sent, as a string." }, "longitude": { "type": "string", "example": "77.1751171", "description": "Longitude you sent, as a string." }, "postalCode": { "type": "string", "example": "110009", "description": "Postal code (PIN)." }, "Country": { "type": "string", "example": "India" }, "District": { "type": "string", "example": "North", "description": "District." }, "PinCode": { "type": "object", "properties": { "OfficeName": { "type": "string", "example": "Nirankari Colony", "description": "Post office name." }, "OfficeType": { "type": "string", "example": "S.O", "description": "Post office type, e.g. `S.O` (sub office)." }, "Value": { "type": "string", "example": "110009", "description": "Postal code (PIN)." } } }, "Road": { "type": "string", "example": "", "description": "Nearest road. Empty when none is known." }, "State": { "type": "string", "example": "DELHI", "description": "State." }, "Status": { "type": "boolean", "example": true, "description": "`true` when an address was found." }, "Tehsil": { "type": "string", "example": "Model Town", "description": "Tehsil (sub-district)." }, "Village": { "type": "string", "example": "", "description": "Village. Empty when not in a village." }, "location_llt": { "type": "string", "example": "28.7074634,77.1751171", "description": "`\"lat,lon\"` string." }, "country": { "type": "string", "example": "India" }, "province": { "type": "string", "example": "DELHI" }, "district": { "type": "string", "example": "North" }, "ward": { "type": "string", "example": "Model Town" }, "resultType": { "type": "integer", "example": 3, "description": "`3` = coordinate lookup." }, "address": { "type": "string", "example": "Model Town, North, DELHI", "description": "Formatted address." }, "shortAddress": { "type": "string", "example": "Model Town, North, DELHI", "description": "Short formatted address." }, "name": { "type": "string", "example": "Model Town, North, DELHI", "description": "Display name." } } }, "description": "One document for the point." } } }, "example": { "docs": [ { "latitude": "28.7074634", "longitude": "77.1751171", "postalCode": "110009", "Country": "India", "District": "North", "PinCode": { "OfficeName": "Nirankari Colony", "OfficeType": "S.O", "Value": "110009" }, "Road": "", "State": "DELHI", "Status": true, "Tehsil": "Model Town", "Village": "", "location_llt": "28.7074634,77.1751171", "country": "India", "province": "DELHI", "district": "North", "ward": "Model Town", "resultType": 3, "address": "Model Town, North, DELHI", "shortAddress": "Model Town, North, DELHI", "name": "Model Town, North, DELHI" } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "1", "x-server": "core" } }, "/geocode/reverse": { "post": { "tags": [ "Location and Address Intelligence APIs" ], "summary": "Reverse Geocode API", "description": "The response is an **array** even for a single point. To look up several points in one call, see [Batch Reverse Geocoding](/docs/api/batch-reverse-geocoding).", "operationId": "reverseGeocodeAPI", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "longitude": { "type": "number", "example": 77.06615, "description": "Longitude of the point, decimal degrees." }, "latitude": { "type": "number", "example": 28.462238, "description": "Latitude of the point, decimal degrees." } }, "required": [ "longitude", "latitude" ] }, "example": { "longitude": 77.06615, "latitude": 28.462238 } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Country": { "type": "string", "example": "India", "description": "Country." }, "District": { "type": "string", "example": "Gurugram", "description": "District." }, "PinCode": { "type": "object", "properties": { "OfficeName": { "type": "string", "example": "Industrial Estate (Gurgaon)", "description": "Post office name." }, "OfficeType": { "type": "string", "example": "S.O", "description": "Post office type, e.g. `S.O` (sub office)." }, "Value": { "type": "string", "example": "122007", "description": "Postal code (PIN)." } } }, "Road": { "type": "string", "example": "", "description": "Nearest road name. Empty when none is known." }, "State": { "type": "string", "example": "HARYANA", "description": "State." }, "Status": { "type": "boolean", "example": true, "description": "`true` when an address was found." }, "Tehsil": { "type": "string", "example": "Gurgaon", "description": "Tehsil (sub-district)." }, "Village": { "type": "string", "example": "", "description": "Village. Empty when the point is not in a village." } }, "description": "One address per input point." } }, "example": [ { "Country": "India", "District": "Gurugram", "PinCode": { "OfficeName": "Industrial Estate (Gurgaon)", "OfficeType": "S.O", "Value": "122007" }, "Road": "", "State": "HARYANA", "Status": true, "Tehsil": "Gurgaon", "Village": "" } ] } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "2", "x-server": "core" } }, "/routing/adapter/route": { "post": { "tags": [ "Route and Journey Intelligence APIs" ], "summary": "Route API", "operationId": "routeAPI", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "locations": { "type": "array", "items": { "type": "object", "properties": { "lat": { "type": "number", "example": 21.4943067, "description": "Latitude of the point, decimal degrees." }, "lon": { "type": "number", "example": 86.8692782, "description": "Longitude of the point, decimal degrees." } } }, "description": "Stops, visited in the order given. At least two." }, "costing": { "type": "string", "example": "auto", "description": "Travel mode used for costing. The examples use `auto` (driving) and `pedestrian` (walking)." }, "units": { "type": "string", "example": "km", "description": "Distance unit: `km`." } }, "required": [ "locations", "costing", "units" ] }, "example": { "locations": [ { "lat": 21.4943067, "lon": 86.8692782 }, { "lat": 21.4335349694959, "lon": 86.8405786566617 } ], "costing": "auto", "units": "km" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "trip": { "type": "object", "properties": { "locations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "break" }, "lat": { "type": "number", "example": 21.494306 }, "lon": { "type": "number", "example": 86.869278 }, "side_of_street": { "type": "string", "example": "left", "description": "Side of the street the stop is on." }, "original_index": { "type": "integer", "example": 0, "description": "Position of this stop in your request." } } }, "description": "The input stops as snapped to the road network." }, "legs": { "type": "array", "items": { "type": "object", "properties": { "maneuvers": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "integer", "example": 3 }, "instruction": { "type": "string", "example": "Drive east.", "description": "Human-readable instruction." }, "verbal_succinct_transition_instruction": { "type": "string", "example": "Drive east." }, "verbal_pre_transition_instruction": { "type": "string", "example": "Drive east." }, "verbal_post_transition_instruction": { "type": "string", "example": "Continue for 2 kilometers." }, "time": { "type": "number", "example": 158.239, "description": "Time for this maneuver, seconds." }, "length": { "type": "number", "example": 2.197, "description": "Length of this maneuver, in `units`." }, "cost": { "type": "number", "example": 151.988 }, "begin_shape_index": { "type": "integer", "example": 0 }, "end_shape_index": { "type": "integer", "example": 28 }, "travel_mode": { "type": "string", "example": "drive" }, "travel_type": { "type": "string", "example": "car" } } }, "description": "Turn-by-turn instructions for the leg." }, "summary": { "type": "object", "properties": { "has_time_restrictions": { "type": "boolean", "example": false }, "has_toll": { "type": "boolean", "example": false }, "has_highway": { "type": "boolean", "example": false }, "has_ferry": { "type": "boolean", "example": false }, "min_lat": { "type": "number", "example": 21.431431 }, "min_lon": { "type": "number", "example": 86.838567 }, "max_lat": { "type": "number", "example": 21.49335 }, "max_lon": { "type": "number", "example": 86.889226 }, "time": { "type": "number", "example": 547.566, "description": "Leg travel time, seconds." }, "length": { "type": "number", "example": 11.486, "description": "Leg length, in `units`." }, "cost": { "type": "number", "example": 521.159 } } }, "shape": { "type": "string", "example": "}wu~g@si`udD|AkPhBgm@aDoYo@eLc@sfFp@oJpHc_@lFiYxHm`A~@aMsAkPuWax@{DwQoBmSUkSdAoeFsAaUyFk[aNal@_FeO}DeWkFaU{x@guBwGiYaSgjB]_IY_H]kG`WhCx_ArJr~Dd`@tt@hHvcArLjkAtNfMrAr`AnKpmAfObgBfSzaCnXbg@lJje@jPftCfmArmDl{Avf@hTbe@`QxUxInkAhf@jkE`lB`VlKxP`ItUvNzTtSl[b]hgFr_HnyApiBf}E|gGtpA||AtsAdfBn{@`gA`UpZpo@tx@p{@`kAvm@zw@zgC`dDveIp|JrfEdiFpv@x`A|rArbBrnAz{ArCjDhxAvjBli@nq@pK`Oz\\~a@ftAdcB~AxByHzGunBefC", "description": "Leg geometry as an encoded polyline." } } }, "description": "One leg between each pair of consecutive stops." }, "summary": { "type": "object", "properties": { "has_time_restrictions": { "type": "boolean", "example": false }, "has_toll": { "type": "boolean", "example": false, "description": "`true` when the route uses a toll road." }, "has_highway": { "type": "boolean", "example": false, "description": "`true` when the route uses a highway." }, "has_ferry": { "type": "boolean", "example": false, "description": "`true` when the route uses a ferry." }, "min_lat": { "type": "number", "example": 21.431431 }, "min_lon": { "type": "number", "example": 86.838567 }, "max_lat": { "type": "number", "example": 21.49335 }, "max_lon": { "type": "number", "example": 86.889226 }, "time": { "type": "number", "example": 547.566, "description": "Total travel time, seconds." }, "length": { "type": "number", "example": 11.486, "description": "Total length, in `units`." }, "cost": { "type": "number", "example": 521.159 } } }, "status_message": { "type": "string", "example": "Found route between points", "description": "Result message." }, "status": { "type": "integer", "example": 0, "description": "`0` when a route was found." }, "units": { "type": "string", "example": "kilometers", "description": "Distance unit used in the response." }, "language": { "type": "string", "example": "en-US", "description": "Language of the instructions." } } } } }, "example": { "trip": { "locations": [ { "type": "break", "lat": 21.494306, "lon": 86.869278, "side_of_street": "left", "original_index": 0 }, { "type": "break", "lat": 21.433534, "lon": 86.840578, "side_of_street": "left", "original_index": 1 } ], "legs": [ { "maneuvers": [ { "type": 3, "instruction": "Drive east.", "verbal_succinct_transition_instruction": "Drive east.", "verbal_pre_transition_instruction": "Drive east.", "verbal_post_transition_instruction": "Continue for 2 kilometers.", "time": 158.239, "length": 2.197, "cost": 151.988, "begin_shape_index": 0, "end_shape_index": 28, "travel_mode": "drive", "travel_type": "car" }, { "type": 10, "instruction": "Turn right onto NH16/AH45/Balasore Bypass. Continue on NH16/AH45.", "verbal_transition_alert_instruction": "Turn right onto NH16.", "verbal_succinct_transition_instruction": "Turn right.", "verbal_pre_transition_instruction": "Turn right onto NH16, AH45.", "verbal_post_transition_instruction": "Continue on NH16, AH45 for 9 kilometers.", "street_names": [ "NH16", "AH45" ], "begin_street_names": [ "NH16", "AH45", "Balasore Bypass" ], "time": 365.522, "length": 8.966, "cost": 340.377, "begin_shape_index": 28, "end_shape_index": 76, "travel_mode": "drive", "travel_type": "car" } ], "summary": { "has_time_restrictions": false, "has_toll": false, "has_highway": false, "has_ferry": false, "min_lat": 21.431431, "min_lon": 86.838567, "max_lat": 21.49335, "max_lon": 86.889226, "time": 547.566, "length": 11.486, "cost": 521.159 }, "shape": "}wu~g@si`udD|AkPhBgm@aDoYo@eLc@sfFp@oJpHc_@lFiYxHm`A~@aMsAkPuWax@{DwQoBmSUkSdAoeFsAaUyFk[aNal@_FeO}DeWkFaU{x@guBwGiYaSgjB]_IY_H]kG`WhCx_ArJr~Dd`@tt@hHvcArLjkAtNfMrAr`AnKpmAfObgBfSzaCnXbg@lJje@jPftCfmArmDl{Avf@hTbe@`QxUxInkAhf@jkE`lB`VlKxP`ItUvNzTtSl[b]hgFr_HnyApiBf}E|gGtpA||AtsAdfBn{@`gA`UpZpo@tx@p{@`kAvm@zw@zgC`dDveIp|JrfEdiFpv@x`A|rArbBrnAz{ArCjDhxAvjBli@nq@pK`Oz\\~a@ftAdcB~AxByHzGunBefC" } ], "summary": { "has_time_restrictions": false, "has_toll": false, "has_highway": false, "has_ferry": false, "min_lat": 21.431431, "min_lon": 86.838567, "max_lat": 21.49335, "max_lon": 86.889226, "time": 547.566, "length": 11.486, "cost": 521.159 }, "status_message": "Found route between points", "status": 0, "units": "kilometers", "language": "en-US" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "3a", "x-server": "core" } }, "/routing/in-shortest/route/v1/{profile}/{coordinates}": { "get": { "tags": [ "Route and Journey Intelligence APIs" ], "summary": "Distance API - two points", "operationId": "distanceAPITwoPoints", "parameters": [ { "name": "profile", "in": "path", "required": true, "description": "Routing profile. The examples use `car` and `foot`.", "schema": { "type": "string", "example": "car" }, "example": "car" }, { "name": "coordinates", "in": "path", "required": true, "description": "Semicolon-separated `lon,lat` pairs. Two pairs = point-to-point; more than two = one leg per consecutive pair.", "schema": { "type": "string", "example": "86.8692782,21.4943067;86.8405786566617,21.4335349694959" }, "example": "86.8692782,21.4943067;86.8405786566617,21.4335349694959" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "routes": { "type": "array", "items": { "type": "object", "properties": { "weight_name": { "type": "string", "example": "taxi", "description": "Name of the cost model used." }, "weight": { "type": "number", "example": 11486.098, "description": "Internal routing cost. Ignore it." }, "duration": { "type": "number", "example": 547.567, "description": "Total duration, seconds." }, "distance": { "type": "number", "example": 11486.098, "description": "Total distance, metres." }, "legs": { "type": "array", "items": { "type": "object", "properties": { "weight": { "type": "number", "example": 11486.098 }, "duration": { "type": "number", "example": 547.567, "description": "Leg duration, seconds." }, "steps": { "type": "array", "items": {} }, "distance": { "type": "number", "example": 11486.098, "description": "Leg distance, metres." }, "summary": { "type": "string", "example": "" } } }, "description": "One leg between each pair of consecutive points." }, "geometry": { "type": "string", "example": "indbCapeqOHw@HsCOsACi@CeVBc@^gBVsA\\oEFm@Iw@mAuDS{@IaAA_ADaVGgAWyAq@oCUs@QmAWeAyDyJ[sA_AwIA_@C[A[jALnEd@dRhBjD\\zEj@rFp@l@FpEf@xFr@lI~@`LpA`Cb@xBv@|MxFlPfH~BbAxBx@fAb@tF|BlSzIhAf@v@^fAp@dA`AzA`BfVx[~GtIfUnYdGjHlGhI`EdFdAxAzCvD`ErFtCtDtLnOt_@be@|RlVpDpEjG~H|FfHNP|GvIfC`Df@r@~AnBnG~HHJ_@ZeJoL", "description": "Route geometry as an encoded polyline." } } }, "description": "The route found." }, "waypoints": { "type": "array", "items": { "type": "object", "properties": { "distance": { "type": "number", "example": 364.278, "description": "Distance from the input point to the snapped position, metres." }, "name": { "type": "string", "example": "", "description": "Road name at the snapped position." }, "location": { "type": "array", "items": { "type": "number", "example": 86.86865 }, "description": "Snapped position, `[longitude, latitude]`." } } }, "description": "Input points snapped to the road network, in input order." }, "code": { "type": "string", "example": "Ok", "description": "`Ok` on success." } } }, "example": { "routes": [ { "weight_name": "taxi", "weight": 11486.098, "duration": 547.567, "distance": 11486.098, "legs": [ { "weight": 11486.098, "duration": 547.567, "steps": [], "distance": 11486.098, "summary": "" } ], "geometry": "indbCapeqOHw@HsCOsACi@CeVBc@^gBVsA\\oEFm@Iw@mAuDS{@IaAA_ADaVGgAWyAq@oCUs@QmAWeAyDyJ[sA_AwIA_@C[A[jALnEd@dRhBjD\\zEj@rFp@l@FpEf@xFr@lI~@`LpA`Cb@xBv@|MxFlPfH~BbAxBx@fAb@tF|BlSzIhAf@v@^fAp@dA`AzA`BfVx[~GtIfUnYdGjHlGhI`EdFdAxAzCvD`ErFtCtDtLnOt_@be@|RlVpDpEjG~H|FfHNP|GvIfC`Df@r@~AnBnG~HHJ_@ZeJoL" } ], "waypoints": [ { "distance": 364.278, "name": "", "location": [ 86.86865, 21.491087 ] }, { "distance": 23.635, "name": "NH16", "location": [ 86.84073, 21.433376 ] } ], "code": "Ok" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "3b", "x-server": "core" } }, "/routing/in-shortest/route/v1/{profile}/{coordinates}#distance-api-multiple-points": { "get": { "tags": [ "Route and Journey Intelligence APIs" ], "summary": "Distance API - multiple points", "description": "Returns one leg per consecutive pair of points. The example response is shortened to the first two legs and waypoints.", "operationId": "distanceAPIMultiplePoints", "parameters": [ { "name": "profile", "in": "path", "required": true, "description": "Routing profile. The examples use `car` and `foot`.", "schema": { "type": "string", "example": "foot" }, "example": "foot" }, { "name": "coordinates", "in": "path", "required": true, "description": "Semicolon-separated `lon,lat` pairs. Two pairs = point-to-point; more than two = one leg per consecutive pair.", "schema": { "type": "string", "example": "80.267284,13.0363036;80.267779,13.034928;80.267437,13.03525;80.267291,13.036289;80.251724,13.032119" }, "example": "80.267284,13.0363036;80.267779,13.034928;80.267437,13.03525;80.267291,13.036289;80.251724,13.032119" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "routes": { "type": "array", "items": { "type": "object", "properties": { "weight_name": { "type": "string", "example": "pedestrian", "description": "Name of the cost model used." }, "weight": { "type": "number", "example": 2360.007, "description": "Internal routing cost. Ignore it." }, "duration": { "type": "number", "example": 1668.887, "description": "Total duration, seconds." }, "distance": { "type": "number", "example": 2360.007, "description": "Total distance, metres." }, "legs": { "type": "array", "items": { "type": "object", "properties": { "weight": { "type": "number", "example": 152.966 }, "duration": { "type": "number", "example": 107.976, "description": "Leg duration, seconds." }, "steps": { "type": "array", "items": {} }, "distance": { "type": "number", "example": 152.966, "description": "Leg distance, metres." }, "summary": { "type": "string", "example": "" } } }, "description": "One leg between each pair of consecutive points." }, "geometry": { "type": "string", "example": "qaqnA}f|hNCEISIURCx@Ib@ChBOiBNHHt@n@u@o@IIc@By@HSBHTHRBDBFHJx@f@`Al@vAfANXp@tAZdBT|@x@jBPT`AtALLz@lA?pHDjADjDApA?RCDEHSl@GJBRGv@Ef@ABEdA@XAdAFvAB~@?\\?lAAvAAHElBI|AMjEChCIbDNJbB`AnA|@B@LHMpDtA@", "description": "Route geometry as an encoded polyline." } } }, "description": "The route found." }, "waypoints": { "type": "array", "items": { "type": "object", "properties": { "distance": { "type": "number", "example": 48.114, "description": "Distance from the input point to the snapped position, metres." }, "name": { "type": "string", "example": "Subbarayan Salai", "description": "Road name at the snapped position." }, "location": { "type": "array", "items": { "type": "number", "example": 80.267512 }, "description": "Snapped position, `[longitude, latitude]`." } } }, "description": "Input points snapped to the road network, in input order." }, "code": { "type": "string", "example": "Ok", "description": "`Ok` on success." } } }, "example": { "routes": [ { "weight_name": "pedestrian", "weight": 2360.007, "duration": 1668.887, "distance": 2360.007, "legs": [ { "weight": 152.966, "duration": 107.976, "steps": [], "distance": 152.966, "summary": "" }, { "weight": 107.549, "duration": 75.917, "steps": [], "distance": 107.549, "summary": "" } ], "geometry": "qaqnA}f|hNCEISIURCx@Ib@ChBOiBNHHt@n@u@o@IIc@By@HSBHTHRBDBFHJx@f@`Al@vAfANXp@tAZdBT|@x@jBPT`AtALLz@lA?pHDjADjDApA?RCDEHSl@GJBRGv@Ef@ABEdA@XAdAFvAB~@?\\?lAAvAAHElBI|AMjEChCIbDNJbB`AnA|@B@LHMpDtA@" } ], "waypoints": [ { "distance": 48.114, "name": "Subbarayan Salai", "location": [ 80.267512, 13.035933 ] }, { "distance": 15.645, "name": "RK Mutt Road", "location": [ 80.267922, 13.034948 ] } ], "code": "Ok" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "3b", "x-server": "core" } }, "/routing/adapter/sources_to_targets": { "post": { "tags": [ "Route and Journey Intelligence APIs" ], "summary": "Route Matrix API", "operationId": "routeMatrixAPI", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sources": { "type": "array", "items": { "type": "object", "properties": { "lat": { "type": "number", "example": 19.300572, "description": "Latitude of the point, decimal degrees." }, "lon": { "type": "number", "example": 72.862937, "description": "Longitude of the point, decimal degrees." } } }, "description": "Origins." }, "targets": { "type": "array", "items": { "type": "object", "properties": { "lat": { "type": "number", "example": 19.29073, "description": "Latitude of the point, decimal degrees." }, "lon": { "type": "number", "example": 72.878752, "description": "Longitude of the point, decimal degrees." } } }, "description": "Destinations." }, "costing": { "type": "string", "example": "auto", "description": "Travel mode used for costing. The examples use `auto` (driving) and `pedestrian` (walking)." }, "units": { "type": "string", "example": "km", "description": "Distance unit: `km`." } }, "required": [ "sources", "targets", "costing", "units" ] }, "example": { "sources": [ { "lat": 19.300572, "lon": 72.862937 }, { "lat": 19.297798, "lon": 72.8771 }, { "lat": 19.287935, "lon": 72.868946 } ], "targets": [ { "lat": 19.29073, "lon": 72.878752 }, { "lat": 19.302273, "lon": 72.869868 }, { "lat": 19.289839, "lon": 72.857637 } ], "costing": "auto", "units": "km" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "algorithm": { "type": "string", "example": "costmatrix", "description": "Matrix algorithm used." }, "units": { "type": "string", "example": "kilometers", "description": "Distance unit used in the response." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "lon": { "type": "number", "example": 72.862917 }, "lat": { "type": "number", "example": 19.300587 } } }, "description": "Sources as snapped to the road network." }, "targets": { "type": "array", "items": { "type": "object", "properties": { "lon": { "type": "number", "example": 72.878502 }, "lat": { "type": "number", "example": 19.290924 } } }, "description": "Targets as snapped to the road network." }, "sources_to_targets": { "type": "array", "items": { "type": "array", "items": { "type": "object", "properties": { "distance": { "type": "number", "example": 2.847, "description": "Distance from source to target, in `units`." }, "time": { "type": "integer", "example": 277, "description": "Travel time from source to target, seconds." }, "to_index": { "type": "integer", "example": 0, "description": "Index of the target in your request." }, "from_index": { "type": "integer", "example": 0, "description": "Index of the source in your request." } } } }, "description": "One row per source; each row has one cell per target." } } }, "example": { "algorithm": "costmatrix", "units": "kilometers", "sources": [ { "lon": 72.862917, "lat": 19.300587 }, { "lon": 72.877165, "lat": 19.297887 }, { "lon": 72.868706, "lat": 19.287927 } ], "targets": [ { "lon": 72.878502, "lat": 19.290924 }, { "lon": 72.869882, "lat": 19.302307 }, { "lon": 72.857414, "lat": 19.289787 } ], "sources_to_targets": [ [ { "distance": 2.847, "time": 277, "to_index": 0, "from_index": 0 }, { "distance": 1.287, "time": 145, "to_index": 1, "from_index": 0 }, { "distance": 1.846, "time": 157, "to_index": 2, "from_index": 0 } ], [ { "distance": 1.22, "time": 170, "to_index": 0, "from_index": 1 }, { "distance": 1.441, "time": 161, "to_index": 1, "from_index": 1 }, { "distance": 3.106, "time": 281, "to_index": 2, "from_index": 1 } ], [ { "distance": 1.947, "time": 245, "to_index": 0, "from_index": 2 }, { "distance": 2.626, "time": 291, "to_index": 1, "from_index": 2 }, { "distance": 1.734, "time": 189, "to_index": 2, "from_index": 2 } ] ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "13", "x-server": "core" } }, "/routing/optimize": { "post": { "tags": [ "Route and Journey Intelligence APIs" ], "summary": "Optimal Routes API", "operationId": "optimalRoutesAPI", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "locations": { "type": "array", "items": { "type": "object", "properties": { "lon": { "type": "number", "example": 80.2675007, "description": "Longitude of the point, decimal degrees." }, "lat": { "type": "number", "example": 13.0355685, "description": "Latitude of the point, decimal degrees." } } }, "description": "Stops to visit, in any order. The first stop is the start." }, "costing": { "type": "string", "example": "auto", "description": "Travel mode used for costing. The examples use `auto` (driving) and `pedestrian` (walking)." }, "units": { "type": "string", "example": "km", "description": "Distance unit: `km`." } }, "required": [ "locations", "costing", "units" ] }, "example": { "locations": [ { "lon": 80.2675007, "lat": 13.0355685 }, { "lon": 80.267291, "lat": 13.036289 }, { "lon": 80.267437, "lat": 13.03525 }, { "lon": 80.267779, "lat": 13.034928 }, { "lon": 80.251724, "lat": 13.032119 } ], "costing": "auto", "units": "km" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "trip": { "type": "object", "properties": { "locations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "break" }, "lat": { "type": "number", "example": 13.035568 }, "lon": { "type": "number", "example": 80.2675 }, "side_of_street": { "type": "string", "example": "left", "description": "Side of the street the stop is on." }, "original_index": { "type": "integer", "example": 0, "description": "Position of this stop in your request - use it to map the new order back to your input." } } }, "description": "Stops in the optimized visiting order." }, "legs": { "type": "array", "items": { "type": "object", "properties": { "maneuvers": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "integer", "example": 3 }, "instruction": { "type": "string", "example": "Drive southwest on Subbarayan Salai.", "description": "Human-readable instruction." }, "verbal_succinct_transition_instruction": { "type": "string", "example": "Drive southwest." }, "verbal_pre_transition_instruction": { "type": "string", "example": "Drive southwest on Subbarayan Salai." }, "verbal_post_transition_instruction": { "type": "string", "example": "Continue for 400 meters." }, "street_names": { "type": "array", "items": { "type": "string", "example": "Subbarayan Salai" } }, "time": { "type": "number", "example": 39.918, "description": "Time for this maneuver, seconds." }, "length": { "type": "number", "example": 0.442, "description": "Length of this maneuver, in `units`." }, "cost": { "type": "number", "example": 67.968 }, "begin_shape_index": { "type": "integer", "example": 0 }, "end_shape_index": { "type": "integer", "example": 11 }, "travel_mode": { "type": "string", "example": "drive" }, "travel_type": { "type": "string", "example": "car" } } }, "description": "Turn-by-turn instructions for the leg." }, "summary": { "type": "object", "properties": { "has_time_restrictions": { "type": "boolean", "example": false }, "has_toll": { "type": "boolean", "example": false }, "has_highway": { "type": "boolean", "example": false }, "has_ferry": { "type": "boolean", "example": false }, "min_lat": { "type": "number", "example": 13.029259 }, "min_lon": { "type": "number", "example": 80.263792 }, "max_lat": { "type": "number", "example": 13.0357 }, "max_lon": { "type": "number", "example": 80.268026 }, "time": { "type": "number", "example": 253.396, "description": "Leg travel time, seconds." }, "length": { "type": "number", "example": 1.87, "description": "Leg length, in `units`." }, "cost": { "type": "number", "example": 473.711 } } }, "shape": { "type": "string", "example": "gjszWiacbxCbGtDvSpMlZbUdDlG`NtYzGb_@jF~Q`Q|`@hD`FpS~YhCfCtC}DdI{HnBoCrJ~If]dAhTdArRTjACrJl@b\\fBrhBbQ`B}PXuKb@wVV_NLaGXsHLkZ@_ArAi]j@oT}u@gKqc@cEsZaDiD_@yMeCcJcDq`Aa^{AsDeBiBg~@sLoZiEuFy@eE[wCAcA@wAFsElCsKx@", "description": "Leg geometry as an encoded polyline." } } }, "description": "One leg between each pair of consecutive stops." }, "summary": { "type": "object", "properties": { "has_time_restrictions": { "type": "boolean", "example": false }, "has_toll": { "type": "boolean", "example": false, "description": "`true` when the route uses a toll road." }, "has_highway": { "type": "boolean", "example": false, "description": "`true` when the route uses a highway." }, "has_ferry": { "type": "boolean", "example": false, "description": "`true` when the route uses a ferry." }, "min_lat": { "type": "number", "example": 13.029259 }, "min_lon": { "type": "number", "example": 80.25148 }, "max_lat": { "type": "number", "example": 13.036045 }, "max_lon": { "type": "number", "example": 80.268026 }, "time": { "type": "number", "example": 549.848, "description": "Total travel time, seconds." }, "length": { "type": "number", "example": 4.36, "description": "Total length, in `units`." }, "cost": { "type": "number", "example": 1762.634 } } }, "status_message": { "type": "string", "example": "Found route between points", "description": "Result message." }, "status": { "type": "integer", "example": 0, "description": "`0` when a route was found." }, "units": { "type": "string", "example": "kilometers", "description": "Distance unit used in the response." }, "language": { "type": "string", "example": "en-US", "description": "Language of the instructions." } } } } }, "example": { "trip": { "locations": [ { "type": "break", "lat": 13.035568, "lon": 80.2675, "side_of_street": "left", "original_index": 0 }, { "type": "break", "lat": 13.034928, "lon": 80.267779, "side_of_street": "left", "original_index": 3 }, { "type": "break", "lat": 13.03525, "lon": 80.267437, "side_of_street": "right", "original_index": 2 }, { "type": "break", "lat": 13.036289, "lon": 80.267291, "side_of_street": "right", "original_index": 1 }, { "type": "break", "lat": 13.032119, "lon": 80.251724, "side_of_street": "right", "original_index": 4 } ], "legs": [ { "maneuvers": [ { "type": 3, "instruction": "Drive southwest on Subbarayan Salai.", "verbal_succinct_transition_instruction": "Drive southwest.", "verbal_pre_transition_instruction": "Drive southwest on Subbarayan Salai.", "verbal_post_transition_instruction": "Continue for 400 meters.", "street_names": [ "Subbarayan Salai" ], "time": 39.918, "length": 0.442, "cost": 67.968, "begin_shape_index": 0, "end_shape_index": 11, "travel_mode": "drive", "travel_type": "car" }, { "type": 15, "instruction": "Turn left onto Venkatesa Agraharam Road.", "verbal_transition_alert_instruction": "Turn left onto Venkatesa Agraharam Road.", "verbal_succinct_transition_instruction": "Turn left. Then Turn right onto Sathyani Muthu Street.", "verbal_pre_transition_instruction": "Turn left onto Venkatesa Agraharam Road. Then Turn right onto Sathyani Muthu Street.", "verbal_post_transition_instruction": "Continue for 50 meters.", "street_names": [ "Venkatesa Agraharam Road" ], "time": 11.643, "length": 0.048, "cost": 33.968, "begin_shape_index": 11, "end_shape_index": 14, "verbal_multi_cue": true, "travel_mode": "drive", "travel_type": "car" } ], "summary": { "has_time_restrictions": false, "has_toll": false, "has_highway": false, "has_ferry": false, "min_lat": 13.029259, "min_lon": 80.263792, "max_lat": 13.0357, "max_lon": 80.268026, "time": 253.396, "length": 1.87, "cost": 473.711 }, "shape": "gjszWiacbxCbGtDvSpMlZbUdDlG`NtYzGb_@jF~Q`Q|`@hD`FpS~YhCfCtC}DdI{HnBoCrJ~If]dAhTdArRTjACrJl@b\\fBrhBbQ`B}PXuKb@wVV_NLaGXsHLkZ@_ArAi]j@oT}u@gKqc@cEsZaDiD_@yMeCcJcDq`Aa^{AsDeBiBg~@sLoZiEuFy@eE[wCAcA@wAFsElCsKx@" } ], "summary": { "has_time_restrictions": false, "has_toll": false, "has_highway": false, "has_ferry": false, "min_lat": 13.029259, "min_lon": 80.25148, "max_lat": 13.036045, "max_lon": 80.268026, "time": 549.848, "length": 4.36, "cost": 1762.634 }, "status_message": "Found route between points", "status": 0, "units": "kilometers", "language": "en-US" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "35", "x-server": "core" } }, "/styles/3d/3d.json": { "get": { "tags": [ "Map Visualization" ], "summary": "Map style - 3D", "operationId": "mapStyle3D", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "8", "x-server": "tiles", "servers": [ { "url": "https://map-cdn.sovereignsolutions.tech", "description": "Map style CDN" } ] } }, "/styles/basic/basic.json": { "get": { "tags": [ "Map Visualization" ], "summary": "Map style - Basic", "operationId": "mapStyleBasic", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "8", "x-server": "tiles", "servers": [ { "url": "https://map-cdn.sovereignsolutions.tech", "description": "Map style CDN" } ] } }, "/styles/bright/bright.json": { "get": { "tags": [ "Map Visualization" ], "summary": "Map style - Bright", "operationId": "mapStyleBright", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "8", "x-server": "tiles", "servers": [ { "url": "https://map-cdn.sovereignsolutions.tech", "description": "Map style CDN" } ] } }, "/styles/dark/dark.json": { "get": { "tags": [ "Map Visualization" ], "summary": "Map style - Dark", "operationId": "mapStyleDark", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "8", "x-server": "tiles", "servers": [ { "url": "https://map-cdn.sovereignsolutions.tech", "description": "Map style CDN" } ] } }, "/styles/fiord/fiord.json": { "get": { "tags": [ "Map Visualization" ], "summary": "Map style - Fiord", "operationId": "mapStyleFiord", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "8", "x-server": "tiles", "servers": [ { "url": "https://map-cdn.sovereignsolutions.tech", "description": "Map style CDN" } ] } }, "/styles/liberty/liberty.json": { "get": { "tags": [ "Map Visualization" ], "summary": "Map style - Liberty", "operationId": "mapStyleLiberty", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "8", "x-server": "tiles", "servers": [ { "url": "https://map-cdn.sovereignsolutions.tech", "description": "Map style CDN" } ] } }, "/styles/positron/positron.json": { "get": { "tags": [ "Map Visualization" ], "summary": "Map style - Positron", "operationId": "mapStylePositron", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "8", "x-server": "tiles", "servers": [ { "url": "https://map-cdn.sovereignsolutions.tech", "description": "Map style CDN" } ] } }, "/styles/terrain/terrain.json": { "get": { "tags": [ "Map Visualization" ], "summary": "Map style - Terrain", "operationId": "mapStyleTerrain", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "8", "x-server": "tiles", "servers": [ { "url": "https://map-cdn.sovereignsolutions.tech", "description": "Map style CDN" } ] } }, "/styles/toner/toner.json": { "get": { "tags": [ "Map Visualization" ], "summary": "Map style - Toner", "operationId": "mapStyleToner", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "8", "x-server": "tiles", "servers": [ { "url": "https://map-cdn.sovereignsolutions.tech", "description": "Map style CDN" } ] } }, "/{tenant}/api/app-base/data-layer/{layerName}/layer-detail": { "post": { "tags": [ "Custom Integrations" ], "summary": "Get a layer's field definitions (schema)", "description": "**Read this before writing to the layer.** `properties[]` is the authoritative field list - a create or update body may only use these `propertyName` keys.\n\n- `propertyName`: The key to send in a request body\n- `displayName`: Human label shown in the platform UI - never sent to the API\n- `dataType`: Numeric type code. See [Field data types](/docs/models/data-types) for the codes and the JSON value each expects\n- `required`: `true` means the field must be present on create\n- `isSystem`: Set by the platform. Do not send these, except `Title` and `Description`\n- `isAdditional`: A custom field defined for this tenant\n\nFields of `dataType` `10` (List) also carry their allowed values, or the layer they read from and any dependency on another field - see [Field data types](/docs/models/data-types).", "operationId": "getALayerSFieldDefinitionsSchema", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "layerName", "in": "path", "required": true, "description": "Data layer name", "schema": { "type": "string", "example": "SAMPLE_DATA" }, "example": "SAMPLE_DATA", "examples": { "SAMPLE_DATA": { "summary": "SAMPLE_DATA", "value": "SAMPLE_DATA" }, "CUSTOMER": { "summary": "CUSTOMER", "value": "CUSTOMER" }, "PRODUCT": { "summary": "PRODUCT", "value": "PRODUCT" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "properties": { "type": "object", "properties": { "layerSettings": { "type": "boolean", "example": true }, "isTakeAll": { "type": "boolean", "example": true } } } }, "required": [ "properties" ] }, "example": { "properties": { "layerSettings": true, "isTakeAll": true } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "layerName": { "type": "string", "example": "SAMPLE_DATA", "description": "Layer the schema belongs to." }, "version": { "type": "integer", "example": 8, "description": "Schema version. It increases every time the layer definition is changed - compare it to detect that your integration is reading an outdated field list." }, "properties": { "type": "array", "items": { "type": "object", "properties": { "propertyName": { "type": "string", "example": "sample_data_invoice_number" }, "displayName": { "type": "string", "example": "Invoice number" }, "dataType": { "type": "integer", "example": 3 }, "required": { "type": "boolean", "example": false }, "isSystem": { "type": "boolean", "example": false }, "isAdditional": { "type": "boolean", "example": true } } }, "description": "One entry per field on the layer. This is the list of keys a create or update body may use." }, "layerSettings": { "type": "object", "properties": {}, "description": "Layer-level configuration, returned when `layerSettings: true` is requested." } } }, "example": { "layerName": "SAMPLE_DATA", "version": 8, "properties": [ { "propertyName": "sample_data_invoice_number", "displayName": "Invoice number", "dataType": 3, "required": false, "isSystem": false, "isAdditional": true }, { "propertyName": "sample_data_option", "displayName": "Option", "dataType": 10, "required": false, "isSystem": false, "isAdditional": true } ], "layerSettings": {} } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "39/41a/41b" } }, "/{tenant}/api/app-base/data-layer/{layerName}": { "post": { "tags": [ "Custom Integrations" ], "summary": "Create a record", "description": "**How to build the body for your own layer**\n\nThe body is a flat JSON object keyed by `propertyName`. Call `layer-detail` on the layer first and send the properties it lists - anything else is ignored. Every value must respect the field's declared [data type](/docs/models/data-types). The example above is the demo `SAMPLE_DATA` layer.\n\nSee [Field data types](/docs/models/data-types) for the `dataType` codes, the JSON value each one expects, and how list fields and their dependency chains work.\n\n**Do not send system fields.** `Id`, `CreatedDate`, `CreatedUser`, `ModifiedDate`, `ModifiedUser` and the `*_created_from` / `*_last_modified_from` markers are set by the platform. `Title` and `Description` are system fields you *may* set - `Title` is the record's display label.\n\n**Validators declared on a field are enforced.** On `SAMPLE_DATA`, `sample_data_mobile_number` must be 8-12 characters.\n\nNo field on `SAMPLE_DATA` is mandatory, so a create call with only `Title` succeeds - but a layer of your own may declare required fields, which `layer-detail` reports as `required: true`.", "operationId": "createARecord", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "layerName", "in": "path", "required": true, "description": "Layer the new record is created in. The body must use that layer's field names", "schema": { "type": "string", "example": "SAMPLE_DATA" }, "example": "SAMPLE_DATA", "examples": { "SAMPLE_DATA": { "summary": "SAMPLE_DATA", "value": "SAMPLE_DATA" }, "CUSTOMER": { "summary": "CUSTOMER", "value": "CUSTOMER" }, "PRODUCT": { "summary": "PRODUCT", "value": "PRODUCT" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Title": { "type": "string", "example": "INV-2026-0042" }, "Description": { "type": "string", "example": "Record created through the API" }, "sample_data_date": { "type": "string", "example": "2026-09-07T09:30:00Z" }, "sample_data_invoice_number": { "type": "string", "example": "INV-2026-0042" }, "sample_data_customer_address": { "type": "string", "example": "12 MG Road, Pune, MAHARASHTRA - 411001" }, "sample_data_mobile_number": { "type": "string", "example": "919000000042" }, "sample_data_geocode": { "type": "string", "example": "{\"type\":\"Point\",\"coordinates\":[73.8567,18.5204]}" }, "sample_data_option": { "type": "string", "example": "1" }, "sample_data_state": { "type": "string", "example": "13" }, "sample_data_district": { "type": "string", "example": "267" }, "sample_data_sub_district": { "type": "string", "example": "01823" }, "sample_data_remarks": { "type": "string", "example": "Created from the API reference example" } }, "required": [ "Title", "Description", "sample_data_date", "sample_data_invoice_number", "sample_data_customer_address", "sample_data_mobile_number", "sample_data_geocode", "sample_data_option", "sample_data_state", "sample_data_district", "sample_data_sub_district", "sample_data_remarks" ] }, "examples": { "Default": { "summary": "Default", "value": { "Title": "INV-2026-0042", "Description": "Record created through the API", "sample_data_date": "2026-09-07T09:30:00Z", "sample_data_invoice_number": "INV-2026-0042", "sample_data_customer_address": "12 MG Road, Pune, MAHARASHTRA - 411001", "sample_data_mobile_number": "919000000042", "sample_data_geocode": "{\"type\":\"Point\",\"coordinates\":[73.8567,18.5204]}", "sample_data_option": "1", "sample_data_state": "13", "sample_data_district": "267", "sample_data_sub_district": "01823", "sample_data_remarks": "Created from the API reference example" } }, "SAMPLE_DATA layer": { "summary": "SAMPLE_DATA layer", "value": { "Title": "INV-2026-0042", "Description": "Record created through the API", "sample_data_date": "2026-09-07T09:30:00Z", "sample_data_invoice_number": "INV-2026-0042", "sample_data_customer_address": "12 MG Road, Pune, MAHARASHTRA - 411001", "sample_data_mobile_number": "919000000042", "sample_data_geocode": "{\"type\":\"Point\",\"coordinates\":[73.8567,18.5204]}", "sample_data_option": "1", "sample_data_state": "13", "sample_data_district": "267", "sample_data_sub_district": "01823", "sample_data_remarks": "Created from the API reference example" } }, "SAMPLE_DATA layer - minimum": { "summary": "SAMPLE_DATA layer - minimum", "value": { "Title": "INV-2026-0043", "sample_data_invoice_number": "INV-2026-0043" } }, "CUSTOMER layer": { "summary": "CUSTOMER layer", "value": { "customer_full_name": "Sample Record", "customer_phone_number": "919000000001", "customer_email": "user@example.com", "customer_category": "Default", "customer_postal_code": "412108", "customer_address": "Mulshi, Pune, MAHARASHTRA - 412108", "customer_location": "{\"coordinates\":[73.55986487231496,18.462925230845542],\"type\":\"Point\"}", "customer_is_active": "true" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "string", "example": "00000000-0000-0000-0000-000000000001", "description": "Identifier of the record just created. Keep it - update, detail and delete all address the record by this value." }, "Layer": { "type": "string", "example": "SAMPLE_DATA", "description": "Layer the record was written to, echoing the `layerName` in the path." }, "Title": { "type": "string", "example": "INV-2026-0042", "description": "Display label of the record." }, "CreatedDate": { "type": "string", "example": "2026-09-07T09:30:12Z", "description": "Server timestamp of the creation, in UTC." }, "CreatedUser": { "type": "string", "example": "", "description": "Username of the account whose token made the call." }, "sample_data_invoice_number": { "type": "string", "example": "INV-2026-0042", "description": "Example of a custom field, returned with the value you sent." }, "sample_data_created_from": { "type": "integer", "example": 3, "description": "Channel the record originated from, set by the platform: `1` Mobile, `2` Web, `3` Others. API calls get `3`." } } }, "example": { "Id": "00000000-0000-0000-0000-000000000001", "Layer": "SAMPLE_DATA", "Title": "INV-2026-0042", "CreatedDate": "2026-09-07T09:30:12Z", "CreatedUser": "", "sample_data_invoice_number": "INV-2026-0042", "sample_data_created_from": 3 } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "39/41a/41b" } }, "/{tenant}/api/app-base/data-layer/{layerName}/search": { "post": { "tags": [ "Custom Integrations" ], "summary": "Search records", "operationId": "searchRecords", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "layerName", "in": "path", "required": true, "description": "Data layer name", "schema": { "type": "string", "example": "SAMPLE_DATA" }, "example": "SAMPLE_DATA", "examples": { "SAMPLE_DATA": { "summary": "SAMPLE_DATA", "value": "SAMPLE_DATA" }, "CUSTOMER": { "summary": "CUSTOMER", "value": "CUSTOMER" }, "PRODUCT": { "summary": "PRODUCT", "value": "PRODUCT" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "skip": { "type": "integer", "example": 0, "description": "Paging - number of records to skip before the page starts. `0` is the first page." }, "take": { "type": "integer", "example": 20, "description": "Paging - maximum number of records to return in this page. `-1` returns every match, which is only safe on small layers. Compare against `total` in the response to know when you have read everything." } }, "required": [ "skip", "take" ] }, "example": { "skip": 0, "take": 20 } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "example": "00000000-0000-0000-0000-000000000001" }, "Layer": { "type": "string", "example": "CUSTOMER" }, "Path": { "type": "string", "example": "/…" }, "CreatedDate": { "type": "string", "example": "2026-07-15T11:15:45Z" }, "CreatedUser": { "type": "string", "example": "admin_apidemo" }, "Title": { "type": "string", "example": "Sample Record" }, "customer_full_name": { "type": "string", "example": "Sample Record" }, "customer_phone_number": { "type": "string", "example": "919000000001" } } }, "description": "The page of matching records. Each entry carries the layer's own fields plus the system fields every record has." }, "total": { "type": "integer", "example": 1, "description": "Total number of records matching the query, ignoring `skip` and `take` - use it to drive paging." } } }, "example": { "data": [ { "Id": "00000000-0000-0000-0000-000000000001", "Layer": "CUSTOMER", "Path": "/…", "CreatedDate": "2026-07-15T11:15:45Z", "CreatedUser": "admin_apidemo", "Title": "Sample Record", "customer_full_name": "Sample Record", "customer_phone_number": "919000000001" } ], "total": 1 } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "39/41a/41b" } }, "/{tenant}/api/app-base/data-layer/{layerName}/{id}": { "put": { "tags": [ "Custom Integrations" ], "summary": "Update a record", "description": "**The update response is not shaped like search or detail.** It returns the internal node record, so it carries platform fields (`NodeId`, `ParentId`, `Name`, `Path`, `ParentIdPath`, `MimeType`) that no other endpoint uses and that you should ignore. Call `{id}/detail` afterwards if you need the record in its normal shape.\n\n**Only the fields you sent come back changed.** `LayerData` and `Properties` list exactly what this call wrote; untouched fields are not echoed. To confirm the full record, read it back with `{id}/detail`.\n\n**Only keys defined on the layer are stored.** A key outside the layer's schema is echoed at the top level of the response but not persisted - it will not appear in `LayerData`, `Properties`, or any later read. Check `LayerData` to confirm which fields the update actually wrote.\n\n**`Modified` reflects the record's creation, not this update** - it can come back equal to `Created`. Use `LayerData` rather than `Modified` to confirm a write took effect.\n\n**Several system fields come back `null`** (`Title`, `Description`, `Type`, `Status`, `Template`, `Content`) whenever the update did not set them.", "operationId": "updateARecord", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "layerName", "in": "path", "required": true, "description": "Layer holding the record to update", "schema": { "type": "string", "example": "SAMPLE_DATA" }, "example": "SAMPLE_DATA", "examples": { "SAMPLE_DATA": { "summary": "SAMPLE_DATA", "value": "SAMPLE_DATA" }, "CUSTOMER": { "summary": "CUSTOMER", "value": "CUSTOMER" }, "PRODUCT": { "summary": "PRODUCT", "value": "PRODUCT" } } }, { "name": "id", "in": "path", "required": true, "description": "`Id` of the record to update", "schema": { "type": "string", "example": "cd8588a9-52ff-4817-881e-e6a801ff4eb5" }, "example": "cd8588a9-52ff-4817-881e-e6a801ff4eb5" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sample_data_remarks": { "type": "string", "example": "Updated remark" } }, "required": [ "sample_data_remarks" ] }, "example": { "sample_data_remarks": "Updated remark" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "string", "example": "cd8588a9-52ff-4817-881e-e6a801ff4eb5", "description": "The record you updated - same value you sent in the path." }, "id": { "type": "string", "example": "cd8588a9-52ff-4817-881e-e6a801ff4eb5", "description": "Duplicate of `Id` in lower case. Read either one; they always carry the same value." }, "Layer": { "type": "string", "example": "ZFLCFX_SAMPLE_DATA", "description": "Internal layer name: your tenant's system code plus the layer name. Search and detail return the plain layer name instead." }, "Name": { "type": "string", "example": "f7b9ed17-9206-4ded-a1b5-45e3bc8ffcf9", "description": "Internal node name of the record. Not the `Id`, and not used by any other endpoint." }, "Title": { "type": "string", "example": null, "description": "Display label. `null` unless the record has one - an update that does not touch `Title` leaves it as is." }, "Description": { "type": "string", "example": null }, "Created": { "type": "string", "example": "2026-09-08T03:45:47.479Z", "description": "When the record was created, UTC." }, "Creator": { "type": "string", "example": "apidemo_sovereignsolutions", "description": "Account that created the record." }, "Modified": { "type": "string", "example": "2026-09-08T03:45:47.479Z", "description": "When this update was applied, UTC." }, "Modifier": { "type": "string", "example": "apidemo_sovereignsolutions", "description": "Account whose token made this call." }, "Path": { "type": "string", "example": "/", "description": "Internal storage location. Read-only, and of no use to an integration." }, "ParentIdPath": { "type": "string", "example": "/2/6025/6053/99689425", "description": "Internal hierarchy path of numeric node IDs. Read-only." }, "NodeId": { "type": "integer", "example": 99772164, "description": "Internal numeric node ID. Read-only." }, "ParentId": { "type": "integer", "example": 99689425, "description": "Internal numeric ID of the parent node. Read-only." }, "LayerData": { "type": "object", "properties": { "sample_data_remarks": { "type": "string", "example": "Updated remark" }, "sample_data_last_modified_from": { "type": "string", "example": "2" } }, "description": "The fields this call actually wrote, keyed by `propertyName`, including the `*_last_modified_from` marker the platform sets itself. Values are returned as strings here, whatever the field type." }, "Properties": { "type": "array", "items": { "type": "object", "properties": { "Name": { "type": "string", "example": "sample_data_remarks" }, "DisplayName": { "type": "string", "example": null }, "Value": { "type": "string", "example": "Updated remark" }, "DataType": { "type": "integer", "example": 3 }, "Format": { "type": "string", "example": null } } }, "description": "The same changed fields in expanded form, each with its `DataType`. See [Field data types](/docs/models/data-types)." }, "sample_data_last_modified_from": { "type": "integer", "example": 2, "description": "Channel of the last change, set by the platform: `1` Mobile, `2` Web, `3` Others." } } }, "example": { "Id": "cd8588a9-52ff-4817-881e-e6a801ff4eb5", "id": "cd8588a9-52ff-4817-881e-e6a801ff4eb5", "Layer": "ZFLCFX_SAMPLE_DATA", "Name": "f7b9ed17-9206-4ded-a1b5-45e3bc8ffcf9", "Title": null, "Description": null, "Created": "2026-09-08T03:45:47.479Z", "Creator": "apidemo_sovereignsolutions", "Modified": "2026-09-08T03:45:47.479Z", "Modifier": "apidemo_sovereignsolutions", "Path": "/", "ParentIdPath": "/2/6025/6053/99689425", "NodeId": 99772164, "ParentId": 99689425, "LayerData": { "sample_data_remarks": "Updated remark", "sample_data_last_modified_from": "2" }, "Properties": [ { "Name": "sample_data_remarks", "DisplayName": null, "Value": "Updated remark", "DataType": 3, "Format": null }, { "Name": "sample_data_last_modified_from", "DisplayName": null, "Value": "2", "DataType": 10, "Format": null } ], "sample_data_last_modified_from": 2 } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "39/41a/41b" }, "delete": { "tags": [ "Custom Integrations" ], "summary": "Delete a record", "operationId": "deleteARecord", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "layerName", "in": "path", "required": true, "description": "Layer holding the record to delete", "schema": { "type": "string", "example": "SAMPLE_DATA" }, "example": "SAMPLE_DATA", "examples": { "SAMPLE_DATA": { "summary": "SAMPLE_DATA", "value": "SAMPLE_DATA" }, "CUSTOMER": { "summary": "CUSTOMER", "value": "CUSTOMER" }, "PRODUCT": { "summary": "PRODUCT", "value": "PRODUCT" } } }, { "name": "id", "in": "path", "required": true, "description": "`Id` of the record to delete, as returned by search or create", "schema": { "type": "string", "example": "00000000-0000-0000-0000-000000000001" }, "example": "00000000-0000-0000-0000-000000000001" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 1, "description": "Number of records actually deleted. `1` = the record was found and removed, `0` = nothing matched the ID. The call returns `200 OK` either way, so check this value to confirm the delete." } } }, "example": { "count": 1 } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "39/41a/41b" } }, "/{tenant}/api/app-base/data-layer/{layerName}/{id}/detail": { "get": { "tags": [ "Custom Integrations" ], "summary": "Get a single record with all its values", "operationId": "getASingleRecordWithAllItsValues", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "layerName", "in": "path", "required": true, "description": "Data layer name", "schema": { "type": "string", "example": "SAMPLE_DATA" }, "example": "SAMPLE_DATA", "examples": { "SAMPLE_DATA": { "summary": "SAMPLE_DATA", "value": "SAMPLE_DATA" }, "CUSTOMER": { "summary": "CUSTOMER", "value": "CUSTOMER" }, "PRODUCT": { "summary": "PRODUCT", "value": "PRODUCT" } } }, { "name": "id", "in": "path", "required": true, "description": "Record ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "string", "example": "", "description": "Record identifier, the value to pass to update and delete." }, "Layer": { "type": "string", "example": "PRODUCT", "description": "Layer the record belongs to." }, "Path": { "type": "string", "example": "/…", "description": "Internal storage location. Read-only." }, "CreatedDate": { "type": "string", "example": "2026-07-15T11:15:45Z", "description": "When the record was created, UTC." }, "CreatedUser": { "type": "string", "example": "", "description": "Account that created it." }, "ModifiedDate": { "type": "string", "example": "2026-07-15T11:15:45Z", "description": "When the record was last changed, UTC." }, "ModifiedUser": { "type": "string", "example": "", "description": "Account that last changed it." }, "Title": { "type": "string", "example": "", "description": "Display label of the record." }, "product_name": { "type": "string", "example": "<value>" } } }, "example": { "Id": "<uuid>", "Layer": "PRODUCT", "Path": "/…", "CreatedDate": "2026-07-15T11:15:45Z", "CreatedUser": "<user>", "ModifiedDate": "2026-07-15T11:15:45Z", "ModifiedUser": "<user>", "Title": "<title>", "product_name": "<value>" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "39/41a/41b" } }, "/{tenant}/employee/create": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Employee - Create an employee", "description": "**What you get back**\n\nThe record is returned inside a `result` / `data` / `resultId` envelope. Two identifiers in `data` you will need later:\n\n- `employee_guid` (What it is: Account identifier, Where you use it: Enable and disable calls (`/employee/enable/{employee_guid}`))\n- `Id` (What it is: Record identifier (UUID), Where you use it: Reading detail (`/employee/detail/{id}`))", "operationId": "employeeCreateAnEmployee", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employee_username": { "type": "string", "example": "apidemo_newuser_9" }, "employee_full_name": { "type": "string", "example": "Demo User 9" }, "employee_email": { "type": "string", "example": "user@example.com" }, "employee_phone": { "type": "string", "example": "919800000009" }, "employee_dob": { "type": "string", "example": "1995-04-17" }, "employee_role": { "type": "string", "example": "Worker" }, "employee_organization_id": { "type": "string", "example": "1" }, "employee_team_id": { "type": "string", "example": "2" }, "employee_reporting_manager": { "type": "string", "example": "your_username" }, "config": { "type": "object", "properties": { "isValueDataType": { "type": "boolean", "example": true }, "createAccount": { "type": "boolean", "example": true } } } }, "required": [ "employee_username", "employee_full_name", "employee_email", "employee_phone", "employee_dob", "employee_role", "employee_organization_id", "employee_team_id", "employee_reporting_manager", "config" ] }, "example": { "employee_username": "apidemo_newuser_9", "employee_full_name": "Demo User 9", "employee_email": "user@example.com", "employee_phone": "919800000009", "employee_dob": "1995-04-17", "employee_role": "Worker", "employee_organization_id": "1", "employee_team_id": "2", "employee_reporting_manager": "your_username", "config": { "isValueDataType": true, "createAccount": true } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "integer", "example": 0, "description": "Status of the call. `0` means it succeeded." }, "data": { "type": "object", "properties": { "employee_guid": { "type": "string", "example": "6ab33224bba47a219f950da5", "description": "Business identifier of the employee - the value the enable and disable calls take in the path." }, "Id": { "type": "string", "example": "a5a78d42-3c18-4c34-b80d-e3046fa8fc0e", "description": "Record ID in the `EMPLOYEE` layer - the value `GET /employee/detail/{id}` takes." }, "employee_full_name": { "type": "string", "example": "Demo User 9" }, "employee_email": { "type": "string", "example": "user@example.com" }, "employee_phone": { "type": "string", "example": "919800000009" }, "employee_team_id": { "type": "string", "example": "2" }, "employee_username": { "type": "string", "example": "apidemo_newuser_9" }, "employee_organization_id": { "type": "string", "example": "1" }, "employee_status": { "type": "string", "example": "3", "description": "Lifecycle state as a numeric code: `1` New, `2` Inactive, `3` Active, `4` Disable." }, "employee_dob": { "type": "string", "example": "1995-04-17" }, "employee_role": { "type": "string", "example": "Worker", "description": "Role code, as sent." }, "employee_reporting_manager": { "type": "string", "example": "apidemo_sovereignsolutions" }, "employee_created_from": { "type": "integer", "example": 3, "description": "Channel that created the record, set by the platform: `1` Mobile, `2` Web, `3` Others." }, "employee_last_modified_from": { "type": "integer", "example": 3, "description": "Channel of the last change, set by the platform: `1` Mobile, `2` Web, `3` Others." }, "Title": { "type": "string", "example": "Demo User 9", "description": "Display label of the record, kept in step with the full name." }, "Path": { "type": "string", "example": "/<internal storage path>", "description": "Internal storage location. Read-only." } }, "description": "The employee as created." }, "resultId": { "type": "string", "example": "LJ2j18NYmQ", "description": "Correlation ID for this call. Quote it when reporting a problem to support." } } }, "example": { "result": 0, "data": { "employee_guid": "6ab33224bba47a219f950da5", "Id": "a5a78d42-3c18-4c34-b80d-e3046fa8fc0e", "employee_full_name": "Demo User 9", "employee_email": "user@example.com", "employee_phone": "919800000009", "employee_team_id": "2", "employee_username": "apidemo_newuser_9", "employee_organization_id": "1", "employee_status": "3", "employee_dob": "1995-04-17", "employee_role": "Worker", "employee_reporting_manager": "apidemo_sovereignsolutions", "employee_created_from": 3, "employee_last_modified_from": 3, "Title": "Demo User 9", "Path": "/<internal storage path>" }, "resultId": "LJ2j18NYmQ" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "46" } }, "/{tenant}/employee/detail/{id}": { "get": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Employee - Get employee detail", "description": "Returns every `employee_*` field, including any left unset as `null` - use this call to read the full current state of an employee.\n\n`employee_status`, `employee_team_id` and `employee_organization_id` are numeric codes here, the same form a write expects (see [Employee](/docs/models/employee) for the code-to-label mapping). The search and partial update responses return these as labels/names instead.", "operationId": "employeeGetEmployeeDetail", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "id", "in": "path", "required": true, "description": "Employee record `Id` (not `employee_guid`)", "schema": { "type": "string", "example": "6c6009a2-3be2-498f-9f25-00a1ab142b25" }, "example": "6c6009a2-3be2-498f-9f25-00a1ab142b25" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "string", "example": "6c6009a2-3be2-498f-9f25-00a1ab142b25", "description": "Record ID of the employee in the `EMPLOYEE` layer." }, "NodeId": { "type": "string", "example": "6c6009a2-3be2-498f-9f25-00a1ab142b25", "description": "Same value as `Id` on this endpoint." }, "Name": { "type": "string", "example": "8267ec96-2ede-405b-954c-28c25ae53431", "description": "Internal node name. Not an identifier any endpoint accepts." }, "Title": { "type": "string", "example": "Demo User 2", "description": "Display label, kept in step with the full name." }, "Description": { "type": "string", "example": null, "description": "Free-text description. `null` unless set." }, "employee_guid": { "type": "string", "example": "6a9bacffc5f4802e0abf1870", "description": "Business identifier of the employee - the value the enable and disable calls take in the path." }, "employee_username": { "type": "string", "example": "apidemo_newuser_2", "description": "Login name. Other records reference the employee by this value." }, "employee_full_name": { "type": "string", "example": "Demo User 2", "description": "Full name." }, "employee_email": { "type": "string", "example": "user@example.com", "description": "Email address." }, "employee_phone": { "type": "string", "example": "919000000002", "description": "Phone number." }, "employee_dob": { "type": "string", "example": "1995-04-17T00:00:00.000Z", "description": "Date of birth, returned as a full UTC timestamp." }, "employee_role": { "type": "string", "example": "Worker", "description": "Role code - the same value accepted on input (e.g. `Worker`). See [Employee](/docs/models/employee)." }, "employee_status": { "type": "string", "example": "4", "description": "Lifecycle state as a **numeric code**: `1` New, `2` Inactive, `3` Active, `4` Disable." }, "employee_team_id": { "type": "string", "example": "2", "description": "Numeric team ID - the value to send back on a write." }, "employee_organization_id": { "type": "string", "example": "1", "description": "Numeric organization ID." }, "employee_reporting_manager": { "type": "string", "example": "apidemo_sovereignsolutions", "description": "Username of the manager this employee reports to." }, "employee_code": { "type": "string", "example": null, "description": "Optional payroll or HR code. `null` unless your tenant uses it." }, "employee_type_id": { "type": "string", "example": null, "description": "Optional employee type. `null` unless your tenant uses it." }, "employee_vehicle_id": { "type": "string", "example": null, "description": "Vehicle assigned to the employee. `null` unless set." }, "employee_image": { "type": "string", "example": null, "description": "Profile photo. `null` unless set." }, "Path": { "type": "string", "example": "/<internal storage path>", "description": "Internal storage location. Read-only." }, "CreatedDate": { "type": "string", "example": "2026-09-05T05:47:43.296Z", "description": "When the employee was created, UTC." }, "CreatedUser": { "type": "string", "example": "apidemo_sovereignsolutions", "description": "Account that created the employee." }, "CreatedUserId": { "type": "integer", "example": 19536, "description": "Numeric ID of the account that created the employee." }, "ModifiedDate": { "type": "string", "example": "2026-09-22T11:00:15.340Z", "description": "When the employee was last changed, UTC." }, "ModifiedUser": { "type": "string", "example": "apidemo_sovereignsolutions", "description": "Account that last changed the employee." }, "ModifiedUserId": { "type": "integer", "example": 19561, "description": "Numeric ID of the account that last changed the employee." }, "DynamicProperties": { "type": "string", "example": null, "description": "Reserved. `null` in normal use." } } }, "example": { "Id": "6c6009a2-3be2-498f-9f25-00a1ab142b25", "NodeId": "6c6009a2-3be2-498f-9f25-00a1ab142b25", "Name": "8267ec96-2ede-405b-954c-28c25ae53431", "Title": "Demo User 2", "Description": null, "employee_guid": "6a9bacffc5f4802e0abf1870", "employee_username": "apidemo_newuser_2", "employee_full_name": "Demo User 2", "employee_email": "user@example.com", "employee_phone": "919000000002", "employee_dob": "1995-04-17T00:00:00.000Z", "employee_role": "Worker", "employee_status": "4", "employee_team_id": "2", "employee_organization_id": "1", "employee_reporting_manager": "apidemo_sovereignsolutions", "employee_code": null, "employee_type_id": null, "employee_vehicle_id": null, "employee_image": null, "Path": "/<internal storage path>", "CreatedDate": "2026-09-05T05:47:43.296Z", "CreatedUser": "apidemo_sovereignsolutions", "CreatedUserId": 19536, "ModifiedDate": "2026-09-22T11:00:15.340Z", "ModifiedUser": "apidemo_sovereignsolutions", "ModifiedUserId": 19561, "DynamicProperties": null } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "46" } }, "/{tenant}/employee/search": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Employee - Search employees in a team", "operationId": "employeeSearchEmployeesInATeam", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "hierarchyPath", "in": "query", "required": false, "description": "Team hierarchy path, `/<tenant>/<team>`", "schema": { "type": "string", "example": "/demo/sovereignsolutions" }, "example": "/demo/sovereignsolutions" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "isInTree": { "type": "boolean", "example": false }, "skip": { "type": "integer", "example": 0, "description": "Paging - number of records to skip before the page starts. `0` is the first page." }, "take": { "type": "integer", "example": 20, "description": "Paging - maximum number of records to return in this page. `-1` returns every match, which is only safe on small layers. Compare against `total` in the response to know when you have read everything." } }, "required": [ "isInTree", "skip", "take" ] }, "example": { "isInTree": false, "skip": 0, "take": 20 } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "example": "a5a78d42-3c18-4c34-b80d-e3046fa8fc0e", "description": "Record ID in the `EMPLOYEE` layer." }, "Layer": { "type": "string", "example": "EMPLOYEE", "description": "Layer the record lives in, always `EMPLOYEE`." }, "Path": { "type": "string", "example": "/<internal storage path>", "description": "Internal storage location. Read-only." }, "ParentPath": { "type": "string", "example": "/<internal storage path>", "description": "Internal storage location of the parent node. Read-only." }, "CreatedDate": { "type": "string", "example": "2026-09-23T01:57:56Z", "description": "When the employee was created, UTC." }, "CreatedUser": { "type": "string", "example": "apidemo_sovereignsolutions", "description": "Account that created the employee." }, "ModifiedDate": { "type": "string", "example": "2026-09-23T01:58:12Z", "description": "When the employee was last changed, UTC." }, "ModifiedUser": { "type": "string", "example": "apidemo_sovereignsolutions", "description": "Account that last changed the employee." }, "Title": { "type": "string", "example": "Demo User 9", "description": "Display label of the record, kept in step with the full name." }, "employee_full_name": { "type": "string", "example": "Demo User 9" }, "employee_email": { "type": "string", "example": "user@example.com" }, "employee_phone": { "type": "string", "example": "919800000009" }, "employee_dob": { "type": "string", "example": "1995-04-17T00:00:00Z", "description": "Date of birth, returned as a full UTC timestamp." }, "employee_team_id__keyfield": { "type": "string", "example": "2", "description": "The numeric team ID behind `employee_team_id`. This is the value to send back on a write." }, "employee_team_id": { "type": "string", "example": "SovereignSolutions", "description": "Team **name**, not the numeric ID." }, "employee_username": { "type": "string", "example": "apidemo_newuser_9", "description": "Login name." }, "employee_status": { "type": "string", "example": "Active", "description": "Lifecycle state as a **label**: `New`, `Inactive`, `Active` or `Disable`." }, "employee_guid": { "type": "string", "example": "6ab33224bba47a219f950da5", "description": "Business identifier of the employee." }, "employee_role": { "type": "string", "example": "Team Member", "description": "Display label of the role, not the code accepted on input - `Worker` comes back as `Team Member`." }, "employee_organization_id": { "type": "string", "example": "demo", "description": "Organization **name**, not the numeric ID." }, "employee_reporting_manager": { "type": "string", "example": "apidemo_sovereignsolutions", "description": "Username of the manager this employee reports to." } } }, "description": "Matching employees, one page." }, "total": { "type": "integer", "example": 15, "description": "Total number of matches, across all pages." } } }, "example": { "data": [ { "Id": "a5a78d42-3c18-4c34-b80d-e3046fa8fc0e", "Layer": "EMPLOYEE", "Path": "/<internal storage path>", "ParentPath": "/<internal storage path>", "CreatedDate": "2026-09-23T01:57:56Z", "CreatedUser": "apidemo_sovereignsolutions", "ModifiedDate": "2026-09-23T01:58:12Z", "ModifiedUser": "apidemo_sovereignsolutions", "Title": "Demo User 9", "employee_full_name": "Demo User 9", "employee_email": "user@example.com", "employee_phone": "919800000009", "employee_dob": "1995-04-17T00:00:00Z", "employee_team_id__keyfield": "2", "employee_team_id": "SovereignSolutions", "employee_username": "apidemo_newuser_9", "employee_status": "Active", "employee_guid": "6ab33224bba47a219f950da5", "employee_role": "Team Member", "employee_organization_id": "demo", "employee_reporting_manager": "apidemo_sovereignsolutions" } ], "total": 15 } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "46" } }, "/{tenant}/employee/disable/{employee_guid}": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Employee - Disable an employee", "description": "**The response is streamed as two JSON objects, sent one after the other** in the same `200 OK` body - not wrapped in an array. Message 1 confirms the account was disabled (`data: true`). Message 2 carries the employee node after the change, with `data.employee_status` now `4`. Read the body until both objects have arrived; a client that parses the whole body as a single JSON document will fail.\n\nThe employee keeps their record and history - disabling only blocks the account. Re-enable with the `/employee/enable` endpoint.", "operationId": "employeeDisableAnEmployee", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "employee_guid", "in": "path", "required": true, "description": "GUID of the employee to disable", "schema": { "type": "string", "example": "6ab33224bba47a219f950da5" }, "example": "6ab33224bba47a219f950da5" } ], "responses": { "200": { "description": "Successful response, streamed as 2 consecutive JSON objects in one body", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "result": { "type": "integer", "example": 0, "description": "Status of the call. `0` means it succeeded." }, "data": { "type": "boolean", "example": true, "description": "`true` when the employee was disabled." }, "resultId": { "type": "string", "example": "H6733QoVCK", "description": "Correlation ID for this call. Quote it when reporting a problem to support." } } }, { "type": "object", "properties": { "result": { "type": "integer", "example": 0, "description": "Status of the call. `0` means it succeeded." }, "data": { "type": "object", "properties": { "employee_guid": { "type": "string", "example": "6ab33224bba47a219f950da5", "description": "The employee you disabled - the same GUID you sent in the path." }, "Id": { "type": "string", "example": "a5a78d42-3c18-4c34-b80d-e3046fa8fc0e", "description": "Record ID in the `EMPLOYEE` layer." }, "employee_status": { "type": "string", "example": "4", "description": "New lifecycle state as a numeric code - `4` (Disable) after a successful disable." }, "employee_last_modified_from": { "type": "integer", "example": 2, "description": "Channel of this change, set by the platform: `1` Mobile, `2` Web, `3` Others." }, "LayerData": { "type": "object", "properties": { "employee_guid": { "type": "string", "example": "6ab33224bba47a219f950da5" }, "employee_status": { "type": "string", "example": "4" } }, "description": "Only the fields this call changed, keyed by field name." }, "Type": { "type": "string", "example": null }, "NodeId": { "type": "integer", "example": 100195153, "description": "Internal numeric node ID. Not an identifier any endpoint accepts." }, "ParentId": { "type": "integer", "example": 99689425, "description": "Internal numeric ID of the parent node." }, "Name": { "type": "string", "example": "26f14f46-696d-4537-a5b4-1237804feadf", "description": "Internal node name." }, "Title": { "type": "string", "example": null }, "Description": { "type": "string", "example": null }, "Created": { "type": "string", "example": "2026-09-23T01:57:56.97Z", "description": "When the employee was created, UTC." }, "Creator": { "type": "string", "example": "apidemo_sovereignsolutions", "description": "Account that created the employee." }, "CreatorId": { "type": "integer", "example": 19561, "description": "Numeric ID of the account that created the employee." }, "Modified": { "type": "string", "example": "2026-09-23T01:58:12.296Z", "description": "When this change was applied, UTC." }, "Modifier": { "type": "string", "example": "apidemo_sovereignsolutions", "description": "Account whose token made this call." }, "ModifierId": { "type": "integer", "example": 19561, "description": "Numeric ID of the account whose token made this call." }, "Path": { "type": "string", "example": "/<internal storage path>", "description": "Internal storage location. Read-only." }, "ParentIdPath": { "type": "string", "example": "/<internal node path>", "description": "Internal node path. Read-only." }, "ParentPath": { "type": "string", "example": null }, "Status": { "type": "string", "example": null }, "Template": { "type": "string", "example": null }, "MimeType": { "type": "object", "properties": { "MimeType": { "type": "string", "example": "application/octet-stream" }, "Display": { "type": "string", "example": "unknown" } } }, "Properties": { "type": "array", "items": { "type": "object", "properties": { "Name": { "type": "string", "example": "employee_guid", "description": "Field name." }, "DisplayName": { "type": "string", "example": null }, "Value": { "type": "string", "example": "6ab33224bba47a219f950da5", "description": "New value." }, "DataType": { "type": "integer", "example": 3, "description": "System data type code of the field. See [Data types](/docs/models/data-types)." }, "Format": { "type": "string", "example": null } } }, "description": "The changed fields again, one entry per field with its value and data type." }, "Layer": { "type": "string", "example": "<TENANT>_EMPLOYEE", "description": "Internal layer name, prefixed with your tenant code." }, "Content": { "type": "string", "example": null }, "IsInherited": { "type": "boolean", "example": false } }, "description": "The employee node after the change." }, "resultId": { "type": "string", "example": "VPE7S0E0hY", "description": "Correlation ID for this message." } } } ] }, "examples": { "Message 1": { "summary": "Message 1", "value": { "result": 0, "data": true, "resultId": "H6733QoVCK" } }, "Message 2 - updated employee node": { "summary": "Message 2 - updated employee node", "value": { "result": 0, "data": { "employee_guid": "6ab33224bba47a219f950da5", "Id": "a5a78d42-3c18-4c34-b80d-e3046fa8fc0e", "employee_status": "4", "employee_last_modified_from": 2, "LayerData": { "employee_guid": "6ab33224bba47a219f950da5", "employee_status": "4" }, "Type": null, "NodeId": 100195153, "ParentId": 99689425, "Name": "26f14f46-696d-4537-a5b4-1237804feadf", "Title": null, "Description": null, "Created": "2026-09-23T01:57:56.97Z", "Creator": "apidemo_sovereignsolutions", "CreatorId": 19561, "Modified": "2026-09-23T01:58:12.296Z", "Modifier": "apidemo_sovereignsolutions", "ModifierId": 19561, "Path": "/<internal storage path>", "ParentIdPath": "/<internal node path>", "ParentPath": null, "Status": null, "Template": null, "MimeType": { "MimeType": "application/octet-stream", "Display": "unknown" }, "Properties": [ { "Name": "employee_guid", "DisplayName": null, "Value": "6ab33224bba47a219f950da5", "DataType": 3, "Format": null }, { "Name": "employee_status", "DisplayName": null, "Value": "4", "DataType": 10, "Format": null } ], "Layer": "<TENANT>_EMPLOYEE", "Content": null, "IsInherited": false }, "resultId": "VPE7S0E0hY" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "46" } }, "/{tenant}/employee/enable/{employee_guid}": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Employee - Enable an employee", "operationId": "employeeEnableAnEmployee", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "employee_guid", "in": "path", "required": true, "description": "GUID of the employee to enable", "schema": { "type": "string", "example": "6a9b7d4bf212b7ed3916862a" }, "example": "6a9b7d4bf212b7ed3916862a" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "employee_guid": { "type": "string", "example": "6a9b7d4bf212b7ed3916862a", "description": "The employee you enabled - the same GUID you sent in the path." }, "Id": { "type": "string", "example": "2e0fec36-963c-4592-b8c9-a2c5096813f8", "description": "Record ID in the `EMPLOYEE` layer." }, "employee_status": { "type": "string", "example": "3", "description": "New lifecycle state as a numeric code - `3` (Active) after a successful enable." }, "Title": { "type": "string", "example": "Demo User (updated)", "description": "Display label of the record." }, "employee_last_modified_from": { "type": "integer", "example": 2, "description": "Channel of this change, set by the platform: `1` Mobile, `2` Web, `3` Others." } } }, "example": { "employee_guid": "6a9b7d4bf212b7ed3916862a", "Id": "2e0fec36-963c-4592-b8c9-a2c5096813f8", "employee_status": "3", "Title": "Demo User (updated)", "employee_last_modified_from": 2 } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "46" } }, "/{tenant}/api/app-base/employees/{employee_guid}": { "put": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Employee - Replace an employee record", "description": "**This is a replace.** Send the full set of fields you want the employee to end up with - a field you leave out is not preserved from the previous state.\n\n**Role and status come back as display labels**, not the codes accepted on input. Map them back through [Employee](/docs/models/employee) before comparing to what you sent.", "operationId": "employeeReplaceAnEmployeeRecord", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "employee_guid", "in": "path", "required": true, "description": "GUID of the employee to update", "schema": { "type": "string", "example": "6a9b7d4bf212b7ed3916862a" }, "example": "6a9b7d4bf212b7ed3916862a" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employee_username": { "type": "string", "example": "field_user_01" }, "employee_full_name": { "type": "string", "example": "Field User Test" }, "employee_email": { "type": "string", "example": "user@example.com" }, "employee_phone": { "type": "string", "example": "919000000003" }, "employee_dob": { "type": "string", "example": "1995-09-14" }, "employee_role": { "type": "string", "example": "Worker" }, "employee_team_id": { "type": "string", "example": "2" }, "employee_reporting_manager": { "type": "string", "example": "your_username" } }, "required": [ "employee_username", "employee_full_name", "employee_email", "employee_phone", "employee_dob", "employee_role", "employee_team_id", "employee_reporting_manager" ] }, "example": { "employee_username": "field_user_01", "employee_full_name": "Field User Test", "employee_email": "user@example.com", "employee_phone": "919000000003", "employee_dob": "1995-09-14", "employee_role": "Worker", "employee_team_id": "2", "employee_reporting_manager": "your_username" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "employee_guid": { "type": "string", "example": "6a9b7d4bf212b7ed3916862a", "description": "The employee you updated - the same GUID you sent in the path." }, "employee_username": { "type": "string", "example": "field_user_01", "description": "Login name. Other records reference the employee by this value." }, "employee_full_name": { "type": "string", "example": "Field User Test", "description": "The value now stored." }, "employee_email": { "type": "string", "example": "user@example.com", "description": "The value now stored." }, "employee_phone": { "type": "string", "example": "919000000003", "description": "The value now stored." }, "employee_dob": { "type": "string", "example": "1995-09-14T17:00:00Z", "description": "Date of birth, returned as a full UTC timestamp even though it is sent as a date." }, "employee_role": { "type": "string", "example": "Team Member", "description": "Returned as the **display label** of the role, not the code you sent - `Worker` comes back as `Team Member`. See [Employee](/docs/models/employee)." }, "employee_status": { "type": "string", "example": "New", "description": "Account lifecycle state: `New`, `Inactive`, `Active` or `Disable`. This call does not change it." }, "employee_team_id": { "type": "string", "example": "2", "description": "Team the employee belongs to." }, "employee_team_id__keyfield": { "type": "string", "example": "2", "description": "Internal duplicate of `employee_team_id`. Ignore it." }, "employee_reporting_manager": { "type": "string", "example": "apidemo_sovereignsolutions", "description": "Username of the manager this employee reports to." }, "employee_last_modified_from": { "type": "integer", "example": 2, "description": "Channel of this change, set by the platform: `1` Mobile, `2` Web, `3` Others." }, "Title": { "type": "string", "example": "Field User Test", "description": "Display label of the record, kept in step with the full name." } } }, "example": { "employee_guid": "6a9b7d4bf212b7ed3916862a", "employee_username": "field_user_01", "employee_full_name": "Field User Test", "employee_email": "user@example.com", "employee_phone": "919000000003", "employee_dob": "1995-09-14T17:00:00Z", "employee_role": "Team Member", "employee_status": "New", "employee_team_id": "2", "employee_team_id__keyfield": "2", "employee_reporting_manager": "apidemo_sovereignsolutions", "employee_last_modified_from": 2, "Title": "Field User Test" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "46" }, "patch": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Employee - Partially update an employee", "description": "**Send only what you want to change.** Unlike `PUT`, fields you leave out keep their current value; the response returns the full record as it now stands.\n\n**Names come back where IDs went in.** `employee_team_id` and `employee_organization_id` are returned as names (`SovereignSolutions`, `demo`) although a create or replace sends numeric IDs. The numeric team ID is still available as `employee_team_id__keyfield` - use that value when writing the employee back.", "operationId": "employeePartiallyUpdateAnEmployee", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "employee_guid", "in": "path", "required": true, "description": "GUID of the employee to update", "schema": { "type": "string", "example": "6a9b7d4bf212b7ed3916862a" }, "example": "6a9b7d4bf212b7ed3916862a" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employee_full_name": { "type": "string", "example": "Demo User (updated)" } }, "required": [ "employee_full_name" ] }, "example": { "employee_full_name": "Demo User (updated)" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "employee_guid": { "type": "string", "example": "6a9b7d4bf212b7ed3916862a", "description": "The employee you updated - the same GUID you sent in the path." }, "Id": { "type": "string", "example": "2e0fec36-963c-4592-b8c9-a2c5096813f8", "description": "Record ID in the `EMPLOYEE` layer. Different from `employee_guid`; the employee endpoints address the employee by the GUID." }, "employee_username": { "type": "string", "example": "field_user_01", "description": "Login name. Other records reference the employee by this value." }, "employee_full_name": { "type": "string", "example": "Demo User (updated)", "description": "The value now stored." }, "employee_email": { "type": "string", "example": "user@example.com", "description": "The value now stored." }, "employee_phone": { "type": "string", "example": "919000000003", "description": "The value now stored." }, "employee_dob": { "type": "string", "example": "1995-09-14T17:00:00Z", "description": "Date of birth, returned as a full UTC timestamp even though it is sent as a date." }, "employee_role": { "type": "string", "example": "Team Member", "description": "Display label of the role, not the code accepted on input - `Worker` comes back as `Team Member`. See [Employee](/docs/models/employee)." }, "employee_status": { "type": "string", "example": "New", "description": "Account lifecycle state: `New`, `Inactive`, `Active` or `Disable`. Unchanged by this call." }, "employee_team_id": { "type": "string", "example": "SovereignSolutions", "description": "Team **name**, not the numeric ID you send on create." }, "employee_team_id__keyfield": { "type": "string", "example": "2", "description": "The numeric team ID behind `employee_team_id`. This is the value to send back on a write." }, "employee_organization_id": { "type": "string", "example": "demo", "description": "Organization **name**, not the numeric ID you send on create." }, "employee_reporting_manager": { "type": "string", "example": "apidemo_sovereignsolutions", "description": "Username of the manager this employee reports to." }, "employee_last_modified_from": { "type": "integer", "example": 2, "description": "Channel of this change, set by the platform: `1` Mobile, `2` Web, `3` Others." }, "Layer": { "type": "string", "example": "EMPLOYEE", "description": "Layer the record lives in, always `EMPLOYEE`." }, "Title": { "type": "string", "example": "Demo User (updated)", "description": "Display label of the record, kept in step with the full name." }, "Path": { "type": "string", "example": "/<internal storage path>", "description": "Internal storage location. Read-only." }, "ParentPath": { "type": "string", "example": "/<internal storage path>", "description": "Internal storage location of the parent node. Read-only." }, "CreatedDate": { "type": "string", "example": "2026-09-05T02:24:11Z", "description": "When the employee was created, UTC." }, "CreatedUser": { "type": "string", "example": "apidemo_sovereignsolutions", "description": "Account that created the employee." }, "ModifiedDate": { "type": "string", "example": "2026-09-08T06:53:25Z", "description": "When this update was applied, UTC." }, "ModifiedUser": { "type": "string", "example": "apidemo_sovereignsolutions", "description": "Account whose token made this call." } } }, "example": { "employee_guid": "6a9b7d4bf212b7ed3916862a", "Id": "2e0fec36-963c-4592-b8c9-a2c5096813f8", "employee_username": "field_user_01", "employee_full_name": "Demo User (updated)", "employee_email": "user@example.com", "employee_phone": "919000000003", "employee_dob": "1995-09-14T17:00:00Z", "employee_role": "Team Member", "employee_status": "New", "employee_team_id": "SovereignSolutions", "employee_team_id__keyfield": "2", "employee_organization_id": "demo", "employee_reporting_manager": "apidemo_sovereignsolutions", "employee_last_modified_from": 2, "Layer": "EMPLOYEE", "Title": "Demo User (updated)", "Path": "/<internal storage path>", "ParentPath": "/<internal storage path>", "CreatedDate": "2026-09-05T02:24:11Z", "CreatedUser": "apidemo_sovereignsolutions", "ModifiedDate": "2026-09-08T06:53:25Z", "ModifiedUser": "apidemo_sovereignsolutions" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "46" } }, "/{tenant}/employee/search#search-employees-across-the-tenant": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Employee - Search employees across the tenant", "operationId": "employeeSearchEmployeesAcrossTheTenant", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "skip": { "type": "integer", "example": 0, "description": "Paging - number of records to skip before the page starts. `0` is the first page." }, "take": { "type": "integer", "example": 20, "description": "Paging - maximum number of records to return in this page. `-1` returns every match, which is only safe on small layers. Compare against `total` in the response to know when you have read everything." }, "searchKey": { "type": "string", "example": "field_user_01" } }, "required": [ "skip", "take", "searchKey" ] }, "examples": { "Default": { "summary": "Default", "value": { "skip": 0, "take": 20, "searchKey": "field_user_01" } }, "List all": { "summary": "List all", "value": { "skip": 0, "take": 20 } }, "Search by username": { "summary": "Search by username", "value": { "skip": 0, "take": 20, "searchKey": "field_user_01" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "example": "f62b56f8-72e2-4691-bfae-24923cb1825d" }, "Layer": { "type": "string", "example": "EMPLOYEE" }, "CreatedDate": { "type": "string", "example": "2026-06-05T03:59:53Z" }, "Title": { "type": "string", "example": "Test 1" }, "employee_username": { "type": "string", "example": "field_user_01" }, "employee_full_name": { "type": "string", "example": "Test 1" }, "employee_status": { "type": "string", "example": "3" } } } }, "total": { "type": "integer", "example": 1 } } }, "example": { "data": [ { "Id": "f62b56f8-72e2-4691-bfae-24923cb1825d", "Layer": "EMPLOYEE", "CreatedDate": "2026-06-05T03:59:53Z", "Title": "Test 1", "employee_username": "field_user_01", "employee_full_name": "Test 1", "employee_status": "3" } ], "total": 1 } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "46" } }, "/{tenant}/tracking/push": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Tracking - Push GPS points from a device", "description": "The body is a JSON **array**, one object per GPS point - send a single-element array for one point.", "operationId": "trackingPushGPSPointsFromADevice", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "driver": { "type": "string", "example": "your_username", "description": "Username of the employee the device belongs to." }, "trackerId": { "type": "string", "example": "mydevice@your_username", "description": "Device identifier. The live and history calls read the track back by this value." }, "heading": { "type": "integer", "example": 0 }, "lat": { "type": "number", "example": 18.4585507, "description": "Latitude, decimal degrees." }, "lng": { "type": "number", "example": 75.4128607, "description": "Longitude, decimal degrees." }, "motionActivity": { "type": "integer", "example": 0 }, "session": { "type": "integer", "example": 1790131313 }, "speed": { "type": "integer", "example": 0 }, "timestamp": { "type": "integer", "example": 1790131380, "description": "Time of the fix, Unix epoch seconds." }, "jobStatus": { "type": "integer", "example": 2 }, "meta": { "type": "string", "example": "{\"sourceType\":\"api\",\"accuracy\":1217.35,\"battery\":\"86%\",\"networkType\":\"Mobile\"}", "description": "Extra device metadata as a **JSON-encoded string**, not an object." } }, "description": "One GPS point. Send several objects to push a batch." } }, "example": [ { "driver": "your_username", "trackerId": "mydevice@your_username", "heading": 0, "lat": 18.4585507, "lng": 75.4128607, "motionActivity": 0, "session": 1790131313, "speed": 0, "timestamp": 1790131380, "jobStatus": 2, "meta": "{\"sourceType\":\"api\",\"accuracy\":1217.35,\"battery\":\"86%\",\"networkType\":\"Mobile\"}" } ] } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "object", "properties": { "success": { "type": "boolean", "example": true, "description": "`true` when the points were accepted." }, "time": { "type": "string", "example": "2026-09-23T02:29:38.888Z", "description": "Server time the batch was accepted, UTC." } } } } }, "example": { "status": { "success": true, "time": "2026-09-23T02:29:38.888Z" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "34" } }, "/{tenant}/tracking/live": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Tracking - Get current positions", "operationId": "trackingGetCurrentPositions", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "layer": { "type": "string", "example": "EMPLOYEE", "description": "Layer the trackers belong to, `EMPLOYEE`." }, "page": { "type": "integer", "example": 1, "description": "Page number, starting at `1`." }, "pageSize": { "type": "integer", "example": 20, "description": "Trackers per page." }, "searchKey": { "type": "string", "example": "", "description": "Free-text filter. Empty string returns all." }, "sort": { "type": "array", "items": { "type": "string", "example": "ts" }, "description": "Fields to sort by." } }, "required": [ "layer", "page", "pageSize", "searchKey", "sort" ] }, "example": { "layer": "EMPLOYEE", "page": 1, "pageSize": 20, "searchKey": "", "sort": [ "ts" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "integer", "example": 0, "description": "Status of the call. `0` means it succeeded." }, "status": { "type": "object", "properties": { "success": { "type": "boolean", "example": true, "description": "`true` when the call succeeded." }, "message": { "type": "string", "example": "" } } }, "data": { "type": "object", "properties": { "trackers": { "type": "array", "items": { "type": "object", "properties": { "driver": { "type": "string", "example": "apidemo_newuser_9", "description": "Username of the employee." }, "trackingInfo": { "type": "array", "items": { "type": "object", "properties": { "trackerId": { "type": "string", "example": "mydevice@apidemo_newuser_9", "description": "Device the position came from." }, "lat": { "type": "number", "example": 18.4585507, "description": "Latitude of the latest fix." }, "lng": { "type": "number", "example": 75.4128607, "description": "Longitude of the latest fix." }, "ts": { "type": "integer", "example": 1790131380, "description": "Time of the latest fix, Unix epoch seconds." }, "speed": { "type": "integer", "example": 0 }, "heading": { "type": "integer", "example": 0 }, "device_status": { "type": "integer", "example": 2 }, "session": { "type": "string", "example": "1790131313" }, "employee_username": { "type": "string", "example": "apidemo_newuser_9" }, "employee_organization_id": { "type": "integer", "example": 1 }, "employee_team_id": { "type": "integer", "example": 2 }, "employee_type_id": { "type": "integer", "example": 0 }, "received": { "type": "integer", "example": 1790132970, "description": "When the platform received the fix, Unix epoch seconds." }, "employee_full_name": { "type": "string", "example": "Demo User 9" }, "meta_event": { "type": "string", "example": "" }, "meta": { "type": "string", "example": "{\"sourceType\":\"api\",\"accuracy\":1217.35,\"battery\":\"86%\",\"networkType\":\"Mobile\"}", "description": "Device metadata sent with the point, as a JSON-encoded string." }, "address": { "type": "string", "example": "" }, "action_code": { "type": "string", "example": "off_duty" }, "typeCode": { "type": "string", "example": "DUTY" }, "event_ts": { "type": "integer", "example": 0 }, "motionActivity": { "type": "integer", "example": 0 }, "employee_status": { "type": "integer", "example": 3, "description": "Employee lifecycle state as a numeric code: `1` New, `2` Inactive, `3` Active, `4` Disable." }, "employee_meta": { "type": "string", "example": "{\"employee_code\": null, \"employee_dob\": \"1995-04-17T00:00:00\", \"employee_email\": \"user@example.com\", \"employee_guid\": \"6ab33224bba47a219f950da5\", \"employee_phone\": \"919800000009\", \"employee_reporting_manager\": \"apidemo_sovereignsolutions\", \"employee_role\": \"Worker\", \"employee_vehicle_id\": null, \"hierarchyPath\": \"/demo/sovereignsolutions\"}", "description": "Employee profile fields as a JSON-encoded string." }, "meta_tracking": { "type": "string", "example": "{\"sourceType\":\"api\",\"accuracy\":1217.35,\"battery\":\"86%\",\"networkType\":\"Mobile\"}", "description": "Device metadata sent with the point, as a JSON-encoded string." }, "employee_image": { "type": "string", "example": "" } } } }, "latest_events": { "type": "object", "properties": { "DUTY": { "type": "object", "properties": { "action_code": { "type": "string", "example": "off_duty" }, "typeCode": { "type": "string", "example": "DUTY" }, "event_ts": { "type": "integer", "example": 0 }, "meta_event": { "type": "string", "example": "" }, "address": { "type": "string", "example": "" } } } }, "description": "Most recent event per event type, keyed by type code." }, "latest_duty_event": { "type": "object", "properties": { "action_code": { "type": "string", "example": "off_duty" }, "typeCode": { "type": "string", "example": "DUTY" }, "event_ts": { "type": "integer", "example": 0 }, "meta_event": { "type": "string", "example": "" }, "address": { "type": "string", "example": "" } }, "description": "Most recent duty event (`on_duty` / `off_duty`)." }, "employee_image": { "type": "string", "example": "" } } }, "description": "One entry per employee with a known position." }, "total": { "type": "integer", "example": 1, "description": "Total number of trackers matching the request." }, "counters": { "type": "object", "properties": { "employee_username": { "type": "object", "properties": { "apidemo_newuser_9": { "type": "integer", "example": 1 } } }, "device_status": { "type": "object", "properties": { "2": { "type": "integer", "example": 1 } } }, "action_code": { "type": "object", "properties": { "off_duty": { "type": "integer", "example": 1 } } } }, "description": "Counts of the returned trackers, grouped by username, device status and duty action." } } } } }, "example": { "result": 0, "status": { "success": true, "message": "" }, "data": { "trackers": [ { "driver": "apidemo_newuser_9", "trackingInfo": [ { "trackerId": "mydevice@apidemo_newuser_9", "lat": 18.4585507, "lng": 75.4128607, "ts": 1790131380, "speed": 0, "heading": 0, "device_status": 2, "session": "1790131313", "employee_username": "apidemo_newuser_9", "employee_organization_id": 1, "employee_team_id": 2, "employee_type_id": 0, "received": 1790132970, "employee_full_name": "Demo User 9", "meta_event": "", "meta": "{\"sourceType\":\"api\",\"accuracy\":1217.35,\"battery\":\"86%\",\"networkType\":\"Mobile\"}", "address": "", "action_code": "off_duty", "typeCode": "DUTY", "event_ts": 0, "motionActivity": 0, "employee_status": 3, "employee_meta": "{\"employee_code\": null, \"employee_dob\": \"1995-04-17T00:00:00\", \"employee_email\": \"user@example.com\", \"employee_guid\": \"6ab33224bba47a219f950da5\", \"employee_phone\": \"919800000009\", \"employee_reporting_manager\": \"apidemo_sovereignsolutions\", \"employee_role\": \"Worker\", \"employee_vehicle_id\": null, \"hierarchyPath\": \"/demo/sovereignsolutions\"}", "meta_tracking": "{\"sourceType\":\"api\",\"accuracy\":1217.35,\"battery\":\"86%\",\"networkType\":\"Mobile\"}", "employee_image": "" } ], "latest_events": { "DUTY": { "action_code": "off_duty", "typeCode": "DUTY", "event_ts": 0, "meta_event": "", "address": "" } }, "latest_duty_event": { "action_code": "off_duty", "typeCode": "DUTY", "event_ts": 0, "meta_event": "", "address": "" }, "employee_image": "" } ], "total": 1, "counters": { "employee_username": { "apidemo_newuser_9": 1 }, "device_status": { "2": 1 }, "action_code": { "off_duty": 1 } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "34" } }, "/{tenant}/tracking/history": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Tracking - Get historical track", "description": "Coordinates in `data` are GeoJSON order - **longitude first**.", "operationId": "trackingGetHistoricalTrack", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "trackerId": { "type": "string", "example": "mydevice@your_username", "description": "Device to read the track for." }, "from": { "type": "string", "example": "1788022800", "description": "Start of the range, Unix epoch seconds, sent as a string." }, "to": { "type": "string", "example": "1791651599", "description": "End of the range, Unix epoch seconds, sent as a string." } }, "required": [ "trackerId", "from", "to" ] }, "example": { "trackerId": "mydevice@your_username", "from": "1788022800", "to": "1791651599" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "integer", "example": 0, "description": "Status of the call. `0` means it succeeded." }, "status": { "type": "object", "properties": { "success": { "type": "boolean", "example": true, "description": "`true` when the call succeeded." }, "message": { "type": "string", "example": "" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "deviceStatus": { "type": "object", "properties": { "value": { "type": "integer", "example": 1 }, "iconColor": { "type": "string", "example": "#7CB342" }, "session": { "type": "string", "example": "1790131313", "description": "Session the points belong to." } } }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "number", "example": 75.4128607 } }, "description": "Track points as `[longitude, latitude]` pairs, in time order." }, "times": { "type": "array", "items": { "type": "integer", "example": 1790131380 }, "description": "Unix epoch seconds for each point, same order as `data`." }, "metaData": { "type": "array", "items": { "type": "object", "properties": { "speed": { "type": "integer", "example": 0 }, "heading": { "type": "integer", "example": 0 } } }, "description": "Speed and heading for each point, same order as `data`." } } }, "description": "One entry per tracking session in the range." } } }, "example": { "result": 0, "status": { "success": true, "message": "" }, "data": [ { "deviceStatus": { "value": 1, "iconColor": "#7CB342", "session": "1790131313" }, "data": [ [ 75.4128607, 18.4585507 ] ], "times": [ 1790131380 ], "metaData": [ { "speed": 0, "heading": 0 } ] } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "34" } }, "/{tenant}/api/app-base/plans/create": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "PJP - Create a plan (with nested visits)", "operationId": "pjpCreateAPlanWithNestedVisits", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "plan_assignee_username": { "type": "string", "example": "apidemo_newuser_9" }, "plan_name": { "type": "string", "example": "test plan", "description": "Name for the plan." }, "visits": { "type": "array", "items": { "type": "object", "properties": { "visit_target_guid": { "type": "string", "example": "6aa0bb299521e3582ef555f8", "description": "Must belong to a customer already assigned to `visit_assignee_username` (directly or via an `ALL` assignment). Customers assigned to another user cannot be planned for this assignee." }, "visit_assignee_username": { "type": "string", "example": "apidemo_newuser_9", "description": "The plan's own assignee - sent as a username here (contrast with the standalone `POST /visits`, where this same field name takes an `employee_guid` instead)." }, "visit_date": { "type": "string", "example": "2026-09-25T16:59:59.999Z", "description": "Must be today or later (UTC)." }, "visit_priority": { "type": "string", "example": "3", "description": "Priority, sent as a code string (the example sends `\"3\"`)." }, "visit_estimate_time": { "type": "string", "example": "30", "description": "Estimated visit duration, sent as a string (the example sends `\"30\"`)." }, "visit_objective": { "type": "string", "example": "test", "description": "Purpose of the visit, free text." }, "visit_order": { "type": "integer", "example": 0, "description": "Position of the visit in the day's sequence, starting at `0`." } } } }, "plan_date": { "type": "string", "example": "2026-09-25T16:59:59.999Z", "description": "Must be today or later (UTC)." }, "config": { "type": "object", "properties": { "timeZoneOffset": { "type": "integer", "example": -420, "description": "Client time-zone offset in minutes (the example `-420` is UTC+7)." } } } }, "required": [ "plan_assignee_username", "plan_name", "visits", "plan_date", "config" ] }, "example": { "plan_assignee_username": "apidemo_newuser_9", "plan_name": "test plan", "visits": [ { "visit_target_guid": "6aa0bb299521e3582ef555f8", "visit_assignee_username": "apidemo_newuser_9", "visit_date": "2026-09-25T16:59:59.999Z", "visit_priority": "3", "visit_estimate_time": "30", "visit_objective": "test", "visit_order": 0 }, { "visit_target_guid": "6aa3d2b3d1d2d6ccfde198cd", "visit_assignee_username": "apidemo_newuser_9", "visit_date": "2026-09-25T16:59:59.999Z", "visit_priority": "3", "visit_estimate_time": "30", "visit_objective": "test", "visit_order": 1 } ], "plan_date": "2026-09-25T16:59:59.999Z", "config": { "timeZoneOffset": -420 } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "plan_guid": { "type": "string", "example": "6ab386e8e2e38f375be67f45", "description": "Identifier of the plan just created. Use it to read, update or delete the plan." }, "plan_assignee_username": { "type": "string", "example": "apidemo_newuser_9", "description": "The field user this plan belongs to." }, "plan_name": { "type": "string", "example": "test plan", "description": "The plan name as stored - the value you sent in `plan_name`." }, "visits": { "type": "array", "items": { "type": "object", "properties": { "visit_target_guid": { "type": "string", "example": "6aa0bb299521e3582ef555f8" }, "visit_assignee_username": { "type": "string", "example": "apidemo_newuser_9" }, "visit_date": { "type": "string", "example": "2026-09-25T16:59:59.999Z" }, "visit_priority": { "type": "string", "example": "3" }, "visit_estimate_time": { "type": "integer", "example": 30, "description": "Estimated visit duration - sent as a string, returned as a number." }, "visit_objective": { "type": "string", "example": "test" }, "visit_order": { "type": "integer", "example": 0, "description": "Position of the visit in the day's sequence, as sent." }, "__customerInfo": { "type": "object", "properties": { "customer_guid": { "type": "string", "example": "6aa0bb299521e3582ef555f8" }, "customer_full_name": { "type": "string", "example": "My Customer" }, "Title": { "type": "string", "example": "My Customer" }, "customer_address": { "type": "string", "example": "Mulshi, Pune, MAHARASHTRA - 412108" }, "customer_postal_code": { "type": "string", "example": "412108" }, "customer_category": { "type": "string", "example": "Default" }, "customer_is_active": { "type": "integer", "example": 1 }, "customer_assigned_team": { "type": "string", "example": "2" }, "customer_assignee": { "type": "string", "example": "all" } }, "description": "The full customer record resolved from `visit_target_guid` (shape: [Customer](/docs/models/customer)). Trimmed to its identifying fields in the example above for brevity." }, "Title": { "type": "string", "example": "Visit 1790150375739", "description": "Generated by the platform (`Visit <timestamp>`) - do not send." }, "visit_status": { "type": "integer", "example": 1, "description": "Numeric status code - `1` = New." }, "visit_contact_full_name": { "type": "string", "example": "My Customer", "description": "Copied from the target customer's contact details, along with the other `visit_contact_*` fields." }, "visit_contact_phone_number": { "type": "string", "example": "919000000002" }, "visit_contact_email": { "type": "string", "example": "user@example.com" }, "visit_address": { "type": "string", "example": "Mulshi, Pune, MAHARASHTRA - 412108", "description": "Copied from the target customer." }, "visit_administrative_1": { "type": "string", "example": "33", "description": "Copied from the target customer's administrative codes (`visit_administrative_1..3`)." }, "visit_administrative_2": { "type": "string", "example": "138" }, "visit_administrative_3": { "type": "string", "example": "14204" }, "visit_postal_code": { "type": "string", "example": "412108" }, "visit_customer_category": { "type": "string", "example": "Default" }, "visit_location": { "type": "string", "example": "{\n \"type\": \"Point\",\n \"coordinates\": [\n 73.55986487231496,\n 18.462925230845542\n ]\n}", "description": "Copied from the target customer, as a GeoJSON `Point` string." }, "visit_boundary": { "type": "string", "example": null }, "validated": { "type": "boolean", "example": true, "description": "Whether this visit has been validated." }, "notified": { "type": "boolean", "example": true, "description": "Whether the assignee has been notified of this visit." }, "__isValid": { "type": "boolean", "example": true, "description": "Whether this visit passed validation. See `__dataErrors` for what failed when `false`." }, "__dataErrors": { "type": "array", "items": {}, "description": "What failed validation for this visit, if `__isValid` is `false`. Empty when the visit is valid." }, "visit_plan_guid": { "type": "string", "example": "6ab386e8e2e38f375be67f45", "description": "The plan this visit belongs to." }, "visit_created_from": { "type": "integer", "example": 2 }, "visit_last_modified_from": { "type": "integer", "example": 2 }, "Id": { "type": "string", "example": "f3fc45bd-3790-4c97-b795-2dc59931a919" }, "visit_guid": { "type": "string", "example": "6ab386eae2e38f35d9e67f75", "description": "Identifier of this visit. Generated by the platform - do not send it on create." }, "isSuccess": { "type": "boolean", "example": true, "description": "Whether this individual visit was created successfully. The plan call can return `200 OK` while one visit fails - check this flag per visit." } } }, "description": "One entry per visit created with the plan, each expanded with the customer details resolved from `visit_target_guid`." }, "plan_date": { "type": "string", "example": "2026-09-25T16:59:59.999Z", "description": "The day the plan covers." }, "plan_created_from": { "type": "integer", "example": 2, "description": "Channel the plan was created from: `1` Mobile, `2` Web, `3` Others." }, "plan_last_modified_from": { "type": "integer", "example": 2, "description": "Channel of the last change." }, "Id": { "type": "string", "example": "4837cc76-5ae0-4b6a-ba46-5e0c7cf4f827", "description": "Record ID of the plan. The plan endpoints address it by `plan_guid`, not by this value." }, "Path": { "type": "string", "example": "/<internal storage path>", "description": "Internal storage location. Read-only." } } }, "examples": { "Success": { "summary": "Success", "value": { "plan_guid": "6ab386e8e2e38f375be67f45", "plan_assignee_username": "apidemo_newuser_9", "plan_name": "test plan", "visits": [ { "visit_target_guid": "6aa0bb299521e3582ef555f8", "visit_assignee_username": "apidemo_newuser_9", "visit_date": "2026-09-25T16:59:59.999Z", "visit_priority": "3", "visit_estimate_time": 30, "visit_objective": "test", "visit_order": 0, "__customerInfo": { "customer_guid": "6aa0bb299521e3582ef555f8", "customer_full_name": "My Customer", "Title": "My Customer", "customer_address": "Mulshi, Pune, MAHARASHTRA - 412108", "customer_postal_code": "412108", "customer_category": "Default", "customer_is_active": 1, "customer_assigned_team": "2", "customer_assignee": "all" }, "Title": "Visit 1790150375739", "visit_status": 1, "visit_contact_full_name": "My Customer", "visit_contact_phone_number": "919000000002", "visit_contact_email": "user@example.com", "visit_address": "Mulshi, Pune, MAHARASHTRA - 412108", "visit_administrative_1": "33", "visit_administrative_2": "138", "visit_administrative_3": "14204", "visit_postal_code": "412108", "visit_customer_category": "Default", "visit_location": "{\n \"type\": \"Point\",\n \"coordinates\": [\n 73.55986487231496,\n 18.462925230845542\n ]\n}", "visit_boundary": null, "validated": true, "notified": true, "__isValid": true, "__dataErrors": [], "visit_plan_guid": "6ab386e8e2e38f375be67f45", "visit_created_from": 2, "visit_last_modified_from": 2, "Id": "f3fc45bd-3790-4c97-b795-2dc59931a919", "visit_guid": "6ab386eae2e38f35d9e67f75", "isSuccess": true }, { "visit_target_guid": "6aa3d2b3d1d2d6ccfde198cd", "visit_assignee_username": "apidemo_newuser_9", "visit_date": "2026-09-25T16:59:59.999Z", "visit_priority": "3", "visit_estimate_time": 30, "visit_objective": "test", "visit_order": 1, "__customerInfo": { "customer_guid": "6aa3d2b3d1d2d6ccfde198cd", "customer_full_name": "New customer", "Title": "New customer", "customer_address": "ABC", "customer_postal_code": "451331", "customer_category": null, "customer_is_active": 1, "customer_assigned_team": "2", "customer_assignee": "all" }, "Title": "Visit 1790150375740", "visit_status": 1, "visit_contact_full_name": "New customer", "visit_contact_phone_number": null, "visit_contact_email": null, "visit_address": "ABC", "visit_administrative_1": "26", "visit_administrative_2": "570", "visit_administrative_3": "13563", "visit_postal_code": "451331", "visit_customer_category": null, "visit_location": "{\n \"type\": \"Point\",\n \"coordinates\": [\n 75.97974198425027,\n 21.888548035168114\n ]\n}", "visit_boundary": null, "validated": true, "notified": true, "__isValid": true, "__dataErrors": [], "visit_plan_guid": "6ab386e8e2e38f375be67f45", "Id": "6fc95dff-c53b-4ec5-b34d-99c48f3637e7", "visit_guid": "6ab386ede2e38f44f7e67f76", "isSuccess": true } ], "plan_date": "2026-09-25T16:59:59.999Z", "plan_created_from": 2, "plan_last_modified_from": 2, "Id": "4837cc76-5ae0-4b6a-ba46-5e0c7cf4f827", "Path": "/<internal storage path>" } }, "Response - some visits are invalid (errorCode 3001)": { "summary": "Response - some visits are invalid (errorCode 3001)", "value": { "result": -1, "resultId": "gx5isi129d", "data": { "plan_assignee_username": "apidemo_newuser_9", "plan_date": "2026-09-23T16:59:59.999Z", "plan_created_from": 2, "plan_last_modified_from": 2, "plan_name": "Plan for apidemo_newuser_9 created on 23/09/2026", "Path": "/<internal storage path>" }, "errorMessage": "Some visits are invalid.", "message": "Some visits are invalid.", "errorDetails": [ { "data": { "visit_target_category": "Audit", "visit_target_guid": "6aa3d2b3d1d2d6ccfde198cd", "visit_assignee_username": "apidemo_newuser_9", "visit_date": "2026-09-23T16:59:59.999Z", "visit_status": 1, "visit_priority": "Medium", "visit_objective": "Audit", "visit_estimate_time": 10, "__customerInfo": { "customer_guid": "6aa3d2b3d1d2d6ccfde198cd", "customer_full_name": "New customer", "Title": "New customer", "customer_address": "ABC", "customer_postal_code": "451331", "customer_assignee": "all", "customer_assigned_team": "2" }, "Title": "Visit 1790149244060", "visit_contact_full_name": "New customer", "visit_address": "ABC", "visit_postal_code": "451331", "visit_location": "{\"type\":\"Point\",\"coordinates\":[75.97974198425027,21.888548035168114]}", "validated": true, "notified": true, "__isValid": true, "__dataErrors": [] }, "isValid": false, "isSuccess": false, "message": "A visit already exists for this customer on this date", "details": [ { "visit_date": "A visit already exists for this customer on this date" } ] } ], "errorCode": 3001 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "36" } }, "/{tenant}/api/app-base/plans/{plan_guid}": { "get": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "PJP - Get a plan", "description": "**This call does not return the plan's visits.** It returns the plan record only - the `visit_guid`s returned on create are what you have to read each visit's detail.", "operationId": "pjpGetAPlan", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "plan_guid", "in": "path", "required": true, "description": "Plan GUID", "schema": { "type": "string", "example": "6aa13d2e620f0c4efa094477" }, "example": "6aa13d2e620f0c4efa094477" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "plan_guid": { "type": "string", "example": "6aa13d2e620f0c4efa094477", "description": "The plan you requested - same value you sent in the path." }, "Id": { "type": "string", "example": "f3d2c4b9-0d46-426d-ac3f-7400eedc94fd", "description": "Record ID of the plan in the `PLAN` layer. Not used by the plan endpoints, which address the plan by `plan_guid`." }, "Layer": { "type": "string", "example": "PLAN", "description": "Layer the record lives in, always `PLAN`." }, "Path": { "type": "string", "example": "/<internal storage path>", "description": "Internal storage location. Read-only." }, "ParentPath": { "type": "string", "example": "/<internal storage path>", "description": "Internal storage location of the parent node. Read-only." }, "CreatedDate": { "type": "string", "example": "2026-09-09T11:04:14Z", "description": "When the plan was created, UTC." }, "CreatedUser": { "type": "string", "example": "apidemo_ss", "description": "Account that created the plan." }, "ModifiedDate": { "type": "string", "example": "2026-09-09T11:04:14Z", "description": "When the plan was last changed, UTC." }, "ModifiedUser": { "type": "string", "example": "apidemo_ss", "description": "Account that last changed the plan." }, "Title": { "type": "string", "example": "ZFLCFX_PLAN", "description": "Returned as the internal layer name rather than a per-record label." }, "plan_assignee_username": { "type": "string", "example": "apidemo_ss", "description": "The field user this plan belongs to." }, "plan_date": { "type": "string", "example": "2026-09-10T00:00:59Z", "description": "The day the plan covers." }, "plan_name": { "type": "string", "example": "Plan for apidemo_ss created on 09/09/2026", "description": "Label generated by the platform from the assignee and the plan date." }, "plan_cancel_status": { "type": "string", "example": "Empty", "description": "Cancellation state of the plan. `Empty` means it has not been cancelled." }, "plan_is_repeated": { "type": "boolean", "example": false, "description": "Whether this is a repeating plan (`plan_repeat`/`plan_cycle`) rather than a single date." } } }, "example": { "plan_guid": "6aa13d2e620f0c4efa094477", "Id": "f3d2c4b9-0d46-426d-ac3f-7400eedc94fd", "Layer": "PLAN", "Path": "/<internal storage path>", "ParentPath": "/<internal storage path>", "CreatedDate": "2026-09-09T11:04:14Z", "CreatedUser": "apidemo_ss", "ModifiedDate": "2026-09-09T11:04:14Z", "ModifiedUser": "apidemo_ss", "Title": "ZFLCFX_PLAN", "plan_assignee_username": "apidemo_ss", "plan_date": "2026-09-10T00:00:59Z", "plan_name": "Plan for apidemo_ss created on 09/09/2026", "plan_cancel_status": "Empty", "plan_is_repeated": false } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "36" }, "put": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "PJP - Update a plan", "operationId": "pjpUpdateAPlan", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "plan_guid", "in": "path", "required": true, "description": "Plan GUID", "schema": { "type": "string", "example": "6aa13d2e620f0c4efa094477" }, "example": "6aa13d2e620f0c4efa094477" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "plan_name": { "type": "string", "example": "Updated plan name" } }, "required": [ "plan_name" ] }, "example": { "plan_name": "Updated plan name" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "36" }, "delete": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "PJP - Delete a plan", "operationId": "pjpDeleteAPlan", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "plan_guid", "in": "path", "required": true, "description": "Plan GUID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 1, "description": "Number of records actually deleted. `1` = the record was found and removed, `0` = nothing matched the ID. The call returns `200 OK` either way, so check this value to confirm the delete." } } }, "example": { "count": 1 } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "36" } }, "/{tenant}/api/app-base/plans/search": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "PJP - Search plans", "description": "**Search results do not include visits**, the same as `GET /plans/{plan_guid}` - each entry is the plan record only.", "operationId": "pjpSearchPlans", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "skip": { "type": "integer", "example": 0, "description": "Paging - number of records to skip before the page starts. `0` is the first page." }, "take": { "type": "integer", "example": 20, "description": "Paging - maximum number of records to return in this page. `-1` returns every match, which is only safe on small layers. Compare against `total` in the response to know when you have read everything." }, "plan_assignee_username": { "type": "string", "example": "<username>" }, "sortBy": { "type": "array", "items": { "type": "object", "properties": { "Field": { "type": "string", "example": "CreatedDate_pdt" }, "Direction": { "type": "string", "example": "DESC" } } } } }, "required": [ "skip", "take", "plan_assignee_username", "sortBy" ] }, "example": { "skip": 0, "take": 20, "plan_assignee_username": "<username>", "sortBy": [ { "Field": "CreatedDate_pdt", "Direction": "DESC" } ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "example": "f3d2c4b9-0d46-426d-ac3f-7400eedc94fd" }, "Layer": { "type": "string", "example": "PLAN" }, "Path": { "type": "string", "example": "/<internal storage path>" }, "ParentPath": { "type": "string", "example": "/<internal storage path>" }, "CreatedDate": { "type": "string", "example": "2026-09-09T11:04:14Z" }, "CreatedUser": { "type": "string", "example": "apidemo_ss" }, "ModifiedDate": { "type": "string", "example": "2026-09-09T11:04:14Z" }, "ModifiedUser": { "type": "string", "example": "apidemo_ss" }, "Title": { "type": "string", "example": "ZFLCFX_PLAN" }, "plan_guid": { "type": "string", "example": "6aa13d2e620f0c4efa094477" }, "plan_assignee_username": { "type": "string", "example": "apidemo_ss" }, "plan_date": { "type": "string", "example": "2026-09-10T00:00:59Z" }, "plan_name": { "type": "string", "example": "Plan for apidemo_ss created on 09/09/2026" }, "plan_cancel_status": { "type": "string", "example": "Empty" }, "plan_is_repeated": { "type": "boolean", "example": false } } }, "description": "The page of matching plans. Each entry carries the same fields as `GET /plans/{plan_guid}` - use `plan_guid` to address one of them." }, "total": { "type": "integer", "example": 2, "description": "Total number of plans matching the query, ignoring `skip` and `take` - use it to drive paging." } } }, "example": { "data": [ { "Id": "f3d2c4b9-0d46-426d-ac3f-7400eedc94fd", "Layer": "PLAN", "Path": "/<internal storage path>", "ParentPath": "/<internal storage path>", "CreatedDate": "2026-09-09T11:04:14Z", "CreatedUser": "apidemo_ss", "ModifiedDate": "2026-09-09T11:04:14Z", "ModifiedUser": "apidemo_ss", "Title": "ZFLCFX_PLAN", "plan_guid": "6aa13d2e620f0c4efa094477", "plan_assignee_username": "apidemo_ss", "plan_date": "2026-09-10T00:00:59Z", "plan_name": "Plan for apidemo_ss created on 09/09/2026", "plan_cancel_status": "Empty", "plan_is_repeated": false } ], "total": 2 } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "36" } }, "/{tenant}/api/app-base/visits": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "PJP - Create a visit", "description": "**This differs from the nested visit format on `POST /plans/create`**, where `visit_assignee_username` is the plan's own assignee and is sent as a username. Check which shape applies to the endpoint you are calling.", "operationId": "pjpCreateAVisit", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "visit_target_guid": { "type": "string", "example": "<customer guid>" }, "visit_assignee_username": { "type": "string", "example": "<employee guid>", "description": "Despite the name, this takes the employee's **`employee_guid`**, not a username. Look up the employee's `employee_guid` first (create, search, or detail) and send that." }, "visit_date": { "type": "string", "example": "2026-09-16T19:29:59.999Z" }, "visit_status": { "type": "string", "example": "New", "description": "Status label on input (`New`, `InProgress`, `Completed`, ...) - see the response for the numeric code it comes back as." }, "visit_priority": { "type": "string", "example": "Medium" }, "visit_objective": { "type": "string", "example": "Audit" }, "visit_estimate_time": { "type": "integer", "example": 10 } }, "required": [ "visit_target_guid", "visit_assignee_username", "visit_date", "visit_status", "visit_priority", "visit_objective", "visit_estimate_time" ] }, "example": { "visit_target_guid": "<customer guid>", "visit_assignee_username": "<employee guid>", "visit_date": "2026-09-16T19:29:59.999Z", "visit_status": "New", "visit_priority": "Medium", "visit_objective": "Audit", "visit_estimate_time": 10 } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "visit_guid": { "type": "string", "example": "6aa27a7199cf318e40bd4670", "description": "Identifier of the visit just created. Use it to read, update or delete this visit." }, "Id": { "type": "string", "example": "38d83949-94d0-45aa-8281-8e7bdf798266", "description": "Record ID of the visit in the `VISIT` layer. Not used by the visit endpoints, which address the visit by `visit_guid`." }, "visit_target_guid": { "type": "string", "example": "6aa0bb299521e3582ef555f8", "description": "Customer this visit is for - echoes what you sent." }, "visit_assignee_username": { "type": "string", "example": "6aa13c3377a22c870a6f1dfb", "description": "Despite the name, this is the employee's **`employee_guid`**, not their username - echoes what you sent." }, "visit_date": { "type": "string", "example": "2026-09-16T19:29:59.999Z" }, "visit_status": { "type": "integer", "example": 1, "description": "Sent as a string label (`New`) and returned as its numeric code (`1`)." }, "visit_priority": { "type": "string", "example": "Medium" }, "visit_objective": { "type": "string", "example": "Audit" }, "visit_estimate_time": { "type": "integer", "example": 10 }, "visit_created_from": { "type": "integer", "example": 2, "description": "Channel the visit was created from: `1` Mobile, `2` Web, `3` Others." }, "visit_last_modified_from": { "type": "integer", "example": 2, "description": "Channel of the last change." }, "visit_ticket_no": { "type": "string", "example": "VISIT-21", "description": "Sequential ticket number generated by the platform, e.g. `VISIT-21`." }, "visit_has_approval": { "type": "boolean", "example": false, "description": "Whether the visit has gone through an approval step. Not set by this call." }, "Path": { "type": "string", "example": "/<internal storage path>", "description": "Internal storage location. Read-only." } } }, "example": { "visit_guid": "6aa27a7199cf318e40bd4670", "Id": "38d83949-94d0-45aa-8281-8e7bdf798266", "visit_target_guid": "6aa0bb299521e3582ef555f8", "visit_assignee_username": "6aa13c3377a22c870a6f1dfb", "visit_date": "2026-09-16T19:29:59.999Z", "visit_status": 1, "visit_priority": "Medium", "visit_objective": "Audit", "visit_estimate_time": 10, "visit_created_from": 2, "visit_last_modified_from": 2, "visit_ticket_no": "VISIT-21", "visit_has_approval": false, "Path": "/<internal storage path>" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "36" } }, "/{tenant}/api/app-base/visits/{visit_guid}": { "get": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "PJP - Get a visit", "operationId": "pjpGetAVisit", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "visit_guid", "in": "path", "required": true, "description": "Visit GUID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "36" }, "put": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "PJP - Update a visit", "operationId": "pjpUpdateAVisit", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "visit_guid", "in": "path", "required": true, "description": "Visit GUID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "36" }, "delete": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "PJP - Delete a visit", "operationId": "pjpDeleteAVisit", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "visit_guid", "in": "path", "required": true, "description": "Visit GUID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 1, "description": "Number of records actually deleted. `1` = the record was found and removed, `0` = nothing matched the ID. The call returns `200 OK` either way, so check this value to confirm the delete." } } }, "example": { "count": 1 } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "36" } }, "/{tenant}/api/app-base/visits/search": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "PJP - Search visits", "operationId": "pjpSearchVisits", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "skip": { "type": "integer", "example": 0, "description": "Paging - number of records to skip before the page starts. `0` is the first page." }, "take": { "type": "integer", "example": -1, "description": "Paging - maximum number of records to return in this page. `-1` returns every match, which is only safe on small layers. Compare against `total` in the response to know when you have read everything." }, "visit_assignee_username": { "type": "string", "example": "<username>" }, "visit_date": { "type": "object", "properties": { "between": { "type": "array", "items": { "type": "string", "example": "2026-07-25T17:00:00.000Z" } } } }, "searchConfig": { "type": "object", "properties": { "includeCustomer": { "type": "boolean", "example": true }, "customerFields": { "type": "array", "items": { "type": "string", "example": "customer_full_name" } } } } }, "required": [ "skip", "take", "visit_assignee_username", "visit_date", "searchConfig" ] }, "example": { "skip": 0, "take": -1, "visit_assignee_username": "<username>", "visit_date": { "between": [ "2026-07-25T17:00:00.000Z", "2026-08-01T16:59:59.999Z" ] }, "searchConfig": { "includeCustomer": true, "customerFields": [ "customer_full_name", "customer_phone_number", "customer_email", "customer_address", "customer_guid" ] } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "36" } }, "/{tenant}/api/ndms2/events": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Events - Record an event", "operationId": "eventsRecordAnEvent", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "typeCode": { "type": "string", "example": "DUTY" }, "actionCode": { "type": "string", "example": "on_duty" }, "layerCode": { "type": "string", "example": "<optional layer>" }, "recordNodeId": { "type": "string", "example": "<optional record id>" } }, "required": [ "typeCode", "actionCode", "layerCode", "recordNodeId" ] }, "example": { "typeCode": "DUTY", "actionCode": "on_duty", "layerCode": "<optional layer>", "recordNodeId": "<optional record id>" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "27" } }, "/{tenant}/api/ndms2/events/search": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Events - Search events", "operationId": "eventsSearchEvents", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "properties": { "createUser": { "type": "string", "example": "<username>" } } } }, "required": [ "filter" ] }, "example": { "filter": { "createUser": "<username>" } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "27" } }, "/{tenant}/api/app-base/data-layer/CUSTOMER/layer-detail": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Customer - Get the CUSTOMER layer's field definitions (schema)", "description": "**Read this before writing to the layer.** `properties[]` is the authoritative field list - a create or update body may only use these `propertyName` keys.\n\n- `propertyName`: The key to send in a request body\n- `displayName`: Human label shown in the platform UI - never sent to the API\n- `dataType`: Numeric type code. See [Field data types](/docs/models/data-types) for the codes and the JSON value each expects\n- `required`: `true` means the field must be present on create\n- `isSystem`: Set by the platform. Do not send these, except `Title` and `Description`\n- `isAdditional`: A custom field defined for this tenant\n\nFields of `dataType` `10` (List) also carry their allowed values, or the layer they read from and any dependency on another field - see [Field data types](/docs/models/data-types).", "operationId": "customerGetTheCUSTOMERLayerSFieldDefinitionsSchema", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "properties": { "type": "object", "properties": { "layerSettings": { "type": "boolean", "example": true }, "isTakeAll": { "type": "boolean", "example": true } } } }, "required": [ "properties" ] }, "example": { "properties": { "layerSettings": true, "isTakeAll": true } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "layerName": { "type": "string", "example": "CUSTOMER", "description": "Layer the schema belongs to." }, "version": { "type": "integer", "example": 8, "description": "Schema version. It increases every time the layer definition is changed - compare it to detect that your integration is reading an outdated field list." }, "properties": { "type": "array", "items": { "type": "object", "properties": { "propertyName": { "type": "string", "example": "customer_full_name" }, "displayName": { "type": "string", "example": "Full name" }, "dataType": { "type": "integer", "example": 3 }, "required": { "type": "boolean", "example": true }, "isSystem": { "type": "boolean", "example": false }, "isAdditional": { "type": "boolean", "example": true } } }, "description": "One entry per field on the layer. This is the list of keys a create or update body may use." }, "layerSettings": { "type": "object", "properties": {}, "description": "Layer-level configuration, returned when `layerSettings: true` is requested." } } }, "example": { "layerName": "CUSTOMER", "version": 8, "properties": [ { "propertyName": "customer_full_name", "displayName": "Full name", "dataType": 3, "required": true, "isSystem": false, "isAdditional": true }, { "propertyName": "customer_category", "displayName": "Category", "dataType": 10, "required": false, "isSystem": false, "isAdditional": true } ], "layerSettings": {} } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "39c" } }, "/{tenant}/api/app-base/data-layer/CUSTOMER": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Customer - Create a customer", "description": "Two identifiers come back: `Id` is the record ID used by detail, update and delete; `customer_guid` is the business identifier other APIs reference, for example as a visit target.", "operationId": "customerCreateACustomer", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_full_name": { "type": "string", "example": "Sample Record" }, "customer_phone_number": { "type": "string", "example": "919000000001" }, "customer_email": { "type": "string", "example": "user@example.com" }, "customer_category": { "type": "string", "example": "Default" }, "customer_postal_code": { "type": "string", "example": "412108" }, "customer_address": { "type": "string", "example": "Mulshi, Pune, MAHARASHTRA - 412108" }, "customer_location": { "type": "string", "example": "{\"coordinates\":[73.55986487231496,18.462925230845542],\"type\":\"Point\"}" }, "customer_is_active": { "type": "string", "example": "true" } }, "required": [ "customer_full_name", "customer_phone_number", "customer_email", "customer_category", "customer_postal_code", "customer_address", "customer_location", "customer_is_active" ] }, "example": { "customer_full_name": "Sample Record", "customer_phone_number": "919000000001", "customer_email": "user@example.com", "customer_category": "Default", "customer_postal_code": "412108", "customer_address": "Mulshi, Pune, MAHARASHTRA - 412108", "customer_location": "{\"coordinates\":[73.55986487231496,18.462925230845542],\"type\":\"Point\"}", "customer_is_active": "true" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_guid": { "type": "string", "example": "6ab380e8e2e38fdef6e66f64", "description": "Business identifier of the customer, used by other APIs such as a visit target." }, "customer_full_name": { "type": "string", "example": "Sample Record", "description": "The value stored." }, "customer_phone_number": { "type": "string", "example": "919000000001", "description": "The value stored." }, "customer_email": { "type": "string", "example": "user@example.com", "description": "The value stored." }, "customer_category": { "type": "string", "example": "Default", "description": "Customer category." }, "customer_postal_code": { "type": "string", "example": "412108", "description": "Postal code (PIN)." }, "customer_address": { "type": "string", "example": "Mulshi, Pune, MAHARASHTRA - 412108", "description": "Address text." }, "customer_location": { "type": "string", "example": "{\"coordinates\":[73.55986487231496,18.462925230845542],\"type\":\"Point\"}", "description": "Customer position as GeoJSON serialized to a string (`[longitude, latitude]`)." }, "customer_is_active": { "type": "string", "example": "true", "description": "`\"true\"` when the customer is active - returned as a string." }, "customer_created_from": { "type": "integer", "example": 2, "description": "Channel that created the record, set by the platform: `1` Mobile, `2` Web, `3` Others." }, "customer_last_modified_from": { "type": "integer", "example": 2, "description": "Channel of the last change, set by the platform: `1` Mobile, `2` Web, `3` Others." }, "Title": { "type": "string", "example": "Sample Record", "description": "Display label of the record, kept in step with the full name." }, "customer_administrative_1": { "type": "integer", "example": 33, "description": "Numeric ID of the state." }, "customer_administrative_2": { "type": "integer", "example": 138, "description": "Numeric ID of the district." }, "customer_administrative_3": { "type": "integer", "example": 14204, "description": "Numeric ID of the tehsil." }, "customer_assigned_team": { "type": "string", "example": "2", "description": "Team the customer belongs to." }, "customer_assignee": { "type": "string", "example": "6a9fc4765f1d93f41e0a548f", "description": "GUID of the employee who owns this customer." }, "Id": { "type": "string", "example": "33f9d21c-10d2-40ea-9561-f3a0a44c1a8c", "description": "Record identifier - the value to use for detail, update and delete." }, "Path": { "type": "string", "example": "/<internal storage path>", "description": "Internal storage location. Read-only." } } }, "example": { "customer_guid": "6ab380e8e2e38fdef6e66f64", "customer_full_name": "Sample Record", "customer_phone_number": "919000000001", "customer_email": "user@example.com", "customer_category": "Default", "customer_postal_code": "412108", "customer_address": "Mulshi, Pune, MAHARASHTRA - 412108", "customer_location": "{\"coordinates\":[73.55986487231496,18.462925230845542],\"type\":\"Point\"}", "customer_is_active": "true", "customer_created_from": 2, "customer_last_modified_from": 2, "Title": "Sample Record", "customer_administrative_1": 33, "customer_administrative_2": 138, "customer_administrative_3": 14204, "customer_assigned_team": "2", "customer_assignee": "6a9fc4765f1d93f41e0a548f", "Id": "33f9d21c-10d2-40ea-9561-f3a0a44c1a8c", "Path": "/<internal storage path>" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "39c" } }, "/{tenant}/api/app-base/data-layer/CUSTOMER/search": { "post": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Customer - Search customers", "operationId": "customerSearchCustomers", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "skip": { "type": "integer", "example": 0, "description": "Paging - number of records to skip before the page starts. `0` is the first page." }, "take": { "type": "integer", "example": 20, "description": "Paging - maximum number of records to return in this page. `-1` returns every match, which is only safe on small layers. Compare against `total` in the response to know when you have read everything." } }, "required": [ "skip", "take" ] }, "example": { "skip": 0, "take": 20 } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "example": "00000000-0000-0000-0000-000000000001" }, "Layer": { "type": "string", "example": "CUSTOMER" }, "CreatedDate": { "type": "string", "example": "2026-07-15T11:15:45Z" }, "Title": { "type": "string", "example": "Sample Record" }, "customer_full_name": { "type": "string", "example": "Sample Record" }, "customer_phone_number": { "type": "string", "example": "919000000001" } } }, "description": "The page of matching records. Each entry carries the layer's own fields plus the system fields every record has." }, "total": { "type": "integer", "example": 1, "description": "Total number of records matching the query, ignoring `skip` and `take` - use it to drive paging." } } }, "example": { "data": [ { "Id": "00000000-0000-0000-0000-000000000001", "Layer": "CUSTOMER", "CreatedDate": "2026-07-15T11:15:45Z", "Title": "Sample Record", "customer_full_name": "Sample Record", "customer_phone_number": "919000000001" } ], "total": 1 } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "39c" } }, "/{tenant}/api/app-base/data-layer/CUSTOMER/{id}": { "put": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Customer - Update a customer", "description": "**The customer update response is compact, not the full record.** It returns the identifiers, the fields this call wrote, and a few ownership fields - not every `customer_*` value. Read the record back with `{id}/detail` if you need its full state.\n\nTwo identifiers are in play: `Id` is the record ID used by detail and delete; `customer_guid` (also returned as lower case `id`) is the business identifier other APIs reference, for example as a visit target.\n\n`Title` reflects the layer name rather than a per-record label for the customer.", "operationId": "customerUpdateACustomer", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "id", "in": "path", "required": true, "description": "`Id` of the customer record to update", "schema": { "type": "string", "example": "a7045037-7f06-478a-8eb4-127e7fcf9526" }, "example": "a7045037-7f06-478a-8eb4-127e7fcf9526" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_full_name": { "type": "string", "example": "Updated Name" } }, "required": [ "customer_full_name" ] }, "example": { "customer_full_name": "Updated Name" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "string", "example": "a7045037-7f06-478a-8eb4-127e7fcf9526", "description": "Record identifier - the value you sent in the path, and the one to use for detail and delete." }, "id": { "type": "string", "example": "6a9f866935eb145649301618", "description": "Lower case `id` is **not** a copy of `Id` here: it carries `customer_guid`. Do not use it where a record ID is expected." }, "customer_guid": { "type": "string", "example": "6a9f866935eb145649301618", "description": "Business identifier of the customer, used by other APIs such as a visit target." }, "customer_full_name": { "type": "string", "example": "Updated Name", "description": "The value this call wrote." }, "customer_assignee": { "type": "string", "example": "6a9b6a8a868d302be9d97ac6", "description": "GUID of the employee who owns this customer, unchanged by this call." }, "customer_assigned_team": { "type": "string", "example": "2", "description": "Team the customer belongs to, unchanged by this call." }, "customer_created_from": { "type": "integer", "example": 2, "description": "Channel the record was created from: `1` Mobile, `2` Web, `3` Others." }, "customer_last_modified_from": { "type": "integer", "example": 2, "description": "Channel of this change, set by the platform." }, "Title": { "type": "string", "example": "ZFLCFX_CUSTOMER", "description": "Returned as the internal layer name rather than a per-record label. Do not rely on it to identify the customer." }, "Path": { "type": "string", "example": "/<internal storage path>", "description": "Internal storage location. Read-only." } } }, "example": { "Id": "a7045037-7f06-478a-8eb4-127e7fcf9526", "id": "6a9f866935eb145649301618", "customer_guid": "6a9f866935eb145649301618", "customer_full_name": "Updated Name", "customer_assignee": "6a9b6a8a868d302be9d97ac6", "customer_assigned_team": "2", "customer_created_from": 2, "customer_last_modified_from": 2, "Title": "ZFLCFX_CUSTOMER", "Path": "/<internal storage path>" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "39c" }, "delete": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Customer - Delete a customer", "operationId": "customerDeleteACustomer", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "id", "in": "path", "required": true, "description": "Customer record ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 1, "description": "Number of records actually deleted. `1` = the customer was found and removed, `0` = nothing matched the ID. The call returns `200 OK` either way, so check this value to confirm the delete." } } }, "example": { "count": 1 } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "39c" } }, "/{tenant}/api/app-base/data-layer/CUSTOMER/{id}/detail": { "get": { "tags": [ "Field Force Mobility Execution APIs" ], "summary": "Customer - Get one customer with all its values", "operationId": "customerGetOneCustomerWithAllItsValues", "parameters": [ { "name": "tenant", "in": "path", "required": true, "description": "Your tenant code. `demo` is a shared demo tenant - treat anything you create there as public.", "schema": { "type": "string", "default": "demo", "example": "demo" }, "example": "demo" }, { "name": "id", "in": "path", "required": true, "description": "Customer record ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "string", "example": "<uuid>", "description": "Record identifier, the value to pass to update and delete." }, "Layer": { "type": "string", "example": "CUSTOMER", "description": "Layer the record belongs to." }, "CreatedDate": { "type": "string", "example": "2026-07-15T11:15:45Z", "description": "When the record was created, UTC." }, "Title": { "type": "string", "example": "<title>", "description": "Display label of the record." }, "customer_full_name": { "type": "string", "example": "<value>" }, "customer_phone_number": { "type": "string", "example": "<value>" } } }, "example": { "Id": "<uuid>", "Layer": "CUSTOMER", "CreatedDate": "2026-07-15T11:15:45Z", "Title": "<title>", "customer_full_name": "<value>", "customer_phone_number": "<value>" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyQueryAuth": [] } ], "x-master-list-no": "39c" } }, "/geocode/suggest": { "post": { "tags": [ "Location and Address Intelligence APIs" ], "summary": "Geocode Suggest API", "operationId": "geocodeSuggestAPI", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "searchKey": { "type": "string", "example": "superm", "description": "Partial text typed so far." } }, "required": [ "searchKey" ] }, "example": { "searchKey": "superm" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "J.D Fresh Supermarket", "description": "Place name." }, "location_llt": { "type": "string", "example": "19.23262075,72.96960290000001", "description": "`\"lat,lon\"` string - the same position as `latitude` / `longitude`." }, "country": { "type": "string", "example": "India", "description": "Country." }, "categorye": { "type": "string", "example": "greengrocer", "description": "Category name." }, "province": { "type": "string", "example": "MAHARASHTRA", "description": "State." }, "_version_": { "type": "integer", "example": 1852547300003414000, "description": "Internal index version. Ignore it." }, "district": { "type": "string", "example": "Thane", "description": "District." }, "id": { "type": "string", "example": "b8d22390-269a-4a86-aa17-2e52beec00e1", "description": "Result ID." }, "categoryCode": { "type": "integer", "example": 2528, "description": "Numeric category code." }, "subCategoryCode": { "type": "integer", "example": 994875171, "description": "Numeric sub-category code." }, "longitude": { "type": "number", "example": 72.96960290000001, "description": "Longitude of the point, decimal degrees." }, "latitude": { "type": "number", "example": 19.23262075, "description": "Latitude of the point, decimal degrees." }, "resultType": { "type": "integer", "example": 2, "description": "Kind of match. `2` = place / POI." } } }, "description": "Suggestions, best first." } } }, "example": { "docs": [ { "name": "J.D Fresh Supermarket", "location_llt": "19.23262075,72.96960290000001", "country": "India", "categorye": "greengrocer", "province": "MAHARASHTRA", "_version_": 1852547300003414000, "district": "Thane", "id": "b8d22390-269a-4a86-aa17-2e52beec00e1", "categoryCode": 2528, "subCategoryCode": 994875171, "longitude": 72.96960290000001, "latitude": 19.23262075, "resultType": 2 }, { "name": "Royalmart Supermarket", "location_llt": "13.049469035867427,77.50793970982083", "country": "India", "categorye": "retail", "province": "KARNATAKA", "_version_": 1852547287804280800, "district": "Bangalore", "id": "9dd98de3-0b63-4090-a9fa-28da6d71ed20", "categoryCode": 7212, "subCategoryCode": 726126339, "longitude": 77.50793970982083, "latitude": 13.049469035867427, "resultType": 2 } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "6", "x-server": "core" } }, "/geocode/reverse#reverse-geocode-several-points-in-one-call": { "post": { "tags": [ "Location and Address Intelligence APIs" ], "summary": "Batch Reverse Geocoding API", "description": "Same endpoint as the [Reverse Geocode API](/docs/api/reverse-geocode); sending a flat array of `longitude, latitude` pairs instead of an object returns one address per pair.", "operationId": "batchReverseGeocodingAPI", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "number", "example": 77.06615, "description": "Flat list of numbers: `longitude, latitude` for the first point, then the next point, and so on." } }, "example": [ 77.06615, 28.462238, 72.8455, 19.0829 ] } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Country": { "type": "string", "example": "India", "description": "Country." }, "District": { "type": "string", "example": "Gurugram", "description": "District." }, "PinCode": { "type": "object", "properties": { "OfficeName": { "type": "string", "example": "Industrial Estate (Gurgaon)", "description": "Post office name." }, "OfficeType": { "type": "string", "example": "S.O", "description": "Post office type, e.g. `S.O` (sub office)." }, "Value": { "type": "string", "example": "122007", "description": "Postal code (PIN)." } } }, "Road": { "type": "string", "example": "", "description": "Nearest road name. Empty when none is known." }, "State": { "type": "string", "example": "HARYANA", "description": "State." }, "Status": { "type": "boolean", "example": true, "description": "`true` when an address was found." }, "Tehsil": { "type": "string", "example": "Gurgaon", "description": "Tehsil (sub-district)." }, "Village": { "type": "string", "example": "", "description": "Village. Empty when the point is not in a village." } }, "description": "One address per input point, in input order." } }, "example": [ { "Country": "India", "District": "Gurugram", "PinCode": { "OfficeName": "Industrial Estate (Gurgaon)", "OfficeType": "S.O", "Value": "122007" }, "Road": "", "State": "HARYANA", "Status": true, "Tehsil": "Gurgaon", "Village": "" }, { "Country": "India", "District": "Mumbai Suburban", "PinCode": { "OfficeName": "Santacruz(East)", "OfficeType": "S.O", "Value": "400055" }, "Road": "NCL Colony Road", "State": "MAHARASHTRA", "Status": true, "Tehsil": "Mumbai Suburban", "Village": "" } ] } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "26b", "x-server": "core" } }, "/geocode/digipin-decode": { "post": { "tags": [ "Location and Address Intelligence APIs" ], "summary": "Decode a DIGIPIN (JSON body)", "operationId": "decodeADIGIPINJSONBody", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "digipin": { "type": "string", "example": "4T38MJK524", "description": "10-character DIGIPIN to decode." } }, "required": [ "digipin" ] }, "example": { "digipin": "4T38MJK524" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "latitude": { "type": "string", "example": "13.067526", "description": "Latitude of the cell centre, as a string." }, "longitude": { "type": "string", "example": "80.270956", "description": "Longitude of the cell centre, as a string." }, "level": { "type": "integer", "example": 10, "description": "Number of DIGIPIN characters decoded." }, "bounds": { "type": "object", "properties": { "minLatitude": { "type": "string", "example": "13.067509", "description": "South edge of the cell." }, "maxLatitude": { "type": "string", "example": "13.067543", "description": "North edge of the cell." }, "minLongitude": { "type": "string", "example": "80.270939", "description": "West edge of the cell." }, "maxLongitude": { "type": "string", "example": "80.270973", "description": "East edge of the cell." } } } } }, "example": { "latitude": "13.067526", "longitude": "80.270956", "level": 10, "bounds": { "minLatitude": "13.067509", "maxLatitude": "13.067543", "minLongitude": "80.270939", "maxLongitude": "80.270973" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-server": "core" } }, "/geocode/digipin-decode#decode-a-digipin-query-string": { "get": { "tags": [ "Location and Address Intelligence APIs" ], "summary": "Decode a DIGIPIN (query string)", "operationId": "decodeADIGIPINQueryString", "parameters": [ { "name": "digipin", "in": "query", "required": true, "description": "10-character DIGIPIN to decode.", "schema": { "type": "string", "example": "4T38MJK524" }, "example": "4T38MJK524" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "latitude": { "type": "string", "example": "13.067526", "description": "Latitude of the cell centre, as a string." }, "longitude": { "type": "string", "example": "80.270956", "description": "Longitude of the cell centre, as a string." }, "level": { "type": "integer", "example": 10, "description": "Number of DIGIPIN characters decoded." }, "bounds": { "type": "object", "properties": { "minLatitude": { "type": "string", "example": "13.067509", "description": "South edge of the cell." }, "maxLatitude": { "type": "string", "example": "13.067543", "description": "North edge of the cell." }, "minLongitude": { "type": "string", "example": "80.270939", "description": "West edge of the cell." }, "maxLongitude": { "type": "string", "example": "80.270973", "description": "East edge of the cell." } } } } }, "example": { "latitude": "13.067526", "longitude": "80.270956", "level": 10, "bounds": { "minLatitude": "13.067509", "maxLatitude": "13.067543", "minLongitude": "80.270939", "maxLongitude": "80.270973" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-server": "core" } }, "/geocode/digipin-encode": { "get": { "tags": [ "Location and Address Intelligence APIs" ], "summary": "Encode coordinates into a DIGIPIN", "operationId": "encodeCoordinatesIntoADIGIPIN", "parameters": [ { "name": "latitude", "in": "query", "required": true, "description": "Latitude, decimal degrees.", "schema": { "type": "string", "example": "13.067526" }, "example": "13.067526" }, { "name": "longitude", "in": "query", "required": true, "description": "Longitude, decimal degrees.", "schema": { "type": "string", "example": "80.270956" }, "example": "80.270956" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "digipin": { "type": "string", "example": "4T38MJK524", "description": "10-character DIGIPIN of the cell containing the point." } } }, "example": { "digipin": "4T38MJK524" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-server": "core" } }, "/routing/adapter/isochrone": { "post": { "tags": [ "Route and Journey Intelligence APIs" ], "summary": "Isochrone API - by distance", "operationId": "isochroneAPIByDistance", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "locations": { "type": "array", "items": { "type": "object", "properties": { "lat": { "type": "number", "example": 30.744014, "description": "Latitude of the point, decimal degrees." }, "lon": { "type": "number", "example": 73.990508, "description": "Longitude of the point, decimal degrees." } } }, "description": "Starting point." }, "costing": { "type": "string", "example": "auto", "description": "Travel mode used for costing. The examples use `auto` (driving) and `pedestrian` (walking)." }, "polygons": { "type": "boolean", "example": true, "description": "`true` returns polygons." }, "contours": { "type": "array", "items": { "type": "object", "properties": { "distance": { "type": "number", "example": 5.0, "description": "Distance limit for this contour." }, "color": { "type": "string", "example": "ff0000", "description": "Hex colour (without `#`) to tag the polygon with." } } }, "description": "Limits to compute - one polygon each." } }, "required": [ "locations", "costing", "polygons", "contours" ] }, "example": { "locations": [ { "lat": 30.744014, "lon": 73.990508 } ], "costing": "auto", "polygons": true, "contours": [ { "distance": 5.0, "color": "ff0000" } ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "object", "properties": { "properties": { "type": "object", "properties": { "fill-opacity": { "type": "number", "example": 0.33, "description": "Suggested fill opacity." }, "fillColor": { "type": "string", "example": "#ff0000", "description": "Fill colour, for rendering." }, "opacity": { "type": "number", "example": 0.33, "description": "Suggested opacity." }, "fill": { "type": "string", "example": "#ff0000", "description": "Fill colour, for rendering." }, "fillOpacity": { "type": "number", "example": 0.33, "description": "Suggested fill opacity." }, "color": { "type": "string", "example": "#ff0000", "description": "Colour you requested, for rendering." }, "contour": { "type": "integer", "example": 5, "description": "The contour value this polygon represents." }, "metric": { "type": "string", "example": "distance", "description": "`distance` or `time`." } } }, "geometry": { "type": "object", "properties": { "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number", "example": 73.990508 } } }, "description": "Polygon rings of `[longitude, latitude]` points." }, "type": { "type": "string", "example": "Polygon" } } }, "type": { "type": "string", "example": "Feature" } } }, "description": "One polygon per contour." }, "type": { "type": "string", "example": "FeatureCollection", "description": "Always `FeatureCollection`." } } }, "example": { "features": [ { "properties": { "fill-opacity": 0.33, "fillColor": "#ff0000", "opacity": 0.33, "fill": "#ff0000", "fillOpacity": 0.33, "color": "#ff0000", "contour": 5, "metric": "distance" }, "geometry": { "coordinates": [ [ [ 73.990508, 30.744847 ], [ 73.989841, 30.744681 ], [ 73.989675, 30.744014 ], [ 73.989841, 30.743347 ], [ 73.990508, 30.743181 ], [ 73.991175, 30.743347 ], [ 73.991341, 30.744014 ], [ 73.991175, 30.744681 ], [ 73.990508, 30.744847 ] ] ], "type": "Polygon" }, "type": "Feature" } ], "type": "FeatureCollection" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "15", "x-server": "core" } }, "/routing/adapter/isochrone#isochrone-api-by-travel-time": { "post": { "tags": [ "Route and Journey Intelligence APIs" ], "summary": "Isochrone API - by travel time", "operationId": "isochroneAPIByTravelTime", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "locations": { "type": "array", "items": { "type": "object", "properties": { "lat": { "type": "number", "example": 30.744014, "description": "Latitude of the point, decimal degrees." }, "lon": { "type": "number", "example": 73.990508, "description": "Longitude of the point, decimal degrees." } } }, "description": "Starting point." }, "costing": { "type": "string", "example": "pedestrian", "description": "Travel mode used for costing. The examples use `auto` (driving) and `pedestrian` (walking)." }, "polygons": { "type": "boolean", "example": true, "description": "`true` returns polygons." }, "contours": { "type": "array", "items": { "type": "object", "properties": { "time": { "type": "number", "example": 15.0, "description": "Travel-time limit for this contour." }, "color": { "type": "string", "example": "ff0000", "description": "Hex colour (without `#`) to tag the polygon with." } } }, "description": "Limits to compute - one polygon each." } }, "required": [ "locations", "costing", "polygons", "contours" ] }, "example": { "locations": [ { "lat": 30.744014, "lon": 73.990508 } ], "costing": "pedestrian", "polygons": true, "contours": [ { "time": 15.0, "color": "ff0000" } ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "object", "properties": { "properties": { "type": "object", "properties": { "fill-opacity": { "type": "number", "example": 0.33, "description": "Suggested fill opacity." }, "fillColor": { "type": "string", "example": "#ff0000", "description": "Fill colour, for rendering." }, "opacity": { "type": "number", "example": 0.33, "description": "Suggested opacity." }, "fill": { "type": "string", "example": "#ff0000", "description": "Fill colour, for rendering." }, "fillOpacity": { "type": "number", "example": 0.33, "description": "Suggested fill opacity." }, "color": { "type": "string", "example": "#ff0000", "description": "Colour you requested, for rendering." }, "contour": { "type": "integer", "example": 15, "description": "The contour value this polygon represents." }, "metric": { "type": "string", "example": "time", "description": "`distance` or `time`." } } }, "geometry": { "type": "object", "properties": { "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number", "example": 73.990508 } } }, "description": "Polygon rings of `[longitude, latitude]` points." }, "type": { "type": "string", "example": "Polygon" } } }, "type": { "type": "string", "example": "Feature" } } }, "description": "One polygon per contour." }, "type": { "type": "string", "example": "FeatureCollection", "description": "Always `FeatureCollection`." } } }, "example": { "features": [ { "properties": { "fill-opacity": 0.33, "fillColor": "#ff0000", "opacity": 0.33, "fill": "#ff0000", "fillOpacity": 0.33, "color": "#ff0000", "contour": 15, "metric": "time" }, "geometry": { "coordinates": [ [ [ 73.990508, 30.744952 ], [ 73.989633, 30.744889 ], [ 73.989633, 30.743139 ], [ 73.991383, 30.743139 ], [ 73.991383, 30.744889 ], [ 73.990508, 30.744952 ] ] ], "type": "Polygon" }, "type": "Feature" } ], "type": "FeatureCollection" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "15", "x-server": "core" } }, "/routing/adapter/nearest/v1/{profile}/{coordinates}": { "get": { "tags": [ "Route and Journey Intelligence APIs" ], "summary": "Snap a point to the nearest road", "operationId": "snapAPointToTheNearestRoad", "parameters": [ { "name": "profile", "in": "path", "required": true, "description": "Routing profile. The example uses `car`.", "schema": { "type": "string", "example": "car" }, "example": "car" }, { "name": "coordinates", "in": "path", "required": true, "description": "Point to snap, as `lon,lat`.", "schema": { "type": "string", "example": "72.8460,19.0806" }, "example": "72.8460,19.0806" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "Ok", "description": "`Ok` on success." }, "waypoints": { "type": "array", "items": { "type": "object", "properties": { "nodes": { "type": "array", "items": { "type": "integer", "example": 245668413 }, "description": "Internal road-graph node IDs." }, "hint": { "type": "string", "example": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "description": "Internal hint. Ignore it." }, "location": { "type": "array", "items": { "type": "number", "example": 72.846003 }, "description": "Snapped position on the road, `[longitude, latitude]`." }, "name": { "type": "string", "example": "Station Road", "description": "Name of the road." }, "distance": { "type": "number", "example": 3.666487744, "description": "Distance from the input point to the snapped position, metres." } } }, "description": "The snapped point." } } }, "example": { "code": "Ok", "waypoints": [ { "nodes": [ 245668413, 245668413 ], "hint": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "location": [ 72.846003, 19.080533 ], "name": "Station Road", "distance": 3.666487744 } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "16", "x-server": "core" } }, "/routing/adapter/locate": { "post": { "tags": [ "Route and Journey Intelligence APIs" ], "summary": "Get road details at a point", "description": "The example response is shortened to the first road segment.", "operationId": "getRoadDetailsAtAPoint", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "locations": { "type": "array", "items": { "type": "object", "properties": { "lat": { "type": "number", "example": 19.0829, "description": "Latitude of the point, decimal degrees." }, "lon": { "type": "number", "example": 72.8455, "description": "Longitude of the point, decimal degrees." } } }, "description": "Points to look up." }, "verbose": { "type": "boolean", "example": true, "description": "`true` returns the full road attributes." } }, "required": [ "locations", "verbose" ] }, "example": { "locations": [ { "lat": 19.0829, "lon": 72.8455 } ], "verbose": true } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "input_lon": { "type": "number", "example": 72.8455, "description": "Longitude you sent." }, "nodes": { "type": "array", "items": {} }, "input_lat": { "type": "number", "example": 19.0829, "description": "Latitude you sent." }, "edges": { "type": "array", "items": { "type": "object", "properties": { "access_restrictions": { "type": "array", "items": {} }, "live_speed": { "type": "object", "properties": {} }, "correlated_lon": { "type": "number", "example": 72.845463, "description": "Longitude of the point snapped onto this segment." }, "side_of_street": { "type": "string", "example": "neither" }, "linear_reference": { "type": "string", "example": "KzPNHA2R7HrgAAADAA46UJc=" }, "percent_along": { "type": "number", "example": 0.59093 }, "outbound_reach": { "type": "integer", "example": 50 }, "distance": { "type": "number", "example": 3.9, "description": "Distance from the input point to the segment, metres." }, "edge_info": { "type": "object", "properties": { "speed_limit": { "type": "integer", "example": 0, "description": "Posted speed limit. `0` when unknown." }, "mean_elevation": { "type": "string", "example": null }, "shape": { "type": "string", "example": "qkvkc@qhc}iCxFJ" }, "names": { "type": "array", "items": {}, "description": "Road names of the segment." }, "bike_network": { "type": "object", "properties": { "mountain": { "type": "boolean", "example": false }, "local": { "type": "boolean", "example": false }, "regional": { "type": "boolean", "example": false }, "national": { "type": "boolean", "example": false } } }, "way_id": { "type": "integer", "example": 1487977608 } } }, "edge": { "type": "object", "properties": { "bridge": { "type": "boolean", "example": false }, "access": { "type": "object", "properties": { "truck": { "type": "boolean", "example": true }, "pedestrian": { "type": "boolean", "example": true }, "wheelchair": { "type": "boolean", "example": true }, "taxi": { "type": "boolean", "example": true }, "HOV": { "type": "boolean", "example": true }, "emergency": { "type": "boolean", "example": false }, "motorcycle": { "type": "boolean", "example": true }, "car": { "type": "boolean", "example": true }, "moped": { "type": "boolean", "example": true }, "bus": { "type": "boolean", "example": true }, "bicycle": { "type": "boolean", "example": true } }, "description": "Which travel modes may use the segment." }, "has_sign": { "type": "boolean", "example": false }, "deadend": { "type": "boolean", "example": false }, "country_crossing": { "type": "boolean", "example": false }, "tunnel": { "type": "boolean", "example": false }, "seasonal": { "type": "boolean", "example": false }, "end_restriction": { "type": "object", "properties": { "truck": { "type": "boolean", "example": false }, "pedestrian": { "type": "boolean", "example": false }, "wheelchair": { "type": "boolean", "example": false }, "taxi": { "type": "boolean", "example": false }, "HOV": { "type": "boolean", "example": false }, "emergency": { "type": "boolean", "example": false }, "motorcycle": { "type": "boolean", "example": false }, "car": { "type": "boolean", "example": false }, "moped": { "type": "boolean", "example": false }, "bus": { "type": "boolean", "example": false }, "bicycle": { "type": "boolean", "example": false } } }, "cycle_lane": { "type": "string", "example": "none" }, "start_restriction": { "type": "object", "properties": { "truck": { "type": "boolean", "example": false }, "pedestrian": { "type": "boolean", "example": false }, "wheelchair": { "type": "boolean", "example": false }, "taxi": { "type": "boolean", "example": false }, "HOV": { "type": "boolean", "example": false }, "emergency": { "type": "boolean", "example": false }, "motorcycle": { "type": "boolean", "example": false }, "car": { "type": "boolean", "example": false }, "moped": { "type": "boolean", "example": false }, "bus": { "type": "boolean", "example": false }, "bicycle": { "type": "boolean", "example": false } } }, "geo_attributes": { "type": "object", "properties": { "curvature": { "type": "integer", "example": 0 }, "max_down_slope": { "type": "integer", "example": 0 }, "max_up_slope": { "type": "integer", "example": 0 }, "weighted_grade": { "type": "integer", "example": 0 }, "length": { "type": "integer", "example": 14 } } }, "part_of_complex_restriction": { "type": "boolean", "example": false }, "access_restriction": { "type": "boolean", "example": false }, "traffic_signal": { "type": "boolean", "example": false }, "toll": { "type": "boolean", "example": false, "description": "`true` on a toll road." }, "round_about": { "type": "boolean", "example": false }, "bike_network": { "type": "boolean", "example": false }, "speeds": { "type": "object", "properties": { "predicted": { "type": "boolean", "example": false }, "constrained_flow": { "type": "integer", "example": 0 }, "free_flow": { "type": "integer", "example": 0 }, "type": { "type": "string", "example": "classified" }, "default": { "type": "integer", "example": 20 } } }, "truck_route": { "type": "boolean", "example": false }, "end_node": { "type": "object", "properties": { "value": { "type": "integer", "example": 982109701018 }, "id": { "type": "integer", "example": 29269 }, "tile_id": { "type": "integer", "example": 628851 }, "level": { "type": "integer", "example": 2 } } }, "not_thru": { "type": "boolean", "example": false }, "destination_only": { "type": "boolean", "example": true }, "yield_sign": { "type": "boolean", "example": false }, "classification": { "type": "object", "properties": { "internal": { "type": "boolean", "example": false }, "link": { "type": "boolean", "example": false }, "surface": { "type": "string", "example": "paved_smooth" }, "use": { "type": "string", "example": "service_road", "description": "What the road is used for, e.g. `service_road`." }, "classification": { "type": "string", "example": "service_other" } } }, "sac_scale": { "type": "string", "example": "none" }, "forward": { "type": "boolean", "example": false }, "stop_sign": { "type": "boolean", "example": false }, "lane_count": { "type": "integer", "example": 1, "description": "Number of lanes." }, "sidewalk_right": { "type": "boolean", "example": false }, "sidewalk_left": { "type": "boolean", "example": false } } }, "heading": { "type": "number", "example": 2.6 }, "inbound_reach": { "type": "integer", "example": 50 }, "correlated_lat": { "type": "number", "example": 19.082902, "description": "Latitude of the point snapped onto this segment." }, "edge_id": { "type": "object", "properties": { "value": { "type": "integer", "example": 2123597923226 }, "id": { "type": "integer", "example": 63288 }, "tile_id": { "type": "integer", "example": 628851 }, "level": { "type": "integer", "example": 2 } } }, "predicted_speeds": { "type": "array", "items": {} } } }, "description": "Road segments near the point." } }, "description": "One entry per input point." } }, "example": [ { "input_lon": 72.8455, "nodes": [], "input_lat": 19.0829, "edges": [ { "access_restrictions": [], "live_speed": {}, "correlated_lon": 72.845463, "side_of_street": "neither", "linear_reference": "KzPNHA2R7HrgAAADAA46UJc=", "percent_along": 0.59093, "outbound_reach": 50, "distance": 3.9, "edge_info": { "speed_limit": 0, "mean_elevation": null, "shape": "qkvkc@qhc}iCxFJ", "names": [], "bike_network": { "mountain": false, "local": false, "regional": false, "national": false }, "way_id": 1487977608 }, "edge": { "bridge": false, "access": { "truck": true, "pedestrian": true, "wheelchair": true, "taxi": true, "HOV": true, "emergency": false, "motorcycle": true, "car": true, "moped": true, "bus": true, "bicycle": true }, "has_sign": false, "deadend": false, "country_crossing": false, "tunnel": false, "seasonal": false, "end_restriction": { "truck": false, "pedestrian": false, "wheelchair": false, "taxi": false, "HOV": false, "emergency": false, "motorcycle": false, "car": false, "moped": false, "bus": false, "bicycle": false }, "cycle_lane": "none", "start_restriction": { "truck": false, "pedestrian": false, "wheelchair": false, "taxi": false, "HOV": false, "emergency": false, "motorcycle": false, "car": false, "moped": false, "bus": false, "bicycle": false }, "geo_attributes": { "curvature": 0, "max_down_slope": 0, "max_up_slope": 0, "weighted_grade": 0, "length": 14 }, "part_of_complex_restriction": false, "access_restriction": false, "traffic_signal": false, "toll": false, "round_about": false, "bike_network": false, "speeds": { "predicted": false, "constrained_flow": 0, "free_flow": 0, "type": "classified", "default": 20 }, "truck_route": false, "end_node": { "value": 982109701018, "id": 29269, "tile_id": 628851, "level": 2 }, "not_thru": false, "destination_only": true, "yield_sign": false, "classification": { "internal": false, "link": false, "surface": "paved_smooth", "use": "service_road", "classification": "service_other" }, "sac_scale": "none", "forward": false, "stop_sign": false, "lane_count": 1, "sidewalk_right": false, "sidewalk_left": false }, "heading": 2.6, "inbound_reach": 50, "correlated_lat": 19.082902, "edge_id": { "value": 2123597923226, "id": 63288, "tile_id": 628851, "level": 2 }, "predicted_speeds": [] } ] } ] } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "16", "x-server": "core" } }, "/elevation/30m": { "get": { "tags": [ "Map Visualization" ], "summary": "Elevation - single location", "operationId": "elevationSingleLocation", "parameters": [ { "name": "locations", "in": "query", "required": true, "description": "`latitude,longitude` pairs separated by `|`, or an encoded polyline.", "schema": { "type": "string", "example": "28.6129,77.2295" }, "example": "28.6129,77.2295" }, { "name": "format", "in": "query", "required": false, "description": "`json` (default) or `geojson`.", "schema": { "type": "string" } }, { "name": "interpolation", "in": "query", "required": false, "description": "How to interpolate between data points: `nearest`, `bilinear` (default) or `cubic`.", "schema": { "type": "string" } }, { "name": "nodata_value", "in": "query", "required": false, "description": "Elevation to return where the dataset has no data: `null` (default), `nan`, or an integer such as `-9999`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "dataset": { "type": "string", "example": "srtm30m", "description": "Dataset the elevation comes from." }, "elevation": { "type": "integer", "example": 213, "description": "Elevation in metres. `null` when the location is outside the dataset or has no data." }, "location": { "type": "object", "properties": { "lat": { "type": "number", "example": 28.6129, "description": "Latitude of the location." }, "lng": { "type": "number", "example": 77.2295, "description": "Longitude of the location." } } } } }, "description": "One entry per input location, in input order." }, "status": { "type": "string", "example": "OK", "description": "`OK` on success, `INVALID_REQUEST` for an input error, `SERVER_ERROR` otherwise." } } }, "example": { "results": [ { "dataset": "srtm30m", "elevation": 213, "location": { "lat": 28.6129, "lng": 77.2295 } } ], "status": "OK" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "23", "x-server": "core" } }, "/elevation/30m#elevation-single-location-geojson": { "get": { "tags": [ "Map Visualization" ], "summary": "Elevation - single location (GeoJSON)", "operationId": "elevationSingleLocationGeoJSON", "parameters": [ { "name": "locations", "in": "query", "required": true, "description": "`latitude,longitude` pairs separated by `|`, or an encoded polyline.", "schema": { "type": "string", "example": "28.6129,77.2295" }, "example": "28.6129,77.2295" }, { "name": "format", "in": "query", "required": false, "description": "`json` (default) or `geojson`.", "schema": { "type": "string", "example": "geojson" }, "example": "geojson" }, { "name": "interpolation", "in": "query", "required": false, "description": "How to interpolate between data points: `nearest`, `bilinear` (default) or `cubic`.", "schema": { "type": "string" } }, { "name": "nodata_value", "in": "query", "required": false, "description": "Elevation to return where the dataset has no data: `null` (default), `nan`, or an integer such as `-9999`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "object", "properties": { "geometry": { "type": "object", "properties": { "coordinates": { "type": "array", "items": { "type": "number", "example": 77.2295 }, "description": "`[longitude, latitude, elevation]` - elevation in metres." }, "type": { "type": "string", "example": "Point" } } }, "properties": { "type": "object", "properties": { "dataset": { "type": "string", "example": "srtm30m", "description": "Dataset the elevation comes from." } } }, "type": { "type": "string", "example": "Feature" } } }, "description": "One point feature per input location, in input order." }, "type": { "type": "string", "example": "FeatureCollection", "description": "Always `FeatureCollection`." } } }, "example": { "features": [ { "geometry": { "coordinates": [ 77.2295, 28.6129, 213 ], "type": "Point" }, "properties": { "dataset": "srtm30m" }, "type": "Feature" } ], "type": "FeatureCollection" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "23", "x-server": "core" } }, "/elevation/30m#elevation-multiple-locations": { "get": { "tags": [ "Map Visualization" ], "summary": "Elevation - multiple locations", "operationId": "elevationMultipleLocations", "parameters": [ { "name": "locations", "in": "query", "required": true, "description": "`latitude,longitude` pairs separated by `|`, or an encoded polyline.", "schema": { "type": "string", "example": "28.6129,77.2295|31.1048,77.1734|12.9716,77.5946" }, "example": "28.6129,77.2295|31.1048,77.1734|12.9716,77.5946" }, { "name": "format", "in": "query", "required": false, "description": "`json` (default) or `geojson`.", "schema": { "type": "string" } }, { "name": "interpolation", "in": "query", "required": false, "description": "How to interpolate between data points: `nearest`, `bilinear` (default) or `cubic`.", "schema": { "type": "string" } }, { "name": "nodata_value", "in": "query", "required": false, "description": "Elevation to return where the dataset has no data: `null` (default), `nan`, or an integer such as `-9999`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "dataset": { "type": "string", "example": "srtm30m", "description": "Dataset the elevation comes from." }, "elevation": { "type": "integer", "example": 213, "description": "Elevation in metres. `null` when the location is outside the dataset or has no data." }, "location": { "type": "object", "properties": { "lat": { "type": "number", "example": 28.6129, "description": "Latitude of the location." }, "lng": { "type": "number", "example": 77.2295, "description": "Longitude of the location." } } } } }, "description": "One entry per input location, in input order." }, "status": { "type": "string", "example": "OK", "description": "`OK` on success, `INVALID_REQUEST` for an input error, `SERVER_ERROR` otherwise." } } }, "example": { "results": [ { "dataset": "srtm30m", "elevation": 213, "location": { "lat": 28.6129, "lng": 77.2295 } }, { "dataset": "srtm30m", "elevation": 2204, "location": { "lat": 31.1048, "lng": 77.1734 } }, { "dataset": "srtm30m", "elevation": 914, "location": { "lat": 12.9716, "lng": 77.5946 } } ], "status": "OK" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "23", "x-server": "core" } }, "/elevation/30m#elevation-multiple-locations-geojson": { "get": { "tags": [ "Map Visualization" ], "summary": "Elevation - multiple locations (GeoJSON)", "operationId": "elevationMultipleLocationsGeoJSON", "parameters": [ { "name": "locations", "in": "query", "required": true, "description": "`latitude,longitude` pairs separated by `|`, or an encoded polyline.", "schema": { "type": "string", "example": "28.6129,77.2295|31.1048,77.1734|12.9716,77.5946" }, "example": "28.6129,77.2295|31.1048,77.1734|12.9716,77.5946" }, { "name": "format", "in": "query", "required": false, "description": "`json` (default) or `geojson`.", "schema": { "type": "string", "example": "geojson" }, "example": "geojson" }, { "name": "interpolation", "in": "query", "required": false, "description": "How to interpolate between data points: `nearest`, `bilinear` (default) or `cubic`.", "schema": { "type": "string" } }, { "name": "nodata_value", "in": "query", "required": false, "description": "Elevation to return where the dataset has no data: `null` (default), `nan`, or an integer such as `-9999`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "object", "properties": { "geometry": { "type": "object", "properties": { "coordinates": { "type": "array", "items": { "type": "number", "example": 77.2295 }, "description": "`[longitude, latitude, elevation]` - elevation in metres." }, "type": { "type": "string", "example": "Point" } } }, "properties": { "type": "object", "properties": { "dataset": { "type": "string", "example": "srtm30m", "description": "Dataset the elevation comes from." } } }, "type": { "type": "string", "example": "Feature" } } }, "description": "One point feature per input location, in input order." }, "type": { "type": "string", "example": "FeatureCollection", "description": "Always `FeatureCollection`." } } }, "example": { "features": [ { "geometry": { "coordinates": [ 77.2295, 28.6129, 213 ], "type": "Point" }, "properties": { "dataset": "srtm30m" }, "type": "Feature" }, { "geometry": { "coordinates": [ 77.1734, 31.1048, 2204 ], "type": "Point" }, "properties": { "dataset": "srtm30m" }, "type": "Feature" }, { "geometry": { "coordinates": [ 77.5946, 12.9716, 914 ], "type": "Point" }, "properties": { "dataset": "srtm30m" }, "type": "Feature" } ], "type": "FeatureCollection" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "23", "x-server": "core" } }, "/elevation/30m#elevation-multiple-locations-post": { "post": { "tags": [ "Map Visualization" ], "summary": "Elevation - multiple locations (POST)", "description": "Same arguments as the `GET` call, in the body - use it when the location list is too long for a URL.", "operationId": "elevationMultipleLocationsPOST", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "locations": { "type": "string", "example": "28.6129,77.2295|31.1048,77.1734|12.9716,77.5946", "description": "`latitude,longitude` pairs separated by `|`, or an encoded polyline." } }, "required": [ "locations" ] }, "example": { "locations": "28.6129,77.2295|31.1048,77.1734|12.9716,77.5946" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "dataset": { "type": "string", "example": "srtm30m", "description": "Dataset the elevation comes from." }, "elevation": { "type": "integer", "example": 213, "description": "Elevation in metres. `null` when the location is outside the dataset or has no data." }, "location": { "type": "object", "properties": { "lat": { "type": "number", "example": 28.6129, "description": "Latitude of the location." }, "lng": { "type": "number", "example": 77.2295, "description": "Longitude of the location." } } } } }, "description": "One entry per input location, in input order." }, "status": { "type": "string", "example": "OK", "description": "`OK` on success, `INVALID_REQUEST` for an input error, `SERVER_ERROR` otherwise." } } }, "example": { "results": [ { "dataset": "srtm30m", "elevation": 213, "location": { "lat": 28.6129, "lng": 77.2295 } }, { "dataset": "srtm30m", "elevation": 2204, "location": { "lat": 31.1048, "lng": 77.1734 } }, { "dataset": "srtm30m", "elevation": 914, "location": { "lat": 12.9716, "lng": 77.5946 } } ], "status": "OK" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "23", "x-server": "core" } }, "/elevation/30m#elevation-multiple-locations-post-geojson": { "post": { "tags": [ "Map Visualization" ], "summary": "Elevation - multiple locations (POST, GeoJSON)", "description": "Same arguments as the `GET` call, in the body - use it when the location list is too long for a URL.", "operationId": "elevationMultipleLocationsPOSTGeoJSON", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "locations": { "type": "string", "example": "28.6129,77.2295|31.1048,77.1734|12.9716,77.5946", "description": "`latitude,longitude` pairs separated by `|`, or an encoded polyline." }, "format": { "type": "string", "example": "geojson", "description": "`json` (default) or `geojson`." } }, "required": [ "locations", "format" ] }, "example": { "locations": "28.6129,77.2295|31.1048,77.1734|12.9716,77.5946", "format": "geojson" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "object", "properties": { "geometry": { "type": "object", "properties": { "coordinates": { "type": "array", "items": { "type": "number", "example": 77.2295 }, "description": "`[longitude, latitude, elevation]` - elevation in metres." }, "type": { "type": "string", "example": "Point" } } }, "properties": { "type": "object", "properties": { "dataset": { "type": "string", "example": "srtm30m", "description": "Dataset the elevation comes from." } } }, "type": { "type": "string", "example": "Feature" } } }, "description": "One point feature per input location, in input order." }, "type": { "type": "string", "example": "FeatureCollection", "description": "Always `FeatureCollection`." } } }, "example": { "features": [ { "geometry": { "coordinates": [ 77.2295, 28.6129, 213 ], "type": "Point" }, "properties": { "dataset": "srtm30m" }, "type": "Feature" }, { "geometry": { "coordinates": [ 77.1734, 31.1048, 2204 ], "type": "Point" }, "properties": { "dataset": "srtm30m" }, "type": "Feature" }, { "geometry": { "coordinates": [ 77.5946, 12.9716, 914 ], "type": "Point" }, "properties": { "dataset": "srtm30m" }, "type": "Feature" } ], "type": "FeatureCollection" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - missing or invalid Bearer token / API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "ApiKeyQueryAuth": [] } ], "x-master-list-no": "23", "x-server": "core" } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "OAuth2 access token obtained from `POST /authen/oauth/token`." }, "ApiKeyQueryAuth": { "type": "apiKey", "in": "query", "name": "api-key", "description": "Tenant API key, sent as a query parameter. Required on every request, including the token call." } }, "schemas": { "ErrorResponse": { "type": "object", "properties": { "error": { "type": "string", "example": "invalid_request" }, "error_description": { "type": "string", "example": "Missing required field" } } }, "SearchEnvelope": { "type": "object", "description": "Standard wrapper for all data-layer search responses.", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "total": { "type": "integer", "example": 1 } } }, "SystemFields": { "type": "object", "description": "System fields present on every data-layer record.", "properties": { "Id": { "type": "string", "format": "uuid" }, "Layer": { "type": "string" }, "Path": { "type": "string" }, "ParentPath": { "type": "string" }, "CreatedDate": { "type": "string", "format": "date-time" }, "CreatedUser": { "type": "string" }, "ModifiedDate": { "type": "string", "format": "date-time" }, "ModifiedUser": { "type": "string" }, "Title": { "type": "string" } } } } } }