org.heigit.ohsome.ohsomeapi.output.dataaggregationresponse.RatioResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ohsome-api Show documentation

A public Web-RESTful-API for "ohsome" OpenStreetMap history data.

There is a newer version: 1.10.4

package org.heigit.ohsome.ohsomeapi.output.dataaggregationresponse;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Getter;

/**
 * Represents the whole JSON response object for the data aggregation response using the /ratio
 * resource. It contains the license and copyright, optional
 * {@link org.heigit.ohsome.ohsomeapi.output.dataaggregationresponse.Metadata Metadata}, as well as
 * the results section showing
 * {@link org.heigit.ohsome.ohsomeapi.output.dataaggregationresponse.RatioResult RatioResult}
 * objects.
 */
@Getter
@AllArgsConstructor
@JsonInclude(Include.NON_NULL)
public class RatioResponse implements Response {

  @ApiModelProperty(notes = "License and copyright info", required = true)
  private Attribution attribution;
  @ApiModelProperty(notes = "Version of this api", required = true)
  private String apiVersion;
  @ApiModelProperty(notes = "Metadata describing the output")
  private Metadata metadata;
  @ApiModelProperty(notes = "ElementsResult for /ratio requests", required = true)
  private RatioResult[] ratioResult;
}