API: LOT_QUERY – Ricerca di un lotto

Gli identificativi del tipo "<***>" sono descritti in questa sezione

Azione

Permette di effettuare ricerche sui lotti sottoposti a conservazione sostitutiva. Per il concetto di "lotto", consultate la sezione conservazione

Richiesta

 
{ 
    "message_type": "LOT_QUERY",
    "version":"1.0",
    "authentication": <AUTHENTICATION>,
"organization_code": <ORGANIZATION_CODE>,
"document_type": <DOCUMENT_TYPE>,
"data": [
{
"field_name": ,
"operation": ( "BETWEEN" | "MATCH" ),
"value1": ,
"value2":
},
...
],
"order_by": [
{
"field_name": ,
"type": ( "ASC" | "DESC" )
},
...
],
"paging" : {
"start": ,
"count":
}
}

Descrizione dei campi

Campo Tipo Descrizione
lot_code String Codice del lotto
reference_year String Anno di riferimento del lotto
conserve_date Time Data di conservazione (EPOC)
number_of_documents String Numero di documenti nel lotto
iso_size String Dimensione del lotto ISO
status String status ( "TO_UPDATE" | "UPDATING" | "FINISHED" | "ERROR" )
status_timeout Time

Risposta OK

200 OK
{
    "status": "OK",
    "comment": "Lot Query Results",
    "rows_count": ,
"rows": [
{
"lot_code": ,
"reference_year": ,
"conserve_date": ,
"iso_size": ,
"number_of_documents": ,
"status": ( "TO_UPDATE" | "UPDATING" | "FINISHED" | "ERROR" ),
"status_timeout":
},
...
]
}

Errori

Vedi sezione Messaggi d'errore.
Attenzione: le informazioni riportate in questa sezione possono non essere perfettamente allineate con la versione corrente del servizio, in continua evoluzione. Per qualunque informazione specifica, vi preghiamo di contattarci.