IPIF / prosopogrAPhI

Tentative way towards a shared API for prosopographical data based on the factoid model (Bradley/Short 2005)
24 stars 6 forks source link

Use case "Autocomplete": human readable identification for a person #20

Closed GVogeler closed 3 years ago

GVogeler commented 3 years ago

It seems to be typical usecase that user want to look up which persons comply to a search constraint, e.g. by filling in an autocomplete input box. The return to this kind of request should be human readable to help the user make decisions on the sensibility of the result. A typical behaviour would be to return an identifier but it should be human readable. Conceptually this human readable label to a person would have to be considere a statement on the person or be constructed from the statements stored in the prosopographical resource and thus only being returned via the factoid and statement endpoints. Creating this on client side is a) expensive and b) needs knowledge about the details of the implementation. We (i.e. @sennierer and @richardhadden and me @GVogeler ) suggest to introduce a return label property for GET requests on the person resource, which would have the following features: