...
Lo stesso risultato può essere ottenuto facendo queste richieste:
• https://iris.unixx.it/gw/rest/api/people?id=12345
• https://iris.unixx.it/gw/rest/api/people?pid=rp12345
• https://iris.unixx.it/gw/rest/api/people?idAb=67890
• https://iris.unixx.it/gw/rest/api/people?cf=XXXXXX00X00X000X
• https://iris.unixx.it/gw/rest/api/people?sourceId=xxxx
• https://iris.unixx.it/gw/rest/api/people?orcid=yyyyyy
Ciascuna delle precedenti richieste restituisce un array JSON contenente l'oggetto corrispondente [{}].
Tutti gli identificatori disponibili per ogni tipo di risorsa sono elencati nella sezione specifica per ogni raccolta.
Se non viene fornito alcun tipo di identificatore, l'uso dell'identificatore "id" è implicito.
Convenzioni sulle risposte REST
Ogni volta che viene effettuata una richiesta, il payload della risposta conterrà solo le informazioni relative alla risorsa.
Altre informazioni quali errori, impaginazione, ordinamento sono disponibili nelle intestazioni HTTP.
Queste intestazioni sono:
- Item-Count
numero di oggetti trovati - Item-Per-Page
numero di elementi per pagina - Page
numero della pagina corrente - Page-Count
numero di pagine disponibili - Rest-Version
versione del rest service - Sort
lista dei campi di ordinamento in formato csv - Dir
direzione di ordinamento (asc|desc)
Risultati di ricerca e ordinamento REST
Per la navigazione e l'ordinamento dei risultati, è possibile utilizzare questi parametri di richiesta della query:
- page
numero di pagina da recuperare - sort
campo di ordinamento - dir
direzione dell'ordinamento (asc, desc)
Per esempio:
• https://iris.unixx.it/gw/rest/api/people?page=2
• https://iris.unixx.it/gw/rest/api/people?name=xxx&sort=name,id
I campi utilizzabili per l'ordinamento sono:
- id
- pid
- year
- name
- startDate
- lastModified
I filtri di ordinamento utilizzabili effettivi per un tipo di risorsa specifico sono specificati nei dettagli del servizio REST.
Gestione degli errori REST
Ogni volta che viene effettuata una richiesta, può essere restituito uno dei seguenti HTTP Response Header:
- 200: OK
- 401: Unauthorized
- 403: Forbidden
- 404: Not Found
- 500: Internal Server Error
Se è capitato un errore interno (Internal Server Error), è possibile usare queste intestazioni per approfondire il problema:
- error-code
codice di errore - error-message
messaggio dei dettagli dell'errore.
Nei rilasci futuri, queste intestazioni potrebbero essere rinominate diventando rispettivamente Error-Code e Error-Message.