Get Single Structure

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "api_hint": {
      "type": "string",
      "description": "If the client provides the parameter, the value SHOULD have the format `vMAJOR` or `vMAJOR.MINOR`, where MAJOR is a major version and MINOR is a minor version of the API. For example, if a client appends `api_hint=v1.0` to the query string, the hint provided is for major version 1 and minor version 0."
    },
    "email_address": {
      "type": "string",
      "format": "email",
      "description": "An email address of the user making the request.\nThe email SHOULD be that of a person and not an automatic system.\nExample: `http://example.com/v1/[email protected]`"
    },
    "entry_id": {
      "type": "string"
    },
    "include": {
      "type": "string",
      "description": "A server MAY implement the JSON API concept of returning [compound documents](https://jsonapi.org/format/1.0/#document-compound-documents) by utilizing the `include` query parameter as specified by [JSON API 1.0](https://jsonapi.org/format/1.0/#fetching-includes).\n\nAll related resource objects MUST be returned as part of an array value for the top-level `included` field, see the section JSON Response Schema: Common Fields.\n\nThe value of `include` MUST be a comma-separated list of \"relationship paths\", as defined in the [JSON API](https://jsonapi.org/format/1.0/#fetching-includes).\nIf relationship paths are not supported, or a server is unable to identify a relationship path a `400 Bad Request` response MUST be made.\n\nThe **default value** for `include` is `references`.\nThis means `references` entries MUST always be included under the top-level field `included` as default, since a server assumes if `include` is not specified by a client in the request, it is still specified as `include=references`.\nNote, if a client explicitly specifies `include` and leaves out `references`, `references` resource objects MUST NOT be included under the top-level field `included`, as per the definition of `included`, see section JSON Response Schema: Common Fields.\n\n> **Note**: A query with the parameter `include` set to the empty string means no related resource objects are to be returned under the top-level field `included`."
    },
    "response_fields": {
      "type": "string",
      "description": "A comma-delimited set of fields to be provided in the output.\nIf provided, these fields MUST be returned along with the REQUIRED fields.\nOther OPTIONAL fields MUST NOT be returned when this parameter is present.\nExample: `http://example.com/v1/structures?response_fields=last_modified,nsites`"
    },
    "response_format": {
      "type": "string",
      "description": "The output format requested (see section Response Format).\nDefaults to the format string 'json', which specifies the standard output format described in this specification.\nExample: `http://example.com/v1/structures?response_format=xml`"
    }
  },
  "required": [
    "entry_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "errors are not allowed",
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "description": "A single structures entry resource",
      "type": "object"
    },
    "errors": {
      "type": "array",
      "description": "A list of unique errors",
      "items": {
        "type": "object",
        "description": "An error response",
        "properties": {
          "code": {
            "type": "string",
            "description": "an application-specific error code, expressed as a string value."
          },
          "detail": {
            "type": "string",
            "description": "A human-readable explanation specific to this occurrence of the problem."
          },
          "id": {
            "type": "string",
            "description": "A unique identifier for this particular occurrence of the problem."
          },
          "links": {
            "description": "A links object storing about",
            "type": "object"
          },
          "meta": {
            "description": "a meta object containing non-standard meta-information about the error.",
            "type": "object"
          },
          "source": {
            "description": "An object containing references to the source of the error",
            "type": "object"
          },
          "status": {
            "type": "string",
            "description": "the HTTP status code applicable to this problem, expressed as a string value."
          },
          "title": {
            "type": "string",
            "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization."
          }
        }
      }
    },
    "included": {
      "type": "object"
    },
    "jsonapi": {
      "description": "Information about the JSON API used",
      "type": "object"
    },
    "links": {
      "description": "Links associated with the primary data or errors",
      "type": "object"
    },
    "meta": {
      "description": "A meta object containing non-standard information",
      "type": "object"
    }
  }
}