| GET | /v8/readings-bulk | ||
|---|---|---|---|
| GET | /v8/readings-bulk/{from} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| From | path | Time stamp with format: yyyyMMdd-HHmmss-ffffff | No | If not given, the first object is given after the last request, otherwise gives the first ... data objects received from EDSN/Grid operator received after the given time stamp. Keep in mind, the time stamp is related to when SDS received the data from EDSN, not the date of the data itself! |
| IncludeIntervalObjects | query | Boolean, default: true | No | Include received interval objects in the result |
| IncludeDayObjects | query | Boolean, default: false | No | Include received day objects in the result |
| ObjectFilter | query | Enum: None, Hour, Day, LastDayOnly, Month | No | Gives option to filter return objects, for example to get always only hour records or day records |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | String | Yes | Api-key. Used to provide credentials to the api. Can also be provided through the request headers with key: X-API-KEY |
| None | |
| Hour | |
| Day | |
| LastDayOnly | |
| Month |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Message | form | string | No | |
| TimeStamp | form | string | Yes | |
| DayObjectCount | form | int? | No | |
| IntervalObjectCount | form | int? | No | |
| RejectionObjectCount | form | int? | No | |
| DayObjects | form | List<P4ReadingDay> | No | |
| IntervalObjects | form | List<P4ReadingInterval> | No | |
| RejectionObjects | form | List<P4Rejection> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Ean | form | string | No | |
| MeterId | form | string | No | |
| QueryDate | form | DateOnly | No | |
| MeasureUnit | form | string | No | |
| R180 | form | decimal? | No | |
| R181 | form | decimal? | No | |
| R182 | form | decimal? | No | |
| R280 | form | decimal? | No | |
| R281 | form | decimal? | No | |
| R282 | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Ean | form | string | No | |
| MeterId | form | string | No | |
| QueryDate | form | DateOnly | No | |
| MeasureUnit | form | string | No | |
| Items | form | List<P4ReadingIntervalItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DateTimeOffset | form | DateTimeOffset | No | |
| R180 | form | decimal | No | |
| R280 | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Ean | form | string | No | |
| QueryDate | form | DateOnly | No | |
| QueryReason | form | string | No | |
| RejectionCode | form | string | No | |
| RejectionText | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v8/readings-bulk HTTP/1.1 Host: p4.smartdatasolutions.eu Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
message: String,
timeStamp: String,
dayObjectCount: 0,
intervalObjectCount: 0,
rejectionObjectCount: 0,
dayObjects:
[
{
ean: String,
meterId: String,
queryDate: 0001-01-01,
measureUnit: String,
r180: 0,
r181: 0,
r182: 0,
r280: 0,
r281: 0,
r282: 0
}
],
intervalObjects:
[
{
ean: String,
meterId: String,
queryDate: 0001-01-01,
measureUnit: String,
items:
[
{
dateTimeOffset: 0001-01-01T00:00:00.0000000+00:00,
r180: 0,
r280: 0
}
]
}
],
rejectionObjects:
[
{
ean: String,
queryDate: 0001-01-01,
queryReason: String,
rejectionCode: String,
rejectionText: String
}
]
}