Configuration API endpoints
This section discusses parameters for each Configuration API endpoint, expected response, sample request, response payloads, and error scenarios.
-
POST/api/config/flat - Gets the flat configuration for the requested meters or service points.
Request body:
{
"idList": [
"API_ART_SP_DEL"
],
"idType": 0,
"startTime": {
"seconds": 1609479000,
"nanos": 0
},
"endTime": {
"seconds": 1925011800,
"nanos": 0
},
"correlationID": "string",
"returnFormulaChannels": true,
"returnImportedChannels": true
}
Response:
{
"flatConfigurations": [
{
"addressingType": 0,
"servicePoint": {
"id": "API_ART_SP_DEL",
"programId": "SPP_SWP_GAS",
"timeZone": {
"key": "4230dab5-68a2-4da5-92a9-965058382f29",
"description": "(GMT-05:00) Eastern Time (US & Canada)"
},
"commodityTypeId": "PropaneGas",
"billingSystemCycle": "",
"description": "",
"lastUpdateDateUtc": ""
},
"meter": {
"id": "API_ART_METER_DEL",
"number": "API_ART_METER_DEL",
"endpointId": "",
"statusId": "Active",
"programId": "M_SWP_60_GAS",
"timeZone": {
"key": "4230dab5-68a2-4da5-92a9-965058382f29",
"description": "(GMT-05:00) Eastern Time (US & Canada)"
},
"marketTypeId": 4,
"ctRatio": 1,
"ptRatio": 1,
"recordingDevice": "",
"recorderProgram": "",
"collectionSystem": "MV90",
"pressureCompensationFactor": 1,
"ctRatioChange": false,
"ptRatioChange": false,
"lastUpdateDateUtc": ""
},
"channels": [
{
"meterChannelNumber": 1,
"meterChannelType": "Interval",
"meterChannelUom": {
"id": "CCF",
"description": "",
"unit": {
"id": "CCF",
"unitClassId": "Volume",
"defaultFactor": 748.0519481,
"conversionOffset": 0
}
},
"servicePointChannelNumber": 1,
"servicePointChannelUom": {
"id": "CCF",
"description": "",
"unit": {
"id": "CCF",
"unitClassId": "Volume",
"defaultFactor": 748.0519481,
"conversionOffset": 0
}
},
"intervalLengthInSeconds": 3600,
"recorderChannelId": "1",
"externalSystemUomMap": null,
"channelSets": [],
"link": {
"effectiveStartDateUtc": "1970-01-01T00:00:00Z",
"effectiveEndDateUtc": "2071-01-01T00:00:00Z"
},
"intervalLengthChange": false,
"linkedRegisterSPCNumber": null,
"channelDataSource": 0,
"meterID": ""
},
{
"meterChannelNumber": 101,
"meterChannelType": "Register",
"meterChannelUom": {
"id": "CCF",
"description": "",
"unit": {
"id": "CCF",
"unitClassId": "Volume",
"defaultFactor": 748.0519481,
"conversionOffset": 0
}
},
"servicePointChannelNumber": 101,
"servicePointChannelUom": {
"id": "CCF",
"description": "",
"unit": {
"id": "CCF",
"unitClassId": "Volume",
"defaultFactor": 748.0519481,
"conversionOffset": 0
}
},
"intervalLengthInSeconds": 0,
"recorderChannelId": "101",
"externalSystemUomMap": null,
"channelSets": [],
"link": {
"effectiveStartDateUtc": "1970-01-01T00:00:00Z",
"effectiveEndDateUtc": "2071-01-01T00:00:00Z"
},
"intervalLengthChange": false,
"linkedRegisterSPCNumber": null,
"channelDataSource": 0,
"meterID": ""
}
],
"link": {
"effectiveStartDateUtc": "1970-01-01T00:00:00Z",
"effectiveEndDateUtc": "2071-01-01T00:00:00Z"
},
"account": [],
"settlementPoint": null,
"udaValues": [],
"premise": null
}
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - Get flat configuration succeeded.",
"totalNumberOfRecords": 0,
"retailSettlementFlatConfigs": []
}
-
Error scenarios:
-
SC 1: Invalid id
Request body:
Response:
-
SC 2: StartDate Greater than EndDate
Request body:
Response:
-
-
POST/api/config/fetch - Gets the PBC XML/JSON contracts for the requested meters or service points.
Request body:
{
{
"identifier": {
"idList": [
"API_ART_SP_DEL"
],
"idType": "ServicePointId"
},
"startTime": "1609479000",
"correlationID": "string",
"currentOnly": true,
"dontGetPrograms": true,
"dontGetLinkage": true,
"hierarchyType": "Full",
"jsoNformat": true
}
Response:
{
"configurationData": "[{"ServicePointID":"API_ART_SP_DEL","TimeZone":"EasternUS","ServicePointVersions":[{"ServicePointProgramID":"SPP_SWP_GAS"}],"LinkedMeters":[{"Meter":{"MeterID":"API_ART_METER_DEL","MeterNumber":"API_ART_METER_DEL","MeterVersions":[{"MeterProgramID":"M_SWP_60_GAS","ContactForm":0,"MeterStatus":"Active","TimeZone":"EasternUS","ExternalSystemID":"MV90","MeterInstallation":{"CTRatio":1.0,"PTRatio":1.0,"PressureCompensationFactor":1.0,"ServiceType":1},"Multipliers":[{"ChannelNumber":1,"KEMultiplier":1.0,"PulseMultiplier":1.0},{"ChannelNumber":101,"DisplayMultiplier":1.0,"MeterMultiplier":1.0}]}],"ConfiguredForGasDayTake":false}}],"ReadingsImportBehavior":0}]",
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetConfigurations succeeded."
}
-
Error scenarios:
-
SC 1: Invalid ID
Request body:
Response:
-
SC 2: Invalid Type
Request body:
Response:
-
SC 3: Invalid Hierarchy Type
Request body:
Response:
-
-
POST/api/config/delete - Gets the PBC XML/JSON contracts for the requested meters or service points.
Request body:
{
"correlationID": "string",
"idType": "ServicePointId",
"entityId": "API_ART_SP_DEL"
}
Response:
{
"entityId": "API_ART_SP_DEL",
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - Delete configuration succeeded."
}
-
Error scenarios:
-
SC 1: Invalid ID
Request body:
Response:
-
SC 2: Invalid Type
Request body:
Response:
-
-
POST/api/config/search - Searches and returns the results for the given search conditions and entity type.
Request body:
{
"searchConditions": [
{"field":"AccountId","operator":"contains","value":""},{"field":"AccountNumber","operator":"contains","value":""},{"field":"MarketType","operator":"equals","value":"Electric"},{"field":"MeterId","operator":"contains","value":""},{"field":"MeterNumber","operator":"contains","value":""},{"field":"ServicePointDescription","operator":"contains","value":""},{"field":"ServicePointId","operator":"contains","value":""},{"field":"Version","operator":"equals","value":"Current"}
],
"correlationID": "3b4b590a-bdf4-41c2-9f39-883d0a50c68d",
"skip": 0,
"take": 0,
"sortBy": "servicePointID",
"servicePointID": "SP_VQ_1",
"servicePointProgramID": "SPP_ValdationQueue",
"servicePointDescription": "Validation-Queue",
"meterID": "M_VQ_1",
"meterNumber": "M_VQ_1",
"meterProgramID": "MP_ValidationQueue",
"marketTypeId": 0,
"accountID": "A_VQ_1",
"accountNumber": "A_VQ_1",
"searchEntityType": 0
}
Response:
{
"flatConfigurations": [
{
"addressingType": 0,
"servicePoint": {
"id": "string",
"programId": "string",
"timeZone": {
"key": "string",
"description": "string"
},
"commodityTypeId": "string",
"billingSystemCycle": "string",
"description": "string",
"lastUpdateDateUtc": "string"
},
"meter": {
"id": "string",
"number": "string",
"endpointId": "string",
"statusId": "string",
"programId": "string",
"timeZone": {
"key": "string",
"description": "string"
},
"marketTypeId": 0,
"ctRatio": 0,
"ptRatio": 0,
"recordingDevice": "string",
"recorderProgram": "string",
"collectionSystem": "string",
"pressureCompensationFactor": 0,
"ctRatioChange": true,
"ptRatioChange": true,
"lastUpdateDateUtc": "string"
},
"channels": [
{
"meterChannelNumber": 0,
"meterChannelType": "string",
"meterChannelUom": {
"id": "string",
"description": "string",
"unit": {
"id": "string",
"unitClassId": "string",
"defaultFactor": 0,
"conversionOffset": 0
}
},
"servicePointChannelNumber": 0,
"servicePointChannelUom": {
"id": "string",
"description": "string",
"unit": {
"id": "string",
"unitClassId": "string",
"defaultFactor": 0,
"conversionOffset": 0
}
},
"intervalLengthInSeconds": 0,
"recorderChannelId": "string",
"externalSystemUomMap": {
"id": "string",
"externalSystemUomMapAltID": "string",
"unit": {
"id": "string",
"unitClassId": "string",
"defaultFactor": 0,
"conversionOffset": 0
},
"unitOfMeasure": {
"id": "string",
"description": "string",
"unit": {
"id": "string",
"unitClassId": "string",
"defaultFactor": 0,
"conversionOffset": 0
}
}
},
"channelSets": [
{
"channelSetId": "string",
"channelSetType": "string"
}
],
"link": {
"effectiveStartDateUtc": "string",
"effectiveEndDateUtc": "string"
},
"intervalLengthChange": true,
"linkedRegisterSPCNumber": 0,
"channelDataSource": 0,
"meterID": "string"
}
],
"link": {
"effectiveStartDateUtc": "string",
"effectiveEndDateUtc": "string"
},
"account": [
{
"id": "string",
"number": "string",
"customerId": "string",
"customerName": "string",
"servicePointChannelID": "string",
"link": {
"effectiveStartDateUtc": "string",
"effectiveEndDateUtc": "string"
},
"accountProgramID": "string"
}
],
"settlementPoint": {
"id": "string",
"zoneId": "string",
"marketId": "string"
},
"udaValues": [
{
"name": "string",
"value": "string"
}
],
"premise": {
"id": "string",
"status": "string"
}
}
],
"correlationID": "string",
"responseMessageID": "string",
"responseMessage": "string",
"totalNumberOfRecords": 0,
"retailSettlementFlatConfigs": [
{
"servicePointID": "string",
"retailSettlementPoint": {
"id": "string",
"name": "string",
"typeID": "string",
"status": "string",
"description": "string",
"isReportable": true,
"energyReportingID": "string",
"icapReportingID": "string",
"lastUpdateDateUtc": "string"
},
"retailer": {
"id": "string",
"name": "string",
"typeID": "string",
"status": "string",
"description": "string",
"linkedRetailSettlementPoint": "string",
"lastUpdateDateUtc": "string"
},
"enrollment": {
"id": "string",
"name": "string",
"typeID": "string",
"status": "string",
"description": "string",
"customerClass": "string",
"lastUpdateDateUtc": "string"
},
"effectiveStartDateUtc": "string",
"effectiveEndDateUtc": "string",
"zoneID": "string",
"marketID": "string"
}
]
-
POST/api/config/servicepointprograms - Gets IDs of all enabled service point programs (optional filter by market type).
Request body:
{
"marketTypeId": 0,
"correlationID": "string"
}
Response:
{
"ids": [
"RetailSTPT_IND_SZ_1",
"RetailSTPT_IND_SZ_4",
"RetailSTPT_BGK_NZ_2",
"RetailSTPT_IND_SZ_3",
"spp_weather_demo",
"RetailSTPT_IND_WZ_1",
"RetailSTPT_IND_EZ_3",
"SPP_WZ_CA_Pro",
"SPP_WZ_NY_Pro",
"RetailSTPT_IND_NZ_API_2",
"RetailSTPT_BGK_SZ_2",
"SPP_EastZone_BGK",
"RetailSTPT_RAL_EZ_2",
"RetailSTPT_BGK_NZ_API_3",
"SP_SWP_ADV_1_Program",
"RecordingDevice_11032022_0010_Program",
"RetailSTPT_BGK_NZ_1",
"SPP_Bangkok_Pro",
"RetailSTPT_RAL_WZ_3",
"EPF",
"RetailSTPT_RAL_WZ_2",
"SP_Pro_SettlementPoint1_EZ",
"SPP_WestZone_BGK",
"RetailSTPT_IND_EZ_2",
"SP_Pro_SettlementPoint1_WZ",
"SPP_Alaska_Pro",
"RetailSTPT_BGK_WZ_3",
"SPP_NZ_CA_Pro",
"Sample_Program",
"RetailSTPT_BGK_SZ_3",
"IND_SPProg_1",
"SPP_CM_SP_ART_05",
"RetailSTPT_BGK_EZ_3",
"SPP_SWP_DIFF_UOM",
"RetailSTPT_BGK_WZ_1",
"SP_WUI_DE_001_Program",
"SPP_NewYork_Pro",
"SPP_NM_11C",
"SPP_EastZone_IND",
"RetailSTPT_IND_EZ_1",
"RetailSTPT_IND_WZ_3",
"SP_Pro_SettlementPoint1_SZ",
"RetailSTPT_IND_EZ_5",
"SPP_WUI_TST",
"RAL_SPProg_1",
"RetailSTPT_IND_NZ_1",
"SPP_EZ_CA_Pro",
"RetailSTPT_BGK_EZ_2",
"SP_Pro_SettlementPoint",
"RetailSTPT_BGK_NZ_API_4",
"SPP_SZ_CA_Pro",
"RetailSTPT_BGK_WZ_5",
"SPP_Tst_02",
"SPP_NorthZone_IND",
"RetailSTPT_BGK_EZ_4",
"SPP_NM_10C",
"SPP_SouthZone_BGK",
"RetailSTPT_IND_WZ_4",
"RetailSTPT_BGK_SZ_4",
"RetailSTPT_RAL_NZ_1",
"SP_Pro_SettlementPoint_3",
"RetailSTPT_BGK_WZ_2",
"RetailSTPT_RAL_EZ_3",
"RetailSTPT_BGK_SZ_1",
"RetailSTPT_BGK_EZ_5",
"SPP_NorthZone_Pro",
"SPP_WUI_TST1_Linked_Org",
"RetailSTPT_IND_SZ_2",
"RetailSTPT_IND_NZ_API_1",
"SPP_SWP_ELECTRIC_UOM_DIFF_02",
"SP_Pro_SettlementPoint_2",
"SP_Pro_SettlementPoint1_NZ",
"RetailSTPT_BGK_NZ_API_2",
"Transformer_11032022_0010_Program",
"SPP_WestZone_Pro",
"RetailSTPT_BGK_NZ_API_1",
"SPP_India_Pro",
"RetailSTPT_BGK_EZ_1",
"SPP_California_Pro",
"SPP_NZ_NY_Pro",
"SPP_NorthZone_BGK",
"RetailSTPT_IND_NZ_2",
"SP_Pro_SettlementPoint_1",
"BGK_SPProg_1",
"SPP_ValdationQueue",
"SPP_WestZone_IND",
"SPP_NM_9C",
"RetailSTPT_IND_NZ_API_3",
"SPP_SouthZone_Pro",
"ART_SPProg_1",
"SPP_EastZone_Pro",
"SPP_SWP_ELEC_REPROGRAM",
"SP_VQ_1002_Program",
"RetailSTPT_IND_NZ_API_4",
"SPP_SZ_NY_Pro",
"RetailSTPT_BGK_NZ_API_5",
"RetailSTPT_RAL_WZ_4",
"SPP_SWP_GAS",
"RetailSTPT_BGK_WZ_4",
"RetailSTPT_RAL_EZ_4",
"RetailSTPT_IND_WZ_2",
"Meter_11032022_0011_Program",
"RetailSTPT_RAL_SZ_1",
"SPP_CM_SP_ART",
"SPP_SouthZone_IND",
"SPP_SWP_ELECTRIC",
"RetailSTPT_IND_NZ_API_5",
"SP_VQ_1001_Program",
"RetailSTPT_RAL_EZ_5",
"SPP_EZ_NY_Pro",
"RetailSTPT_RAL_EZ_1",
"RetailSTPT_RAL_WZ_1",
"RetailSTPT_IND_EZ_4",
"SPP_WUI_TSY",
"RetailSTPT_RAL_NZ_2"
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GEt service point program id succeeded."
}
-
POST/api/config/meterprograms- Gets list of all meter programs in IEE.
Request body:
{
"marketTypeId": 0,
"correlationID": "string"
}
Response:
{
"ids": [
"mp_weather_demo",
"MP_SWP_60_ELEC_UOMDIFF_01",
"MP_SWP_RECORDER",
"BGK_MProg_1",
"M_WUI_TST1_Linked",
"MP_SWP_15_ELEC",
"MP_NM_11C",
"Transformer_11032022_0010_Program",
"M_SWP_60_GAS",
"MP_SWP_60_ELEC_UOMDIFF_1",
"MP_SWP_60_ELEC",
"MP_WUI_TST_15",
"Sample_Program",
"MP_NM_10C",
"MP_WUI_TST",
"MP_NM_9C",
"MP_ValidationQueue",
"ART_MProg_1",
"M_VQ_1001_Program",
"Meter_11032022_0011_Program",
"MP_SWP_DIFF_CHNL_1",
"MP_WUI_TST1_IntChange",
"MP_SWP_60_ELEC_UOMDIFF",
"M_VQ_1002_Program",
"M_SWP_ADV_1_Program",
"M_WUI_DE_001_Program",
"IND_MProg_1",
"MP_CM_SP_ART_05",
"MP_SWP_DIFF_CHNL_2",
"RecordingDevice_11032022_0010_Program",
"MP_SWP_15_ELEC_2",
"MP_WUI_TST_5",
"MP_WUI_TST_30",
"MP_CM_SP_ART",
"EPF",
"RAL_MProg_1"
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GEt meter program id succeeded."
}
-
POST/api/config/meter-validate- Gets the flat configuration for the requested Meter ID and with the requested validation checks.
Request body:
{
"id": "M_Cust_WZ_IND_3",
"checkIsPBC": true,
"checkHasSPP": true,
"currentOnly": true,
"correlationID": "string"
}
Response:
{
"flatConfigurations": [
{
"addressingType": 0,
"servicePoint": {
"id": "SP_Cust_WZ_IND_3",
"programId": "RAL_SPProg_1",
"timeZone": {
"key": "4230dab5-68a2-4da5-92a9-965058382f29",
"description": "(GMT-05:00) Eastern Time (US & Canada)"
},
"commodityTypeId": "Electric",
"billingSystemCycle": "",
"description": "",
"lastUpdateDateUtc": ""
},
"meter": {
"id": "M_Cust_WZ_IND_3",
"number": "M_Cust_WZ_IND_3",
"endpointId": "",
"statusId": "Active",
"programId": "RAL_MProg_1",
"timeZone": {
"key": "4230dab5-68a2-4da5-92a9-965058382f29",
"description": "(GMT-05:00) Eastern Time (US & Canada)"
},
"marketTypeId": 2,
"ctRatio": 1,
"ptRatio": 1,
"recordingDevice": "",
"recorderProgram": "",
"collectionSystem": "Undefined",
"pressureCompensationFactor": 1,
"ctRatioChange": false,
"ptRatioChange": false,
"lastUpdateDateUtc": ""
},
"channels": [
{
"meterChannelNumber": 1,
"meterChannelType": "Interval/Register",
"meterChannelUom": {
"id": "KWH_DEL",
"description": "",
"unit": {
"id": "KWH",
"unitClassId": "Energy",
"defaultFactor": 1,
"conversionOffset": 0
}
},
"servicePointChannelNumber": 1,
"servicePointChannelUom": {
"id": "KWH_DEL",
"description": "",
"unit": {
"id": "KWH",
"unitClassId": "Energy",
"defaultFactor": 1,
"conversionOffset": 0
}
},
"intervalLengthInSeconds": 3600,
"recorderChannelId": "1",
"externalSystemUomMap": null,
"channelSets": [
{
"channelSetId": "SP_Cust_WZ_IND_3:SP_Cust_WZ_IND_3_1",
"channelSetType": "CHREAD"
}
],
"link": {
"effectiveStartDateUtc": "1970-01-01T00:00:00Z",
"effectiveEndDateUtc": "2071-01-01T00:00:00Z"
},
"intervalLengthChange": false,
"linkedRegisterSPCNumber": 101,
"channelDataSource": 0,
"meterID": ""
}
],
"link": {
"effectiveStartDateUtc": "1970-01-01T00:00:00Z",
"effectiveEndDateUtc": "2071-01-01T00:00:00Z"
},
"account": [],
"settlementPoint": null,
"udaValues": [],
"premise": null
}
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - Meter validation succeeded."
}
-
Error scenarios:
-
SC 1: Invalid ID
Request body:
Response:
-
-
POST/api/config/meter-swap-compatibility- Ensure that requested meters and service point program are compatible for meter swap.
Request body:
{
"meterId1": "M_Cust_WZ_IND_3",
"meterId2": "M_Cust_WZ_IND_2",
"meterIdSppId": "RAL_SPProg_1",
"correlationID": "string"
}
Response:
{
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - Meter Swap Compatibility Succeeded."
}
-
Error scenarios:
-
SC 1: Invalid Meter ID 1
Request body:
Response:
-
SC 2: Invalid Meter ID 2
Request body:
Response:
-
SC 3: Invalid Meter ID Spp ID
Request body:
Response:
-
-
POST/api/config/meter-swap-preview- Return flat configuration for meter swap preview.
Request body:
{
"xmlContract": "<ConfigurationBatch xmlns:schemaLocation="http://www.itron.com/mdm/common/2008/04\ " xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance\ " xmlns="http://www.itron.com/mdm/configuration/2008/04\ "><ConfigurationTransfers><ConfigurationTransfer><ConfigurationTransaction><ConfigurationUpdates><ConfigurationUpdate xsi:type="MeterChange"><ChangeDate>1971-01-01T05:00:00Z</ChangeDate><CommissionStatus>Active</CommissionStatus><ServicePoint><ServicePointID>SP_T_6498_SP</ServicePointID><ServicePointVersions><ServicePointVersion><ServicePointProgramID>SPP_WUI_TST</ServicePointProgramID></ServicePointVersion></ServicePointVersions><LinkedMeters><LinkedMeter><Meter><MeterID>M_T_6498_M2</MeterID></Meter></LinkedMeter></LinkedMeters><ActionOnReadingData xsi:nil="true" /></ServicePoint></ConfigurationUpdate></ConfigurationUpdates></ConfigurationTransaction></ConfigurationTransfer></ConfigurationTransfers></ConfigurationBatch>",
"correlationID": "string",
"jsonConfigurationUpdates": "string",
"jsonConfigurationUpdatesType": 0
}
Response:
{
"flatConfigurations": [
{
"addressingType": 0,
"servicePoint": {
"id": "SP_T_6498_SP",
"programId": "SPP_WUI_TST",
"timeZone": null,
"commodityTypeId": "",
"billingSystemCycle": "",
"description": "",
"lastUpdateDateUtc": ""
},
"meter": {
"id": "M_T_6498_M2",
"number": "M_T_6498_M2",
"endpointId": "",
"statusId": "",
"programId": "",
"timeZone": null,
"marketTypeId": 0,
"ctRatio": 0,
"ptRatio": 0,
"recordingDevice": "",
"recorderProgram": "",
"collectionSystem": "",
"pressureCompensationFactor": 0,
"ctRatioChange": false,
"ptRatioChange": false,
"lastUpdateDateUtc": ""
},
"channels": [
{
"meterChannelNumber": 1,
"meterChannelType": "Interval",
"meterChannelUom": null,
"servicePointChannelNumber": 1,
"servicePointChannelUom": {
"id": "KWH",
"description": "",
"unit": null
},
"intervalLengthInSeconds": 900,
"recorderChannelId": "",
"externalSystemUomMap": null,
"channelSets": [],
"link": null,
"intervalLengthChange": true,
"linkedRegisterSPCNumber": null,
"channelDataSource": 0,
"meterID": ""
},
{
"meterChannelNumber": 2,
"meterChannelType": "Interval",
"meterChannelUom": null,
"servicePointChannelNumber": 2,
"servicePointChannelUom": {
"id": "KWH",
"description": "",
"unit": null
},
"intervalLengthInSeconds": 900,
"recorderChannelId": "",
"externalSystemUomMap": null,
"channelSets": [],
"link": null,
"intervalLengthChange": true,
"linkedRegisterSPCNumber": null,
"channelDataSource": 0,
"meterID": ""
},
{
"meterChannelNumber": 101,
"meterChannelType": "Register",
"meterChannelUom": null,
"servicePointChannelNumber": 101,
"servicePointChannelUom": {
"id": "KWH",
"description": "",
"unit": null
},
"intervalLengthInSeconds": 0,
"recorderChannelId": "",
"externalSystemUomMap": null,
"channelSets": [],
"link": null,
"intervalLengthChange": false,
"linkedRegisterSPCNumber": null,
"channelDataSource": 0,
"meterID": ""
}
],
"link": null,
"account": [],
"settlementPoint": null,
"udaValues": [],
"premise": null
}
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration is succeeded",
"totalNumberOfRecords": 0,
"retailSettlementFlatConfigs": []
}
-
GET/api/config/settlement-markets-Returns the list of settlement market IDs.
Request body:
Response:
{
"ids": [
"MarketAlaska",
"MarketBangkok",
"MarketCalifornia",
"MarketIndia",
"MarketNewYork"
],
"correlationID": "",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetSettlementMarketIDs succeeded."
}
-
POST/api/config/settlement-market-details-Returns a list of settlement markets objects (list of SettlementMarketDetail) filtered by the settlement market IDs submitted in the GetSettlementDetailsRequest.
Request body:
{
"idList": [
"MarketAlaska"
],
"correlationID": "string"
}
Response:
{
"settlementMarketDetails": [
{
"id": "MarketAlaska",
"name": "Alaska",
"description": "Market for Alska",
"effectiveStartDateUtc": "1970-01-01T00:00:00Z",
"effectiveEndDateUtc": "2071-01-01T00:00:00Z",
"marketTypeId": "Market_1_Alaska",
"countryId": "UnitedStates",
"regionId": "AK",
"timeZoneId": "EasternUS",
"holidayListId": "Default",
"externalSystemId": "Undefined",
"servicePointId": "SPI_Alaska",
"settlementPointsCount": 0,
"reportableSettlementPointsCount": 0
}
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetSettlementMarketDetails succeeded."
}
-
Error scenario:
-
SC 1: Invalid Market ID
Request body:
Response:
-
-
GET/api/config/settlement-zones - Returns the list of settlement zone IDs.
Request body:
Response:
{
"ids": [
"EastZone",
"EastZone_BGK",
"EastZone_CA",
"EastZone_IND",
"EastZone_NY",
"NorthZone",
"NorthZone_BGK",
"NorthZone_CA",
"NorthZone_IND",
"NorthZone_NY",
"SouthZone",
"SouthZone_BGK",
"SouthZone_CA",
"SouthZone_IND",
"SouthZone_NY",
"WestZone",
"WestZone_BGK",
"WestZone_CA",
"WestZone_IND",
"WestZone_NY"
],
"correlationID": "",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetSettlementZoneIDs succeeded."
}
-
POST/api/config/settlement-zone-details - Returns a list of settlement zone objects (list of SettlementZone) filtered either by the settlement zone IDs submitted in the request or by both the settlement market ID and the list of submitted settlement zone IDs in the GetSettlementZoneDetailsRequest.
Request body:
{
"idList": [
"WestZone_IND"
],
"correlationID": "string",
"settlementMarketId": "MarketIndia"
}
Response:
{
"settlementZoneDetails": [
{
"id": "WestZone_IND",
"name": "WestZone_IND",
"description": "WestZone_IND",
"effectiveStartDateUtc": "1970-01-01T00:00:00Z",
"effectiveEndDateUtc": "2071-01-01T00:00:00Z",
"marketZoneId": "India_West",
"servicePointId": "SPI_WestZone_IND",
"settlementPointsCount": 1,
"reportableSettlementPointsCount": 1
}
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetSettlementZoneDetails succeeded."
}
-
Error scenarios:
-
SC 1- Invalid Market ID
Request body:
Response:
-
SC 2-Invalid Zone ID
Request body:
Response:
-
-
GET/api/config/retail-settlement-points - Gets all the retail settlement point ids from the database.
Request body:
Response:
{
"ids": [
"RSTPT_BGK_EZ_1",
"RSTPT_BGK_EZ_2",
"RSTPT_BGK_EZ_3",
"RSTPT_BGK_EZ_4",
"RSTPT_BGK_EZ_5",
"RSTPT_BGK_NZ_1",
"RSTPT_BGK_NZ_2",
"RSTPT_BGK_NZ_API_1",
"RSTPT_BGK_NZ_API_2",
"RSTPT_BGK_NZ_API_3",
"RSTPT_BGK_NZ_API_4",
"RSTPT_BGK_NZ_API_5",
"RSTPT_BGK_SZ_1",
"RSTPT_BGK_SZ_2",
"RSTPT_BGK_SZ_3",
"RSTPT_BGK_WZ_1",
"RSTPT_BGK_WZ_2",
"RSTPT_BGK_WZ_3",
"RSTPT_BGK_WZ_4",
"RSTPT_IND_EZ_1",
"RSTPT_IND_EZ_2",
"RSTPT_IND_EZ_3",
"RSTPT_IND_EZ_4",
"RSTPT_IND_EZ_5",
"RSTPT_IND_NZ_1",
"RSTPT_IND_NZ_2",
"RSTPT_IND_NZ_API_1",
"RSTPT_IND_NZ_API_2",
"RSTPT_IND_NZ_API_3",
"RSTPT_IND_NZ_API_4",
"RSTPT_IND_NZ_API_5",
"RSTPT_IND_SZ_1",
"RSTPT_IND_SZ_2",
"RSTPT_IND_SZ_3",
"RSTPT_IND_SZ_4",
"RSTPT_IND_WZ_1",
"RSTPT_IND_WZ_2",
"RSTPT_IND_WZ_3",
"RSTPT_IND_WZ_4"
],
"correlationID": "",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetRetailSettlementPointIDs succeeded."
}
-
POST/api/config/retail-settlement-point-details - Gets the details of given retail settlement point IDs.
Request body:
{
"idList": [
"RSTPT_IND_WZ_4"
],
"correlationID": "string"
}
Response:
{
"retailSettlementPointDetails": [
{
"id": "RSTPT_IND_WZ_4",
"description": "This is point test 3",
"effectiveStartDateUtc": "1970-01-01T00:00:00Z",
"effectiveEndDateUtc": "2071-01-01T00:00:00Z",
"servicePointId": "SP_RSTPT_IND_WZ_4",
"retailSettlementPointTypeId": "RetailSettlementPointType",
"entityStatusId": "Active",
"isReportable": true
}
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetRetailSettlementPointDetails succeeded."
}
-
Error scenario:
-
SC 1: Invalid RSTPT
Request body:
Response:
-
-
POST/api/config/settlement-code-types - Gets the code types for a specific settlement.
Request body:
{
"correlationID": "string",
"settlementCodeType": 0
}
Response:
{
"idsAndDescriptions": [
{
"id": "Market_1_Alaska",
"description": "Market_1_Alaska"
},
{
"id": "Market_2_California",
"description": "Market_2_California"
},
{
"id": "Market_3_NewYork",
"description": "Market_3_NewYork"
},
{
"id": "Market_4_India",
"description": "Market_4_India"
},
{
"id": "Market_5_Raleigh",
"description": "Market_5_Raleigh"
}
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetSettlementCodeTypes succeeded."
}
-
POST/api/config/settlement-points - Gets all the settlement point ids for the given search type(Market/Zone).
Request body:
{
"idList": [
"EastZone_IND"
],
"correlationID": "string",
"settlementPointsSearchType": 1,
"reportableSearchType": 0
}
Response:
{
"ids": [
"STPT_IND_EZ_1"
],
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetSettlementPointIDs succeeded."
}
-
POST/api/config/settlement-statistics - Gets number of reportable, non-reportable and total settlement points for requested market or zone.
Request body:
{
"idList": [
"EastZone_IND"
],
"correlationID": "string",
"settlementPointsSearchType": 1
}
Response:
{
"totalSettlementPoints": 1,
"reportableSettlementPoints": 1,
"nonReportableSettlementPoints": 0,
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetSettlementStatistics succeeded."
}
-
POST/api/config/retailsettlement-statistics - Gets number of reportable, non-reportable and total retailsettlement points for requested market or zone.
Request body:
{
"idList": [
"EastZone_IND"
],
"correlationID": "string",
"settlementPointsSearchType": 1
}
Response:
{
"totalSettlementPoints": 5,
"reportableSettlementPoints": 3,
"nonReportableSettlementPoints": 2,
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetRetailSettlementStatistics succeeded."
}
-
GET/api/config/retail-settlement-point-types - Gets all the retail settlement point types from database.
Request body:
Response:
{
"idsAndDescriptions": [
{
"id": "RetailSettlementPointType",
"description": "RetailSettlementPointType"
},
{
"id": "RST1",
"description": "RST1"
}
],
"correlationID": "",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetRetailSettlementPointTypes succeeded."
}
-
GET/api/config/settlement-retailer-types – Gets list of retailer types from the database.
Request body:
Response:
{
"idsAndDescriptions": [
{
"id": "SettlementRetailerType",
"description": "SettlementRetailerType"
},
{
"id": "SRT1",
"description": "SRT1"
}
],
"correlationID": "",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetSettlementRetailerTypes succeeded."
}
-
GET/api/config/settlement-retailers - Gets the list of settlement retailers for given market and zone, returns all the settlement retailers if market and zone are empty.
Request body:
Response:
{
"correlationID": "",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetAllSettlementRetailers succeeded.",
"settlementRetailers": [
{
"id": "Retailer_BGK_EZ_1",
"name": "Bangkok East Zone Retailer 1",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_EZ_2",
"name": "Bangkok East Zone Retailer 2",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_EZ_3",
"name": "Bangkok East Zone Retailer 3",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_EZ_4",
"name": "Bangkok East Zone Retailer 4",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_EZ_5",
"name": "Bangkok East Zone Retailer 5",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_NZ_1",
"name": "Bangkok North Zone Retailer 1",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_NZ_2",
"name": "Bangkok North Zone Retailer 2",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_NZ_API_1",
"name": "Bangkok North Zone Retailer 1",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_NZ_API_2",
"name": "Bangkok North Zone Retailer 2",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_NZ_API_3",
"name": "Bangkok North Zone Retailer 1",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_NZ_API_4",
"name": "Bangkok North Zone Retailer 1",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_NZ_API_5",
"name": "Bangkok North Zone Retailer 1",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_SZ_1",
"name": "Bangkok South Zone Retailer 1",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_SZ_2",
"name": "Bangkok South Zone Retailer 2",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_SZ_3",
"name": "Bangkok South Zone Retailer 3",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_WZ_1",
"name": "Bangkok West Zone Retailer 1",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_WZ_2",
"name": "Bangkok West Zone Retailer 2",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_WZ_3",
"name": "Bangkok West Zone Retailer 3",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_BGK_WZ_4",
"name": "Bangkok West Zone Retailer 4",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_EZ_1",
"name": "Retailer_IND_EZ_1",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_EZ_2",
"name": "Retailer_IND_EZ_2",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_EZ_3",
"name": "Retailer_IND_EZ_3",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_EZ_4",
"name": "Retailer_IND_EZ_4",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_EZ_5",
"name": "Retailer_IND_EZ_5",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_NZ_1",
"name": "Retailer_IND_NZ_1",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_NZ_2",
"name": "Retailer_IND_NZ_2",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_NZ_API_1",
"name": "India North Zone Retailer 1",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_NZ_API_2",
"name": "India North Zone Retailer 2",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_NZ_API_3",
"name": "India North Zone Retailer 1",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_NZ_API_4",
"name": "India North Zone Retailer 1",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_NZ_API_5",
"name": "India North Zone Retailer 1",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_SZ_1",
"name": "Retailer_IND_SZ_1",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_SZ_2",
"name": "Retailer_IND_SZ_2",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_SZ_3",
"name": "Retailer_IND_SZ_3",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_WZ_1",
"name": "Retailer_IND_WZ_1",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_WZ_2",
"name": "Retailer_IND_WZ_2",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_WZ_3",
"name": "Retailer_IND_WZ_3",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
},
{
"id": "Retailer_IND_WZ_4",
"name": "Retailer_IND_WZ_4",
"typeID": "",
"status": "",
"description": "",
"linkedRetailSettlementPoint": "",
"lastUpdateDateUtc": ""
}
]
}
-
POST/api/config/settlement-enrollment - Converts each retail settlement JSON payload within the SettlementEnrollmentRequest to a compatible Configuration Transfer object for saving against IEE.
-
GET/api/config/commodity-types - Gets list of all available market types.
Request body:
Response:
{
"commodityTypes": [
{
"id": "BlastFurnaceAir",
"abbreviation": "BLA"
},
{
"id": "ChilledWater",
"abbreviation": "CHI"
},
{
"id": "CO2",
"abbreviation": "CO2"
},
{
"id": "Cold",
"abbreviation": "CLD"
},
{
"id": "CompressedAir",
"abbreviation": "COM"
},
{
"id": "ConverterAir",
"abbreviation": "CON"
},
{
"id": "Diesel",
"abbreviation": "DIE"
},
{
"id": "Electric",
"abbreviation": "ELE"
},
{
"id": "FuelOil2",
"abbreviation": "FUE2"
},
{
"id": "FuelOil6",
"abbreviation": "FUE6"
},
{
"id": "Gas",
"abbreviation": "GAS"
},
{
"id": "HotWater",
"abbreviation": "HOT"
},
{
"id": "Intangible",
"abbreviation": "INT"
},
{
"id": "LPG",
"abbreviation": "LPG"
},
{
"id": "Metal",
"abbreviation": "MET"
},
{
"id": "NaturalGasForCOGEN",
"abbreviation": "GC"
},
{
"id": "NaturalGasForSteam",
"abbreviation": "GS"
},
{
"id": "NonUtility",
"abbreviation": "NU"
},
{
"id": "Oxygen",
"abbreviation": "OXY"
},
{
"id": "PropaneGas",
"abbreviation": "PRO"
},
{
"id": "Sewer",
"abbreviation": "SEW"
},
{
"id": "SolidWaste",
"abbreviation": "SOL"
},
{
"id": "Steam",
"abbreviation": "STE"
},
{
"id": "StormWater",
"abbreviation": "XW"
},
{
"id": "Time",
"abbreviation": "TIM"
},
{
"id": "Undefined",
"abbreviation": "Undefined"
},
{
"id": "Warmth",
"abbreviation": "WRM"
},
{
"id": "Water",
"abbreviation": "WAT"
},
{
"id": "Weather",
"abbreviation": "WEA"
}
],
"correlationID": "",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetCommodityTypes succeeded."
}
-
GET/api/config/market-types - Gets list of all available market types.
Request body:
Response:
{
"idsAndDescriptions": [
{
"id": "0",
"description": "Undefined"
},
{
"id": "1",
"description": "Electric"
},
{
"id": "2",
"description": "Water"
},
{
"id": "3",
"description": "Gas"
}
],
"correlationID": "",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetMarketTypes succeeded."
}
-
POST/api/config/linked-entities - Gets the linked entities of the given entity(entityType, entityID) in the given date range.
Request body:
"correlationID": "string",
"currentOnly": true,
"entityId": "SP_RSTPT_IND_WZ_2",
"entityIdType": 0,
"startTime": {
"seconds": 1609479000,
"nanos": 0
},
"endTime": {
"seconds": 1925011800,
"nanos": 0
},
"enrollmentCountsOnly": true
}
Response:
{
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetLinkedEntities succeeded.",
"linkedEntities": [
{
"entityId": "SP_RSTPT_IND_WZ_2:1",
"entityIdType": 10,
"entityDescription": "OLV Channel",
"isLeaf": true,
"effectiveStartTimeUtc": "1970-01-01T00:00:00Z",
"effectiveEndTimeUtc": "2071-01-01T00:00:00Z",
"isCurrent": true,
"display": "SP_RSTPT_IND_WZ_2:1",
"link": {
"effectiveStartDateUtc": "1970-01-01T00:00:00Z",
"effectiveEndDateUtc": "2071-01-01T00:00:00Z"
},
"entityCount": 0,
"lastUpdateDateUtc": "2023-03-13T03:16:22Z"
},
{
"entityId": "SP_RSTPT_IND_WZ_2:2",
"entityIdType": 10,
"entityDescription": "ULV Channel",
"isLeaf": true,
"effectiveStartTimeUtc": "1970-01-01T00:00:00Z",
"effectiveEndTimeUtc": "2071-01-01T00:00:00Z",
"isCurrent": true,
"display": "SP_RSTPT_IND_WZ_2:2",
"link": {
"effectiveStartDateUtc": "1970-01-01T00:00:00Z",
"effectiveEndDateUtc": "2071-01-01T00:00:00Z"
},
"entityCount": 0,
"lastUpdateDateUtc": "2023-03-13T03:16:22Z"
},
{
"entityId": "SP_RSTPT_IND_WZ_2:4",
"entityIdType": 10,
"entityDescription": "RULV Channel",
"isLeaf": true,
"effectiveStartTimeUtc": "1970-01-01T00:00:00Z",
"effectiveEndTimeUtc": "2071-01-01T00:00:00Z",
"isCurrent": true,
"display": "SP_RSTPT_IND_WZ_2:4",
"link": {
"effectiveStartDateUtc": "1970-01-01T00:00:00Z",
"effectiveEndDateUtc": "2071-01-01T00:00:00Z"
},
"entityCount": 0,
"lastUpdateDateUtc": "2023-03-13T03:16:22Z"
},
{
"entityId": "RSTPT_IND_WZ_2",
"entityIdType": 3,
"entityDescription": "This is point test 3",
"isLeaf": false,
"effectiveStartTimeUtc": "1970-01-01T00:00:00Z",
"effectiveEndTimeUtc": "2071-01-01T00:00:00Z",
"isCurrent": true,
"display": "RSTPT_IND_WZ_2",
"link": {
"effectiveStartDateUtc": "1970-01-01T00:00:00Z",
"effectiveEndDateUtc": "2071-01-01T00:00:00Z"
},
"entityCount": 0,
"lastUpdateDateUtc": "2023-03-13T03:37:27Z"
}
]
}
-
POST/api/config/formula-texts - Gets the formula as text for the given entity ID.
Request body:
{
"correlationID": "string",
"entityId": "SP_RSTPT_IND_WZ_2"
}
Response:
{
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetFormulaText succeeded.",
"formulaTexts": [
"SP_RSTPT_IND_WZ_2:1|(SP:2)∗2,"SPRSTPTINDWZ2:2∣@ISUM(group:Retail_IND_WZ_Formula1_2)"
]
}
-
Error scenario:
-
SC 1: Invalid ID
Request body:
Response:
-
-
POST/api/config/servicepoint-channels-bygroup - Gets Service point channels for the given configGroup IDs.
Request body:
{
"idList": [
"Retail_IND_WZ_Formula1_2"
],
"correlationID": "string",
"currentOnly": true,
"idType": "ServicePoint",
"dateRange": {
"start": "string",
"end": "string"
}
}
Response:
{
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetServicePointChannelsByGroup succeeded.",
"servicePointChannels": [
{
"servicePointChannelKey": "7c64540e-773a-4c4c-ae8c-a0e25310c51f",
"channelNumber": 1,
"description": "",
"unitOfMeasureKey": "d484088d-d8ec-4fab-a482-e8475f061052",
"servicePointChannelUom": null,
"spcNodeID": 4881,
"channelType": "Interval",
"id": "SP_Cust_WZ_IND_2:1",
"nodeKey": "bcf30226-f9ac-4131-8a07-37383ceb8151",
"channelDataSource": 0,
"entityChannel": []
}
]
}
-
Error scenarios:
-
SC 1: Invalid ID Type
Request body:
Response:
-
SC 2: Invalid Group ID
Request body:
Response:
-
-
POST/ /api/config/servicepoint/channels - Gets Service point channels for the given service point IDs.
Request body:
{
"idList": [
"SP_RSTPT_IND_WZ_2"
],
"correlationID": "string",
"currentOnly": true,
"idType": "ServicePoint",
"dateRange": {
"start": "string",
"end": "string"
}
}
Response:
{
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetServicePointChannels succeeded.",
"servicePointChannels": [
{
"servicePointChannelKey": "2828da6c-832b-42c6-a7b5-b38291bc23a9",
"channelNumber": 1,
"description": "OLV Channel",
"unitOfMeasureKey": "a4f3351a-79a1-4561-906c-c5cb40ffb52c",
"servicePointChannelUom": {
"id": "KWH",
"description": "Energy_coEle - KilowattHours",
"unit": {
"id": "KWH",
"unitClassId": "Energy",
"defaultFactor": 1,
"conversionOffset": 0
}
},
"spcNodeID": 4841,
"channelType": "Interval",
"id": "SP_RSTPT_IND_WZ_2:1",
"nodeKey": "d8d29f6f-a430-4f73-9f8f-0cb0ad0106f7",
"channelDataSource": 3,
"entityChannel": [
{
"channelId": "SP_RSTPT_IND_WZ_2:1",
"channelNumber": "",
"description": "",
"channelType": "Interval",
"channelUom": {
"id": "KWH",
"description": "Energy_coEle - KilowattHours",
"unit": {
"id": "KWH",
"unitClassId": "Energy",
"defaultFactor": 1,
"conversionOffset": 0
}
},
"intervalLengthInSeconds": 3600,
"rollLengthInSeconds": 0,
"keMultiplier": 0,
"displayMultiplier": 0,
"numberOfDials": 0,
"numberOfDecimals": 0,
"truncationFactor": 0,
"sourceReactive": "",
"encoderType": "",
"meterChannelOffset": "",
"meterLink": []
}
]
},
{
"servicePointChannelKey": "9ac1655d-492d-4572-abd8-24db0fcfc863",
"channelNumber": 2,
"description": "ULV Channel",
"unitOfMeasureKey": "a4f3351a-79a1-4561-906c-c5cb40ffb52c",
"servicePointChannelUom": {
"id": "KWH",
"description": "Energy_coEle - KilowattHours",
"unit": {
"id": "KWH",
"unitClassId": "Energy",
"defaultFactor": 1,
"conversionOffset": 0
}
},
"spcNodeID": 4842,
"channelType": "Interval",
"id": "SP_RSTPT_IND_WZ_2:2",
"nodeKey": "908c666e-a646-46b7-9be5-c94c7e9abf36",
"channelDataSource": 3,
"entityChannel": [
{
"channelId": "SP_RSTPT_IND_WZ_2:2",
"channelNumber": "",
"description": "",
"channelType": "Interval",
"channelUom": {
"id": "KWH",
"description": "Energy_coEle - KilowattHours",
"unit": {
"id": "KWH",
"unitClassId": "Energy",
"defaultFactor": 1,
0 "conversionOffset": 0
}
},
"intervalLengthInSeconds": 3600,
"rollLengthInSeconds": 0,
"keMultiplier": 0,
"displayMultiplier": 0,
"numberOfDials": 0,
"numberOfDecimals": 0,
"truncationFactor": 0,
"sourceReactive": "",
"encoderType": "",
"meterChannelOffset": "",
"meterLink": []
}
]
},
{
"servicePointChannelKey": "8eb922df-9d35-4633-9b17-cb8ef69aebde",
"channelNumber": 4,
"description": "RULV Channel",
"unitOfMeasureKey": "a4f3351a-79a1-4561-906c-c5cb40ffb52c",
"servicePointChannelUom": {
"id": "KWH",
"description": "Energy_coEle - KilowattHours",
"unit": {
"id": "KWH",
"unitClassId": "Energy",
"defaultFactor": 1,
"conversionOffset": 0
}
},
"spcNodeID": 4843,
"channelType": "Interval",
"id": "SP_RSTPT_IND_WZ_2:4",
"nodeKey": "3eabdb51-0804-442b-9cb0-a2458c57abc6",
"channelDataSource": 1,
"entityChannel": [
{
"channelId": "SP_RSTPT_IND_WZ_2:4",
"channelNumber": "",
"description": "",
"channelType": "Interval",
"channelUom": {
"id": "KWH",
"description": "Energy_coEle - KilowattHours",
"unit": {
"id": "KWH",
"unitClassId": "Energy",
"defaultFactor": 1,
"conversionOffset": 0
}
},
"intervalLengthInSeconds": 3600,
"rollLengthInSeconds": 0,
"keMultiplier": 0,
"displayMultiplier": 0,
"numberOfDials": 0,
"numberOfDecimals": 0,
"truncationFactor": 0,
"sourceReactive": "",
"encoderType": "",
"meterChannelOffset": "",
"meterLink": []
}
]
}
]
}
-
Error scenarios:
-
SC 1: Invalid ID Type
Request body:
Response:
-
SC 2: Invalid Entity ID
Request body:
Response:
-
-
POST/api/config/meter/channels - Gets meter channels(Interval/Register) for the given meter IDs.
Request body:
{
"idList": [
"M_Cust_ART_01"
],
"correlationID": "string",
"currentOnly": true,
"idType": "Meter",
"dateRange": {
"start": "1970-01-01T00:00:00Z",
"end": "2071-01-01T00:00:00Z"
}
}
Response:
{
"correlationID": "string",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - GetMeterChannels succeeded.",
"meterChannels": [
{
"channelId": "M_Cust_ART_01:1",
"channelNumber": "1",
"description": "",
"channelType": "Register",
"channelUom": {
"id": "KWH_DEL",
"description": "kWh Electric Delivered",
"unit": {
"id": "KWH",
"unitClassId": "Energy",
"defaultFactor": 1,
"conversionOffset": 0
}
},
"intervalLengthInSeconds": 0,
"rollLengthInSeconds": 0,
"keMultiplier": 0,
"displayMultiplier": 2,
"numberOfDials": 10,
"numberOfDecimals": 0,
"truncationFactor": 0,
"sourceReactive": "",
"encoderType": "",
"meterChannelOffset": "",
"meterLink": []
},
{
"channelId": "M_Cust_ART_01:1",
"channelNumber": "1",
"description": "",
"channelType": "Interval",
"channelUom": {
"id": "KWH_DEL",
"description": "kWh Electric Delivered",
"unit": {
"id": "KWH",
"unitClassId": "Energy",
"defaultFactor": 1,
"conversionOffset": 0
}
},
"intervalLengthInSeconds": 3600,
"rollLengthInSeconds": 3600,
"keMultiplier": 1,
"displayMultiplier": 0,
"numberOfDials": 0,
"numberOfDecimals": 0,
"truncationFactor": 0,
"sourceReactive": "",
"encoderType": "",
"meterChannelOffset": "",
"meterLink": []
}
]
}
-
GET/api/config/config-groups - Gets all config groups available in the system.
Response:
{
"correlationID": "",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - get config groups succeeded.",
"configGroups": [
{
"objectKey": "3d283395-27b2-46f7-aa84-a95c372a3ccf",
"id": "Acc dyn",
"groupType": "Account",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "b13cfba3-0c58-4244-8bcc-498f2e97f232",
"id": "Acc static",
"groupType": "Account",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "736a5d98-b62c-4291-9354-440454c47756",
"id": "Customer dyn",
"groupType": "Customer",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "83aefc5c-7edc-48ab-b6c2-47b63b19ba29",
"id": "Customer static",
"groupType": "Customer",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "aaf6ef3b-0f0e-4a07-b85a-b0400d59ec1f",
"id": "EZ_Alaska_CH1",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "98181e04-a8f0-4094-86a9-3fdb3c649d1e",
"id": "EZ_Alaska_CH2",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "ee0c45c2-3e96-457a-9c0a-35fb28c48ca9",
"id": "EZ_BGK_CH1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "dca0b81e-0b9f-4643-8332-1d4efb2aa09a",
"id": "EZ_BGK_CH2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "3c7b2b52-a4ce-464f-88ae-4c53bbd81bd3",
"id": "EZ_California_CH1",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "e819b05d-75a6-46c5-86b8-7d935d5773b3",
"id": "EZ_California_CH2",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "a19f414b-73b8-4066-a79e-3397a2e199c5",
"id": "EZ_IND_CH1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "9bb77056-0fc5-47b1-8801-1f277e670eab",
"id": "EZ_IND_CH2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "f81061d1-4534-4cf4-89ad-ca783901842b",
"id": "EZ_NewYork_CH1",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "3bdb0be5-ddd5-4bdb-ad4f-ceff98d5e49f",
"id": "EZ_NewYork_CH2",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "29197871-2100-431b-881a-b6945c2dea53",
"id": "Market_Alaska_CH1",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "f08a5dab-b1c1-4610-98de-24354ea3edc1",
"id": "Market_Alaska_CH2",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "62b36ebf-2486-4a85-824f-52b2f25d27a9",
"id": "Market_Bangkok_CH1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "49d67932-21d4-4644-a9fd-28812a98a558",
"id": "Market_Bangkok_CH2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "d4d73ce3-db3b-4242-bb89-8fa948d303ff",
"id": "Market_California_CH1",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "1d1893cb-f40d-4c1b-84c4-b0f596f7a78b",
"id": "Market_California_CH2",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "78bd4d99-4e92-4081-bc80-3c2b14e5cd3c",
"id": "Market_INDIA_CH1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "537f1497-aba6-41e3-aaae-9c585d1265ae",
"id": "Market_INDIA_CH2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "3b211308-9f20-4ff1-902b-af1c972a0b41",
"id": "Market_NewYork_CH1",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "daf60b4d-2ba8-4ac4-8368-fa8bff7aa73a",
"id": "Market_NewYork_CH2",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "160a4821-90bb-40e7-a22b-b380a1f8ff00",
"id": "Meter dyn",
"groupType": "Meter",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "b3100d39-eb7c-4f60-9938-02cc8182a5e3",
"id": "Meter static",
"groupType": "Meter",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "21296ab3-2c13-46d3-b3b1-a2c4febdb7a4",
"id": "NZ_Alaska_CH1",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "c6c8374e-0a8a-4b91-86c0-4e5da7131b2d",
"id": "NZ_Alaska_CH2",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "4b6c762f-fbc2-45df-a225-3c95e65669c6",
"id": "NZ_BGK_CH1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "92e1de66-a818-4d2b-acfc-7aa5e45e2e90",
"id": "NZ_BGK_CH2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "f7f1d285-d001-4cee-a4a5-26181bdca38c",
"id": "NZ_California_CH1",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "d980ce28-9b53-4520-b52e-9a0bcef26565",
"id": "NZ_California_CH2",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "20cdd48e-8973-417d-83a1-2a7db1d4f7b9",
"id": "NZ_IND_CH1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "45ebfeda-ea84-4b63-9244-ef354ae86b84",
"id": "NZ_IND_CH2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "034c0314-a095-4687-85ae-5ba03088d96e",
"id": "NZ_NewYork_CH1",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "61865208-e2f6-4fa6-822e-1e52425a9d00",
"id": "NZ_NewYork_CH2",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "926cce38-54e5-48d0-8246-ea196c6f2757",
"id": "Retail_BGK_EZ_Formula1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "fedd7a10-bc59-4e6c-8499-26fc3c0c1708",
"id": "Retail_BGK_EZ_Formula1_2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "d314c262-d63f-4ec8-96ad-30792bb21132",
"id": "Retail_BGK_EZ_Formula1_3",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "2ac357ef-4754-4aca-93ae-855627ef5df9",
"id": "Retail_BGK_EZ_Formula1_4",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "be4975a0-16eb-4b61-8553-b1b7462d8445",
"id": "Retail_BGK_EZ_Formula1_5",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "b35ff0c9-986d-4a8d-87c7-e77b89f57a14",
"id": "Retail_BGK_NZ_Formula1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "e4ec07c5-0e1a-4a8f-8c64-9b9d60bd3f37",
"id": "Retail_BGK_NZ_Formula1_2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "527a983e-6b9f-4d5a-97fb-4489a5dab45f",
"id": "Retail_BGK_SZ_Formula1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "2564a1be-14bc-4682-8952-0bc4ebc52789",
"id": "Retail_BGK_SZ_Formula1_2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "446f54bb-6082-4915-b99c-a1e931e2b428",
"id": "Retail_BGK_SZ_Formula1_3",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "c0c070cc-204d-49e7-b774-b63d816d21bf",
"id": "Retail_BGK_WZ_Formula1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "e2af2c45-30d9-4ca3-8e0c-8383b638b332",
"id": "Retail_BGK_WZ_Formula1_2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "e447a4a4-d8bb-4820-8f8c-706698f51b07",
"id": "Retail_BGK_WZ_Formula1_3",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "252b83a7-aeac-4694-93e9-fb1824b5b237",
"id": "Retail_BGK_WZ_Formula1_4",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "08ec4dda-90ca-455c-ad3d-1c9c2c481a75",
"id": "Retail_IND_EZ_Formula1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "59fcf07e-dc6e-494d-879f-06f8e209d5de",
"id": "Retail_IND_EZ_Formula1_2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "a4fdf004-ca06-4138-8f04-c412bc5afae4",
"id": "Retail_IND_EZ_Formula1_3",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "4226f6d1-febf-4c6b-9f12-6eaaa60701c3",
"id": "Retail_IND_EZ_Formula1_4",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "a4a60858-b8c6-4a2f-8422-7397d3ff787c",
"id": "Retail_IND_EZ_Formula1_5",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "80cce100-8960-481d-8c6c-c309eed19a4d",
"id": "Retail_IND_NZ_Formula1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "d5b1d7be-7383-4cb6-a9c7-dab3d354069e",
"id": "Retail_IND_NZ_Formula1_2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "d2dc5cd8-80ef-415a-8ced-965ff53ca75e",
"id": "Retail_IND_SZ_Formula1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "6b62391b-b5d6-4fb5-9ec8-8fcf448ae35f",
"id": "Retail_IND_SZ_Formula1_2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "cf8e6cfe-1fb8-43a4-bee2-e242f415ce66",
"id": "Retail_IND_SZ_Formula1_3",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "cdf3eda0-8637-42c1-9795-fd75caf0a914",
"id": "Retail_IND_WZ_Formula1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "afc4e9ab-e76f-4083-b3f4-7bc14df33794",
"id": "Retail_IND_WZ_Formula1_2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "bb9b68bf-e825-4e0e-b7bb-48b847616760",
"id": "Retail_IND_WZ_Formula1_3",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "2bbc7cb1-2d80-4a54-aa0c-dda7643f823f",
"id": "Retail_IND_WZ_Formula1_4",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "12cb75dc-64a6-4c72-9171-ddf33f367ec8",
"id": "SP dyn",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "ed952c09-1625-4b79-9387-24297b099dc2",
"id": "SP static",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "2f829e9a-4c09-445c-8fbe-ed1b65c44654",
"id": "SZ_Alaska_CH1",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "5feabb75-04c4-4a8d-a46c-1df6dcbc8dfe",
"id": "SZ_Alaska_CH2",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "aea5d436-8ca1-4322-81be-6ac723b2da8f",
"id": "SZ_BGK_CH1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "9ac2481d-d70c-4d55-91af-860c7f63d86d",
"id": "SZ_BGK_CH2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "c81cde03-4b1e-4872-ae8e-7fdb7e205dcc",
"id": "SZ_California_CH1",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "c60d963b-7504-46a6-b66f-37bcc27da2b0",
"id": "SZ_California_CH2",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "3110fe8b-b1e4-44c1-9876-5a5b154c7189",
"id": "SZ_IND_CH1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "425f1858-aa86-424b-a883-89ffa006cb26",
"id": "SZ_IND_CH2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "84f031b9-e34c-4665-9aaf-fbe23ead1a02",
"id": "SZ_NewYork_CH1",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "6e650618-28de-4e91-b919-0e57b2a1e732",
"id": "SZ_NewYork_CH2",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "43e9ac50-d29d-4769-bde6-5c196fb1b463",
"id": "WZ_Alaska_CH1",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "c913dec0-1357-40f3-8d60-7d1f1bf7bd07",
"id": "WZ_Alaska_CH2",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "683052e1-c5f3-4323-95d1-34a7bf38b14f",
"id": "WZ_BGK_CH1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "15e8e799-61dd-4a59-b82f-b912f030552c",
"id": "WZ_BGK_CH2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "d12c5bd0-f45a-4db0-a764-a94228a4474c",
"id": "WZ_California_CH1",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "c59df07e-f89d-4d36-aff9-87037ea30f9f",
"id": "WZ_California_CH2",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "eef59720-661c-4864-bb1c-c5783c364d95",
"id": "WZ_IND_CH1",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "abcf4866-ecb4-4235-86bc-56ea500abff5",
"id": "WZ_IND_CH2",
"groupType": "ServicePoint",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "c6a45320-08b9-42f8-83a6-d862112b340e",
"id": "WZ_NewYork_CH1",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
},
{
"objectKey": "bc15d00e-01ae-4629-a5de-0810e2be1850",
"id": "WZ_NewYork_CH2",
"groupType": "ServicePointChannel",
"dateRange": {
"start": "1/1/1970 12:00:00 AM",
"end": "1/1/2071 12:00:00 AM"
}
}
]
}
-
POST/api/config/entity-udas - fetches entity udas(which has value) and its values for the requested entity.
Request body:
{
"entityId":"RSTPT_IND_NZ_1",
"entityIdType":3
}
Response:
{
"correlationID": "44b530be-de94-44f8-aa0a-218de5840eed",
"userDefinedAttributes": "{"RSTPT UDA1":"RSTPT UDA1"}",
"responseMessageID": "200",
"responseMessage": "IEE.Configuration - FetchEntityUdas succeeded."
}
See also IEE Configuration REST API.