diff --git a/slate/source/includes/_energy_apis.md.erb b/slate/source/includes/_energy_apis.md.erb
index fa54c3a1..53e58569 100644
--- a/slate/source/includes/_energy_apis.md.erb
+++ b/slate/source/includes/_energy_apis.md.erb
@@ -10,4 +10,7 @@ This specification defines the APIs for Data Holders exposing Energy endpoints.
Energy OpenAPI Specification (YAML) |
+```diff
+Aligned description of response headers to be consistent with Banking APIs.
+```
<%= partial "includes/cds_energy.md" %>
diff --git a/slate/source/includes/releasenotes/releasenotes.1.20.0.html.md b/slate/source/includes/releasenotes/releasenotes.1.20.0.html.md
index f00ca207..92c1e942 100644
--- a/slate/source/includes/releasenotes/releasenotes.1.20.0.html.md
+++ b/slate/source/includes/releasenotes/releasenotes.1.20.0.html.md
@@ -48,7 +48,7 @@ This release addresses the following Decision Proposals published on [Standards]
|Change|Description|Link|
|------|-----------|----|
-| | | |
+| Fixed Energy Respose Headers | Included descriptions for response headers in the Energy APIs to be consistent with the presentation of the Banking APIs. Addresses [Issue 530 comment](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/530#issuecomment-1238967968) | [Participant Endpoints](../../#energy-apis). |
## Information Security Profile
diff --git a/slate/source/includes/security/_client_registration.md.erb b/slate/source/includes/security/_client_registration.md.erb
index e8597cf3..359da07b 100644
--- a/slate/source/includes/security/_client_registration.md.erb
+++ b/slate/source/includes/security/_client_registration.md.erb
@@ -103,10 +103,6 @@ Decoded SSA
```
-``` diff
-+ Added statement: Get Software Statement Assertion API v1 & v2 has the scope claim explicitly defined.
-```
-
The SSA will conform to the requirements of **[[DCR]](#nref-DCR)** with the following clarifications:
| Client Metadata | Required | Modifiable | Description
diff --git a/swagger-gen/api/cds_energy.json b/swagger-gen/api/cds_energy.json
index 23b8aca4..89fd8c7b 100644
--- a/swagger-gen/api/cds_energy.json
+++ b/swagger-gen/api/cds_energy.json
@@ -4239,9 +4239,9 @@
"description": "Successful response",
"headers": {
"x-v": {
+ "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
"schema": {
- "type": "string",
- "description": "The [version](#response-headers) of the API end point that the data holder has responded with."
+ "type": "string"
}
}
},
@@ -4257,9 +4257,9 @@
"description": "Successful response",
"headers": {
"x-v": {
+ "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
"schema": {
- "type": "string",
- "description": "The [version](#response-headers) of the API end point that the data holder has responded with."
+ "type": "string"
}
}
},
@@ -4275,15 +4275,15 @@
"description": "Successful response",
"headers": {
"x-v": {
+ "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
"schema": {
- "type": "string",
- "description": "The [version](#response-headers) of the API end point that the data holder has responded with."
+ "type": "string"
}
},
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4299,15 +4299,15 @@
"description": "Successful response",
"headers": {
"x-v": {
+ "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
"schema": {
- "type": "string",
- "description": "The [version](#response-headers) of the API end point that the data holder has responded with."
+ "type": "string"
}
},
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4323,15 +4323,15 @@
"description": "Successful response",
"headers": {
"x-v": {
+ "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
"schema": {
- "type": "string",
- "description": "The [version](#response-headers) of the API end point that the data holder has responded with."
+ "type": "string"
}
},
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4347,15 +4347,15 @@
"description": "Successful response",
"headers": {
"x-v": {
+ "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
"schema": {
- "type": "string",
- "description": "The [version](#response-headers) of the API end point that the data holder has responded with."
+ "type": "string"
}
},
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4371,15 +4371,15 @@
"description": "Successful response",
"headers": {
"x-v": {
+ "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
"schema": {
- "type": "string",
- "description": "The [version](#response-headers) of the API end point that the data holder has responded with."
+ "type": "string"
}
},
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4395,15 +4395,15 @@
"description": "Successful response",
"headers": {
"x-v": {
+ "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
"schema": {
- "type": "string",
- "description": "The [version](#response-headers) of the API end point that the data holder has responded with."
+ "type": "string"
}
},
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4419,15 +4419,15 @@
"description": "Successful response",
"headers": {
"x-v": {
+ "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
"schema": {
- "type": "string",
- "description": "The [version](#response-headers) of the API end point that the data holder has responded with."
+ "type": "string"
}
},
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4443,15 +4443,15 @@
"description": "Successful response",
"headers": {
"x-v": {
+ "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
"schema": {
- "type": "string",
- "description": "The [version](#response-headers) of the API end point that the data holder has responded with."
+ "type": "string"
}
},
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4467,15 +4467,15 @@
"description": "Successful response",
"headers": {
"x-v": {
+ "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
"schema": {
- "type": "string",
- "description": "The [version](#response-headers) of the API end point that the data holder has responded with."
+ "type": "string"
}
},
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4491,15 +4491,15 @@
"description": "Successful response",
"headers": {
"x-v": {
+ "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
"schema": {
- "type": "string",
- "description": "The [version](#response-headers) of the API end point that the data holder has responded with."
+ "type": "string"
}
},
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4515,15 +4515,15 @@
"description": "Successful response",
"headers": {
"x-v": {
+ "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
"schema": {
- "type": "string",
- "description": "The [version](#response-headers) of the API end point that the data holder has responded with."
+ "type": "string"
}
},
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4539,15 +4539,15 @@
"description": "Successful response",
"headers": {
"x-v": {
+ "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
"schema": {
- "type": "string",
- "description": "The [version](#response-headers) of the API end point that the data holder has responded with."
+ "type": "string"
}
},
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4563,15 +4563,15 @@
"description": "Successful response",
"headers": {
"x-v": {
+ "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
"schema": {
- "type": "string",
- "description": "The [version](#response-headers) of the API end point that the data holder has responded with."
+ "type": "string"
}
},
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4669,9 +4669,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4687,9 +4687,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4705,9 +4705,9 @@
"description": "The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4756,9 +4756,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4774,9 +4774,9 @@
"description": "The following error codes MUST be supported:
- [404 - Invalid Resource](#error-404-resource-invalid)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4792,9 +4792,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4855,9 +4855,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4873,9 +4873,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4891,9 +4891,9 @@
"description": "The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4951,9 +4951,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4969,9 +4969,9 @@
"description": "The following error codes MUST be supported:
- [404 - Unavailable Service Point](#error-404-unavailable-service-point)
- [404 - Invalid Service Point](#error-404-invalid-service-point)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -4987,9 +4987,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5062,9 +5062,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5080,9 +5080,9 @@
"description": "The following error codes MUST be supported:
- [404 - Unavailable Service Point](#error-404-unavailable-service-point)
- [404 - Invalid Service Point](#error-404-invalid-service-point)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5098,9 +5098,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5116,9 +5116,9 @@
"description": "The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5188,9 +5188,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5206,9 +5206,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5224,9 +5224,9 @@
"description": "The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5297,9 +5297,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5315,9 +5315,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5333,9 +5333,9 @@
"description": "The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
- [422 - Unavailable Service Point](#error-422-unavailable-service-point)
- [422 - Invalid Service Point](#error-422-invalid-service-point)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5393,9 +5393,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5411,9 +5411,9 @@
"description": "The following error codes MUST be supported:
- [404 - Unavailable Service Point](#error-404-unavailable-service-point)
- [404 - Invalid Service Point](#error-404-invalid-service-point)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5429,9 +5429,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5492,9 +5492,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5510,9 +5510,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5528,9 +5528,9 @@
"description": "The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5592,9 +5592,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5610,9 +5610,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5628,9 +5628,9 @@
"description": "The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
- [422 - Unavailable Service Point](#error-422-unavailable-service-point)
- [422 - Invalid Service Point](#error-422-invalid-service-point)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5694,9 +5694,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5712,9 +5712,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5730,9 +5730,9 @@
"description": "The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5793,9 +5793,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5811,9 +5811,9 @@
"description": "The following error codes MUST be supported:
- [404 - Unavailable Energy Account](#error-404-unavailable-energy-account)
- [404 - Invalid Energy Account](#error-404-invalid-energy-account)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5829,9 +5829,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5889,9 +5889,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5907,9 +5907,9 @@
"description": "The following error codes MUST be supported:
- [404 - Unavailable Energy Account](#error-404-unavailable-energy-account)
- [404 - Invalid Energy Account](#error-404-invalid-energy-account)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5925,9 +5925,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -5985,9 +5985,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6003,9 +6003,9 @@
"description": "The following error codes MUST be supported:
- [404 - Unavailable Energy Account](#error-404-unavailable-energy-account)
- [404 - Invalid Energy Account](#error-404-invalid-energy-account)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6021,9 +6021,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6081,9 +6081,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6099,9 +6099,9 @@
"description": "The following error codes MUST be supported:
- [404 - Unavailable Energy Account](#error-404-unavailable-energy-account)
- [404 - Invalid Energy Account](#error-404-invalid-energy-account)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6117,9 +6117,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6180,9 +6180,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6198,9 +6198,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6216,9 +6216,9 @@
"description": "The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6280,9 +6280,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6298,9 +6298,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6316,9 +6316,9 @@
"description": "The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
- [422 - Unavailable Energy Account](#error-422-unavailable-energy-account)
- [422 - Invalid Energy Account](#error-422-invalid-energy-account)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6388,9 +6388,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6406,9 +6406,9 @@
"description": "The following error codes MUST be supported:
- [404 - Unavailable Energy Account](#error-404-unavailable-energy-account)
- [404 - Invalid Energy Account](#error-404-invalid-energy-account)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6424,9 +6424,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6442,9 +6442,9 @@
"description": "The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6511,9 +6511,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6529,9 +6529,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6547,9 +6547,9 @@
"description": "The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6617,9 +6617,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6635,9 +6635,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6653,9 +6653,9 @@
"description": "The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
- [422 - Unavailable Energy Account](#error-422-unavailable-energy-account)
- [422 - Invalid Energy Account](#error-422-invalid-energy-account)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6725,9 +6725,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6743,9 +6743,9 @@
"description": "The following error codes MUST be supported:
- [404 - Unavailable Energy Account](#error-404-unavailable-energy-account)
- [404 - Invalid Energy Account](#error-404-invalid-energy-account)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6761,9 +6761,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6779,9 +6779,9 @@
"description": "The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6848,9 +6848,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6866,9 +6866,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6884,9 +6884,9 @@
"description": "The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6954,9 +6954,9 @@
"description": "The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6972,9 +6972,9 @@
"description": "The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},
@@ -6990,9 +6990,9 @@
"description": "The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
- [422 - Unavailable Energy Account](#error-422-unavailable-energy-account)
- [422 - Invalid Energy Account](#error-422-invalid-energy-account)
",
"headers": {
"x-fapi-interaction-id": {
+ "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"schema": {
- "type": "string",
- "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction."
+ "type": "string"
}
}
},