Settlements API endpoints
This section discusses parameters for each Settlements API endpoint, expected response, and sample request and response payloads, and transaction types.
-
POST /api/settlement/retrieve-settlement-data - Initiate retrieve data task for a given market/zone/settlement point.
Request body:
{
"idList": [
" MarketIndia"
],
"correlationID": "18726453",
"idType": 0,
"startTime": {
"seconds": 0,
"nanos": 0
},
"endTime": {
"seconds": 0,
"nanos": 0
},
"settlementMarketType": 0
}
Response:
{
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "RetrieveSettlementData succeeded.",
"taskIds": [
309832
],
"taskCreationErrors": []
}
-
Error scenarios:
-
SC 1: When IdList is invalid
Response:
Response Message Code : 404
Response Message : " RetrieveSettlementData - could not find settlement markets matching conditions."
-
SC 2: When ID Type / Settlement Market Type is invalid
Response:
Response Message Code : 400
Response Message : " is an invalid JSON literal. Expected the literal 'null'. ”
-
-
POST /api/settlement/submit-settlement-data - Initiate submit data task for a given market/zone/settlement point.
Request body:
{
"idList": [
"MarketAlaska"
],
"correlationID": "5329f895-b847-41ae-b05a-a0f3ab36ff3e",
"idType": 0,
"startTime": {
"seconds": 0,
"nanos": 0
},
"endTime": {
"seconds": 0,
"nanos": 0
},
"settlementType": "FinalA",
"settlementMarketType": 0
}
Response:
{
"correlationID": "5329f895-b847-41ae-b05a-a0f3ab36ff3e",
"responseMessageID": "200",
"responseMessage": "SubmitSettlementData succeeded.",
"taskIds": [
1818
],
"taskCreationErrors": []
}
-
Error scenario:
-
SC 1: When ID List is invalid
Response:
Response Message Code : 404
Response Messge : " SubmitSettlementData - could not find settlement markets matching conditions."
-
-
POST /api/settlement/get-settlement-history - Get the submission history for a given settlement point.
Request body:
{
"correlationID": "d528ae2f-1440-4365-aada-fe19f91c4a3e",
"settlementPointId": "MarketAlaska",
"startTime": {
"seconds": 0,
"nanos": 0
},
"endTime": {
"seconds": 0,
"nanos": 0
}
}
Response:
{
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Settlements - GetSettlementHistory succeeded.",
"settlementHistoryItems": [
{
"startDateUtc": "2024-03-01T18:00:00Z",
"endDateUtc": "2024-03-02T19:00:00Z",
"settlementTypeId": "Big_space",
"asOfDateUtc": "2024-06-18T13:40:00Z",
"processingStatus": "ItronError",
"completedTimeUtc": "2024-06-18T13:40:00Z",
"sendLocation": "http://localhost:15001/api/settlement/submitdata ",
"responseMessage": "Failed",
"errorCode": "65103",
"correlationId": "b58dbe04-fc20-498f-be92-3d4b5653d2ea",
"externalSystemId": "MV90"
},
{
"startDateUtc": "2024-03-01T05:00:00Z",
"endDateUtc": "2024-03-08T05:00:00Z",
"settlementTypeId": "PreliminaryA",
"asOfDateUtc": "2024-03-25T09:33:00Z",
"processingStatus": "ItronError",
"completedTimeUtc": "2024-03-25T09:33:00Z",
"sendLocation": "http://localhost:15001/api/settlement/submitdata ",
"responseMessage": "Failed",
"errorCode": "65103",
"correlationId": "22f9b079-46b8-4220-a279-2ae22eb1ec7d",
"externalSystemId": "MV90"
},
{
"startDateUtc": "2024-03-01T05:00:00Z",
"endDateUtc": "2024-03-08T05:00:00Z",
"settlementTypeId": "PreliminaryB",
"asOfDateUtc": "2024-03-25T09:36:00Z",
"processingStatus": "Sent",
"completedTimeUtc": "2024-03-25T09:36:00Z",
"sendLocation": "http://localhost:15001/api/settlement/submitdata ",
"responseMessage": ":The Submit Settlement Data Request has been accepted",
"errorCode": "0",
"correlationId": "6bcde7da-2d1c-4cee-85b7-ad04325e9183",
"externalSystemId": "MV90"
},
{
"startDateUtc": "2024-02-01T05:00:00Z",
"endDateUtc": "2024-02-29T05:00:00Z",
"settlementTypeId": "DemoA",
"asOfDateUtc": "2024-02-21T11:56:00Z",
"processingStatus": "Sent",
"completedTimeUtc": "2024-02-21T11:56:00Z",
"sendLocation": "http://localhost:15001/api/settlement/submitdata ",
"responseMessage": ":The Submit Settlement Data Request has been accepted",
"errorCode": "0",
"correlationId": "e85b7dc9-b0de-4e21-b493-9de7f0fd9dfa",
"externalSystemId": "MV90"
},
{
"startDateUtc": "2024-02-01T05:00:00Z",
"endDateUtc": "2024-02-29T05:00:00Z",
"settlementTypeId": "DemoA",
"asOfDateUtc": "2024-02-21T11:56:00Z",
"processingStatus": "Sent",
"completedTimeUtc": "2024-02-21T11:56:00Z",
"sendLocation": "http://localhost:15001/api/settlement/submitdata ",
"responseMessage": ":The Submit Settlement Data Request has been accepted",
"errorCode": "0",
"correlationId": "b1c8118e-7054-40f6-904f-6648323f5ad2",
"externalSystemId": "MV90"
},
{
"startDateUtc": "2024-01-01T05:00:00Z",
"endDateUtc": "2024-03-31T04:00:00Z",
"settlementTypeId": "PreliminaryB",
"asOfDateUtc": "2024-03-25T09:50:00Z",
"processingStatus": "Sent",
"completedTimeUtc": "2024-03-25T09:52:00Z",
"sendLocation": "http://localhost:15001/api/settlement/submitdata ",
"responseMessage": ":The Submit Settlement Data Request has been accepted",
"errorCode": "0",
"correlationId": "fa23756b-78d2-464a-9527-27e0f644035a",
"externalSystemId": "MV90"
},
{
"startDateUtc": "2023-11-24T05:00:00Z",
"endDateUtc": "2023-11-25T05:00:00Z",
"settlementTypeId": "DemoA",
"asOfDateUtc": "2024-02-07T11:56:00Z",
"processingStatus": "Sent",
"completedTimeUtc": "2024-02-07T11:56:00Z",
"sendLocation": "http://localhost:15001/api/settlement/submitdata ",
"responseMessage": ":The Submit Settlement Data Request has been accepted",
"errorCode": "0",
"correlationId": "a7e8937a-96d5-4e32-b7de-9c4fee7fa144",
"externalSystemId": "MV90"
}
]
}
-
POST /api/settlement/settlement-point-detailsz - Get list of all settlement points along with readings based on zone/settlement point list and given aggregation method.
Request body:
{
"idList": [
"EastZone_IND"
],
"correlationID": "string",
"getReadings": true,
"readingsStartTime": {
"seconds": 1688961600,
"nanos": 0
},
"readingsEndTime": {
"seconds": 1689048000,
"nanos": 0
},
"sortColumn": "string",
"sortDirection": 0,
"takeRows": 10,
"skipRows": 0,
"diffChannelNumber1": 0,
"diffChannelNumber2": 0,
"getWeatherData": true,
"settlementMarketType": 0,
"idType": 1,
"aggregationMethod": 0,
"statusFilter": "string",
"statusFilterChannelNumber": 0
}
Response:
{
"settlementPoints": [
{
"id": "STPT_IND_EZ_1",
"description": "",
"effectiveStartDateUtc": "1970-01-01T00:00:00Z",
"effectiveEndDateUtc": "2071-01-01T00:00:00Z",
"marketReportingId": "STPT_IND_EZ_1_RepID",
"meteringAuthId": "STPT_IND_EZ_1_AuthID",
"meteringDomain": "",
"primaryMeterId": "",
"location": "",
"namePlateRating": "",
"settlementPointTypeId": "301",
"settlementPointOperatorId": "401",
"settlementPointUnitTypeId": "501",
"settlementPointFuelType1Id": "",
"settlementPointFuelType2Id": "",
"isReportable": true,
"servicePointID": "SP_STPT_IND_EZ_1",
"weatherServicePointID": "",
"readingData": [],
"difference": [],
"weatherData": [],
"lastSubmittedTimeUtc": "",
"entityStatus": "",
"distinctStatusesPerChannel": [],
"servicePointChannels": [
{
"meterChannelNumber": 0,
"meterChannelType": "I",
"meterChannelUom": {
"id": "",
"description": "",
"unit": null
},
"servicePointChannelNumber": 1,
"servicePointChannelUom": {
"id": "KWH",
"description": "Energy_coEle - KilowattHours",
"unit": null
},
"intervalLengthInSeconds": 3600,
"recorderChannelId": "",
"externalSystemUomMap": null,
"channelSets": [],
"link": null,
"intervalLengthChange": false,
"linkedRegisterSPCNumber": null,
"channelDataSource": 3,
"meterID": ""
},
{
"meterChannelNumber": 0,
"meterChannelType": "I",
"meterChannelUom": {
"id": "",
"description": "",
"unit": null
},
"servicePointChannelNumber": 2,
"servicePointChannelUom": {
"id": "KWH",
"description": "Energy_coEle - KilowattHours",
"unit": null
},
"intervalLengthInSeconds": 3600,
"recorderChannelId": "",
"externalSystemUomMap": null,
"channelSets": [],
"link": null,
"intervalLengthChange": false,
"linkedRegisterSPCNumber": null,
"channelDataSource": 3,
"meterID": ""
},
{
"meterChannelNumber": 0,
"meterChannelType": "I",
"meterChannelUom": {
"id": "",
"description": "",
"unit": null
},
"servicePointChannelNumber": 3,
"servicePointChannelUom": {
"id": "KWH",
"description": "Energy_coEle - KilowattHours",
"unit": null
},
"intervalLengthInSeconds": 3600,
"recorderChannelId": "",
"externalSystemUomMap": null,
"channelSets": [],
"link": null,
"intervalLengthChange": false,
"linkedRegisterSPCNumber": null,
"channelDataSource": 1,
"meterID": ""
},
{
"meterChannelNumber": 0,
"meterChannelType": "I",
"meterChannelUom": {
"id": "",
"description": "",
"unit": null
},
"servicePointChannelNumber": 4,
"servicePointChannelUom": {
"id": "KWH",
"description": "Energy_coEle - KilowattHours",
"unit": null
},
"intervalLengthInSeconds": 3600,
"recorderChannelId": "",
"externalSystemUomMap": null,
"channelSets": [],
"link": null,
"intervalLengthChange": false,
"linkedRegisterSPCNumber": null,
"channelDataSource": 1,
"meterID": ""
},
{
"meterChannelNumber": 0,
"meterChannelType": "I",
"meterChannelUom": {
"id": "",
"description": "",
"unit": null
},
"servicePointChannelNumber": 5,
"servicePointChannelUom": {
"id": "KWH",
"description": "Energy_coEle - KilowattHours",
"unit": null
},
"intervalLengthInSeconds": 3600,
"recorderChannelId": "",
"externalSystemUomMap": null,
"channelSets": [],
"link": null,
"intervalLengthChange": false,
"linkedRegisterSPCNumber": null,
"channelDataSource": 3,
"meterID": ""
},
{
"meterChannelNumber": 0,
"meterChannelType": "I",
"meterChannelUom": {
"id": "",
"description": "",
"unit": null
},
"servicePointChannelNumber": 6,
"servicePointChannelUom": {
"id": "KWH",
"description": "Energy_coEle - KilowattHours",
"unit": null
},
"intervalLengthInSeconds": 3600,
"recorderChannelId": "",
"externalSystemUomMap": null,
"channelSets": [],
"link": null,
"intervalLengthChange": false,
"linkedRegisterSPCNumber": null,
"channelDataSource": 3,
"meterID": ""
},
{
"meterChannelNumber": 0,
"meterChannelType": "I",
"meterChannelUom": {
"id": "",
"description": "",
"unit": null
},
"servicePointChannelNumber": 7,
"servicePointChannelUom": {
"id": "KWH",
"description": "Energy_coEle - KilowattHours",
"unit": null
},
"intervalLengthInSeconds": 3600,
"recorderChannelId": "",
"externalSystemUomMap": null,
"channelSets": [],
"link": null,
"intervalLengthChange": false,
"linkedRegisterSPCNumber": null,
"channelDataSource": 3,
"meterID": ""
},
{
"meterChannelNumber": 0,
"meterChannelType": "I",
"meterChannelUom": {
"id": "",
"description": "",
"unit": null
},
"servicePointChannelNumber": 8,
"servicePointChannelUom": {
"id": "KWH",
"description": "Energy_coEle - KilowattHours",
"unit": null
},
"intervalLengthInSeconds": 3600,
"recorderChannelId": "",
"externalSystemUomMap": null,
"channelSets": [],
"link": null,
"intervalLengthChange": false,
"linkedRegisterSPCNumber": null,
"channelDataSource": 3,
"meterID": ""
},
{
"meterChannelNumber": 0,
"meterChannelType": "I",
"meterChannelUom": {
"id": "",
"description": "",
"unit": null
},
"servicePointChannelNumber": 9,
"servicePointChannelUom": {
"id": "KWH",
"description": "Energy_coEle - KilowattHours",
"unit": null
},
"intervalLengthInSeconds": 3600,
"recorderChannelId": "",
"externalSystemUomMap": null,
"channelSets": [],
"link": null,
"intervalLengthChange": false,
"linkedRegisterSPCNumber": null,
"channelDataSource": 3,
"meterID": ""
},
{
"meterChannelNumber": 0,
"meterChannelType": "I",
"meterChannelUom": {
"id": "",
"description": "",
"unit": null
},
"servicePointChannelNumber": 10,
"servicePointChannelUom": {
"id": "KWH",
"description": "Energy_coEle - KilowattHours",
"unit": null
},
"intervalLengthInSeconds": 3600,
"recorderChannelId": "",
"externalSystemUomMap": null,
"channelSets": [],
"link": null,
"intervalLengthChange": false,
"linkedRegisterSPCNumber": null,
"channelDataSource": 3,
"meterID": ""
}
],
"retailerID": "",
"enrollmentCount": 0,
"submissionStage": "",
"state": "",
"settlementZoneID": "EastZone_IND"
}
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetSettlementPointDetails succeeded. 942ms",
"totalRows": 1
}
-
Error scenarios:
-
SC 1: When ID List is invalid
Response:
Response Message Code : 404
Response Messge : " IEE.Configuration - GetSettlementPointDetails succeeded. 64ms."
-
SC 2: When ID Type is invalid
Response:
Response Message Code : 400
Response Messge : " IEE.Settlements.GetSettlementPointDetails - IDType must be SettlementMarket, SettlementZone, SettlementPoint, SettlementEnrollment or RetailSettlementPoint."
-
-
POST /api/settlement/save-channelmaps - Save or update settlement channel maps. Required fields: SettlementDataChannelMaps/ SettlementDataChannelMapList(swagger UI).
Note: A list of Settlement Market Types can be obtained from the 'SettlementMarketType' table and a list of Settlement Data Types can be obtained from the 'SettlementDataChanMap' table.
Request body:
{
"settlementDataChanMapList": [
{
"settlementDataChanMapId": "Backup1",
"channelNumber": 6,
"channelType": "interval",
"settlementMarketType": 0,
"idType": 2,
"settlementDataType": 21,
"externalSystemId": "Undefined",
"description": "string"
}
],
"correlationID": "123456",
"settlementMarketId": "MarketIndia"
}
Response:
{
"correlationID": "123456",
"settlementDataChanMaps": [],
"responseMessageID": "200",
"responseMessage": "Saving/updating settlement data channel maps successfully"
}
-
Error scenario:
-
SC 1: When settlementDataChanMapId is invalid
Response:
Response Message Code : 400
Response Messge : " Error mapping types.\r\n\r\nMapping types:\r\nSettlementDataChanMap -> SettlementDataChanMap\r\nIEE.Contracts.Settlements.SettlementDataChanMap -> Itron.EE.Business.Types.Entity.SettlementDataChanMap\r\n\r\nType Map configuration:\r\nSettlementDataChanMap -> SettlementDataChanMap\r\n"
-
-
POST /api/settlement/retrive-channelmaps – Retrieve settlement data channel maps by settlement market external system or all channel maps if market id is not requested.
Request body:
{
"settlementDataChanMapList": [
{
"settlementDataChanMapId": "Backup1",
"channelNumber": 6,
"channelType": "interval",
"settlementMarketType": 0,
"idType": 2,
"settlementDataType": 21,
"externalSystemId": "Undefined",
"description": "string"
}
],
"correlationID": "123456",
"settlementMarketId": "MarketIndia"
}
Response:
{
"correlationID": "123456",
"settlementDataChanMaps": [
{
"settlementDataChanMapId": "Backup1",
"channelNumber": 6,
"channelType": "Interval",
"settlementMarketType": 0,
"idType": 2,
"settlementDataType": 21,
"externalSystemId": "Undefined",
"description": "Backup load value 1 on non-stored formula channel"
},
{
"settlementDataChanMapId": "Backup2",
"channelNumber": 7,
"channelType": "Interval",
"settlementMarketType": 0,
"idType": 2,
"settlementDataType": 22,
"externalSystemId": "Undefined",
"description": "Backup load value 2 on non-stored formula channel"
},
{
"settlementDataChanMapId": "Backup3",
"channelNumber": 8,
"channelType": "Interval",
"settlementMarketType": 0,
"idType": 2,
"settlementDataType": 23,
"externalSystemId": "Undefined",
"description": "Backup load value 3 on non-stored formula channel"
},
{
"settlementDataChanMapId": "Backup4",
"channelNumber": 9,
"channelType": "Interval",
"settlementMarketType": 0,
"idType": 2,
"settlementDataType": 24,
"externalSystemId": "Undefined",
"description": "Backup load value 4 on non-stored formula channel"
},
{
"settlementDataChanMapId": "Backup5",
"channelNumber": 10,
"channelType": "Interval",
"settlementMarketType": 0,
"idType": 2,
"settlementDataType": 25,
"externalSystemId": "Undefined",
"description": "Backup load value 5 on non-stored formula channel"
},
{
"settlementDataChanMapId": "ICAP_OLV",
"channelNumber": 1001,
"channelType": "Register",
"settlementMarketType": 1,
"idType": 1,
"settlementDataType": 6,
"externalSystemId": "Undefined",
"description": "Aggregated ICAP official load value on stored formula channel"
},
{
"settlementDataChanMapId": "ICAP_OLV",
"channelNumber": 1001,
"channelType": "Register",
"settlementMarketType": 1,
"idType": 4,
"settlementDataType": 6,
"externalSystemId": "Undefined",
"description": "Aggregated ICAP official load value on stored formula channel"
},
{
"settlementDataChanMapId": "ICAP_ROLV",
"channelNumber": 1003,
"channelType": "Register",
"settlementMarketType": 1,
"idType": 4,
"settlementDataType": 8,
"externalSystemId": "Undefined",
"description": "ICAP received official load value from imported channel"
},
{
"settlementDataChanMapId": "ICAP_ULV",
"channelNumber": 1002,
"channelType": "Register",
"settlementMarketType": 1,
"idType": 4,
"settlementDataType": 7,
"externalSystemId": "Undefined",
"description": "Aggregated ICAP unofficial load value on stored formula channel"
},
{
"settlementDataChanMapId": "Primary",
"channelNumber": 5,
"channelType": "Interval",
"settlementMarketType": 0,
"idType": 2,
"settlementDataType": 16,
"externalSystemId": "Undefined",
"description": "Primary load value on non-stored formula channel"
},
{
"settlementDataChanMapId": "ROLV",
"channelNumber": 3,
"channelType": "Interval",
"settlementMarketType": 0,
"idType": 1,
"settlementDataType": 3,
"externalSystemId": "Undefined",
"description": "Received official load value from imported channel"
},
{
"settlementDataChanMapId": "ROLV",
"channelNumber": 3,
"channelType": "Interval",
"settlementMarketType": 0,
"idType": 2,
"settlementDataType": 3,
"externalSystemId": "Undefined",
"description": "Received official load value from imported channel"
},
{
"settlementDataChanMapId": "ROLV",
"channelNumber": 3,
"channelType": "Interval",
"settlementMarketType": 1,
"idType": 4,
"settlementDataType": 3,
"externalSystemId": "Undefined",
"description": "Aggregated energy received official load value from imported channel"
},
{
"settlementDataChanMapId": "ROLV",
"channelNumber": 103,
"channelType": "Interval",
"settlementMarketType": 1,
"idType": 1,
"settlementDataType": 3,
"externalSystemId": "Undefined",
"description": "Aggregated energy received official load value from imported channel"
},
{
"settlementDataChanMapId": "RULV",
"channelNumber": 4,
"channelType": "Interval",
"settlementMarketType": 0,
"idType": 2,
"settlementDataType": 4,
"externalSystemId": "Undefined",
"description": "Received unofficial load value from imported channel"
},
{
"settlementDataChanMapId": "RULV",
"channelNumber": 4,
"channelType": "Interval",
"settlementMarketType": 1,
"idType": 4,
"settlementDataType": 4,
"externalSystemId": "Undefined",
"description": "Aggregated energy received unofficial load value from imported channel"
},
{
"settlementDataChanMapId": "SOLV",
"channelNumber": 1,
"channelType": "Interval",
"settlementMarketType": 0,
"idType": 0,
"settlementDataType": 1,
"externalSystemId": "Undefined",
"description": "Send official load value on stored formula channel"
},
{
"settlementDataChanMapId": "SOLV",
"channelNumber": 1,
"channelType": "Interval",
"settlementMarketType": 0,
"idType": 1,
"settlementDataType": 1,
"externalSystemId": "Undefined",
"description": "Send official load value on stored formula channel"
},
{
"settlementDataChanMapId": "SOLV",
"channelNumber": 1,
"channelType": "Interval",
"settlementMarketType": 0,
"idType": 2,
"settlementDataType": 1,
"externalSystemId": "Undefined",
"description": "Sent official load value from stored formula channel"
},
{
"settlementDataChanMapId": "SOLV",
"channelNumber": 1,
"channelType": "Interval",
"settlementMarketType": 1,
"idType": 4,
"settlementDataType": 1,
"externalSystemId": "Undefined",
"description": "Aggregated energy official load value on stored formula channel"
},
{
"settlementDataChanMapId": "SOLV",
"channelNumber": 2,
"channelType": "Interval",
"settlementMarketType": 1,
"idType": 0,
"settlementDataType": 1,
"externalSystemId": "Undefined",
"description": "Send official load value on stored formula channel"
},
{
"settlementDataChanMapId": "SOLV",
"channelNumber": 2,
"channelType": "Interval",
"settlementMarketType": 1,
"idType": 1,
"settlementDataType": 1,
"externalSystemId": "Undefined",
"description": "Aggregated energy official load value on stored formula channel"
},
{
"settlementDataChanMapId": "ULV",
"channelNumber": 2,
"channelType": "Interval",
"settlementMarketType": 0,
"idType": 2,
"settlementDataType": 2,
"externalSystemId": "Undefined",
"description": "Unofficial load value on non-stored formula channel"
},
{
"settlementDataChanMapId": "ULV",
"channelNumber": 2,
"channelType": "Interval",
"settlementMarketType": 1,
"idType": 4,
"settlementDataType": 2,
"externalSystemId": "Undefined",
"description": "Aggregated energy unofficial load value on stored formula channel"
},
{
"settlementDataChanMapId": "ULV",
"channelNumber": 4,
"channelType": "Interval",
"settlementMarketType": 0,
"idType": 1,
"settlementDataType": 2,
"externalSystemId": "Undefined",
"description": "Unofficial load value on non-stored formula channel"
},
{
"settlementDataChanMapId": "ZLL",
"channelNumber": 800,
"channelType": "Interval",
"settlementMarketType": 0,
"idType": 1,
"settlementDataType": 31,
"externalSystemId": "Undefined",
"description": "Zone line losses on imported channel"
}
],
"responseMessageID": "200",
"responseMessage": "Find 26 settlement data channel maps"
}
-
DELETE /api/settlement/channelmaps - Remove settlement data channel maps if these maps exist in IEE.
Request body:
{
"settlementDataChanMapList": [
{
"settlementDataChanMapId": "ZLL",
"channelNumber": 800,
"channelType": "interval",
"settlementMarketType": 0,
"idType": 1,
"settlementDataType": 31,
"externalSystemId": "Undefined",
"description": "string"
}
],
"correlationID": "123456",
"settlementMarketId": "MarketIndia"
}
Response:
{
"correlationID": "123456",
"settlementDataChanMaps": [],
"responseMessageID": "200",
"responseMessage": "Deleting settlement data channel map successfully"
}
-
Error scenario:
-
SC 1: When settlementDataChanMapId is invalid or doesn’t exist
Response:
Response Message Code : 400
Response Messge : " Unable to delete. Cannot find any matched IEE settlement data channel maps.”
-
-
POST /api/settlement/settlement-comparison-data - Gets the settlement comparison data between the given entities like markets zones.
Request body:
{
"correlationID": "string",
"idType": 0,
"id": "MarketIndia",
"startTime": {
"seconds": 0,
"nanos": 0
},
"endTime": {
"seconds": 1681344000,
"nanos": 0
}
}
Response:
{
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "GetSettlementComparisonData completed successfully.",
"comparisonData": [
{
"time": {
"seconds": 1677650400,
"nanos": 0
},
"difference": -427,
"diffPercent": 100,
"wholesale": 0,
"retail": 427,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677654000,
"nanos": 0
},
"difference": -829,
"diffPercent": 100,
"wholesale": 0,
"retail": 829,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677657600,
"nanos": 0
},
"difference": -1259,
"diffPercent": 100,
"wholesale": 0,
"retail": 1259,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677661200,
"nanos": 0
},
"difference": -2151,
"diffPercent": 100,
"wholesale": 0,
"retail": 2151,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677664800,
"nanos": 0
},
"difference": -820,
"diffPercent": 100,
"wholesale": 0,
"retail": 820,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677668400,
"nanos": 0
},
"difference": -884,
"diffPercent": 100,
"wholesale": 0,
"retail": 884,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677672000,
"nanos": 0
},
"difference": -1346,
"diffPercent": 100,
"wholesale": 0,
"retail": 1346,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677675600,
"nanos": 0
},
"difference": -1325,
"diffPercent": 100,
"wholesale": 0,
"retail": 1325,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677679200,
"nanos": 0
},
"difference": -1729,
"diffPercent": 100,
"wholesale": 0,
"retail": 1729,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677682800,
"nanos": 0
},
"difference": -943,
"diffPercent": 100,
"wholesale": 0,
"retail": 943,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677686400,
"nanos": 0
},
"difference": -506,
"diffPercent": 100,
"wholesale": 0,
"retail": 506,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677690000,
"nanos": 0
},
"difference": -614,
"diffPercent": 100,
"wholesale": 0,
"retail": 614,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677693600,
"nanos": 0
},
"difference": -929,
"diffPercent": 100,
"wholesale": 0,
"retail": 929,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677697200,
"nanos": 0
},
"difference": -634,
"diffPercent": 100,
"wholesale": 0,
"retail": 634,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677700800,
"nanos": 0
},
"difference": -2411,
"diffPercent": 100,
"wholesale": 0,
"retail": 2411,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677704400,
"nanos": 0
},
"difference": -2739,
"diffPercent": 100,
"wholesale": 0,
"retail": 2739,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677708000,
"nanos": 0
},
"difference": -886,
"diffPercent": 100,
"wholesale": 0,
"retail": 886,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677711600,
"nanos": 0
},
"difference": -441,
"diffPercent": 100,
"wholesale": 0,
"retail": 441,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677715200,
"nanos": 0
},
"difference": -1389,
"diffPercent": 100,
"wholesale": 0,
"retail": 1389,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677718800,
"nanos": 0
},
"difference": -4244,
"diffPercent": 100,
"wholesale": 0,
"retail": 4244,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677722400,
"nanos": 0
},
"difference": -3142,
"diffPercent": 100,
"wholesale": 0,
"retail": 3142,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677726000,
"nanos": 0
},
"difference": -1857,
"diffPercent": 100,
"wholesale": 0,
"retail": 1857,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677729600,
"nanos": 0
},
"difference": -3641,
"diffPercent": 100,
"wholesale": 0,
"retail": 3641,
"uomId": "KWH"
},
{
"time": {
"seconds": 1677733200,
"nanos": 0
},
"difference": -1784,
"diffPercent": 100,
"wholesale": 0,
"retail": 1784,
"uomId": "KWH"
}
]
}
-
Error scenarios:
-
SC 1: When no reads are available
Response:
Response Message Code : 404
Response Messge : " GetSettlementComparisonData - GetReadings() message: No readings found for ["SPI_India"] “
-
SC 2: When ID is invalid
Response:
Response Message Code : 400
Response Messge : " is an invalid JSON literal. Expected the literal 'null'. ”
-
-
GET /api/settlement/get-settlement-enrollment-types - Get the list of settlement enrollment types from IEE core.
Response:
{
"idsAndDescriptions": [
{
"id": "SettlementEnrollmentType",
"description": "SettlementEnrollmentType"
},
{
"id": "SettlementEnrollmentType1",
"description": "SettlementEnrollmentType1"
}
],
"correlationID": "",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetSettlementEnrollmentTypes succeeded."
}
-
GET /api/settlement/get-settlement-customer-classes - Get list of settlement customer classes from IEE core.
Response:
{
"idsAndDescriptions": [
{
"id": "Commercial",
"description": "Commercial"
},
{
"id": "Industrial",
"description": "Industrial"
},
{
"id": "Residential",
"description": "Residential"
}
],
"correlationID": "",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetSettlementCustomerClasses succeeded."
}
Related topics: