Readings API endpoints
This section discusses parameters for each Readings API endpoint, expected response, sample request, response payloads, and error scenarios.
-
POST/api/readings - Returns a Reading Response comprised of Reading Data entries for each valid set of service point channel reads for specified services points and meter IDs.
-
SC 1: Entity type as service point for a single service point.
Request body:
{
"correlationID": "string",
"idType": "ServicePoint",
"idList": [
"IG_SP_11"
],
"dateRange": {
"start": "2023-07-24T00:00:00Z",
"end": "2023-07-25T00:00:00Z"
},
"aggregationType": "None",
"intervalSizeMinutes": 0,
"rollSizeMinutes": 0
}
Response:
{
"readingData": [
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:1",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T05:00:00+00:00"
},
"value": 12,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T05:00:00+00:00",
"end": "2023-07-24T06:00:00+00:00"
},
"value": 12,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T06:00:00+00:00",
"end": "2023-07-24T07:00:00+00:00"
},
"value": 12,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T07:00:00+00:00",
"end": "2023-07-24T08:00:00+00:00"
},
"value": 12,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T08:00:00+00:00",
"end": "2023-07-24T09:00:00+00:00"
},
"value": 12,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:2",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T05:00:00+00:00"
},
"value": 10,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T05:00:00+00:00",
"end": "2023-07-24T06:00:00+00:00"
},
"value": 10,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T06:00:00+00:00",
"end": "2023-07-24T07:00:00+00:00"
},
"value": 10,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T07:00:00+00:00",
"end": "2023-07-24T08:00:00+00:00"
},
"value": 10,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T08:00:00+00:00",
"end": "2023-07-24T09:00:00+00:00"
},
"value": 10,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:3",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T05:00:00+00:00"
},
"value": 8,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T05:00:00+00:00",
"end": "2023-07-24T06:00:00+00:00"
},
"value": 8,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T06:00:00+00:00",
"end": "2023-07-24T07:00:00+00:00"
},
"value": 8,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T07:00:00+00:00",
"end": "2023-07-24T08:00:00+00:00"
},
"value": 8,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T08:00:00+00:00",
"end": "2023-07-24T09:00:00+00:00"
},
"value": 8,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": ""
}
-
SC 2: Entity type as service point channel for a single service point channel.
Request body:
{
"correlationID": "string",
"idType": "ServicePointChannel",
"idList": [
"IG_SP_11:1"
],
"dateRange": {
"start": "2023-07-24T00:00:00Z",
"end": "2023-07-25T00:00:00Z"
},
"aggregationType": "None",
"intervalSizeMinutes": 0,
"rollSizeMinutes": 0
}
Response:
{
"readingData": [
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:1",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T05:00:00+00:00"
},
"value": 12,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T05:00:00+00:00",
"end": "2023-07-24T06:00:00+00:00"
},
"value": 12,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T06:00:00+00:00",
"end": "2023-07-24T07:00:00+00:00"
},
"value": 12,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T07:00:00+00:00",
"end": "2023-07-24T08:00:00+00:00"
},
"value": 12,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T08:00:00+00:00",
"end": "2023-07-24T09:00:00+00:00"
},
"value": 12,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
}
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": ""
}
-
SC 3: Entity type as service point for a multiple service point.
Request body:
{
"correlationID": "string",
"idType": "ServicePoint",
"idList": [
"IG_SP_11","IG_Test"
],
"dateRange": {
"start": "2023-07-24T00:00:00Z",
"end": "2023-07-25T00:00:00Z"
},
"aggregationType": "None",
"intervalSizeMinutes": 0,
"rollSizeMinutes": 0
}
Response:
{
"readingData": [
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:1",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T05:00:00+00:00"
},
"value": 12,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T05:00:00+00:00",
"end": "2023-07-24T06:00:00+00:00"
},
"value": 12,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T06:00:00+00:00",
"end": "2023-07-24T07:00:00+00:00"
},
"value": 12,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T07:00:00+00:00",
"end": "2023-07-24T08:00:00+00:00"
},
"value": 12,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T08:00:00+00:00",
"end": "2023-07-24T09:00:00+00:00"
},
"value": 12,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:2",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T05:00:00+00:00"
},
"value": 10,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T05:00:00+00:00",
"end": "2023-07-24T06:00:00+00:00"
},
"value": 10,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T06:00:00+00:00",
"end": "2023-07-24T07:00:00+00:00"
},
"value": 10,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T07:00:00+00:00",
"end": "2023-07-24T08:00:00+00:00"
},
"value": 10,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T08:00:00+00:00",
"end": "2023-07-24T09:00:00+00:00"
},
"value": 10,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:3",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T05:00:00+00:00"
},
"value": 8,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T05:00:00+00:00",
"end": "2023-07-24T06:00:00+00:00"
},
"value": 8,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T06:00:00+00:00",
"end": "2023-07-24T07:00:00+00:00"
},
"value": 8,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T07:00:00+00:00",
"end": "2023-07-24T08:00:00+00:00"
},
"value": 8,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T08:00:00+00:00",
"end": "2023-07-24T09:00:00+00:00"
},
"value": 8,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": ""
}
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_Test:1",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T00:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T00:00:00+00:00",
"end": "2023-07-24T01:00:00+00:00"
},
"value": 10,
"status": [
"NV",
"VEESET1PV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T01:00:00+00:00",
"end": "2023-07-24T02:00:00+00:00"
},
"value": 10,
"status": [
"NV",
"VEESET1PV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T02:00:00+00:00",
"end": "2023-07-24T03:00:00+00:00"
},
"value": 10,
"status": [
"NV",
"VEESET1PV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T03:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
},
"value": 10,
"status": [
"NV",
"VEESET1PV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T05:00:00+00:00"
},
"value": 10,
"status": [
"NV",
"VEESET1PV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_Test:2",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T00:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KVA",
"readings": [
{
"dateRange": {
"start": "2023-07-24T00:00:00+00:00",
"end": "2023-07-24T01:00:00+00:00"
},
"value": 20.56,
"status": [
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T01:00:00+00:00",
"end": "2023-07-24T02:00:00+00:00"
},
"value": 20.56,
"status": [
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T02:00:00+00:00",
"end": "2023-07-24T03:00:00+00:00"
},
"value": 20.56,
"status": [
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
},
{
"dateRange": {
"start": "2023-07-24T03:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
},
"value": 20.56,
"status": [
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
}
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_Test:101",
"isRegister": true,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
},
"intervalLength": 0,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
},
"value": 48960,
"status": [
"NV",
"VEESET1PV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_Test:201",
"isRegister": true,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
},
"intervalLength": 0,
"readUnit": "KVA",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
},
"value": 100661.76,
"status": [
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
}
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": ""
}
-
SC 4: Reading API with aggregation type as Sum.
Request body:
{
"correlationID": "string",
"idType": "ServicePoint",
"idList": [
"IG_SP_11"
],
"dateRange": {
"start": "2023-07-24T00:00:00Z",
"end": "2023-07-25T00:00:00Z"
},
"aggregationType": "SUM",
"intervalSizeMinutes": 0,
"rollSizeMinutes": 0
}
Response:
{
"readingData": [
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:1",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"value": 240,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:2",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"value": 200,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:3",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"value": 160,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:4",
"isRegister": true,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
},
"intervalLength": 0,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
},
"value": 100,
"status": [
"ADDED",
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:5",
"isRegister": true,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
},
"intervalLength": 0,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
},
"value": 10,
"status": [
"ADDED",
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:6",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"value": 100,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:7",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"value": 166,
"status": [
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
}
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": ""
}
-
SC 5: API response when interval length is less than the rolling interval length value.
Request body:
{
"correlationID": "string",
"idType": "ServicePoint",
"idList": [
"IG_SP_11"
],
"dateRange": {
"start": "2023-07-24T00:00:00Z",
"end": "2023-07-25T00:00:00Z"
},
"aggregationType": "Average",
"intervalSizeMinutes": 30,
"rollSizeMinutes": 60
}
Response:
{
"readingData": [
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:1",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"value": 11.85,
"status": [
"CHOPPED",
"EDITED",
"EMPTYCONTRIBUTOR",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:2",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"value": 9.875,
"status": [
"CHOPPED",
"EDITED",
"EMPTYCONTRIBUTOR",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:3",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"value": 7.9,
"status": [
"CHOPPED",
"EDITED",
"EMPTYCONTRIBUTOR",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:4",
"isRegister": true,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
},
"intervalLength": 0,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
},
"value": 100,
"status": [
"ADDED",
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:5",
"isRegister": true,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
},
"intervalLength": 0,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
},
"value": 10,
"status": [
"ADDED",
"EDITED",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:6",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"value": 4.9375,
"status": [
"CHOPPED",
"EDITED",
"EMPTYCONTRIBUTOR",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
},
{
"channelIDType": "ServicePointChannelID",
"channelID": "IG_SP_11:7",
"isRegister": false,
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"intervalLength": 60,
"readUnit": "KWH",
"readings": [
{
"dateRange": {
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
},
"value": 8.2,
"status": [
"CHOPPED",
"EDITED",
"EMPTYCONTRIBUTOR",
"NV",
"VEESET1NV",
"VEESET2NV",
"VEESET3NV"
],
"quality": "TOBESAVED"
}
],
"startRead": null,
"endRead": null,
"aggregateStatistics": null
}
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": ""
}
-
Error scenarios:
-
SC 1: Error validation when start date and end date are invalid
Request body:
{
"correlationID": "string",
"idType": "ServicePoint",
"idList": [
"IG_SP_11"
],
"dateRange": {
"start": "2023-07-25T00:00:00Z",
"end": "2023-07-24T00:00:00Z"
},
"aggregationType": "Average",
"intervalSizeMinutes": 30,
"rollSizeMinutes": 60
}
Response:
{
"readingData": [],
"correlationID": "string",
"responseMessageID": "500",
"responseMessage": "ItronEeException caught in Reading.Api.Service.GetReadings: The end time must be before the start time"
}
-
SC 2: Error validation when IdType is invalid
Request body:
{
"correlationID": "string",
"idType": "",
"idList": [
"IG_SP_11"
],
"dateRange": {
"start": "2023-07-24T00:00:00Z",
"end": "2023-07-25T00:00:00Z"
},
"aggregationType": "Average",
"intervalSizeMinutes": 30,
"rollSizeMinutes": 60
}
Response:
{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1 ",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-ee2e4bc935c76bed4d3f22a417bae65a-ed31bf598ecfd92f-00",
"errors": {
"$.idType": [
"The JSON value could not be converted to IEE.Contracts.Common.IDType. Path: $.idType | LineNumber: 2 | BytePositionInLine: 14."
]
}
}
-
-
POST/api/readingAvailable/{physicalchannelsOnly} - Return data available for service point channels. IF no data available, the Reading Data Available is null or empty in the response.
Response:
{
"readingDataAvailables": [
{
"servicePointID": "IG_SP_11",
"channelNumber": 1,
"isRegister": false,
"dateRanges": [
{
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
}
]
},
{
"servicePointID": "IG_SP_11",
"channelNumber": 2,
"isRegister": false,
"dateRanges": [
{
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
}
]
},
{
"servicePointID": "IG_SP_11",
"channelNumber": 3,
"isRegister": false,
"dateRanges": [
{
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
}
]
},
{
"servicePointID": "IG_SP_11",
"channelNumber": 4,
"isRegister": true,
"dateRanges": [
{
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
}
]
},
{
"servicePointID": "IG_SP_11",
"channelNumber": 5,
"isRegister": true,
"dateRanges": [
{
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
}
]
}
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "Retrieved reading data available successfully"
}
Response:
{
"readingDataAvailables": [
{
"servicePointID": "IG_SP_11",
"channelNumber": 1,
"isRegister": false,
"dateRanges": [
{
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
}
]
},
{
"servicePointID": "IG_SP_11",
"channelNumber": 2,
"isRegister": false,
"dateRanges": [
{
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
}
]
},
{
"servicePointID": "IG_SP_11",
"channelNumber": 3,
"isRegister": false,
"dateRanges": [
{
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
}
]
},
{
"servicePointID": "IG_SP_11",
"channelNumber": 4,
"isRegister": true,
"dateRanges": [
{
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
}
]
},
{
"servicePointID": "IG_SP_11",
"channelNumber": 5,
"isRegister": true,
"dateRanges": [
{
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-24T04:00:00+00:00"
}
]
},
{
"servicePointID": "IG_SP_11",
"channelNumber": 6,
"isRegister": false,
"dateRanges": [
{
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
}
]
},
{
"servicePointID": "IG_SP_11",
"channelNumber": 7,
"isRegister": false,
"dateRanges": [
{
"start": "2023-07-24T04:00:00+00:00",
"end": "2023-07-25T00:00:00+00:00"
}
]
}
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "Retrieved reading data available successfully"
}
-
POST/api/formula-contributors - Gets the formula contributors for the formula id within the given date range.
Request body:
{
"correlationID": "string",
"servicePointChannelID": "Formula_Test:1",
"formula": "Formula_Test:1",
"startTime": "2023-07-1T00:00:00Z",
"endTime": "2023-07-2T00:00:00Z",
"explodeMultiLevel": true
}
Response:
{
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "GetFormulaContributors completed successfully.",
"contributorChannels": [
"Formula_Test:1"
]
}
-
Error Scenario:
-
SC 1: Error validation when start date and end date is invalid
Request body:
{
"correlationID": "string",
"servicePointChannelID": "Formula_Test:1",
"formula": "Formula_Test:1",
"startTime": "2023-07-2T00:00:00Z",
"endTime": "2023-07-1T00:00:00Z",
"explodeMultiLevel": false
}
Response:
{
"correlationID": "string",
"responseMessageID": "500",
"responseMessage": "GetFormulaContributors failed: The end time must be before the start time",
"contributorChannels": []
}
See also IEE Reading REST API.
-