TRANXACT.AI Help

Supply Chain · Maps & Geography

Geofences

An area on the map that means something: a customer site, a depot yard, a low emission zone. Crossing one says the truck has arrived without anybody telephoning to ask.

Type REST6 operationsBase path /api/scm/geofencesPublished as /api/v1/geofences

Download specification (OpenAPI 3.1) Screen: Geofences

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 › Geofences 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.geofences · 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/geofencesList geofences

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",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "fence_type": "text",
      "shape": "circle",
      "center_lat": "1250.00",
      "center_lon": "1250.00",
      "radius_m": "1250.00",
      "polygon": {},
      "place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "on_enter": "none",
      "on_exit": "none",
      "is_active": true
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "fence_type": "text",
  "shape": "circle",
  "center_lat": "1250.00",
  "center_lon": "1250.00",
  "radius_m": "1250.00",
  "polygon": {},
  "place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "on_enter": "none",
  "on_exit": "none",
  "is_active": true
}

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

Sample request

curl "https://demo.tranxact.ai/api/scm/geofences/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/geofencesCreate a geofence

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
fence_typetextNoType
shapetextNoShape
Allowed: circle polygon
center_latnumericNoCentre latitude
center_lonnumericNoCentre longitude
radius_mnumericNoRadius (m)
polygonjsonbNoPolygon — An ordered list of [latitude, longitude] pairs. A circle is one comparison and is what almost every arrival event actually needs.
place_iduuidNoAround place
on_entertextNoOn entering
Allowed: none notify arrive_stop start_detention alert
on_exittextNoOn leaving
Allowed: none notify depart_stop stop_detention alert
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "fence_type": "text",
  "shape": "circle",
  "center_lat": "1250.00",
  "center_lon": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "fence_type": "text",
  "shape": "circle",
  "center_lat": "1250.00",
  "center_lon": "1250.00",
  "radius_m": "1250.00",
  "polygon": {},
  "place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "on_enter": "none",
  "on_exit": "none",
  "is_active": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/geofences" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","fence_type":"text","shape":"circle","center_lat":"1250.00","center_lon":"1250.00"}'
PUT/api/scm/geofences/{id}Change a geofence

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
fence_typetextNoType
shapetextNoShape
Allowed: circle polygon
center_latnumericNoCentre latitude
center_lonnumericNoCentre longitude
radius_mnumericNoRadius (m)
polygonjsonbNoPolygon — An ordered list of [latitude, longitude] pairs. A circle is one comparison and is what almost every arrival event actually needs.
place_iduuidNoAround place
on_entertextNoOn entering
Allowed: none notify arrive_stop start_detention alert
on_exittextNoOn leaving
Allowed: none notify depart_stop stop_detention alert
is_activebooleanNoActive
notestextNoNotes

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "fence_type": "text",
  "shape": "circle",
  "center_lat": "1250.00",
  "center_lon": "1250.00",
  "radius_m": "1250.00",
  "polygon": {},
  "place_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "on_enter": "none",
  "on_exit": "none",
  "is_active": true
}

Sample request

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

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/geofences/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/geofences/{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/geofences/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 geofence, 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
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode
nametextread, writeName
fence_typetextread, writeType
shapetextread, writeShape
Allowed: circle polygon
center_latnumericread, writeCentre latitude
center_lonnumericread, writeCentre longitude
radius_mnumericread, writeRadius (m)
polygonjsonbread, writePolygon — An ordered list of [latitude, longitude] pairs. A circle is one comparison and is what almost every arrival event actually needs.
place_iduuidread, writeAround place
on_entertextread, writeOn entering
Allowed: none notify arrive_stop start_detention alert
on_exittextread, writeOn leaving
Allowed: none notify depart_stop stop_detention alert
is_activebooleanread, writeActive
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
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 › Geofences 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.