mod-kb-ebsco-java (v1)

https://github.com/folio-org/mod-kb-ebsco-java

Table of contents

mod-kb-ebsco-java

Implements the eholdings interface using EBSCO KB as backend.

Providers

Collection of available providers in eholdings.

GET /eholdings/providers

Get a list of providers based on the search query.

GET /eholdings/providers
Query Parameters
  • q: (string)

    String used to search to retrieve a collection

    Example:

    ABC-CLIO
  • filter[tags]: (array of string)

    Filter to narrow down results based on assigned tags. Contains list of required tags.

  • sort: (string - default: relevance)

    Option by which results are sorted. Possible values are name, relevance.

  • page: (integer - default: 1 - minimum: 1 - maximum: 2147483647)

    Page number

    Example:

    1
  • count: (integer - default: 25 - minimum: 1 - maximum: 100)

    Page size

    Example:

    100

Response 200

OK

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Provider Collection Schema",
  "description": "Provider Collection Schema",
  "javaType": "org.folio.rest.jaxrs.model.ProviderCollection",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "array",
      "description": "List of providers",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Provider object schema in providers collection",
        "description": "Provider object schema in providers collection",
        "javaType": "org.folio.rest.jaxrs.model.Providers",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier of provider",
            "example": "19"
          },
          "type": {
            "type": "string",
            "description": "Type of resource",
            "example": "providers"
          },
          "attributes": {
            "type": "object",
            "description": "Provider object data attributes",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Provider List Object Data Attributes Schema",
            "javaType": "org.folio.rest.jaxrs.model.ProviderListDataAttributes",
            "additionalProperties": false,
            "properties": {
              "name": {
                "type": "string",
                "description": "Name of provider",
                "example": "EBSCO"
              },
              "packagesTotal": {
                "type": "integer",
                "description": "Total number of packages available for this provider",
                "example": 627
              },
              "packagesSelected": {
                "type": "integer",
                "description": "Total number of packages selected by this provider",
                "example": 49
              },
              "providerToken": {
                "type": "object",
                "description": "Provider token",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Token Schema",
                "javaType": "org.folio.rest.jaxrs.model.Token",
                "additionalProperties": false,
                "properties": {
                  "factName": {
                    "type": "string",
                    "description": "Fact Name",
                    "example": "[[galesiteid]]"
                  },
                  "prompt": {
                    "type": "string",
                    "description": "Prompt",
                    "example": "/itweb/"
                  },
                  "helpText": {
                    "type": "string",
                    "description": "Help text",
                    "example": "What is token and how to use it"
                  },
                  "value": {
                    "type": "string",
                    "description": "Value",
                    "example": "hellotoken"
                  }
                }
              },
              "supportsCustomPackages": {
                "type": "boolean",
                "description": "Whether this provider supports custom packages",
                "example": false
              }
            }
          },
          "relationships": {
            "type": "object",
            "description": "Displays if any resources are included",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Metadata of relationships for a given object",
            "javaType": "org.folio.rest.jaxrs.model.Relationships",
            "additionalProperties": false,
            "properties": {
              "packages": {
                "type": "object",
                "description": "Relationship of packages for a given object",
                "properties": {
                  "data": {
                    "type": "array",
                    "description": "packages Data Information",
                    "items": {
                      "type": "object",
                      "description": "Resources Data",
                      "$schema": "http://json-schema.org/draft-04/schema#",
                      "title": "Data of relationships for a given object",
                      "javaType": "org.folio.rest.jaxrs.model.RelationshipData",
                      "additionalProperties": false,
                      "properties": {
                        "type": {
                          "type": "string",
                          "description": "The Type Schema",
                          "example": "resources"
                        },
                        "id": {
                          "type": "string",
                          "description": "The Id Schema",
                          "example": "269-1565-316875"
                        }
                      }
                    }
                  },
                  "meta": {
                    "type": "object",
                    "description": "Meta information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Metadata of packages related to a provider",
                    "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                    "additionalProperties": false,
                    "properties": {
                      "included": {
                        "type": "boolean",
                        "description": "Relationship between objects",
                        "example": false
                      }
                    }
                  }
                }
              },
              "resources": {
                "type": "object",
                "description": "Relationship of resources for a given object",
                "properties": {
                  "data": {
                    "type": "array",
                    "description": "Resources Data Information",
                    "items": {
                      "type": "object",
                      "description": "Resources Data",
                      "$schema": "http://json-schema.org/draft-04/schema#",
                      "title": "Data of relationships for a given object",
                      "javaType": "org.folio.rest.jaxrs.model.RelationshipData",
                      "additionalProperties": false,
                      "properties": {
                        "type": {
                          "type": "string",
                          "description": "The Type Schema",
                          "example": "resources"
                        },
                        "id": {
                          "type": "string",
                          "description": "The Id Schema",
                          "example": "269-1565-316875"
                        }
                      }
                    }
                  },
                  "meta": {
                    "type": "object",
                    "description": "Meta information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Metadata of packages related to a provider",
                    "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                    "additionalProperties": false,
                    "properties": {
                      "included": {
                        "type": "boolean",
                        "description": "Relationship between objects",
                        "example": false
                      }
                    }
                  }
                }
              },
              "provider": {
                "type": "object",
                "description": "Relationship of provider for a given object",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Metadata of whether an object is related to this resource",
                "javaType": "org.folio.rest.jaxrs.model.MetaIncluded",
                "additionalProperties": false,
                "properties": {
                  "meta": {
                    "type": "object",
                    "description": "Metadata of whether an object is related to this resource",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Metadata of packages related to a provider",
                    "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                    "additionalProperties": false,
                    "properties": {
                      "included": {
                        "type": "boolean",
                        "description": "Relationship between objects",
                        "example": false
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "description": "metadata containing total results in providers collection",
      "$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"
  ]
}

Example:

{
  "data": [{
      "id": "19",
      "type": "providers",
      "attributes": {
        "name": "EBSCO",
        "packagesTotal": 627,
        "packagesSelected": 49,
        "providerToken": null,
        "supportsCustomPackages": false
      },
      "relationships": {
        "packages": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "273",
      "type": "providers",
      "attributes": {
        "name": "EBSCO Open Access Lists",
        "packagesTotal": 23,
        "packagesSelected": 6,
        "providerToken": null,
        "supportsCustomPackages": false
      },
      "relationships": {
        "packages": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "meta": {
    "totalResults": 2
  },
  "jsonapi": {
    "version": "1.0"
  }
}

GET /eholdings/providers/{providerId}

Get provider given providerId

GET /eholdings/providers/{providerId}
URI Parameters
  • providerId: required (string)

    Provider Id of provider to get

Query Parameters
  • include: (string)

    Name of nested resource to include

    Example:

    packages

Response 200

OK

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Provider Object Schema",
  "description": "Provider Schema",
  "javaType": "org.folio.rest.jaxrs.model.Provider",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "description": "Provider Data",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Provider data object schema",
      "javaType": "org.folio.rest.jaxrs.model.ProviderData",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier of provider",
          "example": "19"
        },
        "type": {
          "type": "string",
          "description": "Type of resource",
          "example": "providers"
        },
        "attributes": {
          "type": "object",
          "description": "Provider object data attributes",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "title": "Provider Data Attributes Schema",
          "javaType": "org.folio.rest.jaxrs.model.ProviderGetDataAttributes",
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "description": "Provider name",
              "example": "Gale | Cengage"
            },
            "packagesTotal": {
              "type": "integer",
              "description": "total number of packages",
              "example": 243
            },
            "packagesSelected": {
              "type": "integer",
              "description": "packages selected",
              "example": 18
            },
            "providerToken": {
              "type": "object",
              "description": "provider token",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "title": "Token Schema",
              "javaType": "org.folio.rest.jaxrs.model.Token",
              "additionalProperties": false,
              "properties": {
                "factName": {
                  "type": "string",
                  "description": "Fact Name",
                  "example": "[[galesiteid]]"
                },
                "prompt": {
                  "type": "string",
                  "description": "Prompt",
                  "example": "/itweb/"
                },
                "helpText": {
                  "type": "string",
                  "description": "Help text",
                  "example": "What is token and how to use it"
                },
                "value": {
                  "type": "string",
                  "description": "Value",
                  "example": "hellotoken"
                }
              }
            },
            "supportsCustomPackages": {
              "type": "boolean",
              "description": "Whether this provider supports custom packages",
              "example": false
            },
            "proxy": {
              "type": "object",
              "description": "Proxy",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "title": "Proxy Schema",
              "javaType": "org.folio.rest.jaxrs.model.Proxy",
              "additionalProperties": true,
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Proxy Id",
                  "example": "EZProxy"
                },
                "inherited": {
                  "type": "boolean",
                  "description": "Whether this proxy is inherited",
                  "example": true
                }
              }
            },
            "tags": {
              "type": "object",
              "description": "Provider tags",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "id": "tags.schema",
              "title": "tags",
              "properties": {
                "tagList": {
                  "description": "List of tags",
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "additionalProperties": false
            }
          }
        },
        "relationships": {
          "type": "object",
          "description": "Displays if any resources are included",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "title": "Metadata of relationships for a given object",
          "javaType": "org.folio.rest.jaxrs.model.Relationships",
          "additionalProperties": false,
          "properties": {
            "packages": {
              "type": "object",
              "description": "Relationship of packages for a given object",
              "properties": {
                "data": {
                  "type": "array",
                  "description": "packages Data Information",
                  "items": {
                    "type": "object",
                    "description": "Resources Data",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Data of relationships for a given object",
                    "javaType": "org.folio.rest.jaxrs.model.RelationshipData",
                    "additionalProperties": false,
                    "properties": {
                      "type": {
                        "type": "string",
                        "description": "The Type Schema",
                        "example": "resources"
                      },
                      "id": {
                        "type": "string",
                        "description": "The Id Schema",
                        "example": "269-1565-316875"
                      }
                    }
                  }
                },
                "meta": {
                  "type": "object",
                  "description": "Meta information",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "title": "Metadata of packages related to a provider",
                  "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                  "additionalProperties": false,
                  "properties": {
                    "included": {
                      "type": "boolean",
                      "description": "Relationship between objects",
                      "example": false
                    }
                  }
                }
              }
            },
            "resources": {
              "type": "object",
              "description": "Relationship of resources for a given object",
              "properties": {
                "data": {
                  "type": "array",
                  "description": "Resources Data Information",
                  "items": {
                    "type": "object",
                    "description": "Resources Data",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Data of relationships for a given object",
                    "javaType": "org.folio.rest.jaxrs.model.RelationshipData",
                    "additionalProperties": false,
                    "properties": {
                      "type": {
                        "type": "string",
                        "description": "The Type Schema",
                        "example": "resources"
                      },
                      "id": {
                        "type": "string",
                        "description": "The Id Schema",
                        "example": "269-1565-316875"
                      }
                    }
                  }
                },
                "meta": {
                  "type": "object",
                  "description": "Meta information",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "title": "Metadata of packages related to a provider",
                  "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                  "additionalProperties": false,
                  "properties": {
                    "included": {
                      "type": "boolean",
                      "description": "Relationship between objects",
                      "example": false
                    }
                  }
                }
              }
            },
            "provider": {
              "type": "object",
              "description": "Relationship of provider for a given object",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "title": "Metadata of whether an object is related to this resource",
              "javaType": "org.folio.rest.jaxrs.model.MetaIncluded",
              "additionalProperties": false,
              "properties": {
                "meta": {
                  "type": "object",
                  "description": "Metadata of whether an object is related to this resource",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "title": "Metadata of packages related to a provider",
                  "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                  "additionalProperties": false,
                  "properties": {
                    "included": {
                      "type": "boolean",
                      "description": "Relationship between objects",
                      "example": false
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "included": {
      "type": "array",
      "description": "List of packages for a given provider",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Package object schema for a collection",
        "description": "Package object schema for a collection",
        "javaType": "org.folio.rest.jaxrs.model.PackageCollectionItem",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier of package - combination of providerId-packageId",
            "example": "91525-1152699"
          },
          "type": {
            "type": "string",
            "description": "Type of resource",
            "example": "packages"
          },
          "attributes": {
            "type": "object",
            "description": "Package object data attributes",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Package Object Data Attributes Schema",
            "javaType": "org.folio.rest.jaxrs.model.PackageDataAttributes",
            "additionalProperties": false,
            "properties": {
              "contentType": {
                "type": "string",
                "description": "Content Type of Package",
                "example": "Online Reference",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Content Type Schema",
                "javaType": "org.folio.rest.jaxrs.model.ContentType",
                "additionalProperties": false,
                "enum": [
                  "Aggregated Full Text",
                  "Abstract and Index",
                  "E-Book",
                  "E-Journal",
                  "Print",
                  "Unknown",
                  "Online Reference",
                  "Streaming Media",
                  "Mixed Content"
                ]
              },
              "customCoverage": {
                "type": "object",
                "description": "Custom Coverage",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Coverage Schema",
                "javaType": "org.folio.rest.jaxrs.model.Coverage",
                "additionalProperties": false,
                "properties": {
                  "beginCoverage": {
                    "type": "string",
                    "description": "Begin Coverage Date",
                    "example": "2003-01-01"
                  },
                  "endCoverage": {
                    "type": "string",
                    "description": "End Coverage Date",
                    "example": "2003-12-01"
                  }
                }
              },
              "isCustom": {
                "type": "boolean",
                "description": "Whether this package is custom or not",
                "example": false
              },
              "isSelected": {
                "type": "boolean",
                "description": "Whether this package is selected or not",
                "example": false
              },
              "name": {
                "type": "string",
                "description": "Package name",
                "example": "Shenbao"
              },
              "packageId": {
                "type": "integer",
                "description": "Package Id",
                "example": 1152699
              },
              "packageType": {
                "type": "string",
                "description": "Package type",
                "example": "Complete"
              },
              "providerId": {
                "type": "integer",
                "description": "Provider Id",
                "example": 91525
              },
              "providerName": {
                "type": "string",
                "description": "Provider name",
                "example": "Green Apple - Qingpingguo"
              },
              "selectedCount": {
                "type": "integer",
                "description": "Selected count",
                "example": 0
              },
              "titleCount": {
                "type": "integer",
                "description": "Title count",
                "example": 1
              },
              "visibilityData": {
                "type": "object",
                "description": "Visibility data",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Visibility Data Schema",
                "javaType": "org.folio.rest.jaxrs.model.VisibilityData",
                "additionalProperties": false,
                "properties": {
                  "isHidden": {
                    "type": "boolean",
                    "description": "Whether resource is hidden or not",
                    "example": false
                  },
                  "reason": {
                    "type": "string",
                    "description": "Reason why resource is hidden",
                    "example": "Set by System"
                  }
                }
              },
              "allowKbToAddTitles": {
                "type": "boolean",
                "description": "Allow KB to add titles",
                "example": true
              },
              "packageToken": {
                "type": "object",
                "description": "Package Token",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Token Schema",
                "javaType": "org.folio.rest.jaxrs.model.Token",
                "additionalProperties": false,
                "properties": {
                  "factName": {
                    "type": "string",
                    "description": "Fact Name",
                    "example": "[[galesiteid]]"
                  },
                  "prompt": {
                    "type": "string",
                    "description": "Prompt",
                    "example": "/itweb/"
                  },
                  "helpText": {
                    "type": "string",
                    "description": "Help text",
                    "example": "What is token and how to use it"
                  },
                  "value": {
                    "type": "string",
                    "description": "Value",
                    "example": "hellotoken"
                  }
                }
              },
              "proxy": {
                "type": "object",
                "description": "Proxy",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Proxy Schema",
                "javaType": "org.folio.rest.jaxrs.model.Proxy",
                "additionalProperties": true,
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Proxy Id",
                    "example": "EZProxy"
                  },
                  "inherited": {
                    "type": "boolean",
                    "description": "Whether this proxy is inherited",
                    "example": true
                  }
                }
              },
              "tags": {
                "type": "object",
                "description": "Package tags",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "tags.schema",
                "title": "tags",
                "properties": {
                  "tagList": {
                    "description": "List of tags",
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                },
                "additionalProperties": false
              }
            }
          },
          "relationships": {
            "type": "object",
            "description": "Displays if any resources are included in relationships",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Package relationships object schema in package collection item",
            "javaType": "org.folio.rest.jaxrs.model.PackageRelationship",
            "additionalProperties": false,
            "properties": {
              "resources": {
                "type": "object",
                "description": "Displays Resources Relationship if any",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Relationship for an array of objects",
                "javaType": "org.folio.rest.jaxrs.model.HasManyRelationship",
                "additionalProperties": false,
                "properties": {
                  "data": {
                    "type": "array",
                    "description": "relationship Data Information",
                    "items": {
                      "type": "object",
                      "$schema": "http://json-schema.org/draft-04/schema#",
                      "title": "Data of relationships for a given object",
                      "description": "Data of relationships for a given object",
                      "javaType": "org.folio.rest.jaxrs.model.RelationshipData",
                      "additionalProperties": false,
                      "properties": {
                        "type": {
                          "type": "string",
                          "description": "The Type Schema",
                          "example": "resources"
                        },
                        "id": {
                          "type": "string",
                          "description": "The Id Schema",
                          "example": "269-1565-316875"
                        }
                      }
                    }
                  },
                  "meta": {
                    "type": "object",
                    "description": "Meta information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Metadata of packages related to a provider",
                    "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                    "additionalProperties": false,
                    "properties": {
                      "included": {
                        "type": "boolean",
                        "description": "Relationship between objects",
                        "example": false
                      }
                    }
                  }
                }
              },
              "provider": {
                "type": "object",
                "description": "Displays Provider Relationship if any",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Relationship for a given object",
                "javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
                "additionalProperties": false,
                "properties": {
                  "data": {
                    "type": "object",
                    "description": "relationship Data Information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Data of relationships for a given object",
                    "javaType": "org.folio.rest.jaxrs.model.RelationshipData",
                    "additionalProperties": false,
                    "properties": {
                      "type": {
                        "type": "string",
                        "description": "The Type Schema",
                        "example": "resources"
                      },
                      "id": {
                        "type": "string",
                        "description": "The Id Schema",
                        "example": "269-1565-316875"
                      }
                    }
                  },
                  "meta": {
                    "type": "object",
                    "description": "Meta information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Metadata of packages related to a provider",
                    "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                    "additionalProperties": false,
                    "properties": {
                      "included": {
                        "type": "boolean",
                        "description": "Relationship between objects",
                        "example": false
                      }
                    }
                  }
                }
              },
              "accessType": {
                "type": "object",
                "description": "Displays Access Type Relationship if any",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Relationship for a given object",
                "javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
                "additionalProperties": false,
                "properties": {
                  "data": {
                    "type": "object",
                    "description": "relationship Data Information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Data of relationships for a given object",
                    "javaType": "org.folio.rest.jaxrs.model.RelationshipData",
                    "additionalProperties": false,
                    "properties": {
                      "type": {
                        "type": "string",
                        "description": "The Type Schema",
                        "example": "resources"
                      },
                      "id": {
                        "type": "string",
                        "description": "The Id Schema",
                        "example": "269-1565-316875"
                      }
                    }
                  },
                  "meta": {
                    "type": "object",
                    "description": "Meta information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Metadata of packages related to a provider",
                    "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                    "additionalProperties": false,
                    "properties": {
                      "included": {
                        "type": "boolean",
                        "description": "Relationship between objects",
                        "example": false
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "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",
    "jsonapi"
  ]
}

Example:

{
  "data": {
    "id": "419",
    "type": "providers",
    "attributes": {
      "name": "ecch",
      "packagesTotal": 2,
      "packagesSelected": 0,
      "supportsCustomPackages": false,
      "providerToken": {
        "factName":"siteid",
        "prompt":"/itweb/",
        "helpText":"<ul><li>Enter your token</li></ul>",
        "value": "123456"
      },
      "proxy": {
        "id": "EZProxy",
        "inherited": true
      }
    },
    "relationships": {
      "packages": {
        "data": [{
            "type": "packages",
            "id": "419-3402"
          },
          {
            "type": "packages",
            "id": "419-3291"
          }
        ]
      }
    }
  },
  "included": [{
      "id": "419-3402",
      "type": "packages",
      "attributes": {
        "contentType": "Abstract and Index",
        "customCoverage": {
          "beginCoverage": "",
          "endCoverage": ""
        },
        "isCustom": false,
        "isSelected": false,
        "name": "Case Online Information System - COLIS",
        "packageId": 3402,
        "packageType": "Complete",
        "providerId": 419,
        "providerName": "ecch",
        "selectedCount": 0,
        "titleCount": 1,
        "vendorId": 419,
        "vendorName": "ecch",
        "visibilityData": {
          "isHidden": false,
          "reason": ""
        },
        "allowKbToAddTitles": null
      },
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        },
        "vendor": {
          "meta": {
            "included": false
          }
        },
        "provider": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "419-3291",
      "type": "packages",
      "attributes": {
        "contentType": "Abstract and Index",
        "customCoverage": {
          "beginCoverage": "",
          "endCoverage": ""
        },
        "isCustom": false,
        "isSelected": false,
        "name": "European Case Clearing House Collection",
        "packageId": 3291,
        "packageType": "Complete",
        "providerId": 419,
        "providerName": "ecch",
        "selectedCount": 0,
        "titleCount": 1,
        "vendorId": 419,
        "vendorName": "ecch",
        "visibilityData": {
          "isHidden": false,
          "reason": ""
        },
        "allowKbToAddTitles": null
      },
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        },
        "vendor": {
          "meta": {
            "included": false
          }
        },
        "provider": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Response 404

Not Found

Body

Media type: application/vnd.api+json

Type: any

Example:

{
  "errors": [{
    "title": "Provider not found"
  }],
  "jsonapi": {
    "version": "1.0"
  }
}

PUT /eholdings/providers/{providerId}

Update proxy and token information for a given provider Id.

PUT /eholdings/providers/{providerId}
URI Parameters
  • providerId: required (string)

    Provider Id of provider to get

Headers
  • Content-Type: required (string)

    Example:

    application/vnd.api+json
Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Provider Put Request Schema",
  "description": "Provider Put Request Schema using JSON API",
  "javaType": "org.folio.rest.jaxrs.model.ProviderPutRequest",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "description": "Data object of provider put request",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Provider Put Data Schema",
      "javaType": "org.folio.rest.jaxrs.model.ProviderPutData",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "description": "Provider Data Id",
          "example": "18"
        },
        "type": {
          "type": "string",
          "description": "Provider Data Type",
          "example": "providers"
        },
        "attributes": {
          "type": "object",
          "description": "Provider Data Attributes",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "title": "Provider Data Attributes Schema",
          "javaType": "org.folio.rest.jaxrs.model.ProviderPutDataAttributes",
          "additionalProperties": false,
          "properties": {
            "packagesSelected": {
              "type": "integer",
              "description": "packages selected",
              "example": 18
            },
            "providerToken": {
              "type": "object",
              "description": "provider token",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "title": "Token Schema",
              "javaType": "org.folio.rest.jaxrs.model.Token",
              "additionalProperties": false,
              "properties": {
                "factName": {
                  "type": "string",
                  "description": "Fact Name",
                  "example": "[[galesiteid]]"
                },
                "prompt": {
                  "type": "string",
                  "description": "Prompt",
                  "example": "/itweb/"
                },
                "helpText": {
                  "type": "string",
                  "description": "Help text",
                  "example": "What is token and how to use it"
                },
                "value": {
                  "type": "string",
                  "description": "Value",
                  "example": "hellotoken"
                }
              }
            },
            "proxy": {
              "type": "object",
              "description": "Proxy",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "title": "Proxy Schema",
              "javaType": "org.folio.rest.jaxrs.model.Proxy",
              "additionalProperties": true,
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Proxy Id",
                  "example": "EZProxy"
                },
                "inherited": {
                  "type": "boolean",
                  "description": "Whether this proxy is inherited",
                  "example": true
                }
              }
            }
          }
        }
      },
      "required": [
        "type",
        "attributes"
      ]
    }
  },
  "required": [
    "data"
  ]
}

Example:

{
  "data": {
    "type": "providers",
    "attributes": {
      "providerToken": {
        "value": "hellotoken"
      },
      "proxy": {
        "id": "EZProxy"
      }
    }
  }
}

Response 200

OK

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Provider Object Schema",
  "description": "Provider Schema",
  "javaType": "org.folio.rest.jaxrs.model.Provider",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "description": "Provider Data",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Provider data object schema",
      "javaType": "org.folio.rest.jaxrs.model.ProviderData",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier of provider",
          "example": "19"
        },
        "type": {
          "type": "string",
          "description": "Type of resource",
          "example": "providers"
        },
        "attributes": {
          "type": "object",
          "description": "Provider object data attributes",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "title": "Provider Data Attributes Schema",
          "javaType": "org.folio.rest.jaxrs.model.ProviderGetDataAttributes",
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "description": "Provider name",
              "example": "Gale | Cengage"
            },
            "packagesTotal": {
              "type": "integer",
              "description": "total number of packages",
              "example": 243
            },
            "packagesSelected": {
              "type": "integer",
              "description": "packages selected",
              "example": 18
            },
            "providerToken": {
              "type": "object",
              "description": "provider token",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "title": "Token Schema",
              "javaType": "org.folio.rest.jaxrs.model.Token",
              "additionalProperties": false,
              "properties": {
                "factName": {
                  "type": "string",
                  "description": "Fact Name",
                  "example": "[[galesiteid]]"
                },
                "prompt": {
                  "type": "string",
                  "description": "Prompt",
                  "example": "/itweb/"
                },
                "helpText": {
                  "type": "string",
                  "description": "Help text",
                  "example": "What is token and how to use it"
                },
                "value": {
                  "type": "string",
                  "description": "Value",
                  "example": "hellotoken"
                }
              }
            },
            "supportsCustomPackages": {
              "type": "boolean",
              "description": "Whether this provider supports custom packages",
              "example": false
            },
            "proxy": {
              "type": "object",
              "description": "Proxy",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "title": "Proxy Schema",
              "javaType": "org.folio.rest.jaxrs.model.Proxy",
              "additionalProperties": true,
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Proxy Id",
                  "example": "EZProxy"
                },
                "inherited": {
                  "type": "boolean",
                  "description": "Whether this proxy is inherited",
                  "example": true
                }
              }
            },
            "tags": {
              "type": "object",
              "description": "Provider tags",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "id": "tags.schema",
              "title": "tags",
              "properties": {
                "tagList": {
                  "description": "List of tags",
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "additionalProperties": false
            }
          }
        },
        "relationships": {
          "type": "object",
          "description": "Displays if any resources are included",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "title": "Metadata of relationships for a given object",
          "javaType": "org.folio.rest.jaxrs.model.Relationships",
          "additionalProperties": false,
          "properties": {
            "packages": {
              "type": "object",
              "description": "Relationship of packages for a given object",
              "properties": {
                "data": {
                  "type": "array",
                  "description": "packages Data Information",
                  "items": {
                    "type": "object",
                    "description": "Resources Data",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Data of relationships for a given object",
                    "javaType": "org.folio.rest.jaxrs.model.RelationshipData",
                    "additionalProperties": false,
                    "properties": {
                      "type": {
                        "type": "string",
                        "description": "The Type Schema",
                        "example": "resources"
                      },
                      "id": {
                        "type": "string",
                        "description": "The Id Schema",
                        "example": "269-1565-316875"
                      }
                    }
                  }
                },
                "meta": {
                  "type": "object",
                  "description": "Meta information",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "title": "Metadata of packages related to a provider",
                  "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                  "additionalProperties": false,
                  "properties": {
                    "included": {
                      "type": "boolean",
                      "description": "Relationship between objects",
                      "example": false
                    }
                  }
                }
              }
            },
            "resources": {
              "type": "object",
              "description": "Relationship of resources for a given object",
              "properties": {
                "data": {
                  "type": "array",
                  "description": "Resources Data Information",
                  "items": {
                    "type": "object",
                    "description": "Resources Data",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Data of relationships for a given object",
                    "javaType": "org.folio.rest.jaxrs.model.RelationshipData",
                    "additionalProperties": false,
                    "properties": {
                      "type": {
                        "type": "string",
                        "description": "The Type Schema",
                        "example": "resources"
                      },
                      "id": {
                        "type": "string",
                        "description": "The Id Schema",
                        "example": "269-1565-316875"
                      }
                    }
                  }
                },
                "meta": {
                  "type": "object",
                  "description": "Meta information",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "title": "Metadata of packages related to a provider",
                  "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                  "additionalProperties": false,
                  "properties": {
                    "included": {
                      "type": "boolean",
                      "description": "Relationship between objects",
                      "example": false
                    }
                  }
                }
              }
            },
            "provider": {
              "type": "object",
              "description": "Relationship of provider for a given object",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "title": "Metadata of whether an object is related to this resource",
              "javaType": "org.folio.rest.jaxrs.model.MetaIncluded",
              "additionalProperties": false,
              "properties": {
                "meta": {
                  "type": "object",
                  "description": "Metadata of whether an object is related to this resource",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "title": "Metadata of packages related to a provider",
                  "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                  "additionalProperties": false,
                  "properties": {
                    "included": {
                      "type": "boolean",
                      "description": "Relationship between objects",
                      "example": false
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "included": {
      "type": "array",
      "description": "List of packages for a given provider",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Package object schema for a collection",
        "description": "Package object schema for a collection",
        "javaType": "org.folio.rest.jaxrs.model.PackageCollectionItem",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier of package - combination of providerId-packageId",
            "example": "91525-1152699"
          },
          "type": {
            "type": "string",
            "description": "Type of resource",
            "example": "packages"
          },
          "attributes": {
            "type": "object",
            "description": "Package object data attributes",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Package Object Data Attributes Schema",
            "javaType": "org.folio.rest.jaxrs.model.PackageDataAttributes",
            "additionalProperties": false,
            "properties": {
              "contentType": {
                "type": "string",
                "description": "Content Type of Package",
                "example": "Online Reference",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Content Type Schema",
                "javaType": "org.folio.rest.jaxrs.model.ContentType",
                "additionalProperties": false,
                "enum": [
                  "Aggregated Full Text",
                  "Abstract and Index",
                  "E-Book",
                  "E-Journal",
                  "Print",
                  "Unknown",
                  "Online Reference",
                  "Streaming Media",
                  "Mixed Content"
                ]
              },
              "customCoverage": {
                "type": "object",
                "description": "Custom Coverage",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Coverage Schema",
                "javaType": "org.folio.rest.jaxrs.model.Coverage",
                "additionalProperties": false,
                "properties": {
                  "beginCoverage": {
                    "type": "string",
                    "description": "Begin Coverage Date",
                    "example": "2003-01-01"
                  },
                  "endCoverage": {
                    "type": "string",
                    "description": "End Coverage Date",
                    "example": "2003-12-01"
                  }
                }
              },
              "isCustom": {
                "type": "boolean",
                "description": "Whether this package is custom or not",
                "example": false
              },
              "isSelected": {
                "type": "boolean",
                "description": "Whether this package is selected or not",
                "example": false
              },
              "name": {
                "type": "string",
                "description": "Package name",
                "example": "Shenbao"
              },
              "packageId": {
                "type": "integer",
                "description": "Package Id",
                "example": 1152699
              },
              "packageType": {
                "type": "string",
                "description": "Package type",
                "example": "Complete"
              },
              "providerId": {
                "type": "integer",
                "description": "Provider Id",
                "example": 91525
              },
              "providerName": {
                "type": "string",
                "description": "Provider name",
                "example": "Green Apple - Qingpingguo"
              },
              "selectedCount": {
                "type": "integer",
                "description": "Selected count",
                "example": 0
              },
              "titleCount": {
                "type": "integer",
                "description": "Title count",
                "example": 1
              },
              "visibilityData": {
                "type": "object",
                "description": "Visibility data",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Visibility Data Schema",
                "javaType": "org.folio.rest.jaxrs.model.VisibilityData",
                "additionalProperties": false,
                "properties": {
                  "isHidden": {
                    "type": "boolean",
                    "description": "Whether resource is hidden or not",
                    "example": false
                  },
                  "reason": {
                    "type": "string",
                    "description": "Reason why resource is hidden",
                    "example": "Set by System"
                  }
                }
              },
              "allowKbToAddTitles": {
                "type": "boolean",
                "description": "Allow KB to add titles",
                "example": true
              },
              "packageToken": {
                "type": "object",
                "description": "Package Token",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Token Schema",
                "javaType": "org.folio.rest.jaxrs.model.Token",
                "additionalProperties": false,
                "properties": {
                  "factName": {
                    "type": "string",
                    "description": "Fact Name",
                    "example": "[[galesiteid]]"
                  },
                  "prompt": {
                    "type": "string",
                    "description": "Prompt",
                    "example": "/itweb/"
                  },
                  "helpText": {
                    "type": "string",
                    "description": "Help text",
                    "example": "What is token and how to use it"
                  },
                  "value": {
                    "type": "string",
                    "description": "Value",
                    "example": "hellotoken"
                  }
                }
              },
              "proxy": {
                "type": "object",
                "description": "Proxy",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Proxy Schema",
                "javaType": "org.folio.rest.jaxrs.model.Proxy",
                "additionalProperties": true,
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Proxy Id",
                    "example": "EZProxy"
                  },
                  "inherited": {
                    "type": "boolean",
                    "description": "Whether this proxy is inherited",
                    "example": true
                  }
                }
              },
              "tags": {
                "type": "object",
                "description": "Package tags",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "tags.schema",
                "title": "tags",
                "properties": {
                  "tagList": {
                    "description": "List of tags",
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                },
                "additionalProperties": false
              }
            }
          },
          "relationships": {
            "type": "object",
            "description": "Displays if any resources are included in relationships",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Package relationships object schema in package collection item",
            "javaType": "org.folio.rest.jaxrs.model.PackageRelationship",
            "additionalProperties": false,
            "properties": {
              "resources": {
                "type": "object",
                "description": "Displays Resources Relationship if any",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Relationship for an array of objects",
                "javaType": "org.folio.rest.jaxrs.model.HasManyRelationship",
                "additionalProperties": false,
                "properties": {
                  "data": {
                    "type": "array",
                    "description": "relationship Data Information",
                    "items": {
                      "type": "object",
                      "$schema": "http://json-schema.org/draft-04/schema#",
                      "title": "Data of relationships for a given object",
                      "description": "Data of relationships for a given object",
                      "javaType": "org.folio.rest.jaxrs.model.RelationshipData",
                      "additionalProperties": false,
                      "properties": {
                        "type": {
                          "type": "string",
                          "description": "The Type Schema",
                          "example": "resources"
                        },
                        "id": {
                          "type": "string",
                          "description": "The Id Schema",
                          "example": "269-1565-316875"
                        }
                      }
                    }
                  },
                  "meta": {
                    "type": "object",
                    "description": "Meta information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Metadata of packages related to a provider",
                    "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                    "additionalProperties": false,
                    "properties": {
                      "included": {
                        "type": "boolean",
                        "description": "Relationship between objects",
                        "example": false
                      }
                    }
                  }
                }
              },
              "provider": {
                "type": "object",
                "description": "Displays Provider Relationship if any",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Relationship for a given object",
                "javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
                "additionalProperties": false,
                "properties": {
                  "data": {
                    "type": "object",
                    "description": "relationship Data Information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Data of relationships for a given object",
                    "javaType": "org.folio.rest.jaxrs.model.RelationshipData",
                    "additionalProperties": false,
                    "properties": {
                      "type": {
                        "type": "string",
                        "description": "The Type Schema",
                        "example": "resources"
                      },
                      "id": {
                        "type": "string",
                        "description": "The Id Schema",
                        "example": "269-1565-316875"
                      }
                    }
                  },
                  "meta": {
                    "type": "object",
                    "description": "Meta information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Metadata of packages related to a provider",
                    "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                    "additionalProperties": false,
                    "properties": {
                      "included": {
                        "type": "boolean",
                        "description": "Relationship between objects",
                        "example": false
                      }
                    }
                  }
                }
              },
              "accessType": {
                "type": "object",
                "description": "Displays Access Type Relationship if any",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Relationship for a given object",
                "javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
                "additionalProperties": false,
                "properties": {
                  "data": {
                    "type": "object",
                    "description": "relationship Data Information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Data of relationships for a given object",
                    "javaType": "org.folio.rest.jaxrs.model.RelationshipData",
                    "additionalProperties": false,
                    "properties": {
                      "type": {
                        "type": "string",
                        "description": "The Type Schema",
                        "example": "resources"
                      },
                      "id": {
                        "type": "string",
                        "description": "The Id Schema",
                        "example": "269-1565-316875"
                      }
                    }
                  },
                  "meta": {
                    "type": "object",
                    "description": "Meta information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Metadata of packages related to a provider",
                    "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                    "additionalProperties": false,
                    "properties": {
                      "included": {
                        "type": "boolean",
                        "description": "Relationship between objects",
                        "example": false
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "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",
    "jsonapi"
  ]
}

Example:

{
  "data": {
    "id": "18",
    "type": "providers",
    "attributes": {
      "name": "Gale | Cengage",
      "packagesTotal": 243,
      "packagesSelected": 18,
      "providerToken": {
        "factName": "[[galesiteid]]",
        "prompt": "/itweb/",
        "helpText": "\u003cul\u003e\r\n    \u003cli\u003eEnter your Gale\u003csup\u003e®\u003c/sup\u003e site ID in the space provided below. The site ID may contain a combination of alpha/numeric characters, varying in length. \u003cblockquote style=\"margin-right: 0px;\" dir=\"ltr\"\u003e\r\n    \u003cp\u003e Example: The site ID immediately follows /itweb/ in a URL. The site ID in the following URL is \u003ci\u003eaa11bb22\u003c/i\u003e. \u003c/p\u003e\r\n    \u003c/blockquote\u003e\u003c/li\u003e\r\n\u003c/ul\u003e\r\n\u003cblockquote style=\"margin-right: 0px;\" dir=\"ltr\"\u003e\u003cblockquote style=\"margin-right: 0px;\" dir=\"ltr\"\u003e\r\n\u003cp\u003e\u003cspan style=\"text-decoration: underline;\"\u003ehttp://infotrac.galegroup.com/itweb/aa11bb22?db=AIM\u003c/span\u003e\u003c/p\u003e\r\n\u003c/blockquote\u003e\u003c/blockquote\u003e\u003cbr /\u003e\r\n\u003cul\u003e\r\n    \u003cli\u003eIf no site ID is specified, your Gale Group links may not function properly, as Gale Group requires this information for authentication. \u003c/li\u003e\r\n    \u003cli\u003eIf you are unable to locate the site ID, please contact Gale Group. For contact information, visit: \u003ca href=\"http://access.gale.com/authentication/\"\u003ehttp://access.gale.com/authentication/\u003c/a\u003e. \u003c/li\u003e\r\n\u003c/ul\u003e\r\n",
        "value": "hellotoken"
      },
      "supportsCustomPackages": false,
      "proxy": {
        "id": "EZProxy",
        "inherited": false
      }
    },
    "relationships": {
      "packages": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "jsonapi": {
    "version": "1.0"
  }
}

PUT /eholdings/providers/{providerId}/tags

Update tags assigned to provider

PUT /eholdings/providers/{providerId}/tags
URI Parameters
  • providerId: required (string)

    Provider Id of provider to get

Headers
  • Content-Type: required (string)

    Example:

    application/vnd.api+json
Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Provider Tags PUT Request Schema",
  "description": "Provider Tags PUT Request Schema using JSON API",
  "javaType": "org.folio.rest.jaxrs.model.ProviderTagsPutRequest",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "description": "Data object of provider tags put request",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Provider Tags Put Data Schema",
      "javaType": "org.folio.rest.jaxrs.model.ProviderTagsPutData",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Data type",
          "type": "string",
          "enum": [
            "tags"
          ],
          "example": "tags"
        },
        "attributes": {
          "description": "Data type attributes",
          "type": "object",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "title": "Provider Tags Object Data Attributes Schema",
          "javaType": "org.folio.rest.jaxrs.model.ProviderTagsDataAttributes",
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "description": "Provider name",
              "example": "Gale | Cengage"
            },
            "tags": {
              "type": "object",
              "description": "Provider tags",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "id": "tags.schema",
              "title": "tags",
              "properties": {
                "tagList": {
                  "description": "List of tags",
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "additionalProperties": false
            }
          },
          "required": [
            "tags"
          ]
        }
      },
      "required": [
        "type",
        "attributes"
      ]
    }
  },
  "required": [
    "data"
  ]
}

Example:

{
  "data": {
    "type": "tags",
    "attributes": {
      "name": "test provider for documentation",
      "tags": {
        "tagList": [
          "folio"
        ]
      }
    }
  }
}

Response 200

OK

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Provider Tags object schema",
  "description": "Provider Tags object schema",
  "javaType": "org.folio.rest.jaxrs.model.ProviderTags",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "description": "The Data Schema",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Provider Tags object schema",
      "javaType": "org.folio.rest.jaxrs.model.ProviderTagsItem",
      "additionalProperties": false,
      "properties": {
        "type": {
          "type": "string",
          "description": "Type of resource",
          "example": "tags"
        },
        "attributes": {
          "type": "object",
          "description": "Provider tags object data attributes",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "title": "Provider Tags Object Data Attributes Schema",
          "javaType": "org.folio.rest.jaxrs.model.ProviderTagsDataAttributes",
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "description": "Provider name",
              "example": "Gale | Cengage"
            },
            "tags": {
              "type": "object",
              "description": "Provider tags",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "id": "tags.schema",
              "title": "tags",
              "properties": {
                "tagList": {
                  "description": "List of tags",
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "additionalProperties": false
            }
          },
          "required": [
            "tags"
          ]
        }
      }
    },
    "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",
    "jsonapi"
  ]
}

Example:

{
  "data": {
    "type": "tags",
    "attributes": {
      "name": "test provider name",
      "tags": {
        "tagList": [
          "folio"
        ]
      }
    }
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Response 422

Unprocessable Entity

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Error Response object",
        "description": "Error Response Schema for JSON API",
        "javaType": "org.folio.rest.jaxrs.model.JsonapiErrorResponse",
        "additionalProperties": false,
        "properties": {
          "title": {
            "type": "string",
            "description": "Error Message Title",
            "example": "Invalid KB API Credentials"
          },
          "detail": {
            "type": "string",
            "description": "Error Message Detail",
            "example": "Kb api credentials are invalid"
          },
          "source": {
            "type": "object",
            "description": "Source of Error Message",
            "example": {}
          }
        }
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$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"
      ]
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "Invalid name",
      "detail": "Name can't be blank",
      "source": {}
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

GET /eholdings/providers/{providerId}/packages

Search within a list of packages associated with a given provider.

GET /eholdings/providers/{providerId}/packages
URI Parameters
  • providerId: required (string)

    Provider Id of provider to get

Query Parameters
  • q: (string)

    String used to search to retrieve a collection

    Example:

    ABC-CLIO
  • filter[tags]: (array of string)

    Filter to narrow down results based on assigned tags. Contains list of required tags.

  • filter[access-type]: (array of string)

    Filter to narrow down results based on assigned access type.

  • filter[selected]: (string)

    Filter to narrow down results based on selection status. Possible values are all, true, false, ebsco.

    Example:

    all
  • filter[type]: (string - default: all)

    Filter to narrow down results based on content type. Defaults to all. Possible values are all, aggregatedfulltext, abstractandindex, ebook, ejournal, print, unknown, streamingmedia, mixedcontent, onlinereference.

    Example:

    ebook
  • sort: (string - default: relevance)

    Option by which results are sorted. Possible values are name, relevance.

  • page: (integer - default: 1 - minimum: 1 - maximum: 2147483647)

    Page number

    Example:

    1
  • count: (integer - default: 25 - minimum: 1 - maximum: 100)

    Page size

    Example:

    100

Response 200

OK

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Package Collection Schema",
  "description": "Package Collection Schema",
  "javaType": "org.folio.rest.jaxrs.model.PackageCollection",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "array",
      "description": "List of packages",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Package object schema for a collection",
        "description": "Package object schema for a collection",
        "javaType": "org.folio.rest.jaxrs.model.PackageCollectionItem",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier of package - combination of providerId-packageId",
            "example": "91525-1152699"
          },
          "type": {
            "type": "string",
            "description": "Type of resource",
            "example": "packages"
          },
          "attributes": {
            "type": "object",
            "description": "Package object data attributes",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Package Object Data Attributes Schema",
            "javaType": "org.folio.rest.jaxrs.model.PackageDataAttributes",
            "additionalProperties": false,
            "properties": {
              "contentType": {
                "type": "string",
                "description": "Content Type of Package",
                "example": "Online Reference",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Content Type Schema",
                "javaType": "org.folio.rest.jaxrs.model.ContentType",
                "additionalProperties": false,
                "enum": [
                  "Aggregated Full Text",
                  "Abstract and Index",
                  "E-Book",
                  "E-Journal",
                  "Print",
                  "Unknown",
                  "Online Reference",
                  "Streaming Media",
                  "Mixed Content"
                ]
              },
              "customCoverage": {
                "type": "object",
                "description": "Custom Coverage",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Coverage Schema",
                "javaType": "org.folio.rest.jaxrs.model.Coverage",
                "additionalProperties": false,
                "properties": {
                  "beginCoverage": {
                    "type": "string",
                    "description": "Begin Coverage Date",
                    "example": "2003-01-01"
                  },
                  "endCoverage": {
                    "type": "string",
                    "description": "End Coverage Date",
                    "example": "2003-12-01"
                  }
                }
              },
              "isCustom": {
                "type": "boolean",
                "description": "Whether this package is custom or not",
                "example": false
              },
              "isSelected": {
                "type": "boolean",
                "description": "Whether this package is selected or not",
                "example": false
              },
              "name": {
                "type": "string",
                "description": "Package name",
                "example": "Shenbao"
              },
              "packageId": {
                "type": "integer",
                "description": "Package Id",
                "example": 1152699
              },
              "packageType": {
                "type": "string",
                "description": "Package type",
                "example": "Complete"
              },
              "providerId": {
                "type": "integer",
                "description": "Provider Id",
                "example": 91525
              },
              "providerName": {
                "type": "string",
                "description": "Provider name",
                "example": "Green Apple - Qingpingguo"
              },
              "selectedCount": {
                "type": "integer",
                "description": "Selected count",
                "example": 0
              },
              "titleCount": {
                "type": "integer",
                "description": "Title count",
                "example": 1
              },
              "visibilityData": {
                "type": "object",
                "description": "Visibility data",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Visibility Data Schema",
                "javaType": "org.folio.rest.jaxrs.model.VisibilityData",
                "additionalProperties": false,
                "properties": {
                  "isHidden": {
                    "type": "boolean",
                    "description": "Whether resource is hidden or not",
                    "example": false
                  },
                  "reason": {
                    "type": "string",
                    "description": "Reason why resource is hidden",
                    "example": "Set by System"
                  }
                }
              },
              "allowKbToAddTitles": {
                "type": "boolean",
                "description": "Allow KB to add titles",
                "example": true
              },
              "packageToken": {
                "type": "object",
                "description": "Package Token",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Token Schema",
                "javaType": "org.folio.rest.jaxrs.model.Token",
                "additionalProperties": false,
                "properties": {
                  "factName": {
                    "type": "string",
                    "description": "Fact Name",
                    "example": "[[galesiteid]]"
                  },
                  "prompt": {
                    "type": "string",
                    "description": "Prompt",
                    "example": "/itweb/"
                  },
                  "helpText": {
                    "type": "string",
                    "description": "Help text",
                    "example": "What is token and how to use it"
                  },
                  "value": {
                    "type": "string",
                    "description": "Value",
                    "example": "hellotoken"
                  }
                }
              },
              "proxy": {
                "type": "object",
                "description": "Proxy",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Proxy Schema",
                "javaType": "org.folio.rest.jaxrs.model.Proxy",
                "additionalProperties": true,
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Proxy Id",
                    "example": "EZProxy"
                  },
                  "inherited": {
                    "type": "boolean",
                    "description": "Whether this proxy is inherited",
                    "example": true
                  }
                }
              },
              "tags": {
                "type": "object",
                "description": "Package tags",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "tags.schema",
                "title": "tags",
                "properties": {
                  "tagList": {
                    "description": "List of tags",
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                },
                "additionalProperties": false
              }
            }
          },
          "relationships": {
            "type": "object",
            "description": "Displays if any resources are included in relationships",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Package relationships object schema in package collection item",
            "javaType": "org.folio.rest.jaxrs.model.PackageRelationship",
            "additionalProperties": false,
            "properties": {
              "resources": {
                "type": "object",
                "description": "Displays Resources Relationship if any",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Relationship for an array of objects",
                "javaType": "org.folio.rest.jaxrs.model.HasManyRelationship",
                "additionalProperties": false,
                "properties": {
                  "data": {
                    "type": "array",
                    "description": "relationship Data Information",
                    "items": {
                      "type": "object",
                      "$schema": "http://json-schema.org/draft-04/schema#",
                      "title": "Data of relationships for a given object",
                      "description": "Data of relationships for a given object",
                      "javaType": "org.folio.rest.jaxrs.model.RelationshipData",
                      "additionalProperties": false,
                      "properties": {
                        "type": {
                          "type": "string",
                          "description": "The Type Schema",
                          "example": "resources"
                        },
                        "id": {
                          "type": "string",
                          "description": "The Id Schema",
                          "example": "269-1565-316875"
                        }
                      }
                    }
                  },
                  "meta": {
                    "type": "object",
                    "description": "Meta information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Metadata of packages related to a provider",
                    "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                    "additionalProperties": false,
                    "properties": {
                      "included": {
                        "type": "boolean",
                        "description": "Relationship between objects",
                        "example": false
                      }
                    }
                  }
                }
              },
              "provider": {
                "type": "object",
                "description": "Displays Provider Relationship if any",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Relationship for a given object",
                "javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
                "additionalProperties": false,
                "properties": {
                  "data": {
                    "type": "object",
                    "description": "relationship Data Information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Data of relationships for a given object",
                    "javaType": "org.folio.rest.jaxrs.model.RelationshipData",
                    "additionalProperties": false,
                    "properties": {
                      "type": {
                        "type": "string",
                        "description": "The Type Schema",
                        "example": "resources"
                      },
                      "id": {
                        "type": "string",
                        "description": "The Id Schema",
                        "example": "269-1565-316875"
                      }
                    }
                  },
                  "meta": {
                    "type": "object",
                    "description": "Meta information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Metadata of packages related to a provider",
                    "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                    "additionalProperties": false,
                    "properties": {
                      "included": {
                        "type": "boolean",
                        "description": "Relationship between objects",
                        "example": false
                      }
                    }
                  }
                }
              },
              "accessType": {
                "type": "object",
                "description": "Displays Access Type Relationship if any",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Relationship for a given object",
                "javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
                "additionalProperties": false,
                "properties": {
                  "data": {
                    "type": "object",
                    "description": "relationship Data Information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Data of relationships for a given object",
                    "javaType": "org.folio.rest.jaxrs.model.RelationshipData",
                    "additionalProperties": false,
                    "properties": {
                      "type": {
                        "type": "string",
                        "description": "The Type Schema",
                        "example": "resources"
                      },
                      "id": {
                        "type": "string",
                        "description": "The Id Schema",
                        "example": "269-1565-316875"
                      }
                    }
                  },
                  "meta": {
                    "type": "object",
                    "description": "Meta information",
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Metadata of packages related to a provider",
                    "javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
                    "additionalProperties": false,
                    "properties": {
                      "included": {
                        "type": "boolean",
                        "description": "Relationship between objects",
                        "example": false
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "description": "metadata containing total results in packages collection",
      "$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",
    "jsonapi"
  ]
}

Example:

{
  "data": [{
    "id": "0-1117849",
    "type": "packages",
    "attributes": {
      "contentType": "Unknown",
      "customCoverage": {
        "beginCoverage": "",
        "endCoverage": ""
      },
      "isCustom": false,
      "isSelected": false,
      "name": "",
      "packageId": 1117849,
      "packageType": "Complete",
      "providerId": 0,
      "providerName": "System Account",
      "selectedCount": 0,
      "titleCount": 0,
      "vendorId": 0,
      "vendorName": "System Account",
      "visibilityData": {
        "isHidden": false,
        "reason": ""
      }
    },
    "relationships": {
      "resources": {
        "meta": {
          "included": false
        }
      },
      "vendor": {
        "meta": {
          "included": false
        }
      },
      "provider": {
        "meta": {
          "included": false
        }
      }
    }
  }]
}

Response 400

Bad Request

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Error Response object",
        "description": "Error Response Schema for JSON API",
        "javaType": "org.folio.rest.jaxrs.model.JsonapiErrorResponse",
        "additionalProperties": false,
        "properties": {
          "title": {
            "type": "string",
            "description": "Error Message Title",
            "example": "Invalid KB API Credentials"
          },
          "detail": {
            "type": "string",
            "description": "Error Message Detail",
            "example": "Kb api credentials are invalid"
          },
          "source": {
            "type": "object",
            "description": "Source of Error Message",
            "example": {}
          }
        }
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$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"
      ]
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "Search parameter cannot be empty"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Response 404

Not Found

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Error Response object",
        "description": "Error Response Schema for JSON API",
        "javaType": "org.folio.rest.jaxrs.model.JsonapiErrorResponse",
        "additionalProperties": false,
        "properties": {
          "title": {
            "type": "string",
            "description": "Error Message Title",
            "example": "Invalid KB API Credentials"
          },
          "detail": {
            "type": "string",
            "description": "Error Message Detail",
            "example": "Kb api credentials are invalid"
          },
          "source": {
            "type": "object",
            "description": "Source of Error Message",
            "example": {}
          }
        }
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$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"
      ]
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "Provider not found"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}