Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: PAIA info endpoints #76

Open
nichtich opened this issue Feb 21, 2019 · 1 comment
Open

Feature: PAIA info endpoints #76

nichtich opened this issue Feb 21, 2019 · 1 comment

Comments

@nichtich
Copy link
Member

nichtich commented Feb 21, 2019

patron types can be arbitrary URIs defined anywhere but the ILS backend will likely know best about user types, so it should also make information about it available. Example:

https://example.org/paia/info/patrontype/42

=>

{
  "title": "student"
}

Similar information could be made available for storageid and feeid

@nichtich
Copy link
Member Author

nichtich commented Feb 22, 2019

Suggestion: extend PAIA with an additional part PAIA info in addition to PAIA core and PAIA auth.

GET https://example.org/info/

Return an JSON object with information about the PAIA server. Minimum information should be base URL of PAIA core and PAIA auth, if available, for instance:

{
  "core": "https://example.org/core/",
  "auth":  "https://example.org/auth/"
}

GET https://example.org/info/storage/

Return a JSON array with storages supported by the PAIA server or HTTP 501 if this list is not supported. Storages are found in document field storageid

GET https://example.org/info/storage/{storageid}

Return a JSON object describing a storage if this storage is known to the PAIA server or HTTP 501 if storage lookup is not supported or HTTP 404 if the storage is not known. Example:

https://example.org/info/storage/http://uri.gbv.de/organization/isil/DE-999@xxx

{
  "id": "http://uri.gbv.de/organization/isil/DE-999@xxx",
  "description": "Magazin",
  "href": "...optional URL..."
}

GET https://example.org/info/fee/

Return a JSON array with fee types supported by the PAIA server or HTTP 501 if this list is not supported. Fees are found in fee field feeid.

GET https://example.org/info/fee/{feeid}

https://example.org/info/fee/de-999:fee-type:123

{
  "id": "de-999:fee-type:123",
  "description": "Mahngebühr",
  "amount": "1.00 EUR"
}

GET https://example.org/info/user-type/

Return a JSON array with user types supported by the PAIA server or HTTP 501 if this list is not supported. User types are found in patron field type

GET https://example.org/info/user-type/{type}

https://example.org/info/user-type/de-999:user-type:42

{
  "id": "de-999:user-type:42",
  "description": "Studierende"
}

See also #70 for conditions (this includes delivery places aka desks).

@nichtich nichtich changed the title Feature list patron types Feature list: PAIA info endpoints Feb 22, 2019
@nichtich nichtich changed the title Feature list: PAIA info endpoints Feature: PAIA info endpoints Feb 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant