Projects Get

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "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"
    },
    "isAnalysis": {
      "type": "boolean"
    },
    "isMobile": {
      "type": "boolean"
    },
    "limit": {
      "type": "integer",
      "description": "Change the number of results returned."
    },
    "offset": {
      "type": "integer"
    },
    "order_by": {
      "type": "object"
    },
    "page": {
      "type": "integer",
      "description": "Paginate through results."
    },
    "parameter": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "parameter_id": {
      "type": "integer"
    },
    "project": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "project_id": {
      "type": "integer"
    },
    "sensorType": {
      "type": "string"
    },
    "sort": {
      "description": "Define sort order.",
      "type": "object"
    },
    "sourceName": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "unit": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "results"
  ],
  "properties": {
    "meta": {
      "type": "object"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "name",
          "subtitle",
          "locations",
          "locationIds",
          "parameters",
          "measurements",
          "firstUpdated",
          "lastUpdated"
        ],
        "properties": {
          "bbox": {
            "type": "array",
            "items": {
              "type": "number"
            }
          },
          "countries": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "entity": {
            "type": "string"
          },
          "firstUpdated": {
            "type": "string",
            "format": "date-time"
          },
          "id": {
            "type": "integer"
          },
          "isAnalysis": {
            "type": "boolean"
          },
          "isMobile": {
            "type": "boolean"
          },
          "lastUpdated": {
            "type": "string",
            "format": "date-time"
          },
          "locationIds": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "locations": {
            "type": "integer"
          },
          "measurements": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "parameters": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "unit",
                "count",
                "average",
                "lastValue",
                "locations",
                "parameter",
                "lastUpdated",
                "firstUpdated",
                "parameterId"
              ],
              "properties": {
                "average": {
                  "type": "number"
                },
                "count": {
                  "type": "integer"
                },
                "displayName": {
                  "type": "string"
                },
                "firstUpdated": {
                  "type": "string",
                  "format": "date-time"
                },
                "lastUpdated": {
                  "type": "string",
                  "format": "date-time"
                },
                "lastValue": {
                  "type": "number"
                },
                "locations": {
                  "type": "integer"
                },
                "parameter": {
                  "type": "string"
                },
                "parameterId": {
                  "type": "integer"
                },
                "unit": {
                  "type": "string"
                }
              }
            }
          },
          "sensorType": {
            "type": "string"
          },
          "sources": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "subtitle": {
            "type": "string"
          }
        }
      }
    }
  }
}