v1

latestOpenAPI 3.0.02026-07-23135518615.8 KB
DIP Message Validation Endpoints

Submit IF-033 with Event Code MSAppSPRequest message for validation

Allows a Market Participant to validate a single messages for debugging purposes only

post/validate/IF-033/MSAppSPRequest

Request body

Example request

[
  {
    "payload": {
      "CommonBlock": {
        "S0": {
          "schemaVersion": "011"
        },
        "S1": {
          "environmentTag": "DEV",
          "subText": "additonal text to separate messages in testing - ignore in production",
          "senderUniqueReference": "S-IF-005-0123456789-SUP-20222313-12345687a1234567a",
          "senderTimestamp": "2022-03-21T19:05:00+00:00",
          "senderDIPID": "1009012345",
          "senderRoleID": "SUP",
          "senderCorrelationID": "CI-20220401-1234567890123abce123092",
          "DIPConnectionProviderID": "1009012345"
        },
        "A0": {
          "primaryRecipients": [
            "1009012345"
          ],
          "secondaryRecipients": [
            "1009012345"
          ],
          "always": [
            "1009012345"
          ]
        },
        "D0": {
          "transactionID": "T-IF-006-0123456789-SUP-20220401-1234CC0123456789",
          "transactionTimestamp": "2022-03-21T19:05:00+00:00",
          "publicationID": "PUB-001",
          "initialCorrelationID": "CI-20220401-1234567890123abce123092",
          "serviceTicketURL": "https://<baseURL>/nav_to.do?uri=<table name>.do?sys_id=-1%26sysparm_query=<field=value>"
        },
        "M0": {
          "MPANCore": "2000056535971",
          "distributorDIPID": "1009012345",
          "GSPGroupID": "_K"
        }
      },
      "CustomBlock": {
        "B012": {
          "serviceProviderAppointmentRequestingSupplierDIPID": "1009012345",
          "serviceProviderAppointmentRequestingSupplierMPID": "EMEB"
        },
        "B070": {
          "proposedMeteringServiceDIPID": "1009012345",
          "proposedMeteringServiceMPID": "EMEB",
          "proposedMeteringServiceDIPEffectiveFromDate": "2022-03-21T19:05:00+00:00",
          "contractReferenceMeteringService": "MTR-123-123",
          "appointmentScenario": "COS"
        },
        "B072": {
          "incumbentMeteringServiceDIPID": "1009012345",
          "incumbentMeteringServiceMPID": "EMEB"
        },
        "B022": {
          "meteringPointPostcode": "SW1A 2AA",
          "addressLine1": "Address Line",
          "addressLine2": "Address Line",
          "addressLine3": "Address Line",
          "addressLine4": "Address Line",
          "addressLine5": "Address Line",
          "addressLine6": "Address Line",
          "addressLine7": "Address Line",
          "addressLine8": "Address Line",
          "addressLine9": "Address Line"
        },
        "B023": {
          "connectionTypeIndicator": "W",
          "connectionTypeEffectiveFromDate": "2022-03-21T19:05:00+00:00",
          "energyDirection": "I"
        },
        "B024": {
          "DUOSTariffIDEffectiveFromDate": "2022-03-21T19:05:00+00:00"
        },
        "B025": {
          "energisationStatus": "D",
          "energisationStatusEffectiveFromDate": "2022-03-21T19:05:00+00:00"
        },
        "B026": {
          "marketSegmentIndicator": "S",
          "marketSegmentIndicatorEffectiveFromDate": "2022-03-21T19:05:00+00:00"
        },
        "B029": {
          "DCCServiceFlag": "A",
          "DCCEffectiveFromDate": "2022-03-21T19:05:00+00:00"
        },
        "B031": {
          "SMSOID": "TRIL",
          "SMSOEffectiveFromDate": "2022-03-21T19:05:00+00:00"
        },
        "B032": {
          "profileClass": "02",
          "profileClassEffectiveFromDate": "2022-03-21T19:05:00+00:00",
          "SSC": "0123",
          "SSCEffectiveFromDate": "2022-03-21T19:05:00+00:00"
        },
        "B905List": [
          {
            "existingMeter": {
              "meterID": "A123456789",
              "meterType": "S2CDE",
              "manufacturersMakeAndType": "SIEMENS ZMD120AR44.0200.C4",
              "ESMEGUID": "0C-A2-F4-00-00-76-21-BC",
              "meterLocation": "A",
              "numberOfDisplayedRegisterDigits": 5,
              "meterInstallationDate": "2022-03-21T19:05:00+00:00"
            },
            "existingMAP": {
              "meterAssetProviderID": "MAP1",
              "meterAssetProviderEffectiveFromDate": "2022-03-21T19:05:00+00:00"
            }
          }
        ],
        "B907List": [
          {
            "existingMeter": {
              "linkedImportExportMPAN": "2000056535971",
              "linkedMPANEnergyDirection": "I",
              "importExportMPANSupplierDIPID": "1009012345",
              "importExportMPANSupplierMPID": "EMEB"
            },
            "historyMAP": [
              {
                "existingMeter": {
                  "meterID": "A123456789",
                  "meterType": "S2CDE",
                  "manufacturersMakeAndType": "SIEMENS ZMD120AR44.0200.C4",
                  "ESMEGUID": "0C-A2-F4-00-00-76-21-BC",
                  "meterLocation": "A",
                  "numberOfDisplayedRegisterDigits": 5,
                  "meterInstallationDate": "2022-03-21T19:05:00+00:00"
                },
                "historyMAP": [
                  {
                    "meterAssetProviderID": "MAP1",
                    "meterAssetProviderEffectiveFromDate": "2022-03-21T19:05:00+00:00"
                  }
                ]
              }
            ]
          }
        ],
        "B908List": [
          {
            "existingMeter": {
              "primaryMPAN": "2000056535971",
              "secondaryMPAN": "2000056535971"
            },
            "historyMAP": [
              {
                "existingMeter": {
                  "meterID": "A123456789",
                  "meterType": "S2CDE",
                  "manufacturersMakeAndType": "SIEMENS ZMD120AR44.0200.C4",
                  "ESMEGUID": "0C-A2-F4-00-00-76-21-BC",
                  "meterLocation": "A",
                  "numberOfDisplayedRegisterDigits": 5,
                  "meterInstallationDate": "2022-03-21T19:05:00+00:00"
                },
                "historyMAP": [
                  {
                    "meterAssetProviderID": "MAP1",
                    "meterAssetProviderEffectiveFromDate": "2022-03-21T19:05:00+00:00"
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
]

Response

Message OK

string required