Provides a simple listing of cities within the platform

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "city": {
      "type": "array",
      "description": "\n        Limit results by a certain city or cities.\n        (ex. ?city=Chicago or ?city=Chicago&city=Boston)\n        ",
      "items": {
        "type": "string"
      }
    },
    "country": {
      "type": "array",
      "description": "\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ",
      "items": {
        "type": "string"
      }
    },
    "country_id": {
      "type": "string",
      "description": "\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        "
    },
    "entity": {
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "description": "Change the number of results returned."
    },
    "offset": {
      "type": "integer"
    },
    "order_by": {
      "description": "Order by a field",
      "type": "object"
    },
    "page": {
      "type": "integer",
      "description": "Paginate through results."
    },
    "sort": {
      "description": "Define sort order.",
      "type": "object"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "results"
  ],
  "properties": {
    "meta": {
      "type": "object"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "city",
          "count",
          "locations",
          "firstUpdated",
          "lastUpdated",
          "parameters"
        ],
        "properties": {
          "city": {
            "type": "string"
          },
          "count": {
            "type": "integer"
          },
          "country": {
            "type": "string"
          },
          "firstUpdated": {
            "type": "string",
            "format": "date-time"
          },
          "lastUpdated": {
            "type": "string",
            "format": "date-time"
          },
          "locations": {
            "type": "integer"
          },
          "parameters": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}