marketinformation.natgrid.co.uk Open in urlscan Pro
2606:4700::6812:7662  Public Scan

Form analysis
0 forms found in the DOM

Text Content

PUBLIC SOAP SERVICE

This API offers access to all published information by publication object data
item. In general, 5 years of rolling historic data can be accessed for most
publication object data items, however, some items may have less than 5 years of
historic data if publishing was introduced within the last 5 years.

The request object accepts query parameters controlling the response.

Parameter Name Title Description LatestFlag String When set to "Y" only return
the latest values published per gas day, otherwise all data published will be
returned. Expected values "Y" or "N". ApplicableForFlag String When set to "Y"
the supplied From and To restriction values are restricting the Applicable For
date, when set to anything else they are applied to the Applicable At date time.
Expected values "Y" or "N". FromDate DateTime Date time to apply as the From
value in Applicable restriction. ToDate DateTime Date time to apply as the To
value in Applicable restriction. DateType String Controls whether date
restriction applies to Gas day or Calendar day. When set to "GASDAY" then the
timestamp for FromDate will be defaulted to the start of the gas Day and
timestamp for ToDate will be defaulted to the end of the Gas Day. Expected
values "NORMALDAY" or "GASDAY". PublicationObjectNameList String Array List of
publication object data item names. These values can be found by reading the
published API data item list.

When executed all published values matching the query parameters are returned
grouped by Publication Object Name with the following fields of data.

Field Name Description ApplicableAt Date and time for which this data is
applicable at. ApplicableFor Date and time indicating the gas day for which this
data is applicable for. Value The data item value. Note this can be character or
numeric, character values have a maximum length of 2000 characters.
GeneratedTimeStamp Date and time on which this data was generated.
QualityIndicator String value indicating any quality markers against the data.
Expected values: "E" Expired, "A" Amended, "C" Corrected, "S" Substituted, "L"
Late Received. Substituted String value indicating the dat has been substituted.
Expected values: "Y" Yes, "N" No CreateDate Date and time on which this data was
published.

This API imposes a limit on the amount of data that can be requested. If the
number of days in the requested date range multiplied by the number of
publication object data items in the request exceeds 3600 then an error response
will be returned.

National Gas Transmission proactively monitors the use of this API. If you are
deemed to be accessing the website at a level that we believe to be unnecessary
given the current rate at which the data on the website is refreshed, we will
ask you to reconsider your API script. This is to ensure that operational and
commercial gas data items continue to be available to all gas community members
and other interested parties in a consistent, timely and accurate manner.


WEB SERVICE: PUBLICWEBSERVICE

Target Namespace:
http://www.NationalGrid.com/MIPI/
WSDL Location:
https://marketinformation.nationalgas.com/MIPIws-public/public/publicwebservice.asmx?wsdl


PORT PUBLICWEBSERVICESOAP PORT TYPESOURCE CODE

Location:
https://marketinformation.nationalgas.com/MIPIws-public/public/publicwebservice.asmx
Protocol:
SOAP
Transport protocol:
SOAP over HTTP
Operations:
 1. GetPublicationDataWMDetailSource code


PORT PUBLICWEBSERVICESOAP12 PORT TYPESOURCE CODE

Location:
https://marketinformation.nationalgas.com/MIPIws-public/public/publicwebservice.asmx
Protocol:
SOAP
Transport protocol:
SOAP over HTTP
Operations:
 1. GetPublicationDataWMDetailSource code


OPERATIONS


PORT TYPE PUBLICWEBSERVICESOAP SOURCE CODE

 1. GetPublicationDataWM
    Source code
    Description:
    This webmethod provides the publication data
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated
    message.
    SOAP action:
    http://www.NationalGrid.com/MIPI/GetPublicationDataWM
    Input:
    GetPublicationDataWMSoapIn (soap:body, use = literal)Source code
    parameters type GetPublicationDataWM
     * reqObject - required; type CLSRequestObject
       * LatestFlag - required; type string
       * ApplicableForFlag - required; type string
       * ToDate type dateTime
       * FromDate type dateTime
       * DateType - required; type string
       * PublicationObjectNameList - type ArrayOfString
         * string - unbounded, nillable; type string
    
    Output:
    GetPublicationDataWMSoapOut (soap:body, use = literal)Source code
    parameters type GetPublicationDataWMResponse
     * GetPublicationDataWMResult - optional; type
       ArrayOfCLSMIPIPublicationObjectBE
       * CLSMIPIPublicationObjectBE - optional, unbounded, nillable; type
         CLSMIPIPublicationObjectBE
         * PublicationObjectName - optional; type string
         * PublicationObjectData - optional; type
           ArrayOfCLSPublicationObjectDataBE
           * CLSPublicationObjectDataBE - optional, unbounded, nillable; type
             CLSPublicationObjectDataBE
             * ApplicableAt type dateTime
             * ApplicableFor type dateTime
             * Value - optional; type string
             * GeneratedTimeStamp type dateTime
             * QualityIndicator - optional; type string
             * Substituted - optional; type string
             * CreatedDate type dateTime


