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

Define typical document errors #33

Open
nichtich opened this issue May 16, 2014 · 2 comments
Open

Define typical document errors #33

nichtich opened this issue May 16, 2014 · 2 comments

Comments

@nichtich
Copy link
Member

Document Error Responses are only given as plain strings. Clients may want more specific information about the type of document error, for instance to provide their own translation or to react based by providing the user different kinds of actions (e.g. search for another document). To do so, a list of typical document errors is required. These document error types could be provided for instance by an error code. Document error types, however, would be optional, so clients must also be able to handle general document errors as it is specified now.

@nichtich
Copy link
Member Author

Possible general error cases for document errors (request/renew/cancel/items):

  • inactive acount state: expired, outstanding fees... (see method patron for details)
  • method not possible with this document: e.g. renew a document that is not held by the user
  • patron quota exceeded: because maximum number of requests/renewals per patron is limited
  • document quota exceeded: because maximum number of requests/renewals of this document limited
  • method not allowed: e.g. renew a document that cannot be renewed for some reason
  • system error: backend system did fully act as expected
  • unknown URI: e.g. requested document or storage not found

@nichtich
Copy link
Member Author

May be part of #76.

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