api-docs/models/Survey.json

{
  "description": "A resource survey of a waypoint, detailing a specific extraction location and the types of resources that can be found there.",
  "type": "object",
  "properties": {
    "signature": {
      "type": "string",
      "description": "A unique signature for the location of this survey. This signature is verified when attempting an extraction using this survey.",
      "minLength": 1
    },
    "symbol": {
      "type": "string",
      "description": "The symbol of the waypoint that this survey is for.",
      "minLength": 1
    },
    "deposits": {
      "type": "array",
      "description": "A list of deposits that can be found at this location. A ship will extract one of these deposits when using this survey in an extraction request. If multiple deposits of the same type are present, the chance of extracting that deposit is increased.",
      "items": {
        "$ref": "./SurveyDeposit.json"
      }
    },
    "expiration": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the survey expires. After this date and time, the survey will no longer be available for extraction."
    },
    "size": {
      "type": "string",
      "description": "The size of the deposit. This value indicates how much can be extracted from the survey before it is exhausted.",
      "enum": [
        "SMALL",
        "MODERATE",
        "LARGE"
      ]
    }
  },
  "required": [
    "signature",
    "symbol",
    "deposits",
    "expiration",
    "size"
  ]
}