WSDL SOURCE CODE

<?xml version="1.0"?>
<wsdl:definitions targetNamespace="http://www.NationalGrid.com/MIPI/"
xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"
xmlns:tns="http://www.NationalGrid.com/MIPI/"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:s="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
xmlns:http="http://schemas.xmlsoap.org/wsdl/http/"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
>
<wsdl:types>
<s:schema elementFormDefault="qualified"
targetNamespace="http://www.NationalGrid.com/MIPI/">
<s:element name="GetPublicationDataWM">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="reqObject"
type="tns:CLSRequestObject" />
</s:sequence>
</s:complexType>
</s:element>
<s:complexType name="CLSRequestObject">
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="LatestFlag" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="ApplicableForFlag" type="s:string"
/>
<s:element minOccurs="1" maxOccurs="1" name="ToDate" type="s:dateTime" />
<s:element minOccurs="1" maxOccurs="1" name="FromDate" type="s:dateTime" />
<s:element minOccurs="1" maxOccurs="1" name="DateType" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="PublicationObjectNameList"
type="tns:ArrayOfString" />
</s:sequence>
</s:complexType>
<s:complexType name="ArrayOfString">
<s:sequence>
<s:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true"
type="s:string" />
</s:sequence>
</s:complexType>
<s:element name="GetPublicationDataWMResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetPublicationDataWMResult"
type="tns:ArrayOfCLSMIPIPublicationObjectBE" />
</s:sequence>
</s:complexType>
</s:element>
<s:complexType name="ArrayOfCLSMIPIPublicationObjectBE">
<s:sequence>
<s:element minOccurs="0" maxOccurs="unbounded" name="CLSMIPIPublicationObjectBE"
nillable="true" type="tns:CLSMIPIPublicationObjectBE" />
</s:sequence>
</s:complexType>
<s:complexType name="CLSMIPIPublicationObjectBE">
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="PublicationObjectName"
type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="PublicationObjectData"
type="tns:ArrayOfCLSPublicationObjectDataBE" />
</s:sequence>
</s:complexType>
<s:complexType name="ArrayOfCLSPublicationObjectDataBE">
<s:sequence>
<s:element minOccurs="0" maxOccurs="unbounded" name="CLSPublicationObjectDataBE"
nillable="true" type="tns:CLSPublicationObjectDataBE" />
</s:sequence>
</s:complexType>
<s:complexType name="CLSPublicationObjectDataBE">
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="ApplicableAt" type="s:dateTime" />
<s:element minOccurs="1" maxOccurs="1" name="ApplicableFor" type="s:dateTime" />
<s:element minOccurs="0" maxOccurs="1" name="Value" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="GeneratedTimeStamp"
type="s:dateTime" />
<s:element minOccurs="0" maxOccurs="1" name="QualityIndicator" type="s:string"
/>
<s:element minOccurs="0" maxOccurs="1" name="Substituted" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="CreatedDate" type="s:dateTime" />
</s:sequence>
</s:complexType>
</s:schema>
</wsdl:types>
<wsdl:message name="GetPublicationDataWMSoapIn">
<wsdl:part name="parameters" element="tns:GetPublicationDataWM" />
</wsdl:message>
<wsdl:message name="GetPublicationDataWMSoapOut">
<wsdl:part name="parameters" element="tns:GetPublicationDataWMResponse" />
</wsdl:message>
<wsdl:portType name="PublicWebServiceSoap">
<wsdl:operation name="GetPublicationDataWM">
<wsdl:documentation>This webmethod provides the publication
data</wsdl:documentation>
<wsdl:input message="tns:GetPublicationDataWMSoapIn" />
<wsdl:output message="tns:GetPublicationDataWMSoapOut" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="PublicWebServiceSoap" type="tns:PublicWebServiceSoap">
<soap:binding transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="GetPublicationDataWM">
<soap:operation
soapAction="http://www.NationalGrid.com/MIPI/GetPublicationDataWM"
style="document" />
<wsdl:input>
<soap:body use="literal" />
</wsdl:input>
<wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:binding name="PublicWebServiceSoap12" type="tns:PublicWebServiceSoap">
<soap12:binding transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="GetPublicationDataWM">
<soap12:operation
soapAction="http://www.NationalGrid.com/MIPI/GetPublicationDataWM"
style="document" />
<wsdl:input>
<soap12:body use="literal" />
</wsdl:input>
<wsdl:output>
<soap12:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="PublicWebService">
<wsdl:port name="PublicWebServiceSoap" binding="tns:PublicWebServiceSoap">
<soap:address
location="https://marketinformation.nationalgas.com/MIPIws-public/public/publicwebservice.asmx"
/>
</wsdl:port>
<wsdl:port name="PublicWebServiceSoap12" binding="tns:PublicWebServiceSoap12">
<soap12:address
location="https://marketinformation.nationalgas.com/MIPIws-public/public/publicwebservice.asmx"
/>
</wsdl:port>
</wsdl:service>
</wsdl:definitions>