Web UI API endpoints

This section discusses parameters for each Web UI API endpoint, expected response, and sample request and response payloads, and transaction types.

GET /api/v{version}/market/transactions. Get the market transactions from the system.

Response:

{

"marketTransactions": [

{

"transactionKey": "cb565c4b-de75-4e96-8693-9c17d617e322",

"transactionId": "S-020-4529822624-REGS-20240306-61NF",

"mpan": "SP_Cust_EZ_BGK_2",

"transactionType": {

"key": "IF-028",

"value": "Supplier consumption amendment request response"

},

"transactionCorrelationId": "85ECEF7D-BE5F-40A4-AFC7-4C500E96C1D2",

"direction": "Sent",

"senderId": "1009012345",

"senderUniqueReference": "S-020-4529822624-REGS-20240306-61NF",

"receivedSentDateTime": "2024-08-05T14:27:10.420Z",

"assignedTo": "itronee",

"assignedToUserKey": "1795134d-ea41-4086-aedd-6d4781d9602d",

"activityStatus": "Open",

"updatedDateTime": "2024-07-25T14:27:10.420Z",

"internalFileName": "Test2",

"externalFileName": "ExternalFileName2",

"responseMessageId": "200"

}

],

"correlationID": "",

"responseMessage": "IEE.Settlements - GetTransactions succeeded. ",

"responseMessageId": "200"

}
Error message

The following image shows the error message that occurs when a required field is not filled out.

"status": 400,

"errors": {

"endDate": [

"The EndDate field is required."

],

"startDate": [

"The StartDate field is required."

],

"transactionType": [

"The TransactionType field is required."

]

}
POST/api/v{version}/market/transactions. Add and create an outbound transaction.

Response:

{

"correlationID": "00000000-0000-0000-0000-000000000000",

"responseMessage": "IEE.Settlements - SaveMarketTransactions succeeded.",

"responseMessageId": "200"

}
GET /api/v{version}/market/transactions/{transactionKey}. Gets the general properties of a transaction by key.

Response:

{

"transactionGroup": {

"key": "Data Integration Platform (DIP)",

"value": "Data Integration Platform (DIP)"

},

"createdDateTime": "2024-08-05T14:27:10.420Z",

"notes": "Notes2",

"updatedBy": "itronee",

"transactionKey": "cb565c4b-de75-4e96-8693-9c17d617e322",

"transactionId": "S-020-4529822624-REGS-20240306-61NF",

"mpan": "SP_Cust_EZ_BGK_2",

"transactionType": {

"key": "IF-028",

"value": "Supplier consumption amendment request response"

},

"transactionCorrelationId": "85ECEF7D-BE5F-40A4-AFC7-4C500E96C1D2",

"direction": "Sent",

"senderId": "1009012345",

"senderUniqueReference": "S-020-4529822624-REGS-20240306-61NF",

"receivedSentDateTime": "2024-08-05T14:27:10.420Z",

"assignedTo": "itronee",

"assignedToUserKey": "1795134d-ea41-4086-aedd-6d4781d9602d",

"activityStatus": "Open",

"updatedDateTime": "2024-08-05T14:27:10.420Z",

"internalFileName": "Test2",

"externalFileName": "ExternalFileName2",

"correlationID": "",

"responseMessage": "IEE.Settlements - FindTransaction succeeded.",

"responseMessageId": "200"

}
PUT /api/v{version}/market/transactions/{transactionKey}. Update transaction with new status, assignee, and notes.

Response:

{

"updateStatusMessage": "",

"correlationID": "00000000-0000-0000-0000-000000000000",

"responseMessage": "IEE.Settlements Market - Update succeeded.",

"responseMessageId": "200"

}
Error scenarios:
- SC 1: When the transaction key is invalid
  
  Response:
  
  Response Message Code: 400
  
  Response Message: IEE.Settlements Market - Update failed.
- SC 2: When the assigned to user key is invalid
  
  Response:
  
  Response Message Code: 400
  
  Response Message: Invalid AssignedToUserKey
- SC 3: When the last modified user key is invalid
  
  Response:
  
  Response Message Code: 400
  
  Response Message : Invalid LastModifiedUserKey
GET /api/v{version}/market/transaction-types. Gets the transaction types from the system.

Response:

