Skip to content
Snippets Groups Projects
get_alma_fdm_swagger.json 4.33 KiB
Newer Older
SAJIDA SIDDIQUI's avatar
SAJIDA SIDDIQUI committed
{
  "swagger" : "2.0",
  "info" : {
    "description" : null,
    "version" : "1.0.0",
    "title" : null,
    "termsOfService" : null,
    "contact" : null,
    "license" : null
  },
  "host" : "api-eu.hosted.exlibrisgroup.com",
  "basePath" : "/almaws/v1",
  "schemes" : [ "https" ],
  "paths" : {
    "/acq/funds" : {
      "get" : {
        "tags" : [ "get_alma_fdm" ],
        "summary" : null,
        "description" : null,
        "operationId" : "get_alma_fdm",
        "produces" : [ "application/json" ],
        "consumes" : [ "application/json" ],
        "parameters" : [ {
          "name" : "q",
          "in" : "query",
          "description" : null,
          "required" : false,
          "type" : "string"
        }, {
          "name" : "view",
          "in" : "query",
          "description" : null,
          "required" : false,
          "type" : "string"
        }, {
          "name" : "apikey",
          "in" : "query",
          "description" : null,
          "required" : false,
          "type" : "string"
        }, {
          "name" : "offset",
          "in" : "query",
          "description" : null,
          "required" : false,
          "type" : "string"
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : null,
          "required" : false,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "$ref" : "#/definitions/get_alma_fdm"
            }
          }
        }
      }
    }
  },
  "definitions" : {
    "get_alma_fdm##fund##owner" : {
      "properties" : {
        "value" : {
          "type" : "string"
        },
        "desc" : {
          "type" : "string"
        }
      }
    },
    "get_alma_fdm##fund##status" : {
      "properties" : {
        "value" : {
          "type" : "string"
        },
        "desc" : {
          "type" : "string"
        }
      }
    },
    "get_alma_fdm##fund##currency" : {
      "properties" : {
        "value" : {
          "type" : "string"
        },
        "desc" : {
          "type" : "string"
        }
      }
    },
    "get_alma_fdm##fund##parent" : {
      "properties" : {
        "value" : {
          "type" : "string"
        },
        "link" : {
          "type" : "string"
        }
      }
    },
    "get_alma_fdm##fund##entity_type" : {
      "properties" : {
        "value" : {
          "type" : "string"
        },
        "desc" : {
          "type" : "string"
        }
      }
    },
    "get_alma_fdm##fund##fiscal_period" : {
      "properties" : {
        "value" : {
          "type" : "string"
        },
        "desc" : {
          "type" : "string"
        }
      }
    },
    "get_alma_fdm##fund##available_for_library" : {
      "properties" : {
        "value" : {
          "type" : "string"
        },
        "desc" : {
          "type" : "string"
        }
      }
    },
    "get_alma_fdm##fund" : {
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "code" : {
          "type" : "string"
        },
        "name" : {
          "type" : "string"
        },
        "owner" : {
          "$ref" : "#/definitions/get_alma_fdm##fund##owner"
        },
        "status" : {
          "$ref" : "#/definitions/get_alma_fdm##fund##status"
        },
        "currency" : {
          "$ref" : "#/definitions/get_alma_fdm##fund##currency"
        },
        "parent" : {
          "$ref" : "#/definitions/get_alma_fdm##fund##parent"
        },
        "external_id" : {
          "type" : "string"
        },
        "entity_type" : {
          "$ref" : "#/definitions/get_alma_fdm##fund##entity_type"
        },
        "fiscal_period" : {
          "$ref" : "#/definitions/get_alma_fdm##fund##fiscal_period"
        },
        "available_for_library" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/get_alma_fdm##fund##available_for_library"
          }
        },
        "link" : {
          "type" : "string"
        }
      }
    },
    "get_alma_fdm" : {
      "properties" : {
        "fund" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/get_alma_fdm##fund"
          }
        },
        "total_record_count" : {
          "type" : "number",
          "format" : "int32"
        }
      }
    }
  }
}