Xoserve · Example Payload

Xoserve Supplier Api Response Example

EnergyUnited KingdomGasUtilitiesEnergy MarketsMeter DataGas NetworksCentral Data Service ProviderData Services

Xoserve Supplier Api Response Example is an example object payload from Xoserve, with 1 top-level field. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

supplier

Example Payload

Raw ↑ 
{
  "supplier": {
    "mprn": "string",
    "street": "string",
    "town": "string",
    "postcode": "string",
    "county": "string",
    "country": "string",
    "uprn": "string",
    "incoming_supplier": "string",
    "supply_point_withdrawal_status": "string",
    "network_owner_effective_from_date": "string",
    "sms_operating_entity_efd": "string",
    "dcc_service_flag_efd": "string",
    "first_smets_installation_date": "string",
    "ihd_install_status": "string",
    "amr_indicator": "string",
    "igt_transportation_charge_rate": "string",
    "igt_transportation_charge_rate_type": "string",
    "igt_charging_methodology": "string",
    "csep_supply_point_offtake_quantity": "string",
    "previous_supplier_name": "string",
    "previous_supplier_short_code": "string",
    "priority_consumers_indicator": "string",
    "csep_max_annual_quantity": "string",
    "original_supply_meter_point_annual_quantity": "string",
    "house_name": "string",
    "house_no": "string",
    "po_box_no": "string",
    "sub_building_name": "string",
    "dependent_street": "string",
    "dependent_local": "string",
    "double_dependent_local": "string",
    "delivery_point_alias": "string",
    "csep_id": "string",
    "meter_imperial_indicator": "string",
    "meter_device_status": "string",
    "latest_meter_read_date": "string",
    "amr_sp": "string",
    "dcc_service_flag": "string",
    "interruption_contract_exists": "string",
    "installing_supplier_id": "string",
    "isolation_status": "string",
    "mam_short_code": "string",
    "meter_number_of_dials": 0,
    "supply_meter_point_shq": "string",
    "address_id": "string",
    "class": "string",
    "current_supplier": "string",
    "current_supplier_name": "string",
    "network_name": "string",
    "twin_stream_site_indicator": "string",
    "ldz_id": "string",
    "market_sector_code": "string",
    "meter_capacity": "string",
    "meter_mechanism": "string",
    "meter_point_status": "string",
    "annual_quantity": "string",
    "msn": "string",
    "formula_year_annual_quantity": "string",
    "smso_id": "string",
    "meter_type": "string",
    "latest_meter_read_type": "string",
    "latest_meter_read_value": "string",
    "formula_year_offtake_quantity": "string",
    "shipper_name": "string",
    "shipper_short_code": "string",
    "end_user_category_code": "string",
    "confirmation_reference_number": "string",
    "confirmation_effective_date": "string",
    "meter_read_batch_frequency": "string",
    "supply_meter_point_current_year_minimum_annual_quantity": "string",
    "meter_manufacturer": "string",
    "meter_installation_date": "string",
    "meter_units": "string",
    "meter_location": "string",
    "correction_factor": "string",
    "gas_act_owner": "string",
    "meter_asset_manager_effective_date": "string",
    "meter_model": "string",
    "meter_year_of_manufacture": "string",
    "meter_link_code": "string",
    "end_user_category_identifier": "string",
    "exit_zone": "string",
    "smp_prospective_formula_year_soq": "string",
    "smp_prospective_formula_year_aq": "string",
    "smp_prospective_formula_year_effective_date": "string",
    "small_large_supply_point_indicator": "string",
    "daily_metered_indicator": "string",
    "convertor_indicator": "string",
    "offtake_quantity": "string"
  }
}