{
  "components": {
    "schemas": {
      "SupplierFull": {
        "type": "object",
        "properties": {
          "mprn": {
            "type": "string",
            "description": "Meter Point Reference Number (MRPN).  A unique identifier for the point at which a meter is, has been or will be connected to the Gas Network"
          },
          "street": {
            "type": "string",
            "description": "Street"
          },
          "town": {
            "type": "string",
            "description": "Town"
          },
          "postcode": {
            "type": "string",
            "description": "Postcode"
          },
          "county": {
            "type": "string",
            "description": "County"
          },
          "country": {
            "type": "string",
            "description": "Country"
          },
          "uprn": {
            "type": "string",
            "description": "Unique identifier for every addressable location in Great Britain"
          },
          "incoming_supplier": {
            "type": "string",
            "description": "A unique three character code used to identify the Incoming Supplier"
          },
          "supply_point_withdrawal_status": {
            "type": "string",
            "description": "Identifies if the site is not registered to a Shipper or the current Shipper has withdrawn"
          },
          "network_owner_effective_from_date": {
            "type": "string",
            "description": "Date the network owner is effective from for a supply meter point"
          },
          "sms_operating_entity_efd": {
            "type": "string",
            "description": "The date on which the Smart Meter System Operator (SMSO) becomes effective"
          },
          "dcc_service_flag_efd": {
            "type": "string",
            "description": "The first inclusive calendar date for which the status of Data Communications Company (DCC) Service Flag applies"
          },
          "first_smets_installation_date": {
            "type": "string",
            "description": "First Smart Metering Equipment Technical Specifications (SMETS) Installation Date"
          },
          "ihd_install_status": {
            "type": "string",
            "description": "Information from the Supplier regarding the status/existence of the In Home Display (IHD) at a supply point"
          },
          "amr_indicator": {
            "type": "string",
            "description": "Automated Meter Reading (AMR) Indicator"
          },
          "igt_transportation_charge_rate": {
            "type": "string",
            "description": "The monetary rate that is applicable to the Supply Meter Point for IGT transportation charges"
          },
          "igt_transportation_charge_rate_type": {
            "type": "string",
            "description": "Indicator showing the type of IGT Transportation Charge Rate being applied"
          },
          "igt_charging_methodology": {
            "type": "string",
            "description": "The IGT charging methodology that is applied to the Supply Point"
          },
          "csep_supply_point_offtake_quantity": {
            "type": "string",
            "description": "The daily offtake (SOQ) of gas (measured in kWh) of all Supply Points associated with the CSEP’s connection to the upstream network, calculated from the EUC AQ and DM SOQ information"
          },
          "previous_supplier_name": {
            "type": "string",
            "description": "Name of the last previous Supplier assigned to the Supply Point"
          },
          "previous_supplier_short_code": {
            "type": "string",
            "description": "Specifies the 3 digit unique Supplier Short Code for the previous Supplier"
          },
          "priority_consumers_indicator": {
            "type": "string",
            "description": "The category of priority consumer at the Supply Meter Point"
          },
          "csep_max_annual_quantity": {
            "type": "string",
            "description": "The total projected maximum annual offtake (AQ) of gas (measured in kWh) of all Supply Meter Points associated with this CSEP’s connection to the upstream network"
          },
          "original_supply_meter_point_annual_quantity": {
            "type": "string",
            "description": "The initial estimated Annual Quantity for the Supply Meter Point"
          },
          "house_name": {
            "type": "string",
            "description": "House Name"
          },
          "house_no": {
            "type": "string",
            "description": "House Number"
          },
          "po_box_no": {
            "type": "string",
            "description": "PO Box Number"
          },
          "sub_building_name": {
            "type": "string",
            "description": "Sub Building Name"
          },
          "dependent_street": {
            "type": "string",
            "description": "Dependent Street"
          },
          "dependent_local": {
            "type": "string",
            "description": "Dependent Locality"
          },
          "double_dependent_local": {
            "type": "string",
            "description": "Double Dependent Locality"
          },
          "delivery_point_alias": {
            "type": "string",
            "description": "Delivery Point Alias"
          },
          "csep_id": {
            "type": "string",
            "description": "The unique identifier for the Connected System Exit Point (CSEP)"
          },
          "meter_imperial_indicator": {
            "type": "string",
            "description": "Indicator identifying if the meter measures volume of gas consumed in metric or imperial units"
          },
          "meter_device_status": {
            "type": "string",
            "description": "A code indicating the current status of the meter installed at the supply point"
          },
          "latest_meter_read_date": {
            "type": "string",
            "description": "Latest Meter Read Date"
          },
          "amr_sp": {
            "type": "string",
            "description": "A unique three character code used to identify the Automated Meter Reading (AMR) Service Provider"
          },
          "dcc_service_flag": {
            "type": "string",
            "description": "Data Communications Company (DCC) Service Flag"
          },
          "interruption_contract_exists": {
            "type": "string",
            "description": "Indicator to identify whether an Interruption Contract Exists on the supply meter point"
          },
          "installing_supplier_id": {
            "type": "string",
            "description": "A unique three character code used to identify the Supplier responsible for the first SMETS Meter Installation at the supply point"
          },
          "isolation_status": {
            "type": "string",
            "description": "Isolation Status"
          },
          "mam_short_code": {
            "type": "string",
            "description": "A unique three character code used to identify the Meter Asset Manager (MAM)"
          },
          "meter_number_of_dials": {
            "type": "integer",
            "description": "Number of dials or digits on the meter which are considered during meter reading",
            "format": "int32"
          },
          "supply_meter_point_shq": {
            "type": "string",
            "description": "Current Supply Meter Point SHQ (Standard Hourly Offtake Quantity)"
          },
          "address_id": {
            "type": "string",
            "description": "Unique (Internal BDP) identifier for the address"
          },
          "class": {
            "type": "string",
            "description": "Denotes the current class type for the Supply Meter Point. VALUES: 1 - Class 1, 2 - Class 2, 3 - Class 3, 4 - Class 4"
          },
          "current_supplier": {
            "type": "string",
            "description": "A unique three character code used to identify the current supplier"
          },
          "current_supplier_name": {
            "type": "string",
            "description": "Name of the current Supplier for the supply meter point"
          },
          "network_name": {
            "type": "string",
            "description": "Gas Distribution Network Name"
          },
          "twin_stream_site_indicator": {
            "type": "string",
            "description": "Indicates if the supply meter point is currently a twin stream site"
          },
          "ldz_id": {
            "type": "string",
            "description": "Unique reference code for the Local Distribution Zone (LDZ)"
          },
          "market_sector_code": {
            "type": "string",
            "description": "A code that specifies that the site is used for domestic or industrial and commercial purposes"
          },
          "meter_capacity": {
            "type": "string",
            "description": "The amount of gas that can be passed through the meter in a given time period. This is the manufacturer's maximum value"
          },
          "meter_mechanism": {
            "type": "string",
            "description": "The coded value of the description of the Meter Mechanism"
          },
          "meter_point_status": {
            "type": "string",
            "description": "The current status of the operability of the supply meter point"
          },
          "annual_quantity": {
            "type": "string",
            "description": "The current annual offtake quantity (AQ) of a Supply Meter Point. Value in kWh."
          },
          "msn": {
            "type": "string",
            "description": "The manufacturer's meter serial number as held on the physical meter currently installed on the supply point"
          },
          "formula_year_annual_quantity": {
            "type": "string",
            "description": "The supply meter point AQ that is fixed throughout the formula year for determination of Transportation rates. Value in kWh"
          },
          "smso_id": {
            "type": "string",
            "description": "The identity of the operator, a Supplier has procured data and communication services from, in respect of a Smart Metering System"
          },
          "meter_type": {
            "type": "string",
            "description": "The type of meter installed at the supply point. \nR = Rotary; T = Turbine; D = Diaphragm of unknown material; L = Leather Diaphragm; S = Synthetic Diaphragm; U = Ultrasonic;Z= Unknown; O = Orifice"
          },
          "latest_meter_read_type": {
            "type": "string",
            "description": "Latest Meter Read Type"
          },
          "latest_meter_read_value": {
            "type": "string",
            "description": "Latest Meter Read Value"
          },
          "formula_year_offtake_quantity": {
            "type": "string",
            "description": "The current value for SOQ of the supply point that is fixed throughout the formula year for determination of transportation rates. Value in kWh"
          },
          "shipper_name": {
            "type": "string",
            "description": "Name of the current Shipper assigned to the Supply Point"
          },
          "shipper_short_code": {
            "type": "string",
            "description": "Specifies the 3 digit unique Shipper Short Code for the current Shipper"
          },
          "end_user_category_code": {
            "type": "string",
            "description": "Acronym for the makeup of an End User Category (EUC). For example: EA:E1903B"
          },
          "confirmation_reference_number": {
            "type": "string",
            "description": "A sequential number that uniquely identifies the Confirmation (only visible where the Supply Point is within the requester's portfolio)"
          },
          "confirmation_effective_date": {
            "type": "string",
            "description": "Date on which the current Shipper took over responsibility for the Supply Point (only visible where the Supply Point is within the requester's portfolio)"
          },
          "meter_read_batch_frequency": {
            "type": "string",
            "description": "The frequency on which reads will be received for class 3 Supply Meter Points. \nVALUES: W-7 days, F –14 days, M –month, 6 –6 monthly. (only visible where the Supply Point is within the requester's portfolio)"
          },
          "supply_meter_point_current_year_minimum_annual_quantity": {
            "type": "string",
            "description": "The minimum bookable annual capacity based on the historic maximum annual offtake for a Supply (only visible where the Supply Point is within the requester's portfolio)"
          },
          "meter_manufacturer": {
            "type": "string",
            "description": "Identifies the Short code of meter manufacturer of the meter installed at theSupply Point (only visible where the Supply Point is within the requester's portfolio)"
          },
          "meter_installation_date": {
            "type": "string",
            "description": "Date the meter was installed at the SupplyPoint (only visible where the Supply Point is within the requester's portfolio)"
          },
          "meter_units": {
            "type": "string",
            "description": "This contains the units the meter installed on a Supply Point is reading in e.g. 10, 100, 1000 (only visible where the Supply Point is within the requester's portfolio)"
          },
          "meter_location": {
            "type": "string",
            "description": "A code representing the location of a meter installed at the Supply Point \nVALUES: 0 -Unknown, 1 -Cellar, 2 -Under Stairs, 3 -Hall, 4 -Kitchen, 5 -Bathroom, 6-Garage, 7 -Canteen, 8 -Cloakroom, 9 -Cupboard, 10 -Domestic, 11 -Front Door, 12 -Hall Cupboard, 13 -Kitchen Cupboard, 14 -Kitchen under the sink, 15 -Landing, 16 -Office, 17 -Office Cupboard, 18 -Outside WC, 19 -Pantry, 20 -Porch, 21 -Public Bar, 22 -Rear of Shop, 23 -Saloon Bar, 24 -Shed, 25 -Shop Front, 26 -Shop Window, 27 -Staff Room, 28 -Store Room, 29 -Toilet, 30 -Under Counter, 31 -Waiting Room, 32 -Meterbox, 98 –Other, 99–Outside (only visible where the Supply Point is within the requester's portfolio)"
          },
          "correction_factor": {
            "type": "string",
            "description": "This is a fixed factor where no convertor is fitted and the meter reading needs to be corrected for Pressure/Altitude/Temperature. Format:999.999999 (only visible where the Supply Point is within the requester's portfolio)"
          },
          "gas_act_owner": {
            "type": "string",
            "description": "Unique code which identifies the role the market participant is acting in. \nValues : T -GAO Transporter , S -GAO Supplier , C -GAO Consumer, U –Unknown."
          },
          "meter_asset_manager_effective_date": {
            "type": "string",
            "description": "The date on which Meter Asset Manager (MAM) is effectively responsible for the meter assets at the Supply Point (only visible where the Supply Point is within the requester's portfolio)"
          },
          "meter_model": {
            "type": "string",
            "description": "The model description of the meter installed at the Supply Point (only visible where the Supply Point is within the requester's portfolio)"
          },
          "meter_year_of_manufacture": {
            "type": "string",
            "description": "The year in which the meter installed at the Supply Point was manufactured expressed as a century date (e.g. 1981) (only visible where the Supply Point is within the requester's portfolio)ah"
          },
          "meter_link_code": {
            "type": "string",
            "description": "A code specifying the functional relationship between meters (the way in which they are linked together) at given locations on an End User's site to be described. \nVALUES: P = Primary Meter, S = Sub-meter, F = Free standing meter"
          },
          "end_user_category_identifier": {
            "type": "string",
            "description": "A unique reference for the End User Category assigned to the Supply Point"
          },
          "exit_zone": {
            "type": "string",
            "description": "Exit Zone code"
          },
          "smp_prospective_formula_year_soq": {
            "type": "string",
            "description": "Prospective Formula Year SOQ value. ‘Prospective’ is a synonym for ‘Perspective’"
          },
          "smp_prospective_formula_year_aq": {
            "type": "string",
            "description": "Prospective Formula Year AQ value. ‘Prospective’ is a synonym for ‘Perspective’"
          },
          "smp_prospective_formula_year_effective_date": {
            "type": "string",
            "description": "Prospective Formula Year effective date. ‘Prospective’ is a synonym for ‘Perspective’"
          },
          "small_large_supply_point_indicator": {
            "type": "string",
            "description": "Indicator showing if a Supply Point is Large(LSP) or Small (SSP) Annual Quantity threshold of 73,200 kWh"
          },
          "daily_metered_indicator": {
            "type": "string",
            "description": "Indicator showing if the Supply Meter Point is Daily Metered \nValues: Daily Metered, Non Daily Metered"
          },
          "convertor_indicator": {
            "type": "string",
            "description": "Indicator for the presence of a Converter Asset. \nValues: Y = Yes, N = NO"
          },
          "offtake_quantity": {
            "type": "string",
            "description": "The current value for the peak daily supply offtake quantity (SOQ) of a supply point.Value in kWh"
          }
        },
        "xml": {
          "name": "supplier"
        }
      },
      "SupplierRestResponse": {
        "type": "object",
        "properties": {
          "supplier": {
            "$ref": "#/components/schemas/SupplierFull"
          }
        }
      },
      "GetRequest": {
        "type": "integer",
        "format": "int64",
        "x-apim-inline": true
      },
      "GetRequest-1": {
        "type": "integer",
        "format": "int64",
        "x-apim-inline": true
      },
      "GetRequest-2": {
        "type": "string",
        "x-apim-inline": true
      },
      "GetRequest-3": {
        "type": "string",
        "x-apim-inline": true
      },
      "GetRequest-4": {
        "type": "string",
        "x-apim-inline": true
      },
      "GetRequest-5": {
        "type": "string",
        "x-apim-inline": true
      },
      "GetRequest-6": {
        "type": "string",
        "x-apim-inline": true
      },
      "GetRequest-7": {
        "type": "string",
        "x-apim-inline": true
      },
      "GetRequest-8": {
        "type": "string",
        "x-apim-inline": true
      },
      "GetRequest-9": {
        "type": "string",
        "x-apim-inline": true
      },
      "GetRequest-10": {
        "type": "string",
        "x-apim-inline": true
      }
    }
  }
}