OperationalCapabilitiesResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/australia-post/main/json-schema/australia-post-operational-capabilities-response-schema.json",
  "title": "OperationalCapabilitiesResponse",
  "x-generated": "2026-10-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/australia-post-locations-v3-openapi.yml#/components/schemas/OperationalCapabilitiesResponse",
  "type": "object",
  "properties": {
    "pagination": {
      "$ref": "#/$defs/Pagination"
    },
    "operational_capabilities": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/OperationalCapabilityResponse"
      }
    }
  },
  "$defs": {
    "CapabilityCategory": {
      "required": [
        "id",
        "name"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "OperationalCapabilityAttributesResponse": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "appointment_required": {
          "type": "string"
        },
        "service_offering": {
          "type": "boolean"
        },
        "categories": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CapabilityCategory"
          }
        }
      }
    },
    "OperationalCapabilityResponse": {
      "required": [
        "attributes",
        "id"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "attributes": {
          "$ref": "#/$defs/OperationalCapabilityAttributesResponse"
        }
      }
    },
    "Pagination": {
      "required": [
        "offset",
        "size",
        "total"
      ],
      "type": "object",
      "properties": {
        "total": {
          "type": "integer",
          "description": "Total number of matches ignoring pagination.",
          "format": "int64"
        },
        "offset": {
          "type": "integer",
          "description": "Current offset (number of items skipped).",
          "format": "int32"
        },
        "size": {
          "type": "integer",
          "description": "Page size (number of items returned in this page).",
          "format": "int32"
        }
      },
      "description": "Pagination metadata for list responses."
    }
  }
}