Skip to content
HALOWERK

Mobility, Warnings and Local Data

subdivision register same parent peers

Subdivision lookup finds other divisions sharing both the same recorded parent and administrative type. Use it when an agent needs peer regions for a coded location.

POST https://ort.halowerk.com/v1/subdivision-register-same-parent-peers

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
codestringYes
Show full input schema
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "maxLength": 20,
      "minLength": 1
    }
  },
  "required": [
    "code"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "code": "FR-75C"
}

Result & documentation

Show published result schema
{
  "type": "object",
  "required": [
    "measured_at",
    "source",
    "data",
    "limitations"
  ],
  "properties": {
    "measured_at": {
      "type": "string"
    },
    "source": {
      "type": "object",
      "required": [
        "reference",
        "retrieved_at"
      ],
      "properties": {
        "reference": {
          "type": "string"
        },
        "retrieved_at": {
          "type": "string"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "total": {
          "type": "integer"
        },
        "peers": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "total",
        "peers"
      ]
    },
    "limitations": {
      "type": "string"
    }
  }
}

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-20 UTC.

More endpoints in this hub

All endpoints in this hub โ†’