⚙️Gestione massiva tramite API REST

Procedura per il caricamento, la modifica e l'eliminazione massiva delle posizioni debitorie su GPD

La gestione massiva può essere innescato tramite API le cui specifiche sono riportate di seguito nel documento. Mediante l'API /brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file è possibile innescare il caricamento, la modifica e l'eliminazione massiva delle posizioni debitorie presenti all'interno di un file compresso come descritto in Specifiche tracciato di input. Il metodo in caso positivo risponde subito con un codice HTTP 202, una volta ottenuta una risposta positiva è possibile verificare lo stato dell'operazione massiva mediante l'utilizzo dell'API /brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file/{fileId}/status. Per ottenere un report completo, comprensivo degli esiti per ogni posizioni debitoria, è necessario interrogare l'API /brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file/{fileId}/report

Le URI che consentono di consultare lo status ed il report dell'operazione effettuata tramite caricamento sono accessibili inserendo come path param il fileID contenuto nel Location header delle risposte alle seguentiAPI POST /organizations/{organization-fiscal-code}/debtpositions/file

PUT /organizations/{organization-fiscal-code}/debtpositions/file

DELETE /organizations/{organization-fiscal-code}/debtpositions/file

"Location" : "brokers/{broker-code}/organizations/{ec-code}/debtpositions/file/{fileID}/status"

Specifiche API

The Organization creates the debt positions listed in the file.

POST/brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file

Path parameters

broker-code*string

The broker code

organization-fiscal-code*string

The organization fiscal code

Body

multipart/form-data

filestring (binary)

File to be uploaded

Response

202400401403409429500

Request accepted.

Request

JavaScriptCurlPython

const response = await fetch('/brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401409500

{
  "title": "text",
  "status": 200,
  "detail": "There was an error processing the request"
}

The Organization updates the debt positions listed in the file.

PUT/brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file

Path parameters

broker-code*string

The broker code

organization-fiscal-code*string

The organization fiscal code

Body

multipart/form-data

filestring (binary)

File to be uploaded

Response

202400401403409429500

Request accepted.

Request

JavaScriptCurlPython

const response = await fetch('/brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file', {
    method: 'PUT',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401409500

{
  "title": "text",
  "status": 200,
  "detail": "There was an error processing the request"
}

The Organization deletes the debt positions based on IUPD listed in the file.

DELETE/brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file

Path parameters

broker-code*string

The broker code

organization-fiscal-code*string

The organization fiscal code

Body

multipart/form-data

filestring (binary)

File to be uploaded

Response

202400401403409429500

Request accepted.

Request

JavaScriptCurlPython

const response = await fetch('/brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file', {
    method: 'DELETE',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401409500

{
  "title": "text",
  "status": 200,
  "detail": "There was an error processing the request"
}

Returns the debt positions upload report.

GET/brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file/{file-id}/report

Path parameters

broker-code*string

The broker code

organization-fiscal-code*string

The organization fiscal code

file-id*string

The unique identifier for file upload

Response

200400401403404429500

Upload report found.

Body

application/json

uploadIDstring

processedIteminteger (int32)

submittedIteminteger (int32)

responsesarray of ResponseEntry (object)

startTimestring (date-time)

Example: "2024-10-08T14:55:16.302Z"

endTimestring (date-time)

Example: "2024-10-08T14:55:16.302Z"

Request

JavaScriptCurlPython

const response = await fetch('/brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file/{file-id}/report', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401404500

{
  "uploadID": "text",
  "responses": [
    {
      "statusCode": 400,
      "statusMessage": "Bad request caused by invalid email address",
      "requestIDs": [
        "text"
      ]
    }
  ],
  "startTime": "2024-10-08T14:55:16.302Z",
  "endTime": "2024-10-08T14:55:16.302Z"
}

Returns the debt positions upload status.

GET/brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file/{file-id}/status

Path parameters

broker-code*string

The broker code

organization-fiscal-code*string

The organization fiscal code

file-id*string

The unique identifier for file upload

Response

200400401403404429500

Upload found.

Body

application/json

uploadIDstring

processedIteminteger (int32)

submittedIteminteger (int32)

startTimestring (date-time)

Example: "2024-10-08T14:55:16.302Z"

Request

JavaScriptCurlPython

const response = await fetch('/brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file/{file-id}/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401404500

{
  "uploadID": "text",
  "startTime": "2024-10-08T14:55:16.302Z"
}