v1

latestOpenAPI 3.0.02026-07-23135518615.8 KB
DIP Channel Replay/Requeue

Replay messages from a DIP Channel Publication

Allows a Market Participant to replay messages

post/dip-channel/{id}/replay/{recipient-id}

Path parameters

id'IF-001' | 'IF-002' | 'IF-003' | 'IF-004' | 'IF-005' | 'IF-006' | 'IF-007' | 'IF-008' | 'IF-009' | 'IF-013' | 'IF-014' | 'IF-015' | 'IF-016' | 'IF-018' | 'IF-019' | 'IF-020' | 'IF-021' | 'IF-022' | 'IF-023' | 'IF-024' | 'IF-025' | 'IF-026' | 'IF-027' | 'IF-028' | 'IF-031' | 'IF-032' | 'IF-033' | 'IF-034' | 'IF-035' | 'IF-036' | 'IF-037' | 'IF-038' | 'IF-039' | 'IF-040' | 'IF-041' | 'IF-043' | 'IF-044' | 'IF-045' | 'IF-047' | 'IF-050' | 'IF-051' | 'IF-061' | 'IF-062' | 'IF-063' | 'IF-064' | 'IF-065' | 'REP-002' | 'REP-002A' | 'REP-002B' | 'REP-003' | 'REP-003A' | 'REP-004' | 'REP-006' | 'REP-007' | 'REP-008' | 'REP-009' | 'REP-900' | 'REP-901' required

Interface ID

Example:IF-007
recipient-idstring required

DIP Participant Id

Example:1009012345

Headers

X-DIP-Signaturestring required
X-DIP-Signature-Datestring required
X-DIP-Content-Hashstring required
X-DIP-Signature-Certificatestring required

Request body

datetimeFromstring nullable required

ISO 8601 Date/time

datetimeTostring nullable required

ISO 8601 Date/time

eventCodestring nullable required

Event Code

MPANstring nullable required

MPAN Core

transactionIDsDT014DIPTransactionID[]
versionstring nullable required

The Schema Version against which the message has been constructed

Example request

{
  "datetimeFrom": "2022-03-21T19:05:00+00:00",
  "datetimeTo": "2022-03-21T19:05:00+00:00",
  "eventCode": "[EventName]",
  "MPAN": "2000056535971",
  "transactionIDs": [
    "T-IF-006-0123456789-SUP-20220401-1234CC0123456789"
  ]
}

Response

Replayed Messages

Example response

[
  {
    "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": {
        "B002": {
          "incomingSupplierDIPID": "1009012345",
          "incomingSupplierMPID": "EMEB",
          "supplierEffectiveFromDate": "2022-03-21T19:05:00+00:00"
        },
        "B004": {
          "domesticPremiseIndicator": true,
          "domesticPremiseIndicatorEffectiveFromDate": "2022-03-21T19:05:00+00:00"
        },
        "B006": {
          "customerDirectContractMeteringService": true,
          "customerDirectContractMeteringServiceDIPID": "1009012345",
          "customerDirectContractDataService": true,
          "customerDirectContractDataServiceDIPID": "1009012345"
        },
        "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"
        },
        "B027": {
          "annualConsumption": "789.000",
          "annualConsumptionEffectiveFromDate": "2022-03-21T19:05:00+00:00",
          "annualConsumptionQualityIndicator": "A"
        },
        "B029": {
          "DCCServiceFlag": "A",
          "DCCEffectiveFromDate": "2022-03-21T19:05:00+00:00"
        },
        "B030": {
          "IHDInstallStatus": "D",
          "IHDEffectiveFromDate": "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"
        },
        "B035List": [
          {
            "linkedImportExportMPAN": "2000056535971",
            "linkedMPANEnergyDirection": "I",
            "importExportMPANSupplierDIPID": "1009012345",
            "importExportMPANSupplierMPID": "EMEB"
          }
        ],
        "B037List": [
          {
            "primaryMPAN": "2000056535971",
            "secondaryMPAN": "2000056535971"
          }
        ]
      }
    }
  }
]