mod-kb-ebsco-java (v1)

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Currencies Collection Schema",
  "description": "Currencies Collection Schema",
  "javaType": "org.folio.rest.jaxrs.model.CurrencyCollection",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "array",
      "description": "List of currencies",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Currency object schema for a collection",
        "description": "Currency object schema for a collection",
        "javaType": "org.folio.rest.jaxrs.model.Currency",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique currency code",
            "example": "EUR"
          },
          "type": {
            "type": "string",
            "description": "Type of resource",
            "enum": [
              "currencies"
            ],
            "example": "currencies"
          },
          "attributes": {
            "type": "object",
            "description": "Currency object data attributes",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Access Type Object Data Attributes Schema",
            "javaType": "org.folio.rest.jaxrs.model.CurrencyDataAttributes",
            "additionalProperties": false,
            "properties": {
              "code": {
                "type": "string",
                "description": "Currency code",
                "example": "EUR"
              },
              "description": {
                "type": "string",
                "description": "Currency full name",
                "example": "Euro"
              }
            },
            "required": [
              "code",
              "description"
            ]
          }
        },
        "required": [
          "type",
          "attributes"
        ]
      }
    },
    "meta": {
      "type": "object",
      "description": "metadata containing total results in collection",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Metadata total results Schema",
      "javaType": "org.folio.rest.jaxrs.model.MetaTotalResults",
      "additionalProperties": false,
      "properties": {
        "totalResults": {
          "type": "integer",
          "description": "Total number of results",
          "example": 2
        }
      },
      "required": [
        "totalResults"
      ]
    },
    "jsonapi": {
      "type": "object",
      "description": "version of json api",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "JSON API Version Schema",
      "javaType": "org.folio.rest.jaxrs.model.JsonAPI",
      "additionalProperties": false,
      "properties": {
        "version": {
          "type": "string",
          "description": "Version of json api being used",
          "example": "1.0"
        }
      },
      "required": [
        "version"
      ]
    }
  },
  "required": [
    "data",
    "meta",
    "jsonapi"
  ]
}

Example:

{
  "data": [
    {
      "code": "AFN",
      "description": "Afghan Afghani"
    },
    {
      "code": "ALL",
      "description": "Albanian Lek"
    },
    {
      "code": "AMD",
      "description": "Armenian Dram"
    },
    {
      "code": "AOA",
      "description": "Angolan Kwanza"
    }
  ],
  "meta": {
    "totalResults": 4
  }
}