TRANXACT.AI Help

Supply Chain · Maps & Geography

Mapping Providers

Which mapping service this company uses. OpenStreetMap needs no key and no account, so the map draws on the first boot; a Google or Mapbox contract is added here.

Type REST6 operationsBase path /api/scm/geo-providersPublished as /api/v1/geo-providers

Download specification (OpenAPI 3.1) Screen: Mapping Providers

Overview

PackageSupply Chain
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Supply Chain › Mapping Providers on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tablescm.geo_providers · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/scm/geo-providersList mapping providers

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "vendor": "google_maps",
      "supports_geocoding": true,
      "supports_routing": true,
      "supports_distance_matrix": true,
      "supports_traffic": true,
      "supports_tiles": true,
      "base_url": "https://example.com",
      "api_key_cipher": "text",
      "tile_url": "https://example.com",
      "attribution": "text",
      "requests_per_second": 10
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/geo-providers?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/geo-providers/{id}Read one mapping provider

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "vendor": "google_maps",
  "supports_geocoding": true,
  "supports_routing": true,
  "supports_distance_matrix": true,
  "supports_traffic": true,
  "supports_tiles": true,
  "base_url": "https://example.com",
  "api_key_cipher": "text",
  "tile_url": "https://example.com",
  "attribution": "text",
  "requests_per_second": 10
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/scm/geo-providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/geo-providersCreate a mapping provider

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
vendortextNoVendor
Allowed: google_maps mapbox here tomtom openstreetmap azure_maps esri ptv internal
supports_geocodingbooleanNoMay be asked to geocode
supports_routingbooleanNoMay be asked to route — A provider licensed for geocoding and not for routing is a real situation, and asking it anyway is a bill.
supports_distance_matrixbooleanNoMay be asked for distances
supports_trafficbooleanNoKnows about traffic
supports_tilesbooleanNoServes map tiles
base_urltextNoBase URL
tile_urltextNoTile URL template
attributiontextNoAttribution
requests_per_secondintegerNoCalls a second
daily_quotaintegerNoDaily quota
is_defaultbooleanNoDefault
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "vendor": "google_maps",
  "supports_geocoding": true,
  "supports_routing": true,
  "supports_distance_matrix": true
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "vendor": "google_maps",
  "supports_geocoding": true,
  "supports_routing": true,
  "supports_distance_matrix": true,
  "supports_traffic": true,
  "supports_tiles": true,
  "base_url": "https://example.com",
  "api_key_cipher": "text",
  "tile_url": "https://example.com",
  "attribution": "text",
  "requests_per_second": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/geo-providers" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","vendor":"google_maps","supports_geocoding":true,"supports_routing":true,"supports_distance_matrix":true}'
PUT/api/scm/geo-providers/{id}Change a mapping provider

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
vendortextNoVendor
Allowed: google_maps mapbox here tomtom openstreetmap azure_maps esri ptv internal
supports_geocodingbooleanNoMay be asked to geocode
supports_routingbooleanNoMay be asked to route — A provider licensed for geocoding and not for routing is a real situation, and asking it anyway is a bill.
supports_distance_matrixbooleanNoMay be asked for distances
supports_trafficbooleanNoKnows about traffic
supports_tilesbooleanNoServes map tiles
base_urltextNoBase URL
tile_urltextNoTile URL template
attributiontextNoAttribution
requests_per_secondintegerNoCalls a second
daily_quotaintegerNoDaily quota
is_defaultbooleanNoDefault
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "vendor": "google_maps",
  "supports_geocoding": true,
  "supports_routing": true,
  "supports_distance_matrix": true,
  "supports_traffic": true,
  "supports_tiles": true,
  "base_url": "https://example.com",
  "api_key_cipher": "text",
  "tile_url": "https://example.com",
  "attribution": "text",
  "requests_per_second": 10
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/geo-providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/scm/geo-providers/{id}Delete a mapping provider

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/scm/geo-providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/geo-providers/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/geo-providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a mapping provider, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
codetextread, writeCode
nametextread, writeName
vendortextread, writeVendor
Allowed: google_maps mapbox here tomtom openstreetmap azure_maps esri ptv internal
supports_geocodingbooleanread, writeMay be asked to geocode
supports_routingbooleanread, writeMay be asked to route — A provider licensed for geocoding and not for routing is a real situation, and asking it anyway is a bill.
supports_distance_matrixbooleanread, writeMay be asked for distances
supports_trafficbooleanread, writeKnows about traffic
supports_tilesbooleanread, writeServes map tiles
base_urltextread, writeBase URL
api_key_cipherbytearead onlyApi key cipher
tile_urltextread, writeTile URL template
attributiontextread, writeAttribution
requests_per_secondintegerread, writeCalls a second
daily_quotaintegerread, writeDaily quota
is_defaultbooleanread, writeDefault
is_activebooleanread, writeActive
last_ok_attimestamp with time zoneread onlyLast ok at
last_errortextread onlyLast error
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Supply Chain › Mapping Providers for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.