Iscrizione titoli a piano di lancio
|
|---|
Iscrizione titoli a piano di lancioQuesta API consente di consultare e creare le iscrizioni dei titoli a piano di lancio. Per gestire le API di iscrizione titoli a piano di lancio tramite autenticazione è necessario utilizzare lo scope: title_api_scope. OperazioniL'API espone i seguenti metodi:
Ricerca dei lanciRicerca dei lanciConsente di effettuare la ricerca dei lanci.Risponde a richieste GET verso: /titoli/launch E' possibile passare in querystring i seguenti parametri opzionali per filtrare la ricerca:
L’operazione restituisce un oggetto JSON contenente i seguenti campi:
L'API può restituire i seguenti codici di errore:
Esempio richiestaGET https://api.messaggerielibri.it/titoli/launch?pageIndex=1&launchStatus=open&orderDirection=asc&launchYear=2023&saleDateFrom=2023-08-01 Authorization: Bearer [TOKEN JWT] Esempio risposta{
"totalCount": 5,
"totalPages": 1,
"page": {
"index": 1,
"size": 50,
"from": 1,
"to": 5
},
"launches": [
{
"launchStatus": "open",
"launchYear": 2023,
"launchNumber": "31.0",
"registrationLimit": "2023-07-13T00:00:00",
"deliveryLimit": "2023-07-20T00:00:00",
"saleDate": "2023-08-01T00:00:00",
"saleDateBy": "2023-08-04T00:00:00",
"billingMonth": "07",
"titlesCount": 0,
FeaturesPer utilizzare il metodo API è necessario possedere una o più delle seguenti features:
altrimenti viene restituito 403 (Forbidden) Recupero dettagli di un lancioRecupero dettagli di un lancioConsente di ottenere il dettaglio di un lancio con i suoi titoli iscritti.Risponde a richieste GET verso: /launch/{year}/{launchNumber} , dove {year} rappresenta l'anno del lancio e {launchNumber} il numero del lancio. L’operazione restituisce un oggetto JSON contenente i seguenti campi:
L’API può restituire i seguenti codici di errore:
Esempio richiesta:GET https://api.messaggerielibri.it/titoli/launch/2023/190 Authorization: Bearer[TOKEN JWT]
Esempio risposta:{
"launch": {
"launchStatus": "opened",
"launchYear": 2023,
"launchNumber": "19.0",
"registrationLimit": "2023-04-20T00:00:00",
"deliveryLimit": "2023-04-27T00:00:00",
"saleDate": "2023-05-09T00:00:00",
"saleDateBy": "2023-05-12T00:00:00",
"billingMonth": "05",
"titlesCount": 0,
FeaturesPer utilizzare il metodo API è necessario possedere una o più delle seguenti features:
altrimenti viene restituito 403 (Forbidden) Iscrizione di una lista di titoli al lancioIscrizione di una lista di titoli al lancioConsente di iscrivere una lista di titoli al lancio.Risponde a richieste POST verso: /titoli/launch/{year}/{launchNumber}/titles, dove {year} rappresenta l'anno del lancio e {launchNumber} il numero del lancio. Per identificare i titoli da iscrivere al lancio viene richiesto un oggetto JSON contenente una lista di ean. Se l’esecuzione è terminata con successo, l’API restituisce 204 No Content senza alcun body. L’API può restituire i seguenti codici di errore:
Esempio richiesta:POST https://api.messaggerielibri.it/titoli/launch/2023/600/titles Authorization: Bearer[TOKEN JWT] Esempio body richiesta["9788831460347"] FeaturesPer utilizzare il metodo API è necessario possedere una o più delle seguenti features:
altrimenti viene restituito 403 (Forbidden) Iscrizione di un singolo titolo al lancioIscrizione di un singolo titolo al lancioConsente di iscrivere un titolo al lancio.Risponde a richieste PUT verso: /titoli/launch/{year}/{launchNumber}/titles/{eanCode}, dove {year} rappresenta l'anno del lancio, {launchNumber} il numero del lancio, {eanCode} l'ean del titolo da iscrivere Se l’esecuzione è terminata con successo, l’API restituisce 204 No Content senza alcun body. L’API può restituire i seguenti codici di errore:
Esempio richiesta:PUT https://api.messaggerielibri.it/titoli/launch/2023/600/titles/0012345678905 Authorization: Bearer[TOKEN JWT] FeaturesPer utilizzare il metodo API è necessario possedere una o più delle seguenti features:
altrimenti viene restituito 403 (Forbidden) Rimozione di una lista di titoli da un lancioRimozione di una lista di titoli da un lancioConsente di rimuovere una lista di titoli da un lancio.Risponde a richieste POST verso: /titoli/launch/{year}/{launchNumber}/titlesDelete, dove {year} rappresenta l'anno del lancio e {launchNumber} il numero del lancio. Per identificare i titoli da rimuovere dal lancio viene richiesto un oggetto JSON contenente una lista di ean. Se l’esecuzione è terminata con successo, l’API restituisce 204 No Content senza alcun body. L’API può restituire i seguenti codici di errore:
Esempio richiesta:POST https://api.messaggerielibri.it/titoli/launch/2023/600/titlesDelete Authorization: Bearer[TOKEN JWT] Esempio body richiesta["9788831460347"] FeaturesPer utilizzare il metodo API è necessario possedere una o più delle seguenti features:
altrimenti viene restituito 403 (Forbidden) Rimozione di un singolo titolo da un lancioRimozione di un singolo titolo da un lancioConsente di rimuovere un titolo dal lancio.Risponde a richieste DELETE verso: /titoli/launch/{year}/{launchNumber}/titles/{eanCode}, dove {year} rappresenta l'anno del lancio, {launchNumber} il numero del lancio, {eanCode} l'ean del titolo da rimuovere. Se l’esecuzione è terminata con successo, l’API restituisce 204 No Content senza alcun body. L’API può restituire i seguenti codici di errore:
Esempio richiesta:DELETE https://api.messaggerielibri.it/titoli/launch/2023/600/titles/0012345678905 Authorization: Bearer[TOKEN JWT] FeaturesPer utilizzare il metodo API è necessario possedere una o più delle seguenti features:
altrimenti viene restituito 403 (Forbidden) |