{

"eventCode": "ActivePowerDefaulted",

"gspGroupId": "AE",

"distributorDipId": "1009012345",

"settlementImpactedDataServiceDipId": "4531824128",

"settlementImpactedSupplierDipId": "4531824128",

"settlementRunExecutionDate": "2022-09-13T07:22:52.525Z",

"settlementCode": "R1 - First Reconciliation",

"runNumber": "1234567",

"connectionTypeIndicator": "L - LV with CT",

"connectionTypeEffectiveFromDate": "2020-09-13T07:22:52.525Z",

"readingTitles": [

"measurementQuantityId",

"consumptionComponentClassId",

"consumptionComponentIndicator",

"settlementDayDate",

"periodDuration",

"settlementPeriodEffectiveToDateTime",

"defaultedSPConsumption",

"defaultLoadShapeFlag"

],

"readings": [

{

"measurementQuantityId": "AI - Active Import",

"consumptionComponentClassId": "120 - Segment-A; Measure-AI; Cons. Component Ind.-C; Conn.-W; Est.Methods-A, A1, A2, A3",

"consumptionComponentIndicator": "C - Consumption",

"settlementDayDate": "2022-09-13T07:22:52.525Z",

"periodDuration": 30,

"settlementPeriodEffectiveToDateTime": "2022-09-13T07:22:52.525Z",

"defaultedSPConsumption": 789,

"defaultLoadShapeFlag": "E - Back Stop"

}

],

"transactionKey": "525afc80-ff56-43b5-9944-05f7ab9d5a2a",

"correlationID": "",

"responseMessage": "IEE.Settlements - GetTransactionsDetail succeeded.",

"responseMessageId": "200"

}
GET /api/v{version}/market/transactions/{transactionId}/data. Gets the data properties for the transaction by the transaction type and transaction ID.

Response:

{

"eventCode": "ActivePowerDefaulted",

"gspGroupId": "AE",

"distributorDipId": "1009012345",

"settlementImpactedDataServiceDipId": "4531824128",

"settlementImpactedSupplierDipId": "4531824128",

"settlementRunExecutionDate": "2022-09-13T07:22:52.525Z",

"settlementCode": "R1 - First Reconciliation",

"runNumber": "1234567",

"connectionTypeIndicator": "L - LV with CT",

"connectionTypeEffectiveFromDate": "2020-09-13T07:22:52.525Z",

"readingTitles": [

"measurementQuantityId",

"consumptionComponentClassId",

"consumptionComponentIndicator",

"settlementDayDate",

"periodDuration",

"settlementPeriodEffectiveToDateTime",

"defaultedSPConsumption",

"defaultLoadShapeFlag"

],

"readings": [

{

"measurementQuantityId": "AI - Active Import",

"consumptionComponentClassId": "120 - Segment-A; Measure-AI; Cons. Component Ind.-C; Conn.-W; Est.Methods-A, A1, A2, A3",

"consumptionComponentIndicator": "C - Consumption",

"settlementDayDate": "2022-09-13T07:22:52.525Z",

"periodDuration": 30,

"settlementPeriodEffectiveToDateTime": "2022-09-13T07:22:52.525Z",

"defaultedSPConsumption": 789,

"defaultLoadShapeFlag": "E - Back Stop"

}

],

"transactionKey": "525afc80-ff56-43b5-9944-05f7ab9d5a2a",

"correlationID": "",

"responseMessage": "IEE.Settlements - GetTransactionsDetail succeeded.",

"responseMessageId": "200"

}
Error scenarios:
- SC 1: When the transaction key is invalid
  
  Response:
  
  Response Message Code: 404
  
  Response Message: No records found for the specified transaction key.
- SC 2: When the transaction key is not in the valid GUID format
  
  Response:
  
  Response Message Code: 400
  
  Response Message : GetTransactionsDetail - invalid TransactionKey.
GET /api/v{version}/market/settings. Gets the customer setting by the customer ID.

Response:

{

"customerID": "eon",

"senderDIPID": "1009012345",

"customerDirectContractDataServiceEffectiveDIPID": "4531824128"

}
GET /api/v{version}/market/transactions/{transactionType}/event-codes. Gets the event codes by the transaction type.

Response:

[

{

"id": "ConsumptionAmendment",

"description": "Consumption Amendment",

"typeId": "ValidationResolutionReason"

}

]