openapi: 3.2.0
info:
title: Pagopa Events API
x-refined-note:
- x-api-id differs across the merged source definitions and was not carried
- x-summary differs across the merged source definitions and was not carried
version: '1.0'
description: 'Operations tagged events across 5 of this provider''s published API definitions: interop-api-v3.yaml, send-b2b-pa-bundle.yaml, pagopa-pdnd-interop-v2-openapi.yml, pagopa-pdnd-interop-v3-openapi.yml, pagopa-send-b2b-pa-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.interop.pagopa.it/v3
description: Production environment
- url: https://api.notifichedigitali.it
description: Ambiente di produzione
- url: https://api.uat.notifichedigitali.it
description: Ambiente di collaudo
- url: https://api.interop.pagopa.it/v2
description: PROD environment
tags:
- name: Events
description: Events routes
paths:
/eserviceEvents:
get:
tags:
- Events
summary: Get E-Service events
description: 'Retrieve list of E-Service events that occurred after the specified event ID.
Results are ordered in ascending order (oldest events first).'
operationId: getEServicesEvents
parameters:
- $ref: '#/components/parameters/EventsDelegationId'
- $ref: '#/components/parameters/LastEventId'
- $ref: '#/components/parameters/EventsLimit'
responses:
'200':
description: E-Service events retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/EServiceEvents'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/RateLimitLimitHeader'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/RateLimitRemainingHeader'
X-Rate-Limit-Interval:
$ref: '#/components/headers/RateLimitIntervalHeader'
Digest:
$ref: '#/components/headers/IntegrityRest02DigestHeader'
Agid-JWT-Signature:
$ref: '#/components/headers/IntegrityRest02AgidJwtSignatureHeader'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- DPoPAuth: []
DPoPProofHeader: []
servers:
- url: https://api.interop.pagopa.it/v3
description: Production environment
/agreementEvents:
get:
tags:
- Events
summary: Get Agreement events
description: 'Retrieve list of Agreement events that occurred after the specified event ID.
Results are ordered in ascending order (oldest events first).'
operationId: getAgreementsEvents
parameters:
- $ref: '#/components/parameters/LastEventId'
- $ref: '#/components/parameters/EventsLimit'
- $ref: '#/components/parameters/EventsDelegationId'
responses:
'200':
description: Agreement events retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/AgreementEvents'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/RateLimitLimitHeader'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/RateLimitRemainingHeader'
X-Rate-Limit-Interval:
$ref: '#/components/headers/RateLimitIntervalHeader'
Digest:
$ref: '#/components/headers/IntegrityRest02DigestHeader'
Agid-JWT-Signature:
$ref: '#/components/headers/IntegrityRest02AgidJwtSignatureHeader'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- DPoPAuth: []
DPoPProofHeader: []
servers:
- url: https://api.interop.pagopa.it/v3
description: Production environment
/attributeEvents:
get:
tags:
- Events
summary: Get Attribute events
description: 'Retrieve list of Attribute events that occurred after the specified event ID.
Results are ordered in ascending order (oldest events first).'
operationId: getAttributesEvents
parameters:
- $ref: '#/components/parameters/LastEventId'
- $ref: '#/components/parameters/EventsLimit'
responses:
'200':
description: Attribute events retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/AttributeEvents'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/RateLimitLimitHeader'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/RateLimitRemainingHeader'
X-Rate-Limit-Interval:
$ref: '#/components/headers/RateLimitIntervalHeader'
Digest:
$ref: '#/components/headers/IntegrityRest02DigestHeader'
Agid-JWT-Signature:
$ref: '#/components/headers/IntegrityRest02AgidJwtSignatureHeader'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- DPoPAuth: []
DPoPProofHeader: []
servers:
- url: https://api.interop.pagopa.it/v3
description: Production environment
/purposeEvents:
get:
tags:
- Events
summary: Get Purpose events
description: 'Retrieve list of Purpose events that occurred after the specified event ID.
Results are ordered in ascending order (oldest events first).'
operationId: getPurposeEvents
parameters:
- $ref: '#/components/parameters/LastEventId'
- $ref: '#/components/parameters/EventsLimit'
- $ref: '#/components/parameters/EventsDelegationId'
responses:
'200':
description: Purpose events retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/PurposeEvents'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/RateLimitLimitHeader'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/RateLimitRemainingHeader'
X-Rate-Limit-Interval:
$ref: '#/components/headers/RateLimitIntervalHeader'
Digest:
$ref: '#/components/headers/IntegrityRest02DigestHeader'
Agid-JWT-Signature:
$ref: '#/components/headers/IntegrityRest02AgidJwtSignatureHeader'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- DPoPAuth: []
DPoPProofHeader: []
servers:
- url: https://api.interop.pagopa.it/v3
description: Production environment
/tenantEvents:
get:
tags:
- Events
summary: Get Tenant events
description: 'Retrieve list of Tenant events that occurred after the specified event ID.
Results are ordered in ascending order (oldest events first).'
operationId: getTenantEvents
parameters:
- $ref: '#/components/parameters/LastEventId'
- $ref: '#/components/parameters/EventsLimit'
responses:
'200':
description: Tenant events retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/TenantEvents'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/RateLimitLimitHeader'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/RateLimitRemainingHeader'
X-Rate-Limit-Interval:
$ref: '#/components/headers/RateLimitIntervalHeader'
Digest:
$ref: '#/components/headers/IntegrityRest02DigestHeader'
Agid-JWT-Signature:
$ref: '#/components/headers/IntegrityRest02AgidJwtSignatureHeader'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- DPoPAuth: []
DPoPProofHeader: []
servers:
- url: https://api.interop.pagopa.it/v3
description: Production environment
/eserviceTemplateEvents:
get:
tags:
- Events
summary: Get EServiceTemplate events
description: 'Retrieve list of EServiceTemplate events that occurred after the specified event ID.
Results are ordered in ascending order (oldest events first).'
operationId: getEServiceTemplateEvents
parameters:
- $ref: '#/components/parameters/LastEventId'
- $ref: '#/components/parameters/EventsLimit'
responses:
'200':
description: EServiceTemplate events retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/EServiceTemplateEvents'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/RateLimitLimitHeader'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/RateLimitRemainingHeader'
X-Rate-Limit-Interval:
$ref: '#/components/headers/RateLimitIntervalHeader'
Digest:
$ref: '#/components/headers/IntegrityRest02DigestHeader'
Agid-JWT-Signature:
$ref: '#/components/headers/IntegrityRest02AgidJwtSignatureHeader'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- DPoPAuth: []
DPoPProofHeader: []
servers:
- url: https://api.interop.pagopa.it/v3
description: Production environment
/keyEvents:
get:
tags:
- Events
summary: Get Key events
description: 'Retrieve list of Key events that occurred after the specified event ID.
Results are ordered in ascending order (oldest events first).'
operationId: getKeyEvents
parameters:
- $ref: '#/components/parameters/LastEventId'
- $ref: '#/components/parameters/EventsLimit'
responses:
'200':
description: Key events retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/KeyEvents'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/RateLimitLimitHeader'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/RateLimitRemainingHeader'
X-Rate-Limit-Interval:
$ref: '#/components/headers/RateLimitIntervalHeader'
Digest:
$ref: '#/components/headers/IntegrityRest02DigestHeader'
Agid-JWT-Signature:
$ref: '#/components/headers/IntegrityRest02AgidJwtSignatureHeader'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- DPoPAuth: []
DPoPProofHeader: []
servers:
- url: https://api.interop.pagopa.it/v3
description: Production environment
/clientEvents:
get:
tags:
- Events
summary: Get Client events
description: 'Retrieve list of Client events that occurred after the specified event ID.
Results are ordered in ascending order (oldest events first).'
operationId: getClientEvents
parameters:
- $ref: '#/components/parameters/LastEventId'
- $ref: '#/components/parameters/EventsLimit'
responses:
'200':
description: Client events retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/ClientEvents'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/RateLimitLimitHeader'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/RateLimitRemainingHeader'
X-Rate-Limit-Interval:
$ref: '#/components/headers/RateLimitIntervalHeader'
Digest:
$ref: '#/components/headers/IntegrityRest02DigestHeader'
Agid-JWT-Signature:
$ref: '#/components/headers/IntegrityRest02AgidJwtSignatureHeader'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- DPoPAuth: []
DPoPProofHeader: []
servers:
- url: https://api.interop.pagopa.it/v3
description: Production environment
/producerKeyEvents:
get:
tags:
- Events
summary: Get Producer Key events
description: 'Retrieve list of Producer Key events that occurred after the specified event ID.
Results are ordered in ascending order (oldest events first).'
operationId: getProducerKeyEvents
parameters:
- $ref: '#/components/parameters/LastEventId'
- $ref: '#/components/parameters/EventsLimit'
responses:
'200':
description: Producer Key events retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerKeyEvents'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/RateLimitLimitHeader'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/RateLimitRemainingHeader'
X-Rate-Limit-Interval:
$ref: '#/components/headers/RateLimitIntervalHeader'
Digest:
$ref: '#/components/headers/IntegrityRest02DigestHeader'
Agid-JWT-Signature:
$ref: '#/components/headers/IntegrityRest02AgidJwtSignatureHeader'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- DPoPAuth: []
DPoPProofHeader: []
servers:
- url: https://api.interop.pagopa.it/v3
description: Production environment
/producerKeychainEvents:
get:
tags:
- Events
summary: Get Producer Keychain events
description: 'Retrieve list of Producer Keychain events that occurred after the specified event ID.
Results are ordered in ascending order (oldest events first).'
operationId: getProducerKeychainEvents
parameters:
- $ref: '#/components/parameters/LastEventId'
- $ref: '#/components/parameters/EventsLimit'
responses:
'200':
description: Producer Keychain events retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerKeychainEvents'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/RateLimitLimitHeader'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/RateLimitRemainingHeader'
X-Rate-Limit-Interval:
$ref: '#/components/headers/RateLimitIntervalHeader'
Digest:
$ref: '#/components/headers/IntegrityRest02DigestHeader'
Agid-JWT-Signature:
$ref: '#/components/headers/IntegrityRest02AgidJwtSignatureHeader'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- DPoPAuth: []
DPoPProofHeader: []
servers:
- url: https://api.interop.pagopa.it/v3
description: Production environment
/producerDelegationEvents:
get:
tags:
- Events
summary: Get Producer Delegations events
description: 'Retrieve list of Producer Delegation events that occurred after the specified event ID.
Results are ordered in ascending order (oldest events first).'
operationId: getProducerDelegationEvents
parameters:
- $ref: '#/components/parameters/LastEventId'
- $ref: '#/components/parameters/EventsLimit'
responses:
'200':
description: Producer Delegation events retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerDelegationEvents'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/RateLimitLimitHeader'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/RateLimitRemainingHeader'
X-Rate-Limit-Interval:
$ref: '#/components/headers/RateLimitIntervalHeader'
Digest:
$ref: '#/components/headers/IntegrityRest02DigestHeader'
Agid-JWT-Signature:
$ref: '#/components/headers/IntegrityRest02AgidJwtSignatureHeader'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- DPoPAuth: []
DPoPProofHeader: []
servers:
- url: https://api.interop.pagopa.it/v3
description: Production environment
/consumerDelegationEvents:
get:
tags:
- Events
summary: Get Consumer Delegations events
description: 'Retrieve list of Consumer Delegation events that occurred after the specified event ID.
Results are ordered in ascending order (oldest events first).'
operationId: getConsumerDelegationEvents
parameters:
- $ref: '#/components/parameters/LastEventId'
- $ref: '#/components/parameters/EventsLimit'
responses:
'200':
description: Consumer Delegation events retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/ConsumerDelegationEvents'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/RateLimitLimitHeader'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/RateLimitRemainingHeader'
X-Rate-Limit-Interval:
$ref: '#/components/headers/RateLimitIntervalHeader'
Digest:
$ref: '#/components/headers/IntegrityRest02DigestHeader'
Agid-JWT-Signature:
$ref: '#/components/headers/IntegrityRest02AgidJwtSignatureHeader'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- DPoPAuth: []
DPoPProofHeader: []
servers:
- url: https://api.interop.pagopa.it/v3
description: Production environment
/purposeTemplateEvents:
get:
tags:
- Events
summary: Get Purpose Template events
description: 'Retrieve list of Purpose Template events that occurred after the specified event ID.
Results are ordered in ascending order (oldest events first).'
operationId: getPurposeTemplateEvents
parameters:
- $ref: '#/components/parameters/LastEventId'
- $ref: '#/components/parameters/EventsLimit'
responses:
'200':
description: Purpose Template events retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/PurposeTemplateEvents'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- DPoPAuth: []
DPoPProofHeader: []
servers:
- url: https://api.interop.pagopa.it/v3
description: Production environment
/delivery-progresses/v2.9/streams/{streamId}/events:
get:
summary: Leggi progressi notifiche v2.9
description: Lettura degli eventi presenti nello stream di aggiornamenti con indicazione che il mittente ha ricevuto e memorizzato l'evento identificato dal parametro _lastEventId_ e tutti gli eventi precedenti. Tali eventi potranno essere cancellati dallo stream.
tags:
- Events
operationId: consumeEventStreamV29
parameters:
- $ref: '#/components/parameters/pathStreamId'
- $ref: '#/components/parameters/queryLastEventId'
responses:
'200':
description: OK
headers:
retry-after:
schema:
type: integer
format: int32
description: 'Numero di millisecondi di attesa prima di effettuare una nuova lettura di eventi.
Sarà valorizzato a zero se ci sono eventi in coda che non sono stati forniti per raggiunta dimensione massima della risposta.
Sarà maggiore di zero se gli eventi in coda sono stati tutti inviati.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProgressResponseV29'
'400':
description: Invalid input
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'403':
description: Not allowed to consume details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'404':
description: Stream not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'429':
description: Too Many Requests
headers:
retry-after:
schema:
type: integer
format: int32
description: Numero di millisecondi di attesa prima di effettuare una nuova lettura di eventi.
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
security:
- ApiKeyAuth: []
servers:
- url: https://api.notifichedigitali.it
description: Ambiente di produzione
- url: https://api.uat.notifichedigitali.it
description: Ambiente di collaudo
/delivery-progresses/streams/{streamId}/events:
get:
deprecated: true
summary: Leggi progressi notifiche v1
description: Permette di leggere gli eventi presenti nello stream di aggiornamenti e indica che la P.A. ha ricevuto e memorizzato l'evento identificato dal parametro _lastEventId_ e tutti gli eventi precedenti. Tali eventi potranno essere cancellati dallo stream.
tags:
- Events
operationId: consumeEventStream
parameters:
- $ref: '#/components/parameters/pathStreamId'
- $ref: '#/components/parameters/queryLastEventId'
responses:
'200':
description: OK
headers:
retry-after:
schema:
type: integer
format: int32
description: Numero di millisecondi di attesa prima di effettuare una nuova lettura di eventi.
Sarà valorizzato a zero se ci sono eventi in coda che non sono stati forniti per raggiunta dimensione massima della risposta.
Sarà maggiore di zero se gli eventi in coda sono stati tutti inviati.
content:
application/json:
schema:
$ref: '#/components/schemas/ProgressResponse'
'400':
description: Invalid input
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'429':
description: Too Many Requests
headers:
retry-after:
schema:
type: integer
format: int32
description: Numero di millisecondi di attesa prima di effettuare una nuova lettura di eventi.
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
security:
- ApiKeyAuth: []
servers:
- url: https://api.notifichedigitali.it
description: Ambiente di produzione
- url: https://api.uat.notifichedigitali.it
description: Ambiente di collaudo
/delivery-progresses/v2.3/streams/{streamId}/events:
get:
deprecated: true
summary: Leggi progressi notifiche v2.3
description: Lettura degli eventi presenti nello stream di aggiornamenti con indicazione che il mittente ha ricevuto e memorizzato l'evento identificato dal parametro _lastEventId_ e tutti gli eventi precedenti. Tali eventi potranno essere cancellati dallo stream.
tags:
- Events
operationId: consumeEventStreamV23
parameters:
- $ref: '#/components/parameters/pathStreamId'
- $ref: '#/components/parameters/queryLastEventId'
responses:
'200':
description: OK
headers:
retry-after:
schema:
type: integer
format: int32
description: 'Numero di millisecondi di attesa prima di effettuare una nuova lettura di eventi.
Sarà valorizzato a zero se ci sono eventi in coda che non sono stati forniti per raggiunta dimensione massima della risposta.
Sarà maggiore di zero se gli eventi in coda sono stati tutti inviati.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProgressResponseV23'
'400':
description: Invalid input
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'403':
description: Not allowed to consume details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'404':
description: Stream not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'429':
description: Too Many Requests
headers:
retry-after:
schema:
type: integer
format: int32
description: Numero di millisecondi di attesa prima di effettuare una nuova lettura di eventi.
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
security:
- ApiKeyAuth: []
servers:
- url: https://api.notifichedigitali.it
description: Ambiente di produzione
- url: https://api.uat.notifichedigitali.it
description: Ambiente di collaudo
/delivery-progresses/v2.4/streams/{streamId}/events:
get:
deprecated: true
summary: Leggi progressi notifiche v2.4
description: Lettura degli eventi presenti nello stream di aggiornamenti con indicazione che il mittente ha ricevuto e memorizzato l'evento identificato dal parametro _lastEventId_ e tutti gli eventi precedenti. Tali eventi potranno essere cancellati dallo stream.
tags:
- Events
operationId: consumeEventStreamV24
parameters:
- $ref: '#/components/parameters/pathStreamId'
- $ref: '#/components/parameters/queryLastEventId'
responses:
'200':
description: OK
headers:
retry-after:
schema:
type: integer
format: int32
description: 'Numero di millisecondi di attesa prima di effettuare una nuova lettura di eventi.
Sarà valorizzato a zero se ci sono eventi in coda che non sono stati forniti per raggiunta dimensione massima della risposta.
Sarà maggiore di zero se gli eventi in coda sono stati tutti inviati.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProgressResponseV24'
'400':
description: Invalid input
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'403':
description: Not allowed to consume details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'404':
description: Stream not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'429':
description: Too Many Requests
headers:
retry-after:
schema:
type: integer
format: int32
description: Numero di millisecondi di attesa prima di effettuare una nuova lettura di eventi.
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
security:
- ApiKeyAuth: []
servers:
- url: https://api.notifichedigitali.it
description: Ambiente di produzione
- url: https://api.uat.notifichedigitali.it
description: Ambiente di collaudo
/delivery-progresses/v2.5/streams/{streamId}/events:
get:
deprecated: true
summary: Leggi progressi notifiche v2.5
description: Lettura degli eventi presenti nello stream di aggiornamenti con indicazione che il mittente ha ricevuto e memorizzato l'evento identificato dal parametro _lastEventId_ e tutti gli eventi precedenti. Tali eventi potranno essere cancellati dallo stream.
tags:
- Events
operationId: consumeEventStreamV25
parameters:
- $ref: '#/components/parameters/pathStreamId'
- $ref: '#/components/parameters/queryLastEventId'
responses:
'200':
description: OK
headers:
retry-after:
schema:
type: integer
format: int32
description: 'Numero di millisecondi di attesa prima di effettuare una nuova lettura di eventi.
Sarà valorizzato a zero se ci sono eventi in coda che non sono stati forniti per raggiunta dimensione massima della risposta.
Sarà maggiore di zero se gli eventi in coda sono stati tutti inviati.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProgressResponseV25'
'400':
description: Invalid input
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'403':
description: Not allowed to consume details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'404':
description: Stream not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'429':
description: Too Many Requests
headers:
retry-after:
schema:
type: integer
format: int32
description: Numero di millisecondi di attesa prima di effettuare una nuova lettura di eventi.
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
security:
- ApiKeyAuth: []
servers:
- url: https://api.notifichedigitali.it
description: Ambiente di produzione
- url: https://api.uat.notifichedigitali.it
description: Ambiente di collaudo
/delivery-progresses/v2.6/streams/{streamId}/events:
get:
deprecated: true
summary: Leggi progressi notifiche v2.6
description: Lettura degli eventi presenti nello stream di aggiornamenti con indicazione che il mittente ha ricevuto e memorizzato l'evento identificato dal parametro _lastEventId_ e tutti gli eventi precedenti. Tali eventi potranno essere cancellati dallo stream.
tags:
- Events
operationId: consumeEventStreamV26
parameters:
- $ref: '#/components/parameters/pathStreamId'
- $ref: '#/components/parameters/queryLastEventId'
responses:
'200':
description: OK
headers:
retry-after:
schema:
type: integer
format: int32
description: 'Numero di millisecondi di attesa prima di effettuare una nuova lettura di eventi.
Sarà valorizzato a zero se ci sono eventi in coda che non sono stati forniti per raggiunta dimensione massima della risposta.
Sarà maggiore di zero se gli eventi in coda sono stati tutti inviati.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProgressResponseV26'
'400':
description: Invalid input
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'403':
description: Not allowed to consume details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'404':
description: Stream not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'429':
description: Too Many Requests
headers:
retry-after:
schema:
type: integer
format: int32
description: Numero di millisecondi di attesa prima di effettuare una nuova lettura di eventi.
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
security:
- ApiKeyAuth: []
servers:
- url: https://api.notifichedigitali.it
description: Ambiente di produzione
- url: https://api.uat.notifichedigitali.it
description: Ambiente di collaudo
/delivery-progresses/v2.7/streams/{streamId}/events:
get:
deprecated: true
summary: Leggi progressi notifiche v2.7
description: Lettura degli eventi presenti nello stream di aggiornamenti con indicazione che il mittente ha ricevuto e memorizzato l'evento identificato dal parametro _lastEventId_ e tutti gli eventi precedenti. Tali eventi potranno essere cancellati dallo stream.
tags:
- Events
operationId: consumeEventStreamV27
parameters:
- $ref: '#/components/parameters/pathStreamId'
- $ref: '#/components/parameters/queryLastEventId'
responses:
'200':
description: OK
headers:
retry-after:
schema:
type: integer
format: int32
description: 'Numero di millisecondi di attesa prima di effettuare una nuova lettura di eventi.
Sarà valorizzato a zero se ci sono eventi in coda che non sono stati forniti per raggiunta dimensione massima della risposta.
Sarà maggiore di zero se gli eventi in coda sono stati tutti inviati.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProgressResponseV27'
'400':
description: Invalid input
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'403':
description: Not allowed to consume details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'404':
description: Stream not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'429':
description: Too Many Requests
headers:
retry-after:
schema:
type: integer
format: int32
description: Numero di millisecondi di attesa prima di effettuare una nuova lettura di eventi.
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
security:
- ApiKeyAuth: []
servers:
- url: https://api.notifichedigitali.it
description: Ambiente di produzione
- url: https://api.uat.notifichedigitali.it
description: Ambiente di collaudo
/delivery-progresses/v2.8/streams/{streamId}/events:
get:
deprecated: true
summary: EXPERIMENTAL - Leggi progressi notifiche v2.8
description: (EXPERIMENTAL) Lettura degli eventi presenti nello stream di aggiornamenti con indicazione che il mittente ha ricevuto e memorizzato l'evento identificato dal parametro _lastEventId_ e tutti gli eventi precedenti. Tali eventi potranno essere cancellati dallo stream.
tags:
- Events
operationId: consumeEventStreamV28
x-pagopa-lambda-name: pn-versioningV1V2StreamLambda:live
x-pagopa-lambda-account: core
parameters:
- $ref: '#/components/parameters/pathStreamId'
- $ref: '#/components/parameters/queryLastEventId'
responses:
'200':
description: OK
headers:
retry-after:
schema:
type: integer
format: int32
description: 'Numero di millisecondi di attesa prima di effettuare una nuova lettura di eventi.
Sarà valorizzato a zero se ci sono eventi in coda che non sono stati forniti per raggiunta dimensione massima della risposta.
Sarà maggiore di zero se gli eventi in coda sono stati tutti inviati.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProgressResponseV28'
'400':
description: Invalid input
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'403':
description: Not allowed to consume details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'404':
description: Stream not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
'429':
description: Too Many Requests
headers:
retry-after:
schema:
type: integer
format: int32
description: Numero di millisecondi di attesa prima di effettuare una nuova lettura di eventi.
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem_2'
security:
- ApiKeyAuth: []
servers:
- url: https://api.notifichedigitali.it
description: Ambiente di produzione
- url: https://api.uat.notifichedigitali.it
description: Ambiente di collaudo
components:
schemas:
ProducerDelegationEvent:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- PRODUCER_DELEGATION_APPROVED
- PRODUCER_DELEGATION_REVOKED
- PRODUCER_DELEGATION_REJECTED
- PRODUCER_DELEGATION_SUBMITTED
- DELEGATION_CONTRACT_GENERATED
eventTimestamp:
type: string
format: date-time
delegationId:
$ref: '#/components/schemas/DelegationId'
required:
- id
- eventType
- eventTimestamp
- delegationId
EServiceTemplateEvents:
type: object
additionalProperties: false
required:
- events
properties:
events:
type: array
items:
$ref: '#/components/schemas/EServiceTemplateEvent'
Problem:
properties:
type:
description: URI reference of type definition
type: string
status:
description: The HTTP status code generated by the origin server for this occurrence of the problem
example: 503
format: int32
minimum: 100
type: integer
exclusiveMaximum: 600
title:
description: A short, summary of the problem type. Written in english and readable
example: Service Unavailable
maxLength: 64
pattern: ^[ -~]{0,64}$
type: string
correlationId:
description: Unique identifier of the request
example: 53af4f2d-0c87-41ef-a645-b726a821852b
maxLength: 64
type: string
detail:
description: A human readable explanation of the problem
example: Request took too long to complete
maxLength: 4096
pattern: ^.{0,1024}$
type: string
errors:
type: array
minItems: 1
items:
$ref: '#/components/schemas/ProblemError'
additionalProperties: false
required:
- type
- status
- title
ProblemError:
properties:
code:
description: Internal code of the error
example: 123-4567
minLength: 8
maxLength: 8
pattern: ^[0-9]{3}-[0-9]{4}$
type: string
detail:
description: A human readable explanation specific to this occurrence of the problem
example: Parameter not valid
maxLength: 4096
pattern: ^.{0,1024}$
type: string
required:
- code
- detail
AgreementEvents:
type: object
additionalProperties: false
required:
- events
properties:
events:
type: array
items:
$ref: '#/components/schemas/AgreementEvent'
PurposeId:
type: string
format: uuid
description: The unique identifier of the Purpose
EServiceEvents:
type: object
additionalProperties: false
required:
- events
properties:
events:
type: array
items:
$ref: '#/components/schemas/EServiceEvent'
ConsumerDelegationEvent:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- CONSUMER_DELEGATION_APPROVED
- CONSUMER_DELEGATION_REVOKED
- CONSUMER_DELEGATION_REJECTED
- CONSUMER_DELEGATION_SUBMITTED
- DELEGATION_CONTRACT_GENERATED
eventTimestamp:
type: string
format: date-time
delegationId:
$ref: '#/components/schemas/DelegationId'
required:
- id
- eventType
- eventTimestamp
- delegationId
TenantId:
type: string
format: uuid
description: The unique identifier of the Tenant
PurposeTemplateEvents:
type: object
additionalProperties: false
required:
- events
properties:
events:
type: array
items:
$ref: '#/components/schemas/PurposeTemplateEvent'
EServiceTemplateEvent:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- ESERVICE_TEMPLATE_DELETED
- ESERVICE_TEMPLATE_VERSION_ACTIVATED
- ESERVICE_TEMPLATE_ADDED
- ESERVICE_TEMPLATE_INTENDED_TARGET_UPDATED
- ESERVICE_TEMPLATE_DESCRIPTION_UPDATED
- ESERVICE_TEMPLATE_DRAFT_VERSION_DELETED
- ESERVICE_TEMPLATE_DRAFT_VERSION_UPDATED
- ESERVICE_TEMPLATE_DRAFT_UPDATED
- ESERVICE_TEMPLATE_NAME_UPDATED
- ESERVICE_TEMPLATE_RISK_ANALYSIS_ADDED
- ESERVICE_TEMPLATE_RISK_ANALYSIS_DELETED
- ESERVICE_TEMPLATE_RISK_ANALYSIS_UPDATED
- ESERVICE_TEMPLATE_VERSION_SUSPENDED
- ESERVICE_TEMPLATE_VERSION_ADDED
- ESERVICE_TEMPLATE_VERSION_ATTRIBUTES_UPDATED
- ESERVICE_TEMPLATE_VERSION_DOCUMENT_ADDED
- ESERVICE_TEMPLATE_VERSION_DOCUMENT_DELETED
- ESERVICE_TEMPLATE_VERSION_DOCUMENT_UPDATED
- ESERVICE_TEMPLATE_VERSION_INTERFACE_ADDED
- ESERVICE_TEMPLATE_VERSION_INTERFACE_DELETED
- ESERVICE_TEMPLATE_VERSION_INTERFACE_UPDATED
- ESERVICE_TEMPLATE_VERSION_PUBLISHED
- ESERVICE_TEMPLATE_VERSION_QUOTAS_UPDATED
- ESERVICE_TEMPLATE_PERSONAL_DATA_FLAG_UPDATED_AFTER_PUBLICATION
eventTimestamp:
type: string
format: date-time
eserviceTemplateId:
$ref: '#/components/schemas/EServiceTemplateId'
eserviceTemplateVersionId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp - eserviceTemplateId
ClientEvents:
type: object
additionalProperties: false
required:
- events
properties:
events:
type: array
items:
$ref: '#/components/schemas/ClientEvent'
PurposeEvent:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- DRAFT_PURPOSE_DELETED
- WAITING_FOR_APPROVAL_PURPOSE_DELETED
- PURPOSE_DELETED_BY_REVOKED_DELEGATION
- PURPOSE_ADDED
- DRAFT_PURPOSE_UPDATED
- NEW_PURPOSE_VERSION_ACTIVATED
- NEW_PURPOSE_VERSION_WAITING_FOR_APPROVAL
- PURPOSE_ACTIVATED
- PURPOSE_ARCHIVED
- PURPOSE_VERSION_OVER_QUOTA_UNSUSPENDED
- PURPOSE_VERSION_REJECTED
- PURPOSE_VERSION_SUSPENDED_BY_CONSUMER
- PURPOSE_VERSION_SUSPENDED_BY_PRODUCER
- PURPOSE_VERSION_UNSUSPENDED_BY_CONSUMER
- PURPOSE_VERSION_UNSUSPENDED_BY_PRODUCER
- PURPOSE_WAITING_FOR_APPROVAL
- WAITING_FOR_APPROVAL_PURPOSE_VERSION_DELETED
- PURPOSE_VERSION_ACTIVATED
- PURPOSE_CLONED
- PURPOSE_VERSION_ARCHIVED_BY_REVOKED_DELEGATION
- RISK_ANALYSIS_DOCUMENT_GENERATED
eventTimestamp:
type: string
format: date-time
purposeId:
$ref: '#/components/schemas/PurposeId'
purposeVersionId:
type: string
format: uuid
consumerDelegationId:
type: string
format: uuid
producerDelegationId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp
- purposeId
DescriptorId:
type: string
format: uuid
description: The unique identifier of the Descriptor
ProducerKeychainEvent:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- PRODUCER_KEYCHAIN_ADDED
- PRODUCER_KEYCHAIN_DELETED
- PRODUCER_KEYCHAIN_ESERVICE_ADDED
- PRODUCER_KEYCHAIN_ESERVICE_REMOVED
eventTimestamp:
type: string
format: date-time
producerKeychainId:
$ref: '#/components/schemas/ProducerKeychainId'
required:
- id
- eventType
- eventTimestamp
- producerKeychainId
TenantEvents:
type: object
additionalProperties: false
required:
- events
properties:
events:
type: array
items:
$ref: '#/components/schemas/TenantEvent'
PurposeTemplateEvent:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- PURPOSE_TEMPLATE_ADDED
- PURPOSE_TEMPLATE_ANNOTATION_DOCUMENT_ADDED
- PURPOSE_TEMPLATE_ANNOTATION_DOCUMENT_DELETED
- PURPOSE_TEMPLATE_ANNOTATION_DOCUMENT_UPDATED
- PURPOSE_TEMPLATE_DRAFT_UPDATED
- PURPOSE_TEMPLATE_DRAFT_DELETED
- PURPOSE_TEMPLATE_PUBLISHED
- PURPOSE_TEMPLATE_SUSPENDED
- PURPOSE_TEMPLATE_UNSUSPENDED
- PURPOSE_TEMPLATE_ARCHIVED
- RISK_ANALYSIS_TEMPLATE_DOCUMENT_GENERATED
- PURPOSE_TEMPLATE_ESERVICE_LINKED
- PURPOSE_TEMPLATE_ESERVICE_UNLINKED
eventTimestamp:
type: string
format: date-time
purposeTemplateId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp
- purposeTemplateId
Kid:
type: string
description: The unique identifier of the Key
AttributeId:
type: string
format: uuid
description: The unique identifier of the Attribute
EServiceTemplateId:
type: string
format: uuid
description: The unique identifier of the E-Service Template
ProducerKeyEvents:
type: object
additionalProperties: false
required:
- events
properties:
events:
type: array
items:
$ref: '#/components/schemas/ProducerKeyEvent'
KeyEvents:
type: object
additionalProperties: false
required:
- events
properties:
events:
type: array
items:
$ref: '#/components/schemas/KeyEvent'
AgreementEvent:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- AGREEMENT_ADDED
- DRAFT_AGREEMENT_UPDATED
- AGREEMENT_DELETED
- AGREEMENT_ACTIVATED
- AGREEMENT_REJECTED
- AGREEMENT_UPGRADED
- AGREEMENT_SUBMITTED
- AGREEMENT_ARCHIVED_BY_CONSUMER
- AGREEMENT_SUSPENDED_BY_CONSUMER
- AGREEMENT_UNSUSPENDED_BY_CONSUMER
- AGREEMENT_SUSPENDED_BY_PRODUCER
- AGREEMENT_UNSUSPENDED_BY_PRODUCER
- AGREEMENT_SUSPENDED_BY_PLATFORM
- AGREEMENT_UNSUSPENDED_BY_PLATFORM
- AGREEMENT_ARCHIVED_BY_UPGRADE
- AGREEMENT_CONSUMER_DOCUMENT_ADDED
- AGREEMENT_CONSUMER_DOCUMENT_REMOVED
- AGREEMENT_ARCHIVED_BY_REVOKED_DELEGATION
- AGREEMENT_DELETED_BY_REVOKED_DELEGATION
- AGREEMENT_SET_MISSING_CERTIFIED_ATTRIBUTES_BY_PLATFORM
- AGREEMENT_SET_DRAFT_BY_PLATFORM
- AGREEMENT_CONTRACT_GENERATED
eventTimestamp:
type: string
format: date-time
agreementId:
$ref: '#/components/schemas/AgreementId'
consumerDelegationId:
type: string
format: uuid
producerDelegationId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp
- agreementId
ClientId:
type: string
format: uuid
description: The unique identifier of the Client
AgreementId:
type: string
format: uuid
description: The unique identifier of the Agreement
AttributeEvents:
type: object
additionalProperties: false
required:
- events
properties:
events:
type: array
items:
$ref: '#/components/schemas/AttributeEvent'
ProducerKeychainEvents:
type: object
additionalProperties: false
required:
- events
properties:
events:
type: array
items:
$ref: '#/components/schemas/ProducerKeychainEvent'
ClientEvent:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- CLIENT_ADDED
- CLIENT_DELETED
- CLIENT_PURPOSE_ADDED
- CLIENT_PURPOSE_REMOVED
eventTimestamp:
type: string
format: date-time
clientId:
$ref: '#/components/schemas/ClientId'
required:
- id
- eventType
- eventTimestamp
- clientId
DelegationId:
type: string
format: uuid
description: The unique identifier of the Delegation
ProducerDelegationEvents:
type: object
additionalProperties: false
required:
- events
properties:
events:
type: array
items:
$ref: '#/components/schemas/ProducerDelegationEvent'
EServiceId:
type: string
format: uuid
description: The unique identifier of the E-Service
EServiceEvent:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- ESERVICE_ADDED
- DRAFT_ESERVICE_UPDATED
- ESERVICE_CLONED
- ESERVICE_DELETED
- ESERVICE_DESCRIPTOR_PUBLISHED
- ESERVICE_DESCRIPTOR_ACTIVATED
- ESERVICE_DESCRIPTOR_APPROVED_BY_DELEGATOR
- ESERVICE_DESCRIPTOR_SUSPENDED
- ESERVICE_DESCRIPTOR_ARCHIVED
- ESERVICE_DESCRIPTOR_ADDED
- ESERVICE_DRAFT_DESCRIPTOR_DELETED
- ESERVICE_DRAFT_DESCRIPTOR_UPDATED
- ESERVICE_DESCRIPTOR_SUBMITTED_BY_DELEGATE
- ESERVICE_DESCRIPTOR_REJECTED_BY_DELEGATOR
- ESERVICE_DESCRIPTOR_DOCUMENT_ADDED
- ESERVICE_DESCRIPTOR_DOCUMENT_UPDATED
- ESERVICE_DESCRIPTOR_DOCUMENT_DELETED
- ESERVICE_DESCRIPTOR_INTERFACE_ADDED
- ESERVICE_DESCRIPTOR_INTERFACE_UPDATED
- ESERVICE_DESCRIPTOR_INTERFACE_DELETED
- ESERVICE_RISK_ANALYSIS_ADDED
- ESERVICE_RISK_ANALYSIS_UPDATED
- ESERVICE_RISK_ANALYSIS_DELETED
- ESERVICE_NAME_UPDATED
- ESERVICE_DESCRIPTION_UPDATED
- ESERVICE_IS_CONSUMER_DELEGABLE_ENABLED
- ESERVICE_IS_CONSUMER_DELEGABLE_DISABLED
- ESERVICE_IS_CLIENT_ACCESS_DELEGABLE_ENABLED
- ESERVICE_IS_CLIENT_ACCESS_DELEGABLE_DISABLED
- ESERVICE_SIGNAL_HUB_ENABLED
- ESERVICE_SIGNAL_HUB_DISABLED
- ESERVICE_DESCRIPTOR_ATTRIBUTES_UPDATED
- ESERVICE_DESCRIPTOR_QUOTAS_UPDATED
- ESERVICE_DESCRIPTOR_AGREEMENT_APPROVAL_POLICY_UPDATED
- ESERVICE_PERSONAL_DATA_FLAG_UPDATED_AFTER_PUBLICATION
- ESERVICE_NAME_UPDATED_BY_TEMPLATE_UPDATE
- ESERVICE_DESCRIPTION_UPDATED_BY_TEMPLATE_UPDATE
- ESERVICE_PERSONAL_DATA_FLAG_UPDATED_BY_TEMPLATE_UPDATE
- ESERVICE_DESCRIPTOR_ATTRIBUTES_UPDATED_BY_TEMPLATE_UPDATE
- ESERVICE_DESCRIPTOR_DOCUMENT_ADDED_BY_TEMPLATE_UPDATE
- ESERVICE_DESCRIPTOR_DOCUMENT_DELETED_BY_TEMPLATE_UPDATE
- ESERVICE_DESCRIPTOR_DOCUMENT_UPDATED_BY_TEMPLATE_UPDATE
- ESERVICE_DESCRIPTOR_QUOTAS_UPDATED_BY_TEMPLATE_UPDATE
- ESERVICE_INSTANCE_LABEL_UPDATED
- MAINTENANCE_ESERVICE_PERSONAL_DATA_FLAG_RESET
eventTimestamp:
type: string
format: date-time
eserviceId:
$ref: '#/components/schemas/EServiceId'
descriptorId:
$ref: '#/components/schemas/DescriptorId'
producerDelegationId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp
- eserviceId
KeyEvent:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- CLIENT_KEY_ADDED
- CLIENT_KEY_DELETED
eventTimestamp:
type: string
format: date-time
kid:
$ref: '#/components/schemas/Kid'
clientId:
$ref: '#/components/schemas/ClientId'
required:
- id
- eventType
- eventTimestamp
- kid
- clientId
ProducerKeychainId:
type: string
format: uuid
description: The unique identifier of the Producer Keychain
PurposeEvents:
type: object
additionalProperties: false
required:
- events
properties:
events:
type: array
items:
$ref: '#/components/schemas/PurposeEvent'
AttributeEvent:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- ATTRIBUTE_ADDED
eventTimestamp:
type: string
format: date-time
attributeId:
$ref: '#/components/schemas/AttributeId'
required:
- id
- eventType
- eventTimestamp
- attributeId
ConsumerDelegationEvents:
type: object
additionalProperties: false
required:
- events
properties:
events:
type: array
items:
$ref: '#/components/schemas/ConsumerDelegationEvent'
ProducerKeyEvent:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- PRODUCER_KEYCHAIN_KEY_ADDED
- PRODUCER_KEYCHAIN_KEY_DELETED
eventTimestamp:
type: string
format: date-time
kid:
$ref: '#/components/schemas/Kid'
producerKeychainId:
$ref: '#/components/schemas/ProducerKeychainId'
required:
- id
- eventType
- eventTimestamp
- kid
- producerKeychainId
TenantEvent:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- MAINTENANCE_TENANT_DELETED
- TENANT_PROMOTED_TO_CERTIFIER
- MAINTENANCE_TENANT_UPDATED
- TENANT_CERTIFIED_ATTRIBUTE_ASSIGNED
- TENANT_CERTIFIED_ATTRIBUTE_REVOKED
- TENANT_DECLARED_ATTRIBUTE_ASSIGNED
- TENANT_DECLARED_ATTRIBUTE_REVOKED
- TENANT_DELEGATED_CONSUMER_FEATURE_ADDED
- TENANT_DELEGATED_CONSUMER_FEATURE_REMOVED
- TENANT_DELEGATED_PRODUCER_FEATURE_ADDED
- TENANT_DELEGATED_PRODUCER_FEATURE_REMOVED
- TENANT_KIND_UPDATED
- TENANT_MAIL_ADDED
- TENANT_MAIL_DELETED
- TENANT_ONBOARD_DETAILS_UPDATED
- TENANT_ONBOARDED
- TENANT_VERIFIED_ATTRIBUTE_ASSIGNED
- TENANT_VERIFIED_ATTRIBUTE_EXPIRATION_UPDATED
- TENANT_VERIFIED_ATTRIBUTE_EXTENSION_UPDATED
- TENANT_VERIFIED_ATTRIBUTE_REVOKED
eventTimestamp:
type: string
format: date-time
tenantId:
$ref: '#/components/schemas/TenantId'
required:
- id
- eventType
- eventTimestamp
- tenantId
ProgressResponseV27:
type: array
items:
$ref: '#/components/schemas/ProgressResponseElementV27'
SendDigitalFeedbackDetails:
type: object
required:
- recIndex
- digitalAddress
- responseStatus
- notificationDate
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
digitalAddress:
$ref: '#/components/schemas/DigitalAddress'
responseStatus:
$ref: '#/components/schemas/ResponseStatus'
notificationDate:
type: string
description: data notifica
format: date-time
deliveryFailureCause:
description: Codice errore, vuoto in caso di successo
type: string
deliveryDetailCode:
type: string
description: "Stato - Codice relativo all'evento - Descrizione:\n - PROGRESS C000 = PREACCETTAZIONE\n - PROGRESS C001 = ACCETTAZIONE\n - PROGRESS C005 = PRESA_IN_CARICO\n - PROGRESS C007 = PREAVVISO_ERRORE_CONSEGNA\n - PROGRESS DP00 = RE-INVIO PEC CAUSA FALLIMENTO TEMPORANEO\n - PROGRESS DP10 = TIMEOUT RICEZIONE RISULTATO\n - ERROR C002 = NON_ACCETTAZIONE\n - ERROR C004 = ERRORE_CONSEGNA\n - ERROR C006 = RILEVAZIONE_VIRUS\n - ERROR C008 = ERRORE_COMUNICAZIONE_SERVER_PEC\n - ERROR C009 = ERRORE_DOMINIO_PEC_NON_VALIDO\n - ERROR C010 = ERROR_INVIO_PEC\n - OK C003 = AVVENUTA_CONSEGNA\n"
sendingReceipts:
type: array
items:
$ref: '#/components/schemas/SendingReceipt'
RequestRefusedDetailsV23:
type: object
properties:
refusalReasons:
type: array
description: Motivazioni che hanno portato al rifiuto della notifica
items:
$ref: '#/components/schemas/NotificationRefusedErrorV23'
TimelineElementDetailsV26:
description: The raw event payload that will be different based on the event.
oneOf:
- $ref: '#/components/schemas/SenderAckCreationRequestDetails'
- $ref: '#/components/schemas/NormalizedAddressDetails'
- $ref: '#/components/schemas/NotificationRequestAcceptedDetails'
- $ref: '#/components/schemas/AnalogFailureWorkflowDetails'
- $ref: '#/components/schemas/AnalogSuccessWorkflowDetails'
- $ref: '#/components/schemas/CompletelyUnreachableCreationRequestDetails'
- $ref: '#/components/schemas/CompletelyUnreachableDetails'
- $ref: '#/components/schemas/DigitalDeliveryCreationRequestDetails'
- $ref: '#/components/schemas/DigitalFailureWorkflowDetails'
- $ref: '#/components/schemas/DigitalSuccessWorkflowDetails'
- $ref: '#/components/schemas/GetAddressInfoDetails'
- $ref: '#/components/schemas/NotificationViewedCreationRequestDetailsV23'
- $ref: '#/components/schemas/NotificationViewedDetailsV23'
- $ref: '#/components/schemas/NotificationRADDRetrievedDetails'
- $ref: '#/components/schemas/PublicRegistryCallDetails'
- $ref: '#/components/schemas/PublicRegistryResponseDetails'
- $ref: '#/components/schemas/RefinementDetailsV23'
- $ref: '#/components/schemas/RequestRefusedDetailsV25'
- $ref: '#/components/schemas/ScheduleAnalogWorkflowDetailsV23'
- $ref: '#/components/schemas/ScheduleDigitalWorkflowDetailsV23'
- $ref: '#/components/schemas/ScheduleRefinementDetails'
- $ref: '#/components/schemas/SendCourtesyMessageDetails'
- $ref: '#/components/schemas/PrepareDigitalDetails'
- $ref: '#/components/schemas/SendDigitalDetails'
- $ref: '#/components/schemas/SendDigitalFeedbackDetails'
- $ref: '#/components/schemas/SendDigitalProgressDetailsV23'
- $ref: '#/components/schemas/BaseAnalogDetails'
- $ref: '#/components/schemas/SendAnalogDetails'
- $ref: '#/components/schemas/SendAnalogFeedbackDetailsV25'
- $ref: '#/components/schemas/BaseRegisteredLetterDetails'
- $ref: '#/components/schemas/SimpleRegisteredLetterDetails'
- $ref: '#/components/schemas/AarCreationRequestDetails'
- $ref: '#/components/schemas/AarGenerationDetails'
- $ref: '#/components/schemas/NotHandledDetails'
- $ref: '#/components/schemas/NotificationPaidDetailsV23'
- $ref: '#/components/schemas/SendAnalogProgressDetailsV23'
- $ref: '#/components/schemas/SimpleRegisteredLetterProgressDetails'
- $ref: '#/components/schemas/ProbableDateAnalogWorkflowDetails'
- $ref: '#/components/schemas/NotificationCancellationRequestDetails'
- $ref: '#/components/schemas/NotificationCancelledDetails'
- $ref: '#/components/schemas/PrepareAnalogDomicileFailureDetails'
- $ref: '#/components/schemas/AnalogWorkflowRecipientDeceasedDetailsV26'
SimpleRegisteredLetterDetails:
type: object
required:
- recIndex
- physicalAddress
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
physicalAddress:
$ref: '#/components/schemas/PhysicalAddress'
productType:
type: string
maxLength: 10
description: "Tipo di invio cartaceo effettivamente inviato\n - __RS__: Raccomandata nazionale Semplice (per Avviso di mancato Recapito)\n - __RIS__: Raccomandata internazionale Semplice\n"
analogCost:
type: integer
description: costo in eurocent dell'invio
format: int32
numberOfPages:
type: integer
description: numero delle pagina che compongono la spedizione cartacea
format: int32
envelopeWeight:
type: integer
description: peso in grammi della busta
format: int32
prepareRequestId:
type: string
description: request id della relativa richiesta di prepare
maxLength: 512
LegalFactCategory:
title: Tipi di atti opponibili a terzi
description: "Tipi di atti opponibili a terzi che Piattaforma Notifiche mette a disposizione dei suoi utenti.\n - _SENDER_ACK_: atto di \"presa in carico\" di una notifica\n - _DIGITAL_DELIVERY_: ..."
type: string
enum:
- SENDER_ACK
- DIGITAL_DELIVERY
- ANALOG_DELIVERY
- RECIPIENT_ACCESS
- PEC_RECEIPT
- ANALOG_FAILURE_DELIVERY
ProblemError_2:
properties:
code:
description: Internal code of the error, in human-readable format
example: PN_PARAMETER_TOO_LONG | PN_PARAMETER_TOO_SHORT | PN_DUPLICATE_ENTRY | etc...
type: string
element:
description: Parameter or request body field name for validation error
example: body.order.item[2].quantity
type: string
detail:
description: A human readable explanation specific to this occurrence of the problem.
example: Parameter not valid
maxLength: 1024
type: string
required:
- code
NotificationCancellationRequestDetails:
type: object
required:
- cancellationRequestId
properties:
cancellationRequestId:
type: string
description: Id della richiesta
maxLength: 512
TimelineElementCategoryV28:
type: string
description: "stato di avanzamento del processo di notifica:`\n * `SENDER_ACK_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di presa in carico per il mittente a safe storage\n * `VALIDATE_NORMALIZE_ADDRESSES_REQUEST` - Invio della richiesta di validazione e normalizzazione indirizzi fisici presenti nella richiesta di notifica\n * `NORMALIZED_ADDRESS` - Salvataggio indirizzi normalizzati\n * `REQUEST_ACCEPTED` - Richiesta di notifica accettata a seguito dei controlli di validazione\n * `REQUEST_REFUSED` - Richiesta di notifica rifiutata per fallimento di validazione\n * `SEND_COURTESY_MESSAGE` - Invio di un messaggio di cortesia\n * `GET_ADDRESS` - Disponibilità dell’indirizzo specifico (domicilio digitale di piattaforma, domicilio digitale speciale, domicilio digitale generale, indirizzo fisico sulla notifica o sui registri nazionali)\n * `PUBLIC_REGISTRY_CALL` - Richiesta ai registri pubblici per ottenere domicilio digitale generale o per ottenere indirizzo fisico da ANPR, da registro della imprese, da anagrafe tributaria.\n * `PUBLIC_REGISTRY_RESPONSE` - Ricevuta la risposta dei registri pubblici\n * `SCHEDULE_ANALOG_WORKFLOW` - Pianificazione del workflow per invio cartaceo\n * `SCHEDULE_DIGITAL_WORKFLOW` -Pianificazione del workflow per invio digitale (PEC) del secondo tentativo in caso di fallimento del primo.\n * `PREPARE_DIGITAL_DOMICILE` - Preparazione per l’invio dell’avviso digitale.Va a valutare la timeline per capire quale sarà il prossimo indirizzo da usare.\n * `SEND_DIGITAL_DOMICILE` - Invio digitale dell’avviso di notifica\n * `SEND_DIGITAL_PROGRESS` - Tentativo di Invio PEC ad un determinato indirizzo.\n * `SEND_DIGITAL_FEEDBACK` - Ottenuto esito ad un invio digitale\n * `SCHEDULE_REFINEMENT` - Pianificato il perfezionamento per decorrenza termini\n * `REFINEMENT` - Perfezionamento per decorrenza termini\n * `DIGITAL_DELIVERY_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di chiusura del workflow digitale a safe storage\n * `DIGITAL_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio digitale\n * `DIGITAL_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio digitale: tutti i tentativi di invio ai domicili digitali sono falliti.\n * `ANALOG_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio cartaceo\n * `ANALOG_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio cartaceo NOTA: se per tutti i destinatari si conclude il workflow con fallimento verrà scatenato l’evento COMPLETELY_UNREACHABLE\n * `PREPARE_SIMPLE_REGISTERED_LETTER` - Invio richiesta di prepare (preparazione ad invio) raccomandata semplice a paperChannel\n * `SEND_SIMPLE_REGISTERED_LETTER` - Invio di raccomandata semplice\n * `SEND_SIMPLE_REGISTERED_LETTER_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea semplice\n * `NOTIFICATION_VIEWED_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di presa visione a safe storage\n * `NOTIFICATION_VIEWED` - Visualizzazione della notifica (perfeziona la notifica se non già perfezionata per decorrenza termini o da altro destinatario)\n * `PREPARE_ANALOG_DOMICILE` - Invio richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `SEND_ANALOG_DOMICILE` - Invio cartaceo dell’avviso di notifica\n * `SEND_ANALOG_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea\n * `SEND_ANALOG_FEEDBACK` - Ricezione esito dell'invio cartaceo\n * `COMPLETELY_UNREACHABLE_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto (simile a opponibile a terzi) di completamento con fallimento del workflow di invio cartaceo\n * `COMPLETELY_UNREACHABLE` - Tutti i destinatari risultano irraggiungibili\n * `AAR_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'AAR (Avviso di Avvenuta Ricezione) a safe storage\n * `AAR_GENERATION` - Generazione dell’AAR (Avviso di Avvenuta Ricezione)\n * `PAYMENT` - Evento di ricezione __dal mittente__ dell'informazione di chiusura di uno o più pagamenti di tipo pagoPA (vedi #/components/schemas/PagoPaPayment). La presenza di questo evento inibisce l'invio di eventuali comunicazioni analogiche future ma non perfeziona la notifica.\n * `NOT_HANDLED` - [DEPRECATO] Per la sperimentazione l'invio analogico non è previsto, viene inserito tale elemento di timeline\n * `PROBABLE_SCHEDULING_ANALOG_DATE` - Data probabile di inizio del flusso analogico\n * `NOTIFICATION_CANCELLATION_REQUEST` - Richiesta di annullamento di una notifica\n * `NOTIFICATION_CANCELLED` - Notifica annullata\n * `PREPARE_ANALOG_DOMICILE_FAILURE` - Fallimento della richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `NOTIFICATION_RADD_RETRIEVED` - Accesso alla notifica tramite la rete RADD. Non perfeziona la notifica.\n * `ANALOG_WORKFLOW_RECIPIENT_DECEASED` - Destinatario deceduto\n * `PUBLIC_REGISTRY_VALIDATION_CALL` - Ricerca dell'indirizzo di spedizione in fase di validazione notifica\n * `PUBLIC_REGISTRY_VALIDATION_RESPONSE` - Recupero dell'indirizzo di spedizione dai registri nazionali\n * `NOTIFICATION_TIMELINE_REWORKED` - Invio richiesta di Rework della timeline per una notifica\n"
enum:
- SENDER_ACK_CREATION_REQUEST
- VALIDATE_NORMALIZE_ADDRESSES_REQUEST
- NORMALIZED_ADDRESS
- REQUEST_ACCEPTED
- SEND_COURTESY_MESSAGE
- GET_ADDRESS
- PUBLIC_REGISTRY_CALL
- PUBLIC_REGISTRY_RESPONSE
- SCHEDULE_ANALOG_WORKFLOW
- SCHEDULE_DIGITAL_WORKFLOW
- PREPARE_DIGITAL_DOMICILE
- SEND_DIGITAL_DOMICILE
- SEND_DIGITAL_PROGRESS
- SEND_DIGITAL_FEEDBACK
- REFINEMENT
- SCHEDULE_REFINEMENT
- DIGITAL_DELIVERY_CREATION_REQUEST
- DIGITAL_SUCCESS_WORKFLOW
- DIGITAL_FAILURE_WORKFLOW
- ANALOG_SUCCESS_WORKFLOW
- ANALOG_FAILURE_WORKFLOW
- PREPARE_SIMPLE_REGISTERED_LETTER
- SEND_SIMPLE_REGISTERED_LETTER
- SEND_SIMPLE_REGISTERED_LETTER_PROGRESS
- NOTIFICATION_VIEWED_CREATION_REQUEST
- NOTIFICATION_VIEWED
- PREPARE_ANALOG_DOMICILE
- SEND_ANALOG_DOMICILE
- SEND_ANALOG_PROGRESS
- SEND_ANALOG_FEEDBACK
- PAYMENT
- COMPLETELY_UNREACHABLE
- COMPLETELY_UNREACHABLE_CREATION_REQUEST
- REQUEST_REFUSED
- AAR_CREATION_REQUEST
- AAR_GENERATION
- NOT_HANDLED
- PROBABLE_SCHEDULING_ANALOG_DATE
- NOTIFICATION_CANCELLATION_REQUEST
- NOTIFICATION_CANCELLED
- PREPARE_ANALOG_DOMICILE_FAILURE
- NOTIFICATION_RADD_RETRIEVED
- ANALOG_WORKFLOW_RECIPIENT_DECEASED
- PUBLIC_REGISTRY_VALIDATION_CALL
- PUBLIC_REGISTRY_VALIDATION_RESPONSE
- NOTIFICATION_TIMELINE_REWORKED
RecipientType:
type: string
enum:
- PF
- PG
ProgressResponseElementV26:
type: object
required:
- eventId
- element
properties:
eventId:
description: Elemento che garantisce univocità e ordinamento temporale all'interno dello stream
type: string
notificationRequestId:
description: Identificativo della richiesta di notifica
type: string
iun:
description: Identificativo della notifica, presente solo se la richiesta di notifica è stata accettata.
type: string
maxLength: 25
pattern: ^[A-Z]{4}-[A-Z]{4}-[A-Z]{4}-[0-9]{6}-[A-Z]{1}-[0-9]{1}$
newStatus:
$ref: '#/components/schemas/NotificationStatusV26'
element:
$ref: '#/components/schemas/TimelineElementV26'
EndWorkflowStatus:
type: string
description: Stato chiusura workflow
enum:
- SUCCESS
- FAILURE
BaseAnalogDetails:
type: object
required:
- recIndex
- physicalAddress
- serviceLevel
- sentAttemptMade
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
physicalAddress:
$ref: '#/components/schemas/PhysicalAddress'
serviceLevel:
$ref: '#/components/schemas/ServiceLevel'
sentAttemptMade:
type: integer
description: numero dei tentativi effettuati
format: int32
relatedRequestId:
type: string
description: Id relativo alla eventuale precedente richiesta di invio cartaceo
maxLength: 512
DeliveryMode:
type: string
description: Tipologia Domiciliazione
enum:
- DIGITAL
- ANALOG
DigitalFailureWorkflowDetails:
type: object
required:
- recIndex
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
paTaxId:
description: Payment PA fiscal code
example: '77777777777'
type: string
maxLength: 11
minLength: 11
pattern: ^\d+$
ResponseStatus:
type: string
description: stato risposta ricevuta da externalChannel
enum:
- OK
- KO
ProgressResponseElementV23:
type: object
required:
- eventId
- element
properties:
eventId:
description: Elemento che garantisce univocità e ordinamento temporale all'interno dello stream
type: string
notificationRequestId:
description: Identificativo della richiesta di notifica
type: string
iun:
description: Identificativo della notifica, presente solo se la richiesta di notifica è stata accettata.
type: string
maxLength: 25
pattern: ^[A-Z]{4}-[A-Z]{4}-[A-Z]{4}-[0-9]{6}-[A-Z]{1}-[0-9]{1}$
newStatus:
$ref: '#/components/schemas/NotificationStatus'
element:
$ref: '#/components/schemas/TimelineElementV23'
SendAnalogFeedbackDetailsV25:
type: object
required:
- recIndex
- physicalAddress
- serviceLevel
- sentAttemptMade
- responseStatus
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
physicalAddress:
$ref: '#/components/schemas/PhysicalAddress'
serviceLevel:
$ref: '#/components/schemas/ServiceLevel'
sentAttemptMade:
type: integer
description: numero dei tentativi effettuati
format: int32
newAddress:
$ref: '#/components/schemas/PhysicalAddress'
responseStatus:
$ref: '#/components/schemas/ResponseStatus'
notificationDate:
type: string
format: date-time
deliveryFailureCause:
type: string
maxLength: 10
description: 'i codici delle motivazioni di mancata consegna possono essere consultati alla seguente [pagina](https://developer.pagopa.it/send/guides/knowledge-base/v2.5/readme/creazione-e-gestione-degli-stream/stream-di-timeline/decodifiche-send_analog#decodifica-deliveryfailurecause)
'
deliveryDetailCode:
type: string
maxLength: 20
description: 'i codici di decodifica degli eventi di invio cartaceo possono essere consultati alla seguente [pagina](https://developer.pagopa.it/send/guides/knowledge-base/v2.5/readme/creazione-e-gestione-degli-stream/stream-di-timeline/decodifiche-send_analog#codici-send_analog_progress-comuni-a-tutte-le-tipologie)
'
attachments:
type: array
items:
$ref: '#/components/schemas/AttachmentDetails'
sendRequestId:
type: string
description: RequestId della richiesta d'invio
maxLength: 512
registeredLetterCode:
type: string
description: Codice della raccomandata
maxLength: 128
NotificationStatusHistoryInvalidatedElement:
description: elenco degli avanzamenti effettuati dal processo di notifica
type: object
required:
- status
- activeFrom
- relatedTimelineElements
properties:
status:
$ref: '#/components/schemas/NotificationStatusV26'
activeFrom:
type: string
description: data e ora di raggiungimento dello stato di avanzamento
format: date-time
relatedTimelineElements:
type: array
description: Eventi avvenuti nello stato
items:
$ref: '#/components/schemas/TimelineElementV28'
RefinementDetailsV23:
type: object
required:
- recIndex
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
notificationCost:
description: costo notifica in euro cents, può essere nullo se la notifica si è perfezionata prima per visualizzazione
example: 1220
type: integer
format: int64
eventTimestamp:
type: string
description: Data evento refinement
format: date-time
DigitalSuccessWorkflowDetails:
type: object
required:
- recIndex
- digitalAddress
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
digitalAddress:
$ref: '#/components/schemas/DigitalAddress'
NotificationStatusV26:
type: string
description: "stato di avanzamento del processo di notifica:\n * `IN_VALIDATION` - notifica depositata in attesa di validazione\n * `ACCEPTED` - L'ente ha depositato la notifica con successo\n * `REFUSED` - Notifica rifiutata a seguito della validazione\n * `DELIVERING` - L'invio della notifica è in corso\n * `DELIVERED` - La notifica è stata consegnata a tutti i destinatari\n * `VIEWED` - Il destinatario ha letto la notifica entro il termine stabilito\n * `EFFECTIVE_DATE` - Il destinatario non ha letto la notifica entro il termine stabilito\n * `UNREACHABLE` - Il destinatario non è reperibile\n * `CANCELLED` - L'ente ha annullato l'invio della notifica\n * `PAID` - [DEPRECATO] Uno dei destinatari ha pagato la notifica\n * `RETURNED_TO_SENDER` - La notifica è stata restituita al mittente\n"
enum:
- IN_VALIDATION
- ACCEPTED
- REFUSED
- DELIVERING
- DELIVERED
- VIEWED
- EFFECTIVE_DATE
- PAID
- UNREACHABLE
- CANCELLED
- RETURNED_TO_SENDER
noticeCode:
description: Payment notice number numero avviso
example: '302000100000019421'
type: string
maxLength: 18
minLength: 18
pattern: ^\d+$
GetAddressInfoDetails:
type: object
required:
- recIndex
- digitalAddressSource
- isAvailable
- attemptDate
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
digitalAddressSource:
$ref: '#/components/schemas/DigitalAddressSource'
isAvailable:
type: boolean
description: Disponibilità indirizzo
attemptDate:
type: string
description: Data tentativo
format: date-time
PublicRegistryResponseDetails:
type: object
required:
- recIndex
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
digitalAddress:
$ref: '#/components/schemas/DigitalAddress'
physicalAddress:
$ref: '#/components/schemas/PhysicalAddress'
TimelineElementV26:
type: object
additionalProperties: false
properties:
elementId:
type: string
maxLength: 512
description: 'Identificativo dell''elemento di timeline: insieme allo IUN della notifica definisce in maniera univoca l''elemento di timeline'
timestamp:
type: string
deprecated: true
description: Istante in cui avviene l'evento descritto in questo elemento di timeline (deprecato, fare riferimento al campo eventTimestamp)
format: date-time
ingestionTimestamp:
type: string
description: Istante in cui l'evento descritto in questo elemento di timeline è gestito da SEND
format: date-time
eventTimestamp:
type: string
description: Istante in cui avviene l'evento descritto in questo elemento di timeline
format: date-time
notificationSentAt:
type: string
description: Momento di ricezione della richiesta di notifica da parte di SEND
format: date-time
legalFactsIds:
type: array
items:
$ref: '#/components/schemas/LegalFactsIdV20'
description: Chiavi dei documenti che provano l'effettivo accadimento dell'evento descritto in timeline. Questo elemento
category:
$ref: '#/components/schemas/TimelineElementCategoryV26'
details:
$ref: '#/components/schemas/TimelineElementDetailsV26'
ProgressResponseElementV27:
type: object
required:
- eventId
- element
properties:
eventId:
description: Elemento che garantisce univocità all'interno dello stream
type: string
notificationRequestId:
description: Identificativo della richiesta di notifica
type: string
iun:
description: Identificativo della notifica, presente solo se la richiesta di notifica è stata accettata.
type: string
maxLength: 25
pattern: ^[A-Z]{4}-[A-Z]{4}-[A-Z]{4}-[0-9]{6}-[A-Z]{1}-[0-9]{1}$
newStatus:
$ref: '#/components/schemas/NotificationStatusV26'
element:
$ref: '#/components/schemas/TimelineElementV26'
PhysicalAddress:
type: object
required:
- address
- municipality
properties:
at:
x-field-extra-annotation: '@lombok.ToString.Exclude'
type: string
description: Campo "presso" dell'indirizzo
address:
x-field-extra-annotation: '@lombok.ToString.Exclude'
type: string
description: Indirizzo del domicilio fisico
addressDetails:
x-field-extra-annotation: '@lombok.ToString.Exclude'
type: string
description: Seconda riga dell'indirizzo fisico
zip:
x-field-extra-annotation: '@lombok.ToString.Exclude'
type: string
description: Codice di avviamento postale. In caso di invio estero diventa facoltativo
municipality:
x-field-extra-annotation: '@lombok.ToString.Exclude'
type: string
description: Comune in cui l'indirizzo si trova
municipalityDetails:
x-field-extra-annotation: '@lombok.ToString.Exclude'
type: string
description: Frazione o località
province:
x-field-extra-annotation: '@lombok.ToString.Exclude'
type: string
description: Provincia in cui si trova l'indirizzo
foreignState:
x-field-extra-annotation: '@lombok.ToString.Exclude'
type: string
description: Denominazione paese estero
description: Indirizzo fisico scoperto durante fase di consegna
TimelineElementCategoryV23:
type: string
description: "stato di avanzamento del processo di notifica:`\n * `SENDER_ACK_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di presa in carico per il mittente a safe storage\n * `VALIDATE_NORMALIZE_ADDRESSES_REQUEST` - Invio della richiesta di validazione e normalizzazione indirizzi fisici presenti nella richiesta di notifica\n * `NORMALIZED_ADDRESS` - Salvataggio indirizzi normalizzati\n * `REQUEST_ACCEPTED` - Richiesta di notifica accettata a seguito dei controlli di validazione\n * `REQUEST_REFUSED` - Richiesta di notifica rifiutata per fallimento di validazione\n * `SEND_COURTESY_MESSAGE` - Invio di un messaggio di cortesia\n * `GET_ADDRESS` - Disponibilità dell’indirizzo specifico (domicilio digitale di piattaforma, domicilio digitale speciale, domicilio digitale generale, indirizzo fisico sulla notifica o sui registri nazionali)\n * `PUBLIC_REGISTRY_CALL` - Richiesta ai registri pubblici per ottenere domicilio digitale generale o per ottenere indirizzo fisico da ANPR, da registro della imprese, da anagrafe tributaria.\n * `PUBLIC_REGISTRY_RESPONSE` - Ricevuta la risposta dei registri pubblici\n * `SCHEDULE_ANALOG_WORKFLOW` - Pianificazione del workflow per invio cartaceo\n * `SCHEDULE_DIGITAL_WORKFLOW` -Pianificazione del workflow per invio digitale (PEC) del secondo tentativo in caso di fallimento del primo.\n * `PREPARE_DIGITAL_DOMICILE` - Preparazione per l’invio dell’avviso digitale.Va a valutare la timeline per capire quale sarà il prossimo indirizzo da usare.\n * `SEND_DIGITAL_DOMICILE` - Invio digitale dell’avviso di notifica\n * `SEND_DIGITAL_PROGRESS` - Tentativo di Invio PEC ad un determinato indirizzo.\n * `SEND_DIGITAL_FEEDBACK` - Ottenuto esito ad un invio digitale\n * `SCHEDULE_REFINEMENT` - Pianificato il perfezionamento per decorrenza termini\n * `REFINEMENT` - Perfezionamento per decorrenza termini\n * `DIGITAL_DELIVERY_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di chiusura del workflow digitale a safe storage\n * `DIGITAL_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio digitale\n * `DIGITAL_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio digitale: tutti i tentativi di invio ai domicili digitali sono falliti.\n * `ANALOG_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio cartaceo\n * `ANALOG_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio cartaceo NOTA: se per tutti i destinatari si conclude il workflow con fallimento verrà scatenato l’evento COMPLETELY_UNREACHABLE\n * `PREPARE_SIMPLE_REGISTERED_LETTER` - Invio richiesta di prepare (preparazione ad invio) raccomandata semplice a paperChannel\n * `SEND_SIMPLE_REGISTERED_LETTER` - Invio di raccomandata semplice\n * `SEND_SIMPLE_REGISTERED_LETTER_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea semplice\n * `NOTIFICATION_VIEWED_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di presa visione a safe storage\n * `NOTIFICATION_VIEWED` - Visualizzazione della notifica (perfeziona la notifica se non già perfezionata per decorrenza termini o da altro destinatario)\n * `PREPARE_ANALOG_DOMICILE` - Invio richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `SEND_ANALOG_DOMICILE` - Invio cartaceo dell’avviso di notifica\n * `SEND_ANALOG_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea\n * `SEND_ANALOG_FEEDBACK` - Ricezione esito dell'invio cartaceo\n * `COMPLETELY_UNREACHABLE_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto (simile a opponibile a terzi) di completamento con fallimento del workflow di invio cartaceo\n * `COMPLETELY_UNREACHABLE` - Tutti i destinatari risultano irraggiungibili\n * `AAR_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'AAR (Avviso di Avvenuta Ricezione) a safe storage\n * `AAR_GENERATION` - Generazione dell’AAR (Avviso di Avvenuta Ricezione)\n * `PAYMENT` - Evento di ricezione __dal mittente__ dell'informazione di chiusura di uno o più pagamenti di tipo pagoPA (vedi #/components/schemas/PagoPaPayment). La presenza di questo evento inibisce l'invio di eventuali comunicazioni analogiche future ma non perfeziona la notifica.\n * `NOT_HANDLED` - [DEPRECATO] Per la sperimentazione l'invio analogico non è previsto, viene inserito tale elemento di timeline\n * `PROBABLE_SCHEDULING_ANALOG_DATE` - Data probabile di inizio del flusso analogico\n * `NOTIFICATION_CANCELLATION_REQUEST` - Richiesta di annullamento di una notifica\n * `NOTIFICATION_CANCELLED` - Notifica annullata\n * `PREPARE_ANALOG_DOMICILE_FAILURE` - Fallimento della richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `NOTIFICATION_RADD_RETRIEVED` - Accesso alla notifica tramite la rete RADD. Non perfeziona la notifica.\n"
enum:
- SENDER_ACK_CREATION_REQUEST
- VALIDATE_NORMALIZE_ADDRESSES_REQUEST
- NORMALIZED_ADDRESS
- REQUEST_ACCEPTED
- SEND_COURTESY_MESSAGE
- GET_ADDRESS
- PUBLIC_REGISTRY_CALL
- PUBLIC_REGISTRY_RESPONSE
- SCHEDULE_ANALOG_WORKFLOW
- SCHEDULE_DIGITAL_WORKFLOW
- PREPARE_DIGITAL_DOMICILE
- SEND_DIGITAL_DOMICILE
- SEND_DIGITAL_PROGRESS
- SEND_DIGITAL_FEEDBACK
- REFINEMENT
- SCHEDULE_REFINEMENT
- DIGITAL_DELIVERY_CREATION_REQUEST
- DIGITAL_SUCCESS_WORKFLOW
- DIGITAL_FAILURE_WORKFLOW
- ANALOG_SUCCESS_WORKFLOW
- ANALOG_FAILURE_WORKFLOW
- PREPARE_SIMPLE_REGISTERED_LETTER
- SEND_SIMPLE_REGISTERED_LETTER
- SEND_SIMPLE_REGISTERED_LETTER_PROGRESS
- NOTIFICATION_VIEWED_CREATION_REQUEST
- NOTIFICATION_VIEWED
- PREPARE_ANALOG_DOMICILE
- SEND_ANALOG_DOMICILE
- SEND_ANALOG_PROGRESS
- SEND_ANALOG_FEEDBACK
- PAYMENT
- COMPLETELY_UNREACHABLE
- COMPLETELY_UNREACHABLE_CREATION_REQUEST
- REQUEST_REFUSED
- AAR_CREATION_REQUEST
- AAR_GENERATION
- NOT_HANDLED
- PROBABLE_SCHEDULING_ANALOG_DATE
- NOTIFICATION_CANCELLATION_REQUEST
- NOTIFICATION_CANCELLED
- PREPARE_ANALOG_DOMICILE_FAILURE
- NOTIFICATION_RADD_RETRIEVED
BaseRegisteredLetterDetails:
type: object
required:
- recIndex
- physicalAddress
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
physicalAddress:
$ref: '#/components/schemas/PhysicalAddress'
RequestRefusedDetailsV25:
type: object
properties:
refusalReasons:
type: array
description: Motivazioni che hanno portato al rifiuto della notifica
items:
$ref: '#/components/schemas/NotificationRefusedErrorV25'
TimelineElementDetailsV28:
description: The raw event payload that will be different based on the event.
oneOf:
- $ref: '#/components/schemas/SenderAckCreationRequestDetails'
- $ref: '#/components/schemas/NormalizedAddressDetails'
- $ref: '#/components/schemas/NotificationRequestAcceptedDetailsV28'
- $ref: '#/components/schemas/AnalogFailureWorkflowDetails'
- $ref: '#/components/schemas/AnalogSuccessWorkflowDetails'
- $ref: '#/components/schemas/CompletelyUnreachableCreationRequestDetailsV28'
- $ref: '#/components/schemas/CompletelyUnreachableDetails'
- $ref: '#/components/schemas/DigitalDeliveryCreationRequestDetailsV28'
- $ref: '#/components/schemas/DigitalFailureWorkflowDetails'
- $ref: '#/components/schemas/DigitalSuccessWorkflowDetails'
- $ref: '#/components/schemas/GetAddressInfoDetails'
- $ref: '#/components/schemas/NotificationViewedCreationRequestDetailsV28'
- $ref: '#/components/schemas/NotificationViewedDetailsV23'
- $ref: '#/components/schemas/NotificationRADDRetrievedDetails'
- $ref: '#/components/schemas/PublicRegistryCallDetails'
- $ref: '#/components/schemas/PublicRegistryResponseDetails'
- $ref: '#/components/schemas/RefinementDetailsV23'
- $ref: '#/components/schemas/RequestRefusedDetailsV27'
- $ref: '#/components/schemas/ScheduleAnalogWorkflowDetailsV23'
- $ref: '#/components/schemas/ScheduleDigitalWorkflowDetailsV23'
- $ref: '#/components/schemas/ScheduleRefinementDetails'
- $ref: '#/components/schemas/SendCourtesyMessageDetails'
- $ref: '#/components/schemas/PrepareDigitalDetails'
- $ref: '#/components/schemas/SendDigitalDetails'
- $ref: '#/components/schemas/SendDigitalFeedbackDetails'
- $ref: '#/components/schemas/SendDigitalProgressDetailsV23'
- $ref: '#/components/schemas/BaseAnalogDetails'
- $ref: '#/components/schemas/SendAnalogDetails'
- $ref: '#/components/schemas/SendAnalogFeedbackDetailsV25'
- $ref: '#/components/schemas/BaseRegisteredLetterDetails'
- $ref: '#/components/schemas/SimpleRegisteredLetterDetails'
- $ref: '#/components/schemas/AarCreationRequestDetails'
- $ref: '#/components/schemas/AarGenerationDetails'
- $ref: '#/components/schemas/NotHandledDetails'
- $ref: '#/components/schemas/NotificationPaidDetailsV23'
- $ref: '#/components/schemas/SendAnalogProgressDetailsV23'
- $ref: '#/components/schemas/SimpleRegisteredLetterProgressDetails'
- $ref: '#/components/schemas/ProbableDateAnalogWorkflowDetails'
- $ref: '#/components/schemas/NotificationCancellationRequestDetails'
- $ref: '#/components/schemas/NotificationCancelledDetails'
- $ref: '#/components/schemas/PrepareAnalogDomicileFailureDetails'
- $ref: '#/components/schemas/AnalogWorkflowRecipientDeceasedDetailsV26'
- $ref: '#/components/schemas/PublicRegistryValidationCallDetails'
- $ref: '#/components/schemas/PublicRegistryValidationResponseDetails'
- $ref: '#/components/schemas/NotificationTimelineReworkedDetails'
NormalizedAddressDetails:
type: object
required:
- recIndex
- oldAddress
- normalizedAddress
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
oldAddress:
$ref: '#/components/schemas/PhysicalAddress'
normalizedAddress:
$ref: '#/components/schemas/PhysicalAddress'
NotificationRADDRetrievedDetails:
type: object
required:
- recIndex
- raddType
- raddTransactionId
- eventTimestamp
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
raddType:
$ref: '#/components/schemas/RaddTypeV23'
raddTransactionId:
$ref: '#/components/schemas/RaddTransactionId'
eventTimestamp:
type: string
description: Data evento
format: date-time
ProgressResponseV23:
type: array
items:
$ref: '#/components/schemas/ProgressResponseElementV23'
LegalFactsIdV20:
description: Chiavi dei documenti generati durante il processo di consegna cartacea
type: object
required:
- key
- category
properties:
key:
description: Chiave dell'atto opponibile a terzi generato durante il processo di consegna
type: string
pattern: ^(safestorage:\/\/)?[A-Za-z0-9._-]+$
maxLength: 512
category:
$ref: '#/components/schemas/LegalFactCategoryV20'
AnalogFailureWorkflowDetails:
type: object
required:
- recIndex
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
generatedAarUrl:
type: string
maxLength: 128
description: Chiave per recupero da safe-storage del documento aar
ProgressResponseV28:
type: array
items:
$ref: '#/components/schemas/ProgressResponseElementV28'
RaddTypeV23:
type: string
description: 'tipo di Rete Anti Digital Divide
__FSU__: Fornitore Servizio Universale
__ALT__: Fornitore RADD Alternativa
'
SendAnalogProgressDetailsV23:
type: object
required:
- recIndex
properties:
recIndex:
type: integer
description: Index destinatario che ha effettuato il pagamento della notifica
format: int32
notificationDate:
type: string
format: date-time
deliveryFailureCause:
type: string
maxLength: 10
description: Vedi deliveryFailureCause in SendAnalogFeedbackDetails
deliveryDetailCode:
type: string
maxLength: 20
description: Vedi deliveryDetailCode in SendAnalogFeedbackDetails
attachments:
type: array
items:
$ref: '#/components/schemas/AttachmentDetails'
sendRequestId:
type: string
description: RequestId della richiesta d'invio
maxLength: 512
registeredLetterCode:
type: string
description: Codice della raccomandata
maxLength: 128
serviceLevel:
$ref: '#/components/schemas/ServiceLevel'
NotHandledDetails:
type: object
required:
- recIndex
- reasonCode
- reason
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
reasonCode:
type: string
description: Codice motivazione casistica non gestita
maxLength: 10
reason:
type: string
description: Motivazione casistica non gestita
maxLength: 2048
RaddTransactionId:
type: string
description: Identificativo della pratica all'interno della rete RADD
maxLength: 512
ProgressResponseElementV25:
type: object
required:
- eventId
- element
properties:
eventId:
description: Elemento che garantisce univocità e ordinamento temporale all'interno dello stream
type: string
notificationRequestId:
description: Identificativo della richiesta di notifica
type: string
iun:
description: Identificativo della notifica, presente solo se la richiesta di notifica è stata accettata.
type: string
maxLength: 25
pattern: ^[A-Z]{4}-[A-Z]{4}-[A-Z]{4}-[0-9]{6}-[A-Z]{1}-[0-9]{1}$
newStatus:
$ref: '#/components/schemas/NotificationStatus'
element:
$ref: '#/components/schemas/TimelineElementV25'
DigitalDeliveryCreationRequestDetails:
type: object
required:
- recIndex
- digitalAddress
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
digitalAddress:
$ref: '#/components/schemas/DigitalAddress'
endWorkflowStatus:
$ref: '#/components/schemas/EndWorkflowStatus'
completionWorkflowDate:
type: string
description: Data chiusura workflow
format: date-time
legalfactId:
type: string
maxLength: 128
description: Identificativo dell'atto opponibile a terzi del quale è stata richiesta la creazione
NotificationRequestAcceptedDetailsV27:
type: object
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
notificationRequestId:
type: string
description: identificativo univoco di una richiesta di invio notifica, non è lo IUN
paProtocolNumber:
type: string
description: Numero di protocollo associato alla notifica, può essere riutilizzato per rettifiche.
pattern: ^.*$
maxLength: 256
idempotenceToken:
type: string
description: token usato per disambiguare "richieste di notificazione" effettuate con lo stesso numero di protocollo.
pattern: ^[ -~]*$
maxLength: 256
IoSendMessageResult:
type: string
description: Risultato invio messaggio su IO
enum:
- NOT_SENT_OPTIN_ALREADY_SENT
- SENT_COURTESY
- SENT_OPTIN
AnalogSuccessWorkflowDetails:
type: object
required:
- recIndex
- physicalAddress
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
physicalAddress:
$ref: '#/components/schemas/PhysicalAddress'
NotificationCancelledDetails:
type: object
required:
- notificationCost
- notRefinedRecipientIndexes
properties:
notificationCost:
description: costo notifica in euro cents, vale 100 * numero di recipient not refined
example: 1220
type: integer
format: int64
notRefinedRecipientIndexes:
type: array
items:
description: indice del recipient non perfezionato
type: integer
format: int32
NotificationRefusedErrorV25:
type: object
properties:
errorCode:
type: string
maxLength: 128
description: "Errori di rifiuto della notifica.\n - FILE_NOTFOUND - I riferimenti dei documenti nella notifica non sono corretti o i documenti non sono stati caricati con successo.\n - FILE_GONE - Allegato non disponibile: superati i termini di conservazione\n - FILE_SHA_ERROR - Il digest calcolato con algoritmi sha256 dei documenti inseriti non è corrispondete a quello del file referenziato.\n - FILE_PDF_INVALID_ERROR - Il file inserito non è in formato pdf.\n - FILE_PDF_TOOBIG_ERROR - Il file pdf ha una dimensione eccedente il limite di 200MB.\n - F24_METADATA_NOT_VALID - I dati contenuti del file dei metadati F24 non rispettano lo schema di validazione.\n - TAXID_NOT_VALID - Codice fiscale del destinatario non corretto (non ancora implementato).\n - RECIPIENT_ID_NOT_VALID - Destinatario non Valido (utilizzato solo per funzionalità non ancora implementate)\n - NOT_VALID_ADDRESS - L'indirizzo di invio cartaceo inserito per il destinatario non ha superato i controlli di correttezza.\n - PAYMENT_NOT_VALID - I dati del pagamento non sono sono registrati sulla piattaforma GPD (modalità asincrona di integrazione pagoPA)\n - SERVICE_UNAVAILABLE - Il sistema non è attualmente disponibile.\n ..."
detail:
type: string
maxLength: 2048
AarGenerationDetails:
type: object
required:
- recIndex
- generatedAarUrl
- numberOfPages
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
generatedAarUrl:
type: string
description: Chiave per recupero da safe-storage del documento aar
maxLength: 128
numberOfPages:
type: integer
description: numero di pagine del PDF generato
format: int32
AnalogWorkflowRecipientDeceasedDetailsV26:
type: object
required:
- recIndex
- physicalAddress
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
physicalAddress:
$ref: '#/components/schemas/PhysicalAddress'
notificationCost:
description: costo notifica in euro cents, può essere nullo se la notifica è stata precedentemente visualizzata
example: 1220
type: integer
format: int64
DigitalAddress:
description: Indirizzo di invio della notifica
required:
- address
- type
type: object
properties:
type:
x-field-extra-annotation: '@lombok.ToString.Exclude'
type: string
description: tipo di indirizzo PEC, REM, SERCQ, SMS, EMAIL, APPIO ...
address:
x-field-extra-annotation: '@lombok.ToString.Exclude'
type: string
description: account@domain
NotificationViewedDetailsV23:
type: object
required:
- recIndex
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
notificationCost:
description: costo notifica in euro cents, può essere nullo se la notifica si è perfezionata prima per decorrenza termini
example: 1220
type: integer
format: int64
raddType:
$ref: '#/components/schemas/RaddTypeV23'
raddTransactionId:
$ref: '#/components/schemas/RaddTransactionId'
delegateInfo:
$ref: '#/components/schemas/DelegateInfo'
eventTimestamp:
type: string
description: Data evento visualizzazione
format: date-time
TimelineElementDetailsV23:
description: The raw event payload that will be different based on the event.
oneOf:
- $ref: '#/components/schemas/SenderAckCreationRequestDetails'
- $ref: '#/components/schemas/NormalizedAddressDetails'
- $ref: '#/components/schemas/NotificationRequestAcceptedDetails'
- $ref: '#/components/schemas/AnalogFailureWorkflowDetails'
- $ref: '#/components/schemas/AnalogSuccessWorkflowDetails'
- $ref: '#/components/schemas/CompletelyUnreachableCreationRequestDetails'
- $ref: '#/components/schemas/CompletelyUnreachableDetails'
- $ref: '#/components/schemas/DigitalDeliveryCreationRequestDetails'
- $ref: '#/components/schemas/DigitalFailureWorkflowDetails'
- $ref: '#/components/schemas/DigitalSuccessWorkflowDetails'
- $ref: '#/components/schemas/GetAddressInfoDetails'
- $ref: '#/components/schemas/NotificationViewedCreationRequestDetailsV23'
- $ref: '#/components/schemas/NotificationViewedDetailsV23'
- $ref: '#/components/schemas/NotificationRADDRetrievedDetails'
- $ref: '#/components/schemas/PublicRegistryCallDetails'
- $ref: '#/components/schemas/PublicRegistryResponseDetails'
- $ref: '#/components/schemas/RefinementDetailsV23'
- $ref: '#/components/schemas/RequestRefusedDetailsV23'
- $ref: '#/components/schemas/ScheduleAnalogWorkflowDetailsV23'
- $ref: '#/components/schemas/ScheduleDigitalWorkflowDetailsV23'
- $ref: '#/components/schemas/ScheduleRefinementDetails'
- $ref: '#/components/schemas/SendCourtesyMessageDetails'
- $ref: '#/components/schemas/PrepareDigitalDetails'
- $ref: '#/components/schemas/SendDigitalDetails'
- $ref: '#/components/schemas/SendDigitalFeedbackDetails'
- $ref: '#/components/schemas/SendDigitalProgressDetailsV23'
- $ref: '#/components/schemas/BaseAnalogDetails'
- $ref: '#/components/schemas/SendAnalogDetails'
- $ref: '#/components/schemas/SendAnalogFeedbackDetails'
- $ref: '#/components/schemas/BaseRegisteredLetterDetails'
- $ref: '#/components/schemas/SimpleRegisteredLetterDetails'
- $ref: '#/components/schemas/AarCreationRequestDetails'
- $ref: '#/components/schemas/AarGenerationDetails'
- $ref: '#/components/schemas/NotHandledDetails'
- $ref: '#/components/schemas/NotificationPaidDetailsV23'
- $ref: '#/components/schemas/SendAnalogProgressDetailsV23'
- $ref: '#/components/schemas/SimpleRegisteredLetterProgressDetails'
- $ref: '#/components/schemas/ProbableDateAnalogWorkflowDetails'
- $ref: '#/components/schemas/NotificationCancellationRequestDetails'
- $ref: '#/components/schemas/NotificationCancelledDetails'
- $ref: '#/components/schemas/PrepareAnalogDomicileFailureDetails'
TimelineElementV25:
type: object
additionalProperties: false
properties:
elementId:
type: string
maxLength: 512
description: 'Identificativo dell''elemento di timeline: insieme allo IUN della notifica definisce in maniera univoca l''elemento di timeline'
timestamp:
type: string
deprecated: true
description: Istante in cui avviene l'evento descritto in questo elemento di timeline (deprecato, fare riferimento al campo eventTimestamp)
format: date-time
ingestionTimestamp:
type: string
description: Istante in cui l'evento descritto in questo elemento di timeline è gestito da SEND
format: date-time
eventTimestamp:
type: string
description: Istante in cui avviene l'evento descritto in questo elemento di timeline
format: date-time
notificationSentAt:
type: string
description: Momento di ricezione della richiesta di notifica da parte di SEND
format: date-time
legalFactsIds:
type: array
items:
$ref: '#/components/schemas/LegalFactsIdV20'
description: Chiavi dei documenti che provano l'effettivo accadimento dell'evento descritto in timeline. Questo elemento
category:
$ref: '#/components/schemas/TimelineElementCategoryV23'
details:
$ref: '#/components/schemas/TimelineElementDetailsV25'
TimelineElementV23:
type: object
additionalProperties: false
properties:
elementId:
type: string
maxLength: 512
description: 'Identificativo dell''elemento di timeline: insieme allo IUN della notifica definisce in maniera univoca l''elemento di timeline'
timestamp:
type: string
description: Momento in cui avviene l'evento descritto in questo elemento di timeline
format: date-time
legalFactsIds:
type: array
items:
$ref: '#/components/schemas/LegalFactsId'
description: Chiavi dei documenti che provano l'effettivo accadimento dell'evento descritto in timeline. Questo elemento
category:
$ref: '#/components/schemas/TimelineElementCategoryV23'
details:
$ref: '#/components/schemas/TimelineElementDetailsV23'
SimpleRegisteredLetterProgressDetails:
type: object
required:
- recIndex
properties:
recIndex:
type: integer
description: Index destinatario che ha effettuato il pagamento della notifica
format: int32
notificationDate:
type: string
format: date-time
deliveryFailureCause:
type: string
maxLength: 10
description: Vedi deliveryFailureCause in SendAnalogFeedbackDetails
deliveryDetailCode:
type: string
maxLength: 20
description: Vedi deliveryDetailCode in SendAnalogFeedbackDetails
attachments:
type: array
items:
$ref: '#/components/schemas/AttachmentDetails'
sendRequestId:
type: string
description: RequestId della richiesta d'invio
maxLength: 512
registeredLetterCode:
type: string
description: Codice della raccomandata
maxLength: 128
TimelineElementV27:
type: object
additionalProperties: false
properties:
elementId:
type: string
maxLength: 512
description: 'Identificativo dell''elemento di timeline: insieme allo IUN della notifica definisce in maniera univoca l''elemento di timeline'
timestamp:
type: string
deprecated: true
description: Istante in cui avviene l'evento descritto in questo elemento di timeline (deprecato, fare riferimento al campo eventTimestamp)
format: date-time
ingestionTimestamp:
type: string
description: Istante in cui l'evento descritto in questo elemento di timeline è gestito da SEND
format: date-time
eventTimestamp:
type: string
description: Istante in cui avviene l'evento descritto in questo elemento di timeline
format: date-time
notificationSentAt:
type: string
description: Momento di ricezione della richiesta di notifica da parte di SEND
format: date-time
legalFactsIds:
type: array
items:
$ref: '#/components/schemas/LegalFactsIdV20'
description: Chiavi dei documenti che provano l'effettivo accadimento dell'evento descritto in timeline. Questo elemento
category:
$ref: '#/components/schemas/TimelineElementCategoryV27'
details:
$ref: '#/components/schemas/TimelineElementDetailsV27'
SendCourtesyMessageDetails:
type: object
required:
- recIndex
- digitalAddress
- sendDate
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
digitalAddress:
$ref: '#/components/schemas/DigitalAddress'
sendDate:
type: string
description: data invio messaggio di cortesia
format: date-time
ioSendMessageResult:
$ref: '#/components/schemas/IoSendMessageResult'
Problem_2:
properties:
type:
description: URI reference of type definition
type: string
status:
description: The HTTP status code generated by the origin server for this occurrence of the problem.
type: integer
format: int32
example: 503
minimum: 100
exclusiveMaximum: 600
title:
description: A short, summary of the problem type. Written in english and readable
example: Service Unavailable
maxLength: 64
pattern: ^[ -~]{0,64}$
type: string
detail:
description: A human readable explanation of the problem.
example: Request took too long to complete.
maxLength: 4096
pattern: ^.{0,4096}$
type: string
traceId:
description: Internal support identifier associated to error
example: 123e4567-e89b-12d3-a456-426614174000
type: string
timestamp:
description: date and time referred to UTC
example: '2022-07-27T12:22:33.444Z'
type: string
format: date-time
errors:
type: array
minItems: 1
items:
$ref: '#/components/schemas/ProblemError_2'
required:
- status
- errors
SendDigitalDetails:
type: object
required:
- recIndex
- digitalAddress
- digitalAddressSource
- retryNumber
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
digitalAddress:
$ref: '#/components/schemas/DigitalAddress'
digitalAddressSource:
$ref: '#/components/schemas/DigitalAddressSource'
retryNumber:
type: integer
description: numero dei tentativi effettuati
format: int32
ProgressResponseV24:
type: array
items:
$ref: '#/components/schemas/ProgressResponseElementV24'
AarCreationRequestDetails:
type: object
required:
- recIndex
- aarKey
- numberOfPages
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
aarKey:
type: string
description: Chiave per recupero da safe-storage del documento aar
maxLength: 128
numberOfPages:
type: integer
description: numero di pagine del PDF generato
format: int32
SendAnalogDetails:
type: object
required:
- recIndex
- physicalAddress
- serviceLevel
- sentAttemptMade
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
physicalAddress:
$ref: '#/components/schemas/PhysicalAddress'
serviceLevel:
$ref: '#/components/schemas/ServiceLevel'
sentAttemptMade:
type: integer
description: numero dei tentativi effettuati
format: int32
relatedRequestId:
type: string
description: Id relativo alla eventuale precedente richiesta di invio cartaceo
maxLength: 512
productType:
type: string
maxLength: 10
description: "Tipo di invio cartaceo effettivamente inviato\n - __AR__: Raccomandata nazionale Andata e Ritorno\n - __890__: Recapito a norma della legge 890/1982\n - __RIR__: Raccomandata internazionale Andata e Ritorno\n"
analogCost:
type: integer
description: costo in eurocent dell'invio
format: int32
numberOfPages:
type: integer
description: numero delle pagina che compongono la spedizione cartacea
format: int32
envelopeWeight:
type: integer
description: peso in grammi della busta
format: int32
prepareRequestId:
type: string
description: request id della relativa richiesta di prepare
maxLength: 512
CompletelyUnreachableCreationRequestDetailsV28:
type: object
required:
- recIndex
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
legalFactId:
type: string
maxLength: 128
description: Identificativo dell'atto opponibile a terzi del quale è stata richiesta la creazione
endWorkflowStatus:
$ref: '#/components/schemas/EndWorkflowStatus'
completionWorkflowDate:
type: string
description: Data chiusura workflow
format: date-time
PrepareAnalogDomicileFailureDetails:
type: object
required:
- recIndex
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
foundAddress:
$ref: '#/components/schemas/PhysicalAddress'
failureCause:
type: string
maxLength: 10
description: "__Motivazione fallimento prepare\n - __D00__ Indirizzo non trovato\n - __D01__ Indirizzo non valido\n - __D02__ Indirizzo coincidente con quello del primo tentativo\n"
prepareRequestId:
type: string
description: RequestId della richiesta di prepare
maxLength: 512
PublicRegistryValidationResponseDetails:
allOf:
- $ref: '#/components/schemas/PublicRegistryResponseDetails'
- type: object
properties:
registry:
type: string
description: "Rappresenta il registro consultato per ottenere l'indirizzo. Può assumere i seguenti valori:\n - ANPR\n - REGISTRO_IMPRESE\n"
maxLength: 128
ScheduleAnalogWorkflowDetailsV23:
type: object
required:
- recIndex
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
schedulingDate:
type: string
description: Data prevista per l'inizio dell'invio analogico
format: date-time
NotificationViewedCreationRequestDetailsV23:
type: object
required:
- recIndex
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
legalfactId:
type: string
maxLength: 128
description: Identificativo dell'atto opponibile a terzi del quale è stata richiesta la creazione
eventTimestamp:
type: string
description: Data ricezione richiesta visualizzazione notifica
format: date-time
raddType:
$ref: '#/components/schemas/RaddTypeV23'
raddTransactionId:
$ref: '#/components/schemas/RaddTransactionId'
delegateInfo:
$ref: '#/components/schemas/DelegateInfo'
NotificationRequestAcceptedDetailsV28:
type: object
properties:
notificationRequestId:
type: string
description: identificativo univoco di una richiesta di invio notifica, non è lo IUN
paProtocolNumber:
type: string
description: Numero di protocollo associato alla notifica, può essere riutilizzato per rettifiche.
pattern: ^.*$
maxLength: 256
idempotenceToken:
type: string
description: token usato per disambiguare "richieste di notificazione" effettuate con lo stesso numero di protocollo.
pattern: ^[ -~]*$
maxLength: 256
RequestRefusedDetailsV27:
type: object
properties:
refusalReasons:
type: array
description: Motivazioni che hanno portato al rifiuto della notifica
items:
$ref: '#/components/schemas/NotificationRefusedErrorV27'
notificationRequestId:
type: string
description: identificativo univoco di una richiesta di invio notifica, non è lo IUN
paProtocolNumber:
type: string
description: Numero di protocollo associato alla notifica, può essere riutilizzato per rettifiche.
pattern: ^.*$
maxLength: 256
idempotenceToken:
type: string
description: token usato per disambiguare "richieste di notificazione" effettuate con lo stesso numero di protocollo.
pattern: ^[ -~]*$
maxLength: 256
CompletelyUnreachableDetails:
type: object
required:
- recIndex
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
legalFactGenerationDate:
type: string
description: Data generazione atto opponibile a terzi allegato
format: date-time
ProgressResponseElement:
type: object
required:
- eventId
- timestamp
properties:
eventId:
description: Elemento che garantisce univocità e ordinamento temporale all'interno dello stream
type: string
timestamp:
description: Istante a cui è avvenuto l'evento
type: string
format: date-time
notificationRequestId:
description: Identificativo della richiesta di notifica
type: string
iun:
description: Identificativo della notifica, presente solo se la richiesta di notifica è stata accettata.
type: string
maxLength: 25
pattern: ^[A-Z]{4}-[A-Z]{4}-[A-Z]{4}-[0-9]{6}-[A-Z]{1}-[0-9]{1}$
newStatus:
$ref: '#/components/schemas/NotificationStatus'
timelineEventCategory:
$ref: '#/components/schemas/TimelineElementCategoryV23'
recipientIndex:
type: integer
format: int32
minimum: 0
description: Indice del destinatario al quale si riferisce l'evento
analogCost:
type: integer
format: int32
description: Eventuale costo in eurocent associato all'evento
channel:
type: string
description: 'Canale a cui si riferisce l''evento. I valori previsti sono: - Per eventi legati a messaggi di cortesia: APPIO, SMS, EMAIL - Per eventi legati all''invio digitale: PEC - Per eventi legati all''invio analogico: AR_REGISTERED_LETTER, REGISTERED_LETTER_890 - Per eventi legati all''invio di raccomandate semplici: SIMPLE_REGISTERED_LETTER'
legalfactIds:
type: array
items:
type: string
example:
- PN_LEGAL_FACTS-0002-9G2S-RK3M-JI62-JK9Q
- PN_LEGAL_FACTS-0002-9G2S-RK3M-JI62-JK9E
description: chiavi degli eventuali allegati associati all'evento
validationErrors:
type: array
description: eventuali errori di validazione associati all'evento
items:
$ref: '#/components/schemas/RefusedReason'
LegalFactsId:
description: Chiavi dei documenti generati durante il processo di consegna cartacea
type: object
required:
- key
- category
properties:
key:
description: Chiave dell'atto opponibile a terzi generato durante il processo di consegna
type: string
pattern: ^(safestorage:\/\/)?[A-Za-z0-9._-]+$
maxLength: 512
category:
$ref: '#/components/schemas/LegalFactCategory'
ServiceLevel:
type: string
description: Livello Servizio
enum:
- AR_REGISTERED_LETTER
- REGISTERED_LETTER_890
TimelineElementV28:
type: object
additionalProperties: false
properties:
elementId:
type: string
maxLength: 512
description: 'Identificativo dell''elemento di timeline: insieme allo IUN della notifica definisce in maniera univoca l''elemento di timeline'
timestamp:
type: string
deprecated: true
description: Istante in cui avviene l'evento descritto in questo elemento di timeline (deprecato, fare riferimento al campo eventTimestamp)
format: date-time
ingestionTimestamp:
type: string
description: Istante in cui l'evento descritto in questo elemento di timeline è gestito da SEND
format: date-time
eventTimestamp:
type: string
description: Istante in cui avviene l'evento descritto in questo elemento di timeline
format: date-time
notificationSentAt:
type: string
description: Momento di ricezione della richiesta di notifica da parte di SEND
format: date-time
legalFactsIds:
type: array
items:
$ref: '#/components/schemas/LegalFactsIdV20'
description: Chiavi dei documenti che provano l'effettivo accadimento dell'evento descritto in timeline. Questo elemento
category:
$ref: '#/components/schemas/TimelineElementCategoryV28'
details:
$ref: '#/components/schemas/TimelineElementDetailsV28'
ProgressResponseElementV28:
type: object
required:
- eventId
- element
properties:
eventId:
description: Elemento che garantisce univocità all'interno dello stream
type: string
notificationRequestId:
description: Identificativo della richiesta di notifica
type: string
iun:
description: Identificativo della notifica, presente solo se la richiesta di notifica è stata accettata.
type: string
maxLength: 25
pattern: ^[A-Z]{4}-[A-Z]{4}-[A-Z]{4}-[0-9]{6}-[A-Z]{1}-[0-9]{1}$
newStatus:
$ref: '#/components/schemas/NotificationStatusV26'
element:
$ref: '#/components/schemas/TimelineElementV27'
DigitalDeliveryCreationRequestDetailsV28:
type: object
required:
- recIndex
- digitalAddress
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
digitalAddress:
$ref: '#/components/schemas/DigitalAddress'
endWorkflowStatus:
$ref: '#/components/schemas/EndWorkflowStatus'
completionWorkflowDate:
type: string
description: Data chiusura workflow
format: date-time
legalFactId:
type: string
maxLength: 128
description: Identificativo dell'atto opponibile a terzi del quale è stata richiesta la creazione
TimelineElementDetailsV27:
description: The raw event payload that will be different based on the event.
oneOf:
- $ref: '#/components/schemas/SenderAckCreationRequestDetails'
- $ref: '#/components/schemas/NormalizedAddressDetails'
- $ref: '#/components/schemas/NotificationRequestAcceptedDetailsV27'
- $ref: '#/components/schemas/AnalogFailureWorkflowDetails'
- $ref: '#/components/schemas/AnalogSuccessWorkflowDetails'
- $ref: '#/components/schemas/CompletelyUnreachableCreationRequestDetails'
- $ref: '#/components/schemas/CompletelyUnreachableDetails'
- $ref: '#/components/schemas/DigitalDeliveryCreationRequestDetails'
- $ref: '#/components/schemas/DigitalFailureWorkflowDetails'
- $ref: '#/components/schemas/DigitalSuccessWorkflowDetails'
- $ref: '#/components/schemas/GetAddressInfoDetails'
- $ref: '#/components/schemas/NotificationViewedCreationRequestDetailsV23'
- $ref: '#/components/schemas/NotificationViewedDetailsV23'
- $ref: '#/components/schemas/NotificationRADDRetrievedDetails'
- $ref: '#/components/schemas/PublicRegistryCallDetails'
- $ref: '#/components/schemas/PublicRegistryResponseDetails'
- $ref: '#/components/schemas/RefinementDetailsV23'
- $ref: '#/components/schemas/RequestRefusedDetailsV27'
- $ref: '#/components/schemas/ScheduleAnalogWorkflowDetailsV23'
- $ref: '#/components/schemas/ScheduleDigitalWorkflowDetailsV23'
- $ref: '#/components/schemas/ScheduleRefinementDetails'
- $ref: '#/components/schemas/SendCourtesyMessageDetails'
- $ref: '#/components/schemas/PrepareDigitalDetails'
- $ref: '#/components/schemas/SendDigitalDetails'
- $ref: '#/components/schemas/SendDigitalFeedbackDetails'
- $ref: '#/components/schemas/SendDigitalProgressDetailsV23'
- $ref: '#/components/schemas/BaseAnalogDetails'
- $ref: '#/components/schemas/SendAnalogDetails'
- $ref: '#/components/schemas/SendAnalogFeedbackDetailsV25'
- $ref: '#/components/schemas/BaseRegisteredLetterDetails'
- $ref: '#/components/schemas/SimpleRegisteredLetterDetails'
- $ref: '#/components/schemas/AarCreationRequestDetails'
- $ref: '#/components/schemas/AarGenerationDetails'
- $ref: '#/components/schemas/NotHandledDetails'
- $ref: '#/components/schemas/NotificationPaidDetailsV23'
- $ref: '#/components/schemas/SendAnalogProgressDetailsV23'
- $ref: '#/components/schemas/SimpleRegisteredLetterProgressDetails'
- $ref: '#/components/schemas/ProbableDateAnalogWorkflowDetails'
- $ref: '#/components/schemas/NotificationCancellationRequestDetails'
- $ref: '#/components/schemas/NotificationCancelledDetails'
- $ref: '#/components/schemas/PrepareAnalogDomicileFailureDetails'
- $ref: '#/components/schemas/AnalogWorkflowRecipientDeceasedDetailsV26'
- $ref: '#/components/schemas/PublicRegistryValidationCallDetails'
- $ref: '#/components/schemas/PublicRegistryValidationResponseDetails'
DelegateInfo:
type: object
properties:
internalId:
type: string
maxLength: 128
taxId:
x-field-extra-annotation: '@lombok.ToString.Exclude'
type: string
maxLength: 128
operatorUuid:
type: string
maxLength: 128
mandateId:
type: string
maxLength: 128
denomination:
x-field-extra-annotation: '@lombok.ToString.Exclude'
type: string
maxLength: 128
delegateType:
$ref: '#/components/schemas/RecipientType'
NotificationStatus:
type: string
description: "stato di avanzamento del processo di notifica:\n * `IN_VALIDATION` - notifica depositata in attesa di validazione\n * `ACCEPTED` - L'ente ha depositato la notifica con successo\n * `REFUSED` - Notifica rifiutata a seguito della validazione\n * `DELIVERING` - L'invio della notifica è in corso\n * `DELIVERED` - La notifica è stata consegnata a tutti i destinatari\n * `VIEWED` - Il destinatario ha letto la notifica entro il termine stabilito\n * `EFFECTIVE_DATE` - Il destinatario non ha letto la notifica entro il termine stabilito\n * `UNREACHABLE` - Il destinatario non è reperibile\n * `CANCELLED` - L'ente ha annullato l'invio della notifica\n * `PAID` - [DEPRECATO] Uno dei destinatari ha pagato la notifica\n"
enum:
- IN_VALIDATION
- ACCEPTED
- REFUSED
- DELIVERING
- DELIVERED
- VIEWED
- EFFECTIVE_DATE
- PAID
- UNREACHABLE
- CANCELLED
TimelineElementCategoryV26:
type: string
description: "stato di avanzamento del processo di notifica:`\n * `SENDER_ACK_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di presa in carico per il mittente a safe storage\n * `VALIDATE_NORMALIZE_ADDRESSES_REQUEST` - Invio della richiesta di validazione e normalizzazione indirizzi fisici presenti nella richiesta di notifica\n * `NORMALIZED_ADDRESS` - Salvataggio indirizzi normalizzati\n * `REQUEST_ACCEPTED` - Richiesta di notifica accettata a seguito dei controlli di validazione\n * `REQUEST_REFUSED` - Richiesta di notifica rifiutata per fallimento di validazione\n * `SEND_COURTESY_MESSAGE` - Invio di un messaggio di cortesia\n * `GET_ADDRESS` - Disponibilità dell’indirizzo specifico (domicilio digitale di piattaforma, domicilio digitale speciale, domicilio digitale generale, indirizzo fisico sulla notifica o sui registri nazionali)\n * `PUBLIC_REGISTRY_CALL` - Richiesta ai registri pubblici per ottenere domicilio digitale generale o per ottenere indirizzo fisico da ANPR, da registro della imprese, da anagrafe tributaria.\n * `PUBLIC_REGISTRY_RESPONSE` - Ricevuta la risposta dei registri pubblici\n * `SCHEDULE_ANALOG_WORKFLOW` - Pianificazione del workflow per invio cartaceo\n * `SCHEDULE_DIGITAL_WORKFLOW` -Pianificazione del workflow per invio digitale (PEC) del secondo tentativo in caso di fallimento del primo.\n * `PREPARE_DIGITAL_DOMICILE` - Preparazione per l’invio dell’avviso digitale.Va a valutare la timeline per capire quale sarà il prossimo indirizzo da usare.\n * `SEND_DIGITAL_DOMICILE` - Invio digitale dell’avviso di notifica\n * `SEND_DIGITAL_PROGRESS` - Tentativo di Invio PEC ad un determinato indirizzo.\n * `SEND_DIGITAL_FEEDBACK` - Ottenuto esito ad un invio digitale\n * `SCHEDULE_REFINEMENT` - Pianificato il perfezionamento per decorrenza termini\n * `REFINEMENT` - Perfezionamento per decorrenza termini\n * `DIGITAL_DELIVERY_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di chiusura del workflow digitale a safe storage\n * `DIGITAL_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio digitale\n * `DIGITAL_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio digitale: tutti i tentativi di invio ai domicili digitali sono falliti.\n * `ANALOG_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio cartaceo\n * `ANALOG_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio cartaceo NOTA: se per tutti i destinatari si conclude il workflow con fallimento verrà scatenato l’evento COMPLETELY_UNREACHABLE\n * `PREPARE_SIMPLE_REGISTERED_LETTER` - Invio richiesta di prepare (preparazione ad invio) raccomandata semplice a paperChannel\n * `SEND_SIMPLE_REGISTERED_LETTER` - Invio di raccomandata semplice\n * `SEND_SIMPLE_REGISTERED_LETTER_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea semplice\n * `NOTIFICATION_VIEWED_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di presa visione a safe storage\n * `NOTIFICATION_VIEWED` - Visualizzazione della notifica (perfeziona la notifica se non già perfezionata per decorrenza termini o da altro destinatario)\n * `PREPARE_ANALOG_DOMICILE` - Invio richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `SEND_ANALOG_DOMICILE` - Invio cartaceo dell’avviso di notifica\n * `SEND_ANALOG_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea\n * `SEND_ANALOG_FEEDBACK` - Ricezione esito dell'invio cartaceo\n * `COMPLETELY_UNREACHABLE_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto (simile a opponibile a terzi) di completamento con fallimento del workflow di invio cartaceo\n * `COMPLETELY_UNREACHABLE` - Tutti i destinatari risultano irraggiungibili\n * `AAR_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'AAR (Avviso di Avvenuta Ricezione) a safe storage\n * `AAR_GENERATION` - Generazione dell’AAR (Avviso di Avvenuta Ricezione)\n * `PAYMENT` - Evento di ricezione __dal mittente__ dell'informazione di chiusura di uno o più pagamenti di tipo pagoPA (vedi #/components/schemas/PagoPaPayment). La presenza di questo evento inibisce l'invio di eventuali comunicazioni analogiche future ma non perfeziona la notifica.\n * `NOT_HANDLED` - [DEPRECATO] Per la sperimentazione l'invio analogico non è previsto, viene inserito tale elemento di timeline\n * `PROBABLE_SCHEDULING_ANALOG_DATE` - Data probabile di inizio del flusso analogico\n * `NOTIFICATION_CANCELLATION_REQUEST` - Richiesta di annullamento di una notifica\n * `NOTIFICATION_CANCELLED` - Notifica annullata\n * `PREPARE_ANALOG_DOMICILE_FAILURE` - Fallimento della richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `NOTIFICATION_RADD_RETRIEVED` - Accesso alla notifica tramite la rete RADD. Non perfeziona la notifica.\n * `ANALOG_WORKFLOW_RECIPIENT_DECEASED` - Destinatario deceduto\n"
enum:
- SENDER_ACK_CREATION_REQUEST
- VALIDATE_NORMALIZE_ADDRESSES_REQUEST
- NORMALIZED_ADDRESS
- REQUEST_ACCEPTED
- SEND_COURTESY_MESSAGE
- GET_ADDRESS
- PUBLIC_REGISTRY_CALL
- PUBLIC_REGISTRY_RESPONSE
- SCHEDULE_ANALOG_WORKFLOW
- SCHEDULE_DIGITAL_WORKFLOW
- PREPARE_DIGITAL_DOMICILE
- SEND_DIGITAL_DOMICILE
- SEND_DIGITAL_PROGRESS
- SEND_DIGITAL_FEEDBACK
- REFINEMENT
- SCHEDULE_REFINEMENT
- DIGITAL_DELIVERY_CREATION_REQUEST
- DIGITAL_SUCCESS_WORKFLOW
- DIGITAL_FAILURE_WORKFLOW
- ANALOG_SUCCESS_WORKFLOW
- ANALOG_FAILURE_WORKFLOW
- PREPARE_SIMPLE_REGISTERED_LETTER
- SEND_SIMPLE_REGISTERED_LETTER
- SEND_SIMPLE_REGISTERED_LETTER_PROGRESS
- NOTIFICATION_VIEWED_CREATION_REQUEST
- NOTIFICATION_VIEWED
- PREPARE_ANALOG_DOMICILE
- SEND_ANALOG_DOMICILE
- SEND_ANALOG_PROGRESS
- SEND_ANALOG_FEEDBACK
- PAYMENT
- COMPLETELY_UNREACHABLE
- COMPLETELY_UNREACHABLE_CREATION_REQUEST
- REQUEST_REFUSED
- AAR_CREATION_REQUEST
- AAR_GENERATION
- NOT_HANDLED
- PROBABLE_SCHEDULING_ANALOG_DATE
- NOTIFICATION_CANCELLATION_REQUEST
- NOTIFICATION_CANCELLED
- PREPARE_ANALOG_DOMICILE_FAILURE
- NOTIFICATION_RADD_RETRIEVED
- ANALOG_WORKFLOW_RECIPIENT_DECEASED
ContactPhase:
type: string
description: Fase in cui è avvenuta la richiesta
enum:
- CHOOSE_DELIVERY
- SEND_ATTEMPT
NotificationRequestAcceptedDetails:
type: object
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
NotificationTimelineReworkedDetails:
type: object
required:
- recIndex
- sentAttemptMade
- invalidatedTimelineAndStatusHistory
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
sentAttemptMade:
type: integer
description: numero dei tentativi effettuati
format: int32
invalidatedTimelineAndStatusHistory:
description: elenco degli avanzamenti effettuati dal processo di notifica prima dell'invalidazione
type: array
items:
$ref: '#/components/schemas/NotificationStatusHistoryInvalidatedElement'
ProgressResponseElementV29:
type: object
required:
- eventId
- element
properties:
eventId:
description: Elemento che garantisce univocità all'interno dello stream
type: string
notificationRequestId:
description: Identificativo della richiesta di notifica
type: string
iun:
description: Identificativo della notifica, presente solo se la richiesta di notifica è stata accettata.
type: string
maxLength: 25
pattern: ^[A-Z]{4}-[A-Z]{4}-[A-Z]{4}-[0-9]{6}-[A-Z]{1}-[0-9]{1}$
newStatus:
$ref: '#/components/schemas/NotificationStatusV26'
element:
$ref: '#/components/schemas/TimelineElementV28'
ProgressResponseV26:
type: array
items:
$ref: '#/components/schemas/ProgressResponseElementV26'
TimelineElementDetailsV25:
description: The raw event payload that will be different based on the event.
oneOf:
- $ref: '#/components/schemas/SenderAckCreationRequestDetails'
- $ref: '#/components/schemas/NormalizedAddressDetails'
- $ref: '#/components/schemas/NotificationRequestAcceptedDetails'
- $ref: '#/components/schemas/AnalogFailureWorkflowDetails'
- $ref: '#/components/schemas/AnalogSuccessWorkflowDetails'
- $ref: '#/components/schemas/CompletelyUnreachableCreationRequestDetails'
- $ref: '#/components/schemas/CompletelyUnreachableDetails'
- $ref: '#/components/schemas/DigitalDeliveryCreationRequestDetails'
- $ref: '#/components/schemas/DigitalFailureWorkflowDetails'
- $ref: '#/components/schemas/DigitalSuccessWorkflowDetails'
- $ref: '#/components/schemas/GetAddressInfoDetails'
- $ref: '#/components/schemas/NotificationViewedCreationRequestDetailsV23'
- $ref: '#/components/schemas/NotificationViewedDetailsV23'
- $ref: '#/components/schemas/NotificationRADDRetrievedDetails'
- $ref: '#/components/schemas/PublicRegistryCallDetails'
- $ref: '#/components/schemas/PublicRegistryResponseDetails'
- $ref: '#/components/schemas/RefinementDetailsV23'
- $ref: '#/components/schemas/RequestRefusedDetailsV25'
- $ref: '#/components/schemas/ScheduleAnalogWorkflowDetailsV23'
- $ref: '#/components/schemas/ScheduleDigitalWorkflowDetailsV23'
- $ref: '#/components/schemas/ScheduleRefinementDetails'
- $ref: '#/components/schemas/SendCourtesyMessageDetails'
- $ref: '#/components/schemas/PrepareDigitalDetails'
- $ref: '#/components/schemas/SendDigitalDetails'
- $ref: '#/components/schemas/SendDigitalFeedbackDetails'
- $ref: '#/components/schemas/SendDigitalProgressDetailsV23'
- $ref: '#/components/schemas/BaseAnalogDetails'
- $ref: '#/components/schemas/SendAnalogDetails'
- $ref: '#/components/schemas/SendAnalogFeedbackDetailsV25'
- $ref: '#/components/schemas/BaseRegisteredLetterDetails'
- $ref: '#/components/schemas/SimpleRegisteredLetterDetails'
- $ref: '#/components/schemas/AarCreationRequestDetails'
- $ref: '#/components/schemas/AarGenerationDetails'
- $ref: '#/components/schemas/NotHandledDetails'
- $ref: '#/components/schemas/NotificationPaidDetailsV23'
- $ref: '#/components/schemas/SendAnalogProgressDetailsV23'
- $ref: '#/components/schemas/SimpleRegisteredLetterProgressDetails'
- $ref: '#/components/schemas/ProbableDateAnalogWorkflowDetails'
- $ref: '#/components/schemas/NotificationCancellationRequestDetails'
- $ref: '#/components/schemas/NotificationCancelledDetails'
- $ref: '#/components/schemas/PrepareAnalogDomicileFailureDetails'
ScheduleRefinementDetails:
type: object
required:
- recIndex
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
schedulingDate:
type: string
format: date-time
NotificationRefusedErrorV23:
type: object
properties:
errorCode:
type: string
maxLength: 128
description: "Errori di rifiuto della notifica.\n - FILE_NOTFOUND\n - FILE_SHA_ERROR\n - TAXID_NOT_VALID\n - SERVICE_UNAVAILABLE\n - FILE_PDF_INVALID_ERROR\n - FILE_PDF_TOOBIG_ERROR\n - NOT_VALID_ADDRESS\n - RECIPIENT_ID_NOT_VALID\n - F24_METADATA_NOT_VALID\n - PAYMENT_NOT_VALID\n ..."
detail:
type: string
maxLength: 2048
TimelineElementCategoryV27:
type: string
description: "stato di avanzamento del processo di notifica:`\n * `SENDER_ACK_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di presa in carico per il mittente a safe storage\n * `VALIDATE_NORMALIZE_ADDRESSES_REQUEST` - Invio della richiesta di validazione e normalizzazione indirizzi fisici presenti nella richiesta di notifica\n * `NORMALIZED_ADDRESS` - Salvataggio indirizzi normalizzati\n * `REQUEST_ACCEPTED` - Richiesta di notifica accettata a seguito dei controlli di validazione\n * `REQUEST_REFUSED` - Richiesta di notifica rifiutata per fallimento di validazione\n * `SEND_COURTESY_MESSAGE` - Invio di un messaggio di cortesia\n * `GET_ADDRESS` - Disponibilità dell’indirizzo specifico (domicilio digitale di piattaforma, domicilio digitale speciale, domicilio digitale generale, indirizzo fisico sulla notifica o sui registri nazionali)\n * `PUBLIC_REGISTRY_CALL` - Richiesta ai registri pubblici per ottenere domicilio digitale generale o per ottenere indirizzo fisico da ANPR, da registro della imprese, da anagrafe tributaria.\n * `PUBLIC_REGISTRY_RESPONSE` - Ricevuta la risposta dei registri pubblici\n * `SCHEDULE_ANALOG_WORKFLOW` - Pianificazione del workflow per invio cartaceo\n * `SCHEDULE_DIGITAL_WORKFLOW` -Pianificazione del workflow per invio digitale (PEC) del secondo tentativo in caso di fallimento del primo.\n * `PREPARE_DIGITAL_DOMICILE` - Preparazione per l’invio dell’avviso digitale.Va a valutare la timeline per capire quale sarà il prossimo indirizzo da usare.\n * `SEND_DIGITAL_DOMICILE` - Invio digitale dell’avviso di notifica\n * `SEND_DIGITAL_PROGRESS` - Tentativo di Invio PEC ad un determinato indirizzo.\n * `SEND_DIGITAL_FEEDBACK` - Ottenuto esito ad un invio digitale\n * `SCHEDULE_REFINEMENT` - Pianificato il perfezionamento per decorrenza termini\n * `REFINEMENT` - Perfezionamento per decorrenza termini\n * `DIGITAL_DELIVERY_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di chiusura del workflow digitale a safe storage\n * `DIGITAL_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio digitale\n * `DIGITAL_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio digitale: tutti i tentativi di invio ai domicili digitali sono falliti.\n * `ANALOG_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio cartaceo\n * `ANALOG_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio cartaceo NOTA: se per tutti i destinatari si conclude il workflow con fallimento verrà scatenato l’evento COMPLETELY_UNREACHABLE\n * `PREPARE_SIMPLE_REGISTERED_LETTER` - Invio richiesta di prepare (preparazione ad invio) raccomandata semplice a paperChannel\n * `SEND_SIMPLE_REGISTERED_LETTER` - Invio di raccomandata semplice\n * `SEND_SIMPLE_REGISTERED_LETTER_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea semplice\n * `NOTIFICATION_VIEWED_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di presa visione a safe storage\n * `NOTIFICATION_VIEWED` - Visualizzazione della notifica (perfeziona la notifica se non già perfezionata per decorrenza termini o da altro destinatario)\n * `PREPARE_ANALOG_DOMICILE` - Invio richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `SEND_ANALOG_DOMICILE` - Invio cartaceo dell’avviso di notifica\n * `SEND_ANALOG_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea\n * `SEND_ANALOG_FEEDBACK` - Ricezione esito dell'invio cartaceo\n * `COMPLETELY_UNREACHABLE_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto (simile a opponibile a terzi) di completamento con fallimento del workflow di invio cartaceo\n * `COMPLETELY_UNREACHABLE` - Tutti i destinatari risultano irraggiungibili\n * `AAR_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'AAR (Avviso di Avvenuta Ricezione) a safe storage\n * `AAR_GENERATION` - Generazione dell’AAR (Avviso di Avvenuta Ricezione)\n * `PAYMENT` - Evento di ricezione __dal mittente__ dell'informazione di chiusura di uno o più pagamenti di tipo pagoPA (vedi #/components/schemas/PagoPaPayment). La presenza di questo evento inibisce l'invio di eventuali comunicazioni analogiche future ma non perfeziona la notifica.\n * `NOT_HANDLED` - [DEPRECATO] Per la sperimentazione l'invio analogico non è previsto, viene inserito tale elemento di timeline\n * `PROBABLE_SCHEDULING_ANALOG_DATE` - Data probabile di inizio del flusso analogico\n * `NOTIFICATION_CANCELLATION_REQUEST` - Richiesta di annullamento di una notifica\n * `NOTIFICATION_CANCELLED` - Notifica annullata\n * `PREPARE_ANALOG_DOMICILE_FAILURE` - Fallimento della richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `NOTIFICATION_RADD_RETRIEVED` - Accesso alla notifica tramite la rete RADD. Non perfeziona la notifica.\n * `ANALOG_WORKFLOW_RECIPIENT_DECEASED` - Destinatario deceduto\n * `PUBLIC_REGISTRY_VALIDATION_CALL` - Ricerca dell'indirizzo di spedizione in fase di validazione notifica\n * `PUBLIC_REGISTRY_VALIDATION_RESPONSE` - Recupero dell'indirizzo di spedizione dai registri nazionali\n"
enum:
- SENDER_ACK_CREATION_REQUEST
- VALIDATE_NORMALIZE_ADDRESSES_REQUEST
- NORMALIZED_ADDRESS
- REQUEST_ACCEPTED
- SEND_COURTESY_MESSAGE
- GET_ADDRESS
- PUBLIC_REGISTRY_CALL
- PUBLIC_REGISTRY_RESPONSE
- SCHEDULE_ANALOG_WORKFLOW
- SCHEDULE_DIGITAL_WORKFLOW
- PREPARE_DIGITAL_DOMICILE
- SEND_DIGITAL_DOMICILE
- SEND_DIGITAL_PROGRESS
- SEND_DIGITAL_FEEDBACK
- REFINEMENT
- SCHEDULE_REFINEMENT
- DIGITAL_DELIVERY_CREATION_REQUEST
- DIGITAL_SUCCESS_WORKFLOW
- DIGITAL_FAILURE_WORKFLOW
- ANALOG_SUCCESS_WORKFLOW
- ANALOG_FAILURE_WORKFLOW
- PREPARE_SIMPLE_REGISTERED_LETTER
- SEND_SIMPLE_REGISTERED_LETTER
- SEND_SIMPLE_REGISTERED_LETTER_PROGRESS
- NOTIFICATION_VIEWED_CREATION_REQUEST
- NOTIFICATION_VIEWED
- PREPARE_ANALOG_DOMICILE
- SEND_ANALOG_DOMICILE
- SEND_ANALOG_PROGRESS
- SEND_ANALOG_FEEDBACK
- PAYMENT
- COMPLETELY_UNREACHABLE
- COMPLETELY_UNREACHABLE_CREATION_REQUEST
- REQUEST_REFUSED
- AAR_CREATION_REQUEST
- AAR_GENERATION
- NOT_HANDLED
- PROBABLE_SCHEDULING_ANALOG_DATE
- NOTIFICATION_CANCELLATION_REQUEST
- NOTIFICATION_CANCELLED
- PREPARE_ANALOG_DOMICILE_FAILURE
- NOTIFICATION_RADD_RETRIEVED
- ANALOG_WORKFLOW_RECIPIENT_DECEASED
- PUBLIC_REGISTRY_VALIDATION_CALL
- PUBLIC_REGISTRY_VALIDATION_RESPONSE
NotificationPaidDetailsV23:
type: object
required:
- recIndex
- recipientType
- paymentSourceChannel
properties:
recIndex:
type: integer
description: Index destinatario che ha effettuato il pagamento della notifica
format: int32
recipientType:
$ref: '#/components/schemas/RecipientType'
amount:
type: integer
description: Importo di pagamento in eurocent
format: int32
creditorTaxId:
$ref: '#/components/schemas/paTaxId'
noticeCode:
$ref: '#/components/schemas/noticeCode'
idF24:
type: string
description: un UUID che identifica un pagamento f24
maxLength: 512
paymentSourceChannel:
type: string
description: Canale sorgente della richiesta di pagamento
maxLength: 512
uncertainPaymentDate:
deprecated: true
type: boolean
description: Indica se la data di pagamento é certa
eventTimestamp:
type: string
description: Data evento pagamento
format: date-time
ProgressResponseElementV24:
type: object
required:
- eventId
- element
properties:
eventId:
description: Elemento che garantisce univocità e ordinamento temporale all'interno dello stream
type: string
notificationRequestId:
description: Identificativo della richiesta di notifica
type: string
iun:
description: Identificativo della notifica, presente solo se la richiesta di notifica è stata accettata.
type: string
maxLength: 25
pattern: ^[A-Z]{4}-[A-Z]{4}-[A-Z]{4}-[0-9]{6}-[A-Z]{1}-[0-9]{1}$
newStatus:
$ref: '#/components/schemas/NotificationStatus'
element:
$ref: '#/components/schemas/TimelineElementV24'
ProgressResponseV25:
type: array
items:
$ref: '#/components/schemas/ProgressResponseElementV25'
NotificationRefusedErrorV27:
type: object
properties:
errorCode:
type: string
maxLength: 128
description: "Errori di rifiuto della notifica.\n - FILE_NOTFOUND - I riferimenti dei documenti nella notifica non sono corretti o i documenti non sono stati caricati con successo.\n - FILE_GONE - Allegato non disponibile: superati i termini di conservazione\n - FILE_SHA_ERROR - Il digest calcolato con algoritmi sha256 dei documenti inseriti non è corrispondete a quello del file referenziato.\n - FILE_PDF_INVALID_ERROR - Il file inserito non è in formato pdf.\n - FILE_PDF_TOOBIG_ERROR - Il file pdf ha una dimensione eccedente il limite di 200MB.\n - F24_METADATA_NOT_VALID - I dati contenuti del file dei metadati F24 non rispettano lo schema di validazione.\n - TAXID_NOT_VALID - Codice fiscale del destinatario non corretto (non ancora implementato).\n - RECIPIENT_ID_NOT_VALID - Destinatario non Valido (utilizzato solo per funzionalità non ancora implementate)\n - NOT_VALID_ADDRESS - L'indirizzo di invio cartaceo inserito per il destinatario non ha superato i controlli di correttezza.\n - PAYMENT_NOT_VALID - I dati del pagamento non sono sono registrati sulla piattaforma GPD (modalità asincrona di integrazione pagoPA)\n - SERVICE_UNAVAILABLE - Il sistema non è attualmente disponibile.\n - ADDRESS_NOT_FOUND - La ricerca dell’indirizzo effettuata con il servizio di LookupAddress non ha prodotto risultati.\n - ADDRESS_SEARCH_FAILED - C'è stato un problema con la ricerca dell'indirizzo effettuata con il servizio di LookupAddess.\n ..."
detail:
type: string
maxLength: 2048
recIndex:
type: integer
description: Index destinatario notifica digitale con errore che ha portato al rifiuto della notifica
format: int32
DigitalAddressSource:
type: string
description: sorgente indirizzo di invio della notifica
enum:
- PLATFORM
- SPECIAL
- GENERAL
RefusedReason:
type: object
properties:
errorCode:
type: string
detail:
type: string
SendDigitalProgressDetailsV23:
type: object
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
deliveryFailureCause:
description: Codice errore, opzionale
type: string
deliveryDetailCode:
type: string
description: Vedi deliveryDetailCode in SendDigitalFeedbackDetails
shouldRetry:
type: boolean
description: indica se il progress ha dato luogo ad un ritentativo
digitalAddress:
$ref: '#/components/schemas/DigitalAddress'
digitalAddressSource:
$ref: '#/components/schemas/DigitalAddressSource'
notificationDate:
type: string
description: data notifica
format: date-time
sendingReceipts:
type: array
items:
$ref: '#/components/schemas/SendingReceipt'
retryNumber:
type: integer
description: numero dei tentativi effettuati
format: int32
eventTimestamp:
type: string
description: Data evento
format: date-time
SendAnalogFeedbackDetails:
type: object
required:
- recIndex
- physicalAddress
- serviceLevel
- sentAttemptMade
- responseStatus
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
physicalAddress:
$ref: '#/components/schemas/PhysicalAddress'
serviceLevel:
$ref: '#/components/schemas/ServiceLevel'
sentAttemptMade:
type: integer
description: numero dei tentativi effettuati
format: int32
newAddress:
$ref: '#/components/schemas/PhysicalAddress'
responseStatus:
$ref: '#/components/schemas/ResponseStatus'
notificationDate:
type: string
format: date-time
deliveryFailureCause:
type: string
maxLength: 10
description: "__Motivazione di mancata consegna__ obbligatorie negli stati di mancata consegna\n - __M01__ destinatario irreperibile\n - __M02__ destinatario deceduto\n - __M03__ destinatario sconosciuto\n - __M04__ destinatario trasferito\n - __M05__ invio rifiutato\n - __M06__ indirizzo inesatto\n - __M07__ indirizzo inesistente\n - __M08__ indirizzo insufficiente\n - __F01__ - in caso di furto\n - __F02__ - in caso di smarrimento\n - __F03__ - in caso di deterioramento\n"
deliveryDetailCode:
type: string
maxLength: 20
description: "Formato: - __deliveryDetailCode__- [prodotto] - [statusCode] - statusDescription\n - __CON080__- [ALL] - [PROGRESS] - Stampato ed Imbustato\n - __RECRS001C__- [RS] - [OK] - Consegnato - Fascicolo Chiuso\n - __RECRS002C__- [RS] - [KO] - Mancata consegna - Fascicolo Chiuso\n - __RECRS002F__- [RS] - [KO] - Irreperibilità Assoluta - Fascicolo Chiuso\n - __RECRS003C__- [RS] - [OK] - Consegnato presso Punti di Giacenza - Fascicolo Chiuso\n - __RECRS004C__- [RS] - [OK] - Mancata consegna presso Punti di Giacenza - Fascicolo Chiuso\n - __RECRS005C__- [RS] - [OK] - Compiuta giacenza - Fascicolo Chiuso\n - __RECRS006__- [RS] - [PROGRESS] - Furto/Smarrimento/deterioramento\n - __RECRN001C__- [AR] - [OK] - Consegnato - Fascicolo Chiuso\n - __RECRN002C__- [AR] - [KO] - Mancata consegna - Fascicolo Chiuso\n - __RECRN002F__- [AR] - [KO] - Irreperibilità Assoluta - Fascicolo Chiuso\n - __RECRN003C__- [AR] - [OK] - Consegnato presso Punti di Giacenza - Fascicolo Chiuso\n - __RECRN004C__- [AR] - [KO] - Mancata consegna presso Punti di Giacenza - Fascicolo Chiuso\n - __RECRN005C__- [AR] - [OK] - Compiuta giacenza - Fascicolo Chiuso\n - __RECRN006__- [AR] - [PROGRESS] - Furto/Smarrimento/deterioramento\n - __RECAG001C__- [890] - [OK] - Consegnato - Fascicolo Chiuso\n - __RECAG002C__- [890] - [OK] - Consegnato a persona abilitata - Fascicolo Chiuso\n - __RECAG003C__- [890] - [KO] - Mancata consegna - Fascicolo Chiuso\n - __RECAG003F__- [890] - [KO] - Irreperibilità Assoluta - Fascicolo Chiuso\n - __RECAG004__- [890] - [PROGRESS] - Furto/Smarrimento/deterioramento\n - __RECAG005C__- [890] - [OK | PROGRESS] - Consegnato presso Punti di Giacenza - Fascicolo Chiuso\n - __RECAG006C__- [890] - [OK | PROGRESS] - Consegna a persona abilitata presso Punti di Giacenza - Fas. Ch.\n - __RECAG007C__- [890] - [KO | PROGRESS] - Mancata consegna presso Punti di Giacenza - Fascicolo Chiuso\n - __RECAG008C__- [890] - [PROGRESS] - Compiuta giacenza - Fascicolo Chiuso\n - __PNAG012__- [890] - [KO] - Distacco d'ufficio 23L - Fascicolo Chiuso\n - __RECRI003C__- [RIR] - [OK] - Consegnato - Fascicolo Chiuso\n - __RECRI004C__- [RIR] - [KO] - Non Consegnato - fascicolo Chiuso\n - __RECRI005__- [RIR] - [PROGRESS] - Furto/Smarrimento/deterioramento\n - __RECRSI003C__- [RIS] - [OK] - Consegnato - Fascicolo Chiuso\n - __RECRSI004C__- [RIS] - [KO] - Non Consegnato - fascicolo Chiuso\n - __RECRSI005__- [RIS] - [PROGRESS] - Furto/Smarrimento/deterioramento\n"
attachments:
type: array
items:
$ref: '#/components/schemas/AttachmentDetails'
sendRequestId:
type: string
description: RequestId della richiesta d'invio
maxLength: 512
registeredLetterCode:
type: string
description: Codice della raccomandata
maxLength: 128
PublicRegistryCallDetails:
type: object
required:
- recIndex
- deliveryMode
- contactPhase
- sentAttemptMade
- sendDate
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
deliveryMode:
$ref: '#/components/schemas/DeliveryMode'
contactPhase:
$ref: '#/components/schemas/ContactPhase'
sentAttemptMade:
type: integer
description: Numero di tentativi di notificazione già effettuati
format: int32
sendDate:
type: string
description: Data invio richiesta ai public registry
format: date-time
TimelineElementV24:
type: object
additionalProperties: false
properties:
elementId:
type: string
maxLength: 512
description: 'Identificativo dell''elemento di timeline: insieme allo IUN della notifica definisce in maniera univoca l''elemento di timeline'
timestamp:
type: string
deprecated: true
description: Istante in cui avviene l'evento descritto in questo elemento di timeline (deprecato, fare riferimento al campo eventTimestamp)
format: date-time
ingestionTimestamp:
type: string
description: Istante in cui l'evento descritto in questo elemento di timeline è gestito da SEND
format: date-time
eventTimestamp:
type: string
description: Istante in cui avviene l'evento descritto in questo elemento di timeline
format: date-time
notificationSentAt:
type: string
description: Momento di ricezione della richiesta di notifica da parte di SEND
format: date-time
legalFactsIds:
type: array
items:
$ref: '#/components/schemas/LegalFactsId'
description: Chiavi dei documenti che provano l'effettivo accadimento dell'evento descritto in timeline. Questo elemento
category:
$ref: '#/components/schemas/TimelineElementCategoryV23'
details:
$ref: '#/components/schemas/TimelineElementDetailsV23'
CompletelyUnreachableCreationRequestDetails:
type: object
required:
- recIndex
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
legalfactId:
type: string
maxLength: 128
description: Identificativo dell'atto opponibile a terzi del quale è stata richiesta la creazione
endWorkflowStatus:
$ref: '#/components/schemas/EndWorkflowStatus'
completionWorkflowDate:
type: string
description: Data chiusura workflow
format: date-time
NotificationViewedCreationRequestDetailsV28:
type: object
required:
- recIndex
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
legalFactId:
type: string
maxLength: 128
description: Identificativo dell'atto opponibile a terzi del quale è stata richiesta la creazione
eventTimestamp:
type: string
description: Data ricezione richiesta visualizzazione notifica
format: date-time
raddType:
$ref: '#/components/schemas/RaddTypeV23'
raddTransactionId:
$ref: '#/components/schemas/RaddTransactionId'
delegateInfo:
$ref: '#/components/schemas/DelegateInfo'
ProbableDateAnalogWorkflowDetails:
type: object
required:
- recIndex
- schedulingAnalogDate
properties:
recIndex:
type: integer
description: Index destinatario che ha effettuato il pagamento della notifica
format: int32
schedulingAnalogDate:
type: string
format: date-time
description: Data probabile di inizio del flusso analogico
PublicRegistryValidationCallDetails:
type: object
required:
- recIndexes
- deliveryMode
- sendDate
properties:
recIndexes:
description: Lista destinatari notifica
type: array
items:
type: integer
format: int32
deliveryMode:
$ref: '#/components/schemas/DeliveryMode'
sendDate:
type: string
description: Data invio richiesta ai public registry
format: date-time
ProgressResponse:
type: array
items:
$ref: '#/components/schemas/ProgressResponseElement'
PrepareDigitalDetails:
type: object
required:
- recIndex
- digitalAddressSource
- retryNumber
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
digitalAddress:
$ref: '#/components/schemas/DigitalAddress'
digitalAddressSource:
$ref: '#/components/schemas/DigitalAddressSource'
retryNumber:
type: integer
description: numero dei tentativi effettuati
format: int32
attemptDate:
type: string
description: data tentativo precedente
format: date-time
nextDigitalAddressSource:
$ref: '#/components/schemas/DigitalAddressSource'
nextSourceAttemptsMade:
type: integer
description: numero del prossimo tentativo da effettuare
format: int32
nextLastAttemptMadeForSource:
type: string
description: data tentativo precedente per prossimo source
format: date-time
ProgressResponseV29:
type: array
items:
$ref: '#/components/schemas/ProgressResponseElementV29'
AttachmentDetails:
type: object
properties:
id:
type: string
maxLength: 128
documentType:
type: string
maxLength: 20
description: 'Codici documentType: - Plico: Indica il plico cartaceo - AR: Indica la ricevuta di ritorno - Indagine: Indica la ricevuta dell''analisi dell''indagine - 23L: Indica la ricevuta 23L
'
url:
type: string
maxLength: 128
date:
type: string
format: date-time
ScheduleDigitalWorkflowDetailsV23:
type: object
required:
- recIndex
- digitalAddressSource
- sentAttemptMade
- lastAttemptDate
properties:
recIndex:
type: integer
description: Index destinatario notifica digitale
format: int32
digitalAddress:
$ref: '#/components/schemas/DigitalAddress'
digitalAddressSource:
$ref: '#/components/schemas/DigitalAddressSource'
sentAttemptMade:
type: integer
format: int32
lastAttemptDate:
type: string
format: date-time
schedulingDate:
type: string
description: Data prevista prossimo tentativo d'invio digitale per quella specifica sorgente di indirizzo
format: date-time
SenderAckCreationRequestDetails:
type: object
properties:
legalFactId:
type: string
maxLength: 128
description: Identificativo dell'atto opponibile a terzi del quale è stata richiesta la creazione
SendingReceipt:
type: object
properties:
id:
type: string
description: messageId del server mittente
maxLength: 1024
system:
type: string
description: nome del server mittente
maxLength: 128
LegalFactCategoryV20:
title: Tipi di atti opponibili a terzi
description: "Tipi di atti opponibili a terzi che Piattaforma Notifiche mette a disposizione dei suoi utenti.
\n - SENDER_ACK
\n - DIGITAL_DELIVERY
\n - ANALOG_DELIVERY
\n - RECIPIENT_ACCESS
\n - PEC_RECEIPT
\n - ANALOG_FAILURE_DELIVERY
\n - NOTIFICATION_CANCELLED
"
type: string
ProducerDelegationEvent_2:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- PRODUCER_DELEGATION_APPROVED
- PRODUCER_DELEGATION_REVOKED
- PRODUCER_DELEGATION_REJECTED
- PRODUCER_DELEGATION_SUBMITTED
- DELEGATION_CONTRACT_GENERATED
eventTimestamp:
type: string
format: date-time
delegationId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp
- delegationId
ConsumerDelegationEvent_2:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- CONSUMER_DELEGATION_APPROVED
- CONSUMER_DELEGATION_REVOKED
- CONSUMER_DELEGATION_REJECTED
- CONSUMER_DELEGATION_SUBMITTED
- DELEGATION_CONTRACT_GENERATED
eventTimestamp:
type: string
format: date-time
delegationId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp
- delegationId
EServiceTemplateEvent_2:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- ESERVICE_TEMPLATE_DELETED
- ESERVICE_TEMPLATE_VERSION_ACTIVATED
- ESERVICE_TEMPLATE_ADDED
- ESERVICE_TEMPLATE_INTENDED_TARGET_UPDATED
- ESERVICE_TEMPLATE_DESCRIPTION_UPDATED
- ESERVICE_TEMPLATE_DRAFT_VERSION_DELETED
- ESERVICE_TEMPLATE_DRAFT_VERSION_UPDATED
- ESERVICE_TEMPLATE_DRAFT_UPDATED
- ESERVICE_TEMPLATE_NAME_UPDATED
- ESERVICE_TEMPLATE_RISK_ANALYSIS_ADDED
- ESERVICE_TEMPLATE_RISK_ANALYSIS_DELETED
- ESERVICE_TEMPLATE_RISK_ANALYSIS_UPDATED
- ESERVICE_TEMPLATE_VERSION_SUSPENDED
- ESERVICE_TEMPLATE_VERSION_ADDED
- ESERVICE_TEMPLATE_VERSION_ATTRIBUTES_UPDATED
- ESERVICE_TEMPLATE_VERSION_DOCUMENT_ADDED
- ESERVICE_TEMPLATE_VERSION_DOCUMENT_DELETED
- ESERVICE_TEMPLATE_VERSION_DOCUMENT_UPDATED
- ESERVICE_TEMPLATE_VERSION_INTERFACE_ADDED
- ESERVICE_TEMPLATE_VERSION_INTERFACE_DELETED
- ESERVICE_TEMPLATE_VERSION_INTERFACE_UPDATED
- ESERVICE_TEMPLATE_VERSION_PUBLISHED
- ESERVICE_TEMPLATE_VERSION_QUOTAS_UPDATED
- ESERVICE_TEMPLATE_PERSONAL_DATA_FLAG_UPDATED_AFTER_PUBLICATION
eventTimestamp:
type: string
format: date-time
eserviceTemplateId:
type: string
format: uuid
eserviceTemplateVersionId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp - eserviceTemplateId
PurposeEvent_2:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- DRAFT_PURPOSE_DELETED
- WAITING_FOR_APPROVAL_PURPOSE_DELETED
- PURPOSE_DELETED_BY_REVOKED_DELEGATION
- PURPOSE_ADDED
- DRAFT_PURPOSE_UPDATED
- NEW_PURPOSE_VERSION_ACTIVATED
- NEW_PURPOSE_VERSION_WAITING_FOR_APPROVAL
- PURPOSE_ACTIVATED
- PURPOSE_ARCHIVED
- PURPOSE_VERSION_OVER_QUOTA_UNSUSPENDED
- PURPOSE_VERSION_REJECTED
- PURPOSE_VERSION_SUSPENDED_BY_CONSUMER
- PURPOSE_VERSION_SUSPENDED_BY_PRODUCER
- PURPOSE_VERSION_UNSUSPENDED_BY_CONSUMER
- PURPOSE_VERSION_UNSUSPENDED_BY_PRODUCER
- PURPOSE_WAITING_FOR_APPROVAL
- WAITING_FOR_APPROVAL_PURPOSE_VERSION_DELETED
- PURPOSE_VERSION_ACTIVATED
- PURPOSE_CLONED
- PURPOSE_VERSION_ARCHIVED_BY_REVOKED_DELEGATION
- RISK_ANALYSIS_DOCUMENT_GENERATED
eventTimestamp:
type: string
format: date-time
purposeId:
type: string
format: uuid
purposeVersionId:
type: string
format: uuid
consumerDelegationId:
type: string
format: uuid
producerDelegationId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp
- purposeId
ProducerKeychainEvent_2:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- PRODUCER_KEYCHAIN_ADDED
- PRODUCER_KEYCHAIN_DELETED
- PRODUCER_KEYCHAIN_ESERVICE_ADDED
- PRODUCER_KEYCHAIN_ESERVICE_REMOVED
eventTimestamp:
type: string
format: date-time
producerKeychainId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp
- producerKeychainId
AgreementEvent_2:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- AGREEMENT_ADDED
- DRAFT_AGREEMENT_UPDATED
- AGREEMENT_DELETED
- AGREEMENT_ACTIVATED
- AGREEMENT_REJECTED
- AGREEMENT_UPGRADED
- AGREEMENT_SUBMITTED
- AGREEMENT_ARCHIVED_BY_CONSUMER
- AGREEMENT_SUSPENDED_BY_CONSUMER
- AGREEMENT_UNSUSPENDED_BY_CONSUMER
- AGREEMENT_SUSPENDED_BY_PRODUCER
- AGREEMENT_UNSUSPENDED_BY_PRODUCER
- AGREEMENT_SUSPENDED_BY_PLATFORM
- AGREEMENT_UNSUSPENDED_BY_PLATFORM
- AGREEMENT_ARCHIVED_BY_UPGRADE
- AGREEMENT_CONSUMER_DOCUMENT_ADDED
- AGREEMENT_CONSUMER_DOCUMENT_REMOVED
- AGREEMENT_ARCHIVED_BY_REVOKED_DELEGATION
- AGREEMENT_DELETED_BY_REVOKED_DELEGATION
- AGREEMENT_SET_MISSING_CERTIFIED_ATTRIBUTES_BY_PLATFORM
- AGREEMENT_SET_DRAFT_BY_PLATFORM
- AGREEMENT_CONTRACT_GENERATED
eventTimestamp:
type: string
format: date-time
agreementId:
type: string
format: uuid
consumerDelegationId:
type: string
format: uuid
producerDelegationId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp
- agreementId
ClientEvent_2:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- CLIENT_ADDED
- CLIENT_DELETED
- CLIENT_PURPOSE_ADDED
- CLIENT_PURPOSE_REMOVED
eventTimestamp:
type: string
format: date-time
clientId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp
- clientId
EServiceEvent_2:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- ESERVICE_ADDED
- DRAFT_ESERVICE_UPDATED
- ESERVICE_CLONED
- ESERVICE_DELETED
- ESERVICE_DESCRIPTOR_PUBLISHED
- ESERVICE_DESCRIPTOR_ACTIVATED
- ESERVICE_DESCRIPTOR_APPROVED_BY_DELEGATOR
- ESERVICE_DESCRIPTOR_SUSPENDED
- ESERVICE_DESCRIPTOR_ARCHIVED
- ESERVICE_DESCRIPTOR_ADDED
- ESERVICE_DRAFT_DESCRIPTOR_DELETED
- ESERVICE_DRAFT_DESCRIPTOR_UPDATED
- ESERVICE_DESCRIPTOR_SUBMITTED_BY_DELEGATE
- ESERVICE_DESCRIPTOR_REJECTED_BY_DELEGATOR
- ESERVICE_DESCRIPTOR_DOCUMENT_ADDED
- ESERVICE_DESCRIPTOR_DOCUMENT_UPDATED
- ESERVICE_DESCRIPTOR_DOCUMENT_DELETED
- ESERVICE_DESCRIPTOR_INTERFACE_ADDED
- ESERVICE_DESCRIPTOR_INTERFACE_UPDATED
- ESERVICE_DESCRIPTOR_INTERFACE_DELETED
- ESERVICE_RISK_ANALYSIS_ADDED
- ESERVICE_RISK_ANALYSIS_UPDATED
- ESERVICE_RISK_ANALYSIS_DELETED
- ESERVICE_NAME_UPDATED
- ESERVICE_DESCRIPTION_UPDATED
- ESERVICE_IS_CONSUMER_DELEGABLE_ENABLED
- ESERVICE_IS_CONSUMER_DELEGABLE_DISABLED
- ESERVICE_IS_CLIENT_ACCESS_DELEGABLE_ENABLED
- ESERVICE_IS_CLIENT_ACCESS_DELEGABLE_DISABLED
- ESERVICE_SIGNAL_HUB_ENABLED
- ESERVICE_SIGNAL_HUB_DISABLED
- ESERVICE_DESCRIPTOR_ATTRIBUTES_UPDATED
- ESERVICE_DESCRIPTOR_QUOTAS_UPDATED
- ESERVICE_DESCRIPTOR_AGREEMENT_APPROVAL_POLICY_UPDATED
- ESERVICE_PERSONAL_DATA_FLAG_UPDATED_AFTER_PUBLICATION
- ESERVICE_NAME_UPDATED_BY_TEMPLATE_UPDATE
- ESERVICE_DESCRIPTION_UPDATED_BY_TEMPLATE_UPDATE
- ESERVICE_PERSONAL_DATA_FLAG_UPDATED_BY_TEMPLATE_UPDATE
- ESERVICE_DESCRIPTOR_ATTRIBUTES_UPDATED_BY_TEMPLATE_UPDATE
- ESERVICE_DESCRIPTOR_DOCUMENT_ADDED_BY_TEMPLATE_UPDATE
- ESERVICE_DESCRIPTOR_DOCUMENT_DELETED_BY_TEMPLATE_UPDATE
- ESERVICE_DESCRIPTOR_DOCUMENT_UPDATED_BY_TEMPLATE_UPDATE
- ESERVICE_DESCRIPTOR_QUOTAS_UPDATED_BY_TEMPLATE_UPDATE
eventTimestamp:
type: string
format: date-time
eserviceId:
type: string
format: uuid
descriptorId:
type: string
format: uuid
producerDelegationId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp
- eserviceId
KeyEvent_2:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- CLIENT_KEY_ADDED
- CLIENT_KEY_DELETED
eventTimestamp:
type: string
format: date-time
kid:
type: string
clientId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp
- kid
- clientId
AttributeEvent_2:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- ATTRIBUTE_ADDED
eventTimestamp:
type: string
format: date-time
attributeId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp
- attributeId
ProducerKeyEvent_2:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- PRODUCER_KEYCHAIN_KEY_ADDED
- PRODUCER_KEYCHAIN_KEY_DELETED
eventTimestamp:
type: string
format: date-time
kid:
type: string
producerKeychainId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp
- kid
- producerKeychainId
TenantEvent_2:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- MAINTENANCE_TENANT_DELETED
- TENANT_PROMOTED_TO_CERTIFIER
- MAINTENANCE_TENANT_UPDATED
- TENANT_CERTIFIED_ATTRIBUTE_ASSIGNED
- TENANT_CERTIFIED_ATTRIBUTE_REVOKED
- TENANT_DECLARED_ATTRIBUTE_ASSIGNED
- TENANT_DECLARED_ATTRIBUTE_REVOKED
- TENANT_DELEGATED_CONSUMER_FEATURE_ADDED
- TENANT_DELEGATED_CONSUMER_FEATURE_REMOVED
- TENANT_DELEGATED_PRODUCER_FEATURE_ADDED
- TENANT_DELEGATED_PRODUCER_FEATURE_REMOVED
- TENANT_KIND_UPDATED
- TENANT_MAIL_ADDED
- TENANT_MAIL_DELETED
- TENANT_ONBOARD_DETAILS_UPDATED
- TENANT_ONBOARDED
- TENANT_VERIFIED_ATTRIBUTE_ASSIGNED
- TENANT_VERIFIED_ATTRIBUTE_EXPIRATION_UPDATED
- TENANT_VERIFIED_ATTRIBUTE_EXTENSION_UPDATED
- TENANT_VERIFIED_ATTRIBUTE_REVOKED
eventTimestamp:
type: string
format: date-time
tenantId:
type: string
format: uuid
required:
- id
- eventType
- eventTimestamp
- tenantId
ProblemError_3:
properties:
code:
description: Internal code of the error, in human-readable format
example: PN_PARAMETER_TOO_LONG | PN_PARAMETER_TOO_SHORT | PN_DUPLICATE_ENTRY | etc...
type: string
element:
description: Parameter or request body field name for validation error
example: body.order.item[2].quantity
type: string
detail:
description: A human readable explanation specific to this occurrence of the problem.
example: Parameter not valid
maxLength: 1024
type: string
required:
- code
Problem_3:
properties:
type:
description: URI reference of type definition
type: string
status:
description: The HTTP status code generated by the origin server for this occurrence of the problem.
type: integer
format: int32
example: 503
minimum: 100
exclusiveMaximum: 600
title:
description: A short, summary of the problem type. Written in english and readable
example: Service Unavailable
maxLength: 64
pattern: ^[ -~]{0,64}$
type: string
detail:
description: A human readable explanation of the problem.
example: Request took too long to complete.
maxLength: 4096
pattern: ^.{0,4096}$
type: string
traceId:
description: Internal support identifier associated to error
example: 123e4567-e89b-12d3-a456-426614174000
type: string
timestamp:
description: date and time referred to UTC
example: '2022-07-27T12:22:33.444Z'
type: string
format: date-time
errors:
type: array
minItems: 1
items:
$ref: '#/components/schemas/ProblemError_3'
required:
- status
- errors
parameters:
LastEventId:
in: query
name: lastEventId
description: 'ID of the last event already received.
Only events that occurred after this ID will be returned.
If not provided, the oldest events up to the specified limit will be returned.
'
schema:
type: string
format: uuid
EventsLimit:
in: query
name: limit
required: true
description: Maximum number of events to return.
schema:
type: integer
format: int32
minimum: 1
maximum: 500
EventsDelegationId:
in: query
name: delegationId
description: "Filter events by delegation ID.\n- Omitted: Return all events, both for delegated and non-delegated resources.\n- Delegation UUID: Return only events for resources related to the specified delegation.\n- null: Return only events for resources accessible without delegation\n (public resources, resources accessible as consumer/producer, owned resources, etc.)\n"
required: false
schema:
type:
- string
- 'null'
format: uuid
pathStreamId:
description: Identificativo dello stream di eventi
name: streamId
in: path
required: true
schema:
type: string
format: uuid
queryLastEventId:
description: Identificativo dell'ultimo evento memorizzato dal chiamante, se non passato si intende dal primo evento presente nello stream. Numero in una stringa di 38 caratteri con padding iniziale composto da '0'.
name: lastEventId
in: query
required: false
schema:
type: string
minLength: 38
maxLength: 38
pattern: ^0\d{37}$
headers:
IntegrityRest02AgidJwtSignatureHeader:
description: 'The `Agid-JWT-Signature` header contains a JSON Web Signature (JWS) signed with the PDND API private key.
It ensures payload integrity and non-repudiation across all responses (both success and error), in compliance with: 1) Linee Guida sull''interoperabilità tecnica delle Pubbliche Amministrazioni - Pattern di sicurezza, 2) RFC 7515 and 3) RFC 7519.
'
schema:
type: string
RateLimitRemainingHeader:
schema:
type: integer
format: int32
minimum: 0
description: Remaining requests within time interval
RateLimitIntervalHeader:
schema:
type: integer
format: int32
minimum: 0
description: Time interval in milliseconds. Allowed requests will be constantly replenished during the interval. At the end of the interval the max allowed requests will be available
RateLimitLimitHeader:
schema:
type: integer
format: int32
minimum: 0
description: Max allowed requests within time interval
IntegrityRest02DigestHeader:
schema:
type: string
pattern: ^SHA-256=[a-zA-Z0-9+/]{43}=$
description: 'Digest of the body using the canonical JSON representation of the response body.
The digest is calculated using the SHA-256 algorithm on the response body
exactly as it is sent to the client, encoded in Base64 as per RFC 3230
'
responses:
Forbidden:
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/RateLimitLimitHeader'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/RateLimitRemainingHeader'
X-Rate-Limit-Interval:
$ref: '#/components/headers/RateLimitIntervalHeader'
Digest:
$ref: '#/components/headers/IntegrityRest02DigestHeader'
Agid-JWT-Signature:
$ref: '#/components/headers/IntegrityRest02AgidJwtSignatureHeader'
Unauthorized:
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/RateLimitLimitHeader'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/RateLimitRemainingHeader'
X-Rate-Limit-Interval:
$ref: '#/components/headers/RateLimitIntervalHeader'
Digest:
$ref: '#/components/headers/IntegrityRest02DigestHeader'
Agid-JWT-Signature:
$ref: '#/components/headers/IntegrityRest02AgidJwtSignatureHeader'
BadRequest:
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/RateLimitLimitHeader'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/RateLimitRemainingHeader'
X-Rate-Limit-Interval:
$ref: '#/components/headers/RateLimitIntervalHeader'
Digest:
$ref: '#/components/headers/IntegrityRest02DigestHeader'
Agid-JWT-Signature:
$ref: '#/components/headers/IntegrityRest02AgidJwtSignatureHeader'
TooManyRequests:
description: Too Many Requests
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/RateLimitLimitHeader'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/RateLimitRemainingHeader'
X-Rate-Limit-Interval:
$ref: '#/components/headers/RateLimitIntervalHeader'
Digest:
$ref: '#/components/headers/IntegrityRest02DigestHeader'
Agid-JWT-Signature:
$ref: '#/components/headers/IntegrityRest02AgidJwtSignatureHeader'
securitySchemes:
DPoPAuth:
type: http
scheme: DPoP
description: 'This Authorization header must be used alongside the DPoP Proof JWT.
Use:
Authorization: DPoP
The access token generated must also have a cnf field.
'
DPoPProofHeader:
type: apiKey
in: header
name: DPoP
description: 'DPoP proof JWT for sender-constrained access. Must accompany the DPoP Authorization header.
'
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
x-refined-from:
- interop-api-v3.yaml
- send-b2b-pa-bundle.yaml
- pagopa-pdnd-interop-v2-openapi.yml
- pagopa-pdnd-interop-v3-openapi.yml
- pagopa-send-b2b-pa-openapi.yml