Sign in
georegion

Changed on
get/api/v1/georegion/{id}/

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in cookie sessionid
    • none

Path parameters

idinteger required

A unique integer value identifying this Geo Region.

Query parameters

format'csv' | 'json' | 'jsonp'

Response

resource_uristring uri required
idinteger required
namestring required
slugstring required
kind'country' | 'state' | 'admin_district' | 'district' | 'admin_cooperation' | 'municipality' | 'borough' | 'zipcode' | 'admin_court_jurisdiction' required
  • country - country
  • state - state
  • admin_district - administrative district
  • district - district
  • admin_cooperation - administrative cooperation
  • municipality - municipality
  • borough - borough
  • zipcode - zipcode
  • admin_court_jurisdiction - administrative court jurisdiction
kind_detailstring
levelinteger
region_identifierstring
global_identifierstring
areanumber double
populationinteger nullable
valid_onstring date-time nullable
part_ofstring uri required
centroidstring required
geomstring required
gov_seatstring required

Changes

  • 195a255a499bRevision changes
    • info

      added to the response property allOf list for the response status (media type: application/json)

    • info

      added to the response property allOf list for the response status (media type: text/csv)

    • info

      added to the response property allOf list for the response status (media type: application/javascript)

    • info

      removed from the response property allOf list for the response status (media type: application/json)

    • info

      removed from the response property allOf list for the response status (media type: text/csv)

    • info

      removed from the response property allOf list for the response status (media type: application/javascript)

  • f5a1531aecbeRevision changes
    • breaking

      for the path request parameter id, the type changed from string to integer

    • breaking

      the response's property type changed from string to no type for status (media type: application/json)

    • warning

      deleted the query request parameter ancestor

    • warning

      deleted the query request parameter id

    • warning

      deleted the query request parameter kind

    • warning

      deleted the query request parameter latlng

    • warning

      deleted the query request parameter level

    • warning

      deleted the query request parameter name

    • warning

      deleted the query request parameter q

    • warning

      deleted the query request parameter region_identifier

    • warning

      deleted the query request parameter slug

    • info

      api operation id retrieveGeoRegion removed and replaced with georegion_retrieve

    • info

      the endpoint scheme security cookieAuth was added to the API

    • info

      api tag georegion added

    • info

      api tag api removed

    • info

      added the new optional query request parameter format

    • info

      added to the response property allOf list for the response status (media type: application/json)

    • info

      added to the response property allOf list for the response status (media type: text/csv)

    • info

      added to the response property allOf list for the response status (media type: application/javascript)

    • info

      the response property became required for the status (media type: application/json)

    • info

      the response property became required for the status (media type: text/csv)

    • info

      the response property became required for the status (media type: application/javascript)

    • info

      the response property became required for the status (media type: application/json)

    • info

      the response property became required for the status (media type: text/csv)

    • info

      the response property became required for the status (media type: application/javascript)

    • info

      the response property became required for the status (media type: application/json)

    • info

      the response property became required for the status (media type: text/csv)

    • info

      the response property became required for the status (media type: application/javascript)

    • info

      the response property became required for the status (media type: application/json)

    • info

      the response property became required for the status (media type: text/csv)

    • info

      the response property became required for the status (media type: application/javascript)

    • info

      the response property became required for the status (media type: application/json)

    • info

      the response property became required for the status (media type: text/csv)

    • info

      the response property became required for the status (media type: application/javascript)

    • info

      the response property became required for the status (media type: application/json)

    • info

      the response property became required for the status (media type: text/csv)

    • info

      the response property became required for the status (media type: application/javascript)

    • info

      removed the admin_cooperation enum value from the response property for the response status (media type: application/json)

    • info

      removed the admin_cooperation enum value from the response property for the response status (media type: text/csv)

    • info

      removed the admin_cooperation enum value from the response property for the response status (media type: application/javascript)

    • info

      removed the admin_court_jurisdiction enum value from the response property for the response status (media type: application/json)

    • info

      removed the admin_court_jurisdiction enum value from the response property for the response status (media type: text/csv)

    • info

      removed the admin_court_jurisdiction enum value from the response property for the response status (media type: application/javascript)

    • info

      removed the admin_district enum value from the response property for the response status (media type: application/json)

    • info

      removed the admin_district enum value from the response property for the response status (media type: text/csv)

    • info

      removed the admin_district enum value from the response property for the response status (media type: application/javascript)

    • info

      removed the borough enum value from the response property for the response status (media type: application/json)

    • info

      removed the borough enum value from the response property for the response status (media type: text/csv)

    • info

      removed the borough enum value from the response property for the response status (media type: application/javascript)

    • info

      removed the country enum value from the response property for the response status (media type: application/json)

    • info

      removed the country enum value from the response property for the response status (media type: text/csv)

    • info

      removed the country enum value from the response property for the response status (media type: application/javascript)

    • info

      removed the district enum value from the response property for the response status (media type: application/json)

    • info

      removed the district enum value from the response property for the response status (media type: text/csv)

    • info

      removed the district enum value from the response property for the response status (media type: application/javascript)

    • info

      removed the municipality enum value from the response property for the response status (media type: application/json)

    • info

      removed the municipality enum value from the response property for the response status (media type: text/csv)

    • info

      removed the municipality enum value from the response property for the response status (media type: application/javascript)

    • info

      removed the state enum value from the response property for the response status (media type: application/json)

    • info

      removed the state enum value from the response property for the response status (media type: text/csv)

    • info

      removed the state enum value from the response property for the response status (media type: application/javascript)

    • info

      removed the zipcode enum value from the response property for the response status (media type: application/json)

    • info

      removed the zipcode enum value from the response property for the response status (media type: text/csv)

    • info

      removed the zipcode enum value from the response property for the response status (media type: application/javascript)