Tabella dei contenuti
Purpose
This section illustrates the concepts and operations related to the purpose within the PDND APIs. For the functional context and lifecycle of purposes on the platform, refer to the dedicated section.
Purpose versions and load estimate management
A Purpose may include multiple versions:
- currentVersion: if present, it is ACTIVE or SUSPENDED;
- waitingForApprovalVersion: if present, it is WAITING_FOR_APPROVAL;
- rejectedVersion: if present, it is the last REJECTED version.
Other possible versions:
- ARCHIVED: contains a previous load estimate;
- REJECTED: version whose load estimate was rejected by the producer.
Each modification of the load estimate always creates a new version of the Purpose.
If the estimate is below the thresholds defined in the e-service version (EServiceDescriptor), or if it is approved by the producer, the previous version of the Purpose is archived.
If the estimate is below the thresholds defined in the e-service version (EServiceDescriptor), or if it is approved by the producer, the previous version of the Purpose is archived.
States and transitions — Overview
| State | Description | Outgoing transitions |
|---|---|---|
| DRAFT | Initial state of the first version of a newly created Purpose. | → ACTIVE (estimate ≤ thresholds in the EServiceDescriptor); → WAITING_FOR_APPROVAL (estimate > thresholds in the EServiceDescriptor); → deletion. |
| WAITING_FOR_APPROVAL | Load estimate above thresholds and waiting for approval by the producer. The currentVersion (if ACTIVE) remains available for voucher generation; once approved, the new version becomes active and archives the previous one. Deletion and rejection do not affect the current version. | → ACTIVE (estimate approved by the producer); → REJECTED (estimate rejected; previous version unchanged); → deletion. |
| ACTIVE | Operational Purpose; the only state that allows voucher generation. | → ACTIVE (load estimate update ≤ thresholds: a new version is created, the previous one archived); → WAITING_FOR_APPROVAL (load estimate update > thresholds: a new version is created, the previous one remains unchanged); → SUSPENDED (manual suspension); → ARCHIVED (manual or automatic archiving after activating a new estimate). |
| SUSPENDED | Temporary suspension (manual by the consumer or producer). Reversible state. | → ACTIVE (if not suspended by the producer and reactivated by the consumer with estimate ≤ thresholds; or if reactivated by the producer, regardless of the estimate); → WAITING_FOR_APPROVAL (if not suspended by the producer and reactivated by the consumer with estimate > thresholds: a new version is created, the previous one remains unchanged); → SUSPENDED (suspension persists or reactivation asymmetric); → ARCHIVED (manual or automatic archiving after activation of a new estimate). |
| ARCHIVED | No longer in use; non-reversible state. If no currentVersion exists, the Purpose is permanently archived. | — (no transitions). |
| REJECTED | Load estimate rejected by the producer; non-reversible state. The consumer may submit a new load estimate. | — (no transitions). |
State details
DRAFT
Characteristics
- Initial state of the first version of the Purpose.
Transitions
- ACTIVE: load estimate below or equal to thresholds.
- WAITING_FOR_APPROVAL: load estimate above thresholds.
- Deletion.
WAITING_FOR_APPROVAL
Characteristics
- Estimate exceeds thresholds and is waiting for producer approval.
- If the current version is ACTIVE, the Purpose remains usable for voucher generation.
- Once the new version is approved, the previous one is archived.
- Deletion and rejection do not affect the current version.
Transitions
- ACTIVE: estimate approved by the producer.
- REJECTED: estimate rejected by the producer (previous version unchanged).
- Deletion.
ACTIVE
Characteristics
- Operational Purpose.
- The only state that allows voucher generation.
Transitions
- ACTIVE: load estimate update ≤ thresholds (creates a new version, archives the previous one).
- WAITING_FOR_APPROVAL: load estimate update > thresholds (creates a new version, keeps the previous one unchanged).
- SUSPENDED: manual suspension.
- ARCHIVED: manual or automatic archiving after activating a new estimate.
SUSPENDED
Access conditions
- Manual suspension by the consumer or producer.
Characteristics
- Temporarily inactive Purpose.
- Reversible state.
Transitions
- ACTIVE:
- if not suspended by the producer and reactivated by the consumer with estimate ≤ thresholds, or
- if reactivated by the producer, regardless of the estimate.
- WAITING_FOR_APPROVAL: not suspended by the producer, reactivated by the consumer with estimate > thresholds (creates a new version, previous one unchanged).
- SUSPENDED: suspension persists or reactivation asymmetric.
- ARCHIVED: manual or automatic archiving after activating a new estimate.
ARCHIVED
Characteristics
- No longer in use.
- Non-reversible state.
- If no currentVersion exists, the Purpose is permanently archived.
Transitions
- None.
REJECTED
Characteristics
- The load estimate of the version was rejected by the producer.
- Non-reversible state.
- The consumer may submit a new estimate modification.
Transitions
- None.
Next page → E-services
Hai bisogno di aiuto?
Apri un ticket utilizzando l’apposita funzione all’interno della tua Area Riservata
