NISMOD-DB++ API

Below is documentation for calls available through the NISMOD-DB++ API with the required details for each call. Users must be logged in to see the content.


API calls

data calls

API calls to access and update datasets within NISMOD-DB++


generic

Generic methods for all datasets


get dataset list

Get a list of datasets available to download

CALL TYPE: GET

Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:


    • get dataset

    Get a dataset from NISMOD-DB

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:



    • assignment

    Assigned households to buildings


    household assignment

    Calls for buildings with households assigned to them

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • CALL TYPE: POST

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:


    • assignment data versions

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • id

  • name: id
    •
  • type: numeric
    •
  • description: The household data version id
    •

    name

  • name: name
    •
  • type: string
    •
  • description: The household data version name
    •

    description

  • name: description
    •
  • type: string
    •
  • description: A description for the household data version
    •

    date_added

  • name: date_added
    •
  • type: timestamp
    •
  • description: The date the household data version was created
    •

    CALL TYPE: POST

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

  • name:
  • type:
  • description:



    • boundaries

    A collection of boundary datasets, from political boundaries to cenus zones


    camkox arc lads

    CaMkOx Arc LAD's

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • gid

  • name: gid
    •
  • type: numeric
    •
  • description: A unique identifier.
    •

    geo_label

  • name: geo_label
    •
  • type: string
    •
  • description: The name (text) of the local authority district
    •

    geo_code

  • name: geo_code
    •
  • type: string
    •
  • description: The ONS (Office for National Statistics) code for the local authority district
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature.
    •


    tyne and wear

    Tyne and Wear boundary

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • gid

  • name: gid
    •
  • type: numeric
    •
  • description: A unique identifier.
    •

    name

  • name: name
    •
  • type: string
    •
  • description: The name of the area.
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature.
    •


    countries

    Countries of the UK

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:


    • GORs

    Government Office Regions

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • gid

  • name: gid
    •
  • type: numeric
    •
  • description: The unique identifier for the features.
    •

    gor_code

  • name: gor_code
    •
  • type: string
    •
  • description: The code of the Government Office Region.
    •

    gor_name

  • name: gor_name
    •
  • type: string
    •
  • description: The name of the Government Office Region.
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature.
    •


    OAs

    Census Output Areas

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • gid

  • name: gid
    •
  • type: numeric
    •
  • description: A unique identifer for the features.
    •

    oa_code

  • name: oa_code
    •
  • type: string
    •
  • description: The Office of National Statitics Output Area code.
    •

    lad_code

  • name: lad_code
    •
  • type: string
    •
  • description: The office of National Statistics Local Authority District code the OA centroid falls within.
    •

    lad_name

  • name: lad_name
    •
  • type: string
    •
  • description: The name of the LAD the OA falls within.
    •

    gor_code

  • name: gor_code
    •
  • type: string
    •
  • description: The Government Office Region code for the area the OA centroid falls within.
    •

    gor_name

  • name: gor_name
    •
  • type: string
    •
  • description: The name of the Government Office Region which the OA centroid falls within.
    •

    oa_neighbours

  • name: oa_neighbours
    •
  • type: string (list of)
    •
  • description: A list of codes for neighbouring census output areas (they each have at least a single touching boundary).
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature.
    •


    OAs in GOR

    Census Output Areas by Government Office Regions

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • gid

  • name: gid
    •
  • type: numeric
    •
  • description: A unique identifer for the features.
    •

    oa_code

  • name: oa_code
    •
  • type: string
    •
  • description: The Office of National Statitics Output Area code.
    •

    lad_code

  • name: lad_code
    •
  • type: string
    •
  • description: The office of National Statistics Local Authority District code the OA centroid falls within.
    •

    lad_name

  • name: lad_name
    •
  • type: string
    •
  • description: The name of the LAD the OA falls within.
    •

    gor_code

  • name: gor_code
    •
  • type: string
    •
  • description: The Government Office Region code for the area the OA centroid falls within.
    •

    gor_name

  • name: gor_name
    •
  • type: string
    •
  • description: The name of the Government Office Region which the OA centroid falls within.
    •

    oa_neighbours

  • name: oa_neighbours
    •
  • type: string (list of)
    •
  • description: A list of codes for neighbouring census output areas (they each have at least a single touching boundary).
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature.
    •


    OAs in LAD

    Census Output Areas by Local Authority Districts

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • gid

  • name: gid
    •
  • type: numeric
    •
  • description: A unique identifer for the features.
    •

    oa_code

  • name: oa_code
    •
  • type: string
    •
  • description: The Office of National Statitics Output Area code.
    •

    lad_code

  • name: lad_code
    •
  • type: string
    •
  • description: The office of National Statistics Local Authority District code the OA centroid falls within.
    •

    lad_name

  • name: lad_name
    •
  • type: string
    •
  • description: The name of the LAD the OA falls within.
    •

    gor_code

  • name: gor_code
    •
  • type: string
    •
  • description: The Government Office Region code for the area the OA centroid falls within.
    •

    gor_name

  • name: gor_name
    •
  • type: string
    •
  • description: The name of the Government Office Region which the OA centroid falls within.
    •

    oa_neighbours

  • name: oa_neighbours
    •
  • type: string (list of)
    •
  • description: A list of codes for neighbouring census output areas (they each have at least a single touching boundary).
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature.
    •


    OAs in MSOA

    Census Output Areas by Middle Layer census Output Areas

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:


    • MSOAs

    Middle layer Super Output Areas

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:


    • MSOAs in LAD

    Middle Layer census Output Areas by Local Authority Districts

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:


    • LADs

    Local Authority Districts

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • gid

  • name: gid
    •
  • type: numeric
    •
  • description: A unique identifer for the features.
    •

    name

  • name: name
    •
  • type: string
    •
  • description: The name of the Local Authority District.
    •

    lad_code

  • name: lad_code
    •
  • type: string
    •
  • description: The Office for National Statitics (ONS) Local Authority District code.
    •

    gor_name

  • name: gor_name
    •
  • type: string
    •
  • description: The name of the Government Office Region the centroid of the LAD falls within.
    •

    gor_code

  • name: gor_code
    •
  • type: string
    •
  • description: The code for the Government Office Region the centroid of the LAD falls within.
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature.
    •


    list lads

    List all local Authority Districts

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • gid

  • name: gid
    •
  • type: numeric
    •
  • description: A unique identifer for the features.
    •

    name

  • name: name
    •
  • type: string
    •
  • description: The name of the Local Authority District.
    •

    lad_code

  • name: lad_code
    •
  • type: string
    •
  • description: The Office for National Statitics (ONS) Local Authority District code.
    •

    gor_name

  • name: gor_name
    •
  • type: string
    •
  • description: The name of the Government Office Region the centroid of the LAD falls within.
    •

    gor_code

  • name: gor_code
    •
  • type: string
    •
  • description: The code for the Government Office Region the centroid of the LAD falls within.
    •


    LAD search with text

    Local Authority District name search

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • name

  • name: name
    •
  • type: string
    •
  • description: The name of the LAD passed
    •

    lad_code

  • name: lad_code
    •
  • type: string
    •
  • description: The code of the LAD.
    •


    LADs in GOR

    Local Authority Districts by Government Office Region

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • gid

  • name: gid
    •
  • type: numeric
    •
  • description: A unique identifer for the features.
    •

    name

  • name: name
    •
  • type: string
    •
  • description: The name of the Local Authority District.
    •

    lad_code

  • name: lad_code
    •
  • type: string
    •
  • description: The Office for National Statitics (ONS) Local Authority District code.
    •

    gor_name

  • name: gor_name
    •
  • type: string
    •
  • description: The name of the Government Office Region the centroid of the LAD falls within.
    •

    gor_code

  • name: gor_code
    •
  • type: string
    •
  • description: The code for the Government Office Region the centroid of the LAD falls within.
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature.
    •



    data

    Access to generic datasets from a wide range of sources


    geoinformation buildings

    Geoinformation buildings

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • bui_id

  • name: bui_id
    •
  • type: string
    •
  • description: The unique building ID
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature.
    •

    toid_number

  • name: toid_number
    •
  • type: integer
    •
  • description: The TOID number, the Ordnance Survey unique identifier, for the feature excluding text characters.
    •

    oa

  • name: oa
    •
  • type: string
    •
  • description: The census output area code the feature falls whithin.
    •

    lad

  • name: lad
    •
  • type: string
    •
  • description: The Local Authority Disctrict the feature falls within.
    •

    gor

  • name: gor
    •
  • type: string
    •
  • description: The Government Office Region the feature falls within.
    •


    os opennames

    Ordnance Survey Open Names

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:


    • world heritage sites

    World heritage sites in England

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • gid

  • name: gid
    •
  • type: integer
    •
  • form:

    • name

  • name: name
    •
  • type: string
    •
  • form:

    • inscrdate

  • name: inscrdate
    •
  • type:
  • form:

    • amenddate

  • name: amenddate
    •
  • type:
  • form:

    • lads

  • name: lads
    •
  • type: list of strings
    •
  • form: [lad_1, lad_2,....]
    •

    lads_coverage

  • name: lads_coverage
    •
  • type: list of numbers (floats)
    •
  • form: [coverage_%_for_lad_1, coverage_%_for_lad_2,....]
    •

    gors

  • name: gors
    •
  • type: list of strings
    •
  • form: [gor_1, gor_2,....]
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • form:


    • scheduled monuments

    Scheduled monumnets in England

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • gid

  • name: gid
    •
  • type: integer
    •
  • form:

    • name

  • name: name
    •
  • type: string
    •
  • form:

    • scheddate

  • name: scheddate
    •
  • type:
  • form:

    • amenddate

  • name: amenddate
    •
  • type:
  • form:

    • lads

  • name: lads
    •
  • type: list of strings
    •
  • form: [lad_1, lad_2,....]
    •

    lads_coverage

  • name: lads_coverage
    •
  • type: list of numbers (floats)
    •
  • form: [coverage_%_for_lad_1, coverage_%_for_lad_2,....]
    •

    gors

  • name: gors
    •
  • type: list of strings
    •
  • form: [gor_1, gor_2,....]
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • form:


    • battlefield sites

    Battle field sites in England

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • gid

  • name: gid
    •
  • type: integer
    •
  • form:

    • name

  • name: name
    •
  • type: string
    •
  • form:

    • regdate

  • name: regdate
    •
  • type:
  • form:

    • amenddate

  • name: amenddate
    •
  • type:
  • form:

    • lads

  • name: lads
    •
  • type: list of strings
    •
  • form: [lad_1, lad_2,....]
    •

    lads_coverage

  • name: lads_coverage
    •
  • type: list of numbers (floats)
    •
  • form: [coverage_%_for_lad_1, coverage_%_for_lad_2,....]
    •

    gors

  • name: gors
    •
  • type: list of strings
    •
  • form: [gor_1, gor_2,....]
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • form:


    • green belt

    Green belt areas in England

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:


    • local nature reserves

    Local nature reserves in England

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • gid

  • name: gid
    •
  • type: integer
    •
  • form:

    • lnr_name

  • name: lnr_name
    •
  • type: string
    •
  • form:

    • lnr_area

  • name: lnr_area
    •
  • type: numeric
    •
  • form:

    • status

  • name: status
    •
  • type: string
    •
  • form:

    • version

  • name: version
    •
  • type:
  • form:

    • lads

  • name: lads
    •
  • type: list of strings
    •
  • form: [lad_1, lad_2,....]
    •

    lads_coverage

  • name: lads_coverage
    •
  • type: list of numbers (floats)
    •
  • form: [coverage_%_for_lad_1, coverage_%_for_lad_2,....]
    •

    gors

  • name: gors
    •
  • type: list of strings
    •
  • form: [gor_1, gor_2,....]
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • form:


    • national nature reserves

    National nature reserves in England

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • gid

  • name: gid
    •
  • type: integer
    •
  • form:

    • nnr_name

  • name: nnr_name
    •
  • type: string
    •
  • form:

    • nnr_area

  • name: nnr_area
    •
  • type: numeric
    •
  • form:

    • status

  • name: status
    •
  • type: string
    •
  • form:

    • version

  • name: version
    •
  • type:
  • form:

    • lads

  • name: lads
    •
  • type: list of strings
    •
  • form: [lad_1, lad_2,....]
    •

    lads_coverage

  • name: lads_coverage
    •
  • type: list of numbers (floats)
    •
  • form: [coverage_%_for_lad_1, coverage_%_for_lad_2,....]
    •

    gors

  • name: gors
    •
  • type: list of strings
    •
  • form: [gor_1, gor_2,....]
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • form:


    • SSSI data

    Sites of special scientific interest (SSSI) data

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • gid

  • name: gid
    •
  • type: integer
    •
  • form:

    • sssi_name

  • name: sssi_name
    •
  • type: string
    •
  • form:

    • sssi_area

  • name: sssi_area
    •
  • type: numeric
    •
  • form:

    • status

  • name: status
    •
  • type:
  • form:

    • version

  • name: version
    •
  • type:
  • form:

    • lads

  • name: lads
    •
  • type: list of strings
    •
  • form: [lad_1, lad_2,....]
    •

    lads_coverage

  • name: lads_coverage
    •
  • type: list of numbers (floats)
    •
  • form: [coverage_%_for_lad_1, coverage_%_for_lad_2,....]
    •

    gors

  • name: gors
    •
  • type: list of strings
    •
  • form: [gor_1, gor_2,....]
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • form:



    • hazards

    Hazard datasets from a range of sources, such as flooding data from the Environment Agency


    citycat output

    CityCat flood model example output

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • id

  • name: id
    •
  • type: numeric
    •
  • description: A unique identifier for features.
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature (flood area).
    •


    EA floodzone3

    Environment Agency flood zone level 3

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • id

  • name: id
    •
  • type: numeric
    •
  • description: A unique identifier.
    •

    type

  • name: type
    •
  • type: string
    •
  • description: The type of flood zone (flood type).
    •

    shape_area

  • name: shape_area
    •
  • type: numeric
    •
  • description: The size of the flood zone.
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature (flood zone).
    •


    EA floodzone2

    Environment Agency Flood zone level 2

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • id

  • name: id
    •
  • type: numeric
    •
  • description: A unique identifier.
    •

    type

  • name: type
    •
  • type: string
    •
  • description: The type of flood zone (flood type).
    •

    shape_area

  • name: shape_area
    •
  • type: numeric
    •
  • description: The size of the flood zone.
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature (flood zone).
    •



    households

    Raw household level data


    population totals

    Aggregated population data

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:


    • households

    Household level population and characteristics data.

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • hh_id

  • name: hh_id
    •
  • type: numeric
    •
  • description: A unique identifier for households.
    •

    number_of_dwellers

  • name: number_of_dwellers
    •
  • type: numeric
    •
  • description: The number of dwellers/people in the household.
    •

    lad

  • name: lad
    •
  • type: string
    •
  • description: The Local Authority District the household lives in.
    •

    OA

  • name: OA
    •
  • type: string
    •
  • description: The census output area the household lives in.
    •

    central_heating

  • name: central_heating
    •
  • type: boolean
    •
  • description: True if the household occupies a dwelling with central heating. False if not.
    •

    tenure_type

  • name: tenure_type
    •
  • type: string
    •
  • description: The status of the household's occupation of the dwelling they live in e.g. rented, owned, mortgaged etc.
    •

    house_type

  • name: house_type
    •
  • type: string
    •
  • description: The form of the dwelling the household live in e.g. flat, semi-detached etc.
    •

    communal_type

  • name: communal_type
    •
  • type: string
    •
  • description: If the household lives in a communal dwelling (given by the house_type), what form of dwelling is this.
    •

    number_of_cars

  • name: number_of_cars
    •
  • type: numeric
    •
  • description: The number of cars the household own/have access to.
    •

    household_composition

  • name: household_composition
    •
  • type: string
    •
  • description: The structure of the household e.g. single, married etc.
    •

    economic_activity

  • name: economic_activity
    •
  • type: string
    •
  • description: The occupation status of the nominated lead member of the household e.g. full time, self employed etc.
    •

    ethnicity

  • name: ethnicity
    •
  • type: string
    •
  • description: The ethnicity of the household/lead member of the househld.
    •

    number_of_bedrooms

  • name: number_of_bedrooms
    •
  • type: numeric
    •
  • description: The number of bedrooms the household have in their dwelling.
    •

    number_of_rooms

  • name: number_of_rooms
    •
  • type: numeric
    •
  • description: The total number of rooms the household have access to in their dwelling.
    •

    CALL TYPE: POST

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • CALL TYPE: PUT

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

  • name:
  • type:
  • description:


    • get households summary

    Household population data aggregated values

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:



    • mastermap

    Access to the Ordnance Survey MasterMap dataset. This includes the topographic layer, with all buildings and land parcels


    buildings

    Ordnance Survey MasterMap buildings data

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • toid

  • name: toid
    •
  • type: string
    •
  • description: The TOID, the Ordnance Survey unique identifier, for the feature.
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature.
    •

    toid_number

  • name: toid_number
    •
  • type: integer
    •
  • description: The TOID number, the Ordnance Survey unique identifier, for the feature excluding text characters.
    •

    oa

  • name: oa
    •
  • type: string
    •
  • description: The census output area code the feature falls whithin.
    •

    lad

  • name: lad
    •
  • type: string
    •
  • description: The Local Authority Disctrict the feature falls within.
    •

    gor

  • name: gor
    •
  • type: string
    •
  • description: The Government Office Region the feature falls within.
    •

    height_toroofbase

  • name: height_toroofbase
    •
  • type: numeric
    •
  • description: The height from the ground to the base of the roof in meters.
    •

    height_torooftop

  • name: height_torooftop
    •
  • type: numeric
    •
  • description: The height from the ground to the top of the roof in meters.
    •

    group_ids

  • name: group_ids
    •
  • type: list of numeric
    •
  • description: A list of IDs linked to the use of the builidng as recorded in the Ordnance Survey AddressBase dataset.
    •

    group_id

  • name: group_id
    •
  • type: numberic
    •
  • description: The dominant id, if there is one, for the use of the building as recorded in the Ordnance Survey Addressbase dataset.
    •

    res_count

  • name: res_count
    •
  • type: numberic
    •
  • description: The number of residential addresses located at the feature/building as calculated using the Address Base dataset.
    •

    nonres_count

  • name: nonres_count
    •
  • type: numeric
    •
  • description: The number of non-residential addresses located at the feature/building as calculated using the Address Base dataset.
    •

    footprint_area

  • name: footprint_area
    •
  • type: numeric
    •
  • description: The area (meters squared) of the footprint of the building.
    •

    number_of_floors

  • name: number_of_floors
    •
  • type: numeric
    •
  • description: An estimate of the number of floors in the building/feature based on the building height and a value of 3m per floor.
    •

    floor_area

  • name: floor_area
    •
  • type: numeric
    •
  • description: The total floor area in a building/feature based on the estimated number of floors and the footprint area of the building.
    •

    class_code

  • name: class_code
    •
  • type: string
    •
  • description: The single code assigned to the building for its use.
    •

    building_use

  • name: building_use
    •
  • type: string
    •
  • description: The purpose of the building based on the address counts
    •

    building_ratio

  • name: building_ratio
    •
  • type: numeric
    •
  • description: The ratio between the longest and shorted edges of the bounding box for the building.
    •

    landparcel_id

  • name: landparcel_id
    •
  • type: numeric
    •
  • description: The id of the landparcel the building resides within.
    •

    household_id

  • name: household_id
    •
  • type: numeric, list of
    •
  • description: The id of each household assigned to the building, where a household originates from a model output
    •

    mistral_building_class

  • name: mistral_building_class
    •
  • type: string
    •
  • description: The mistral class for the form of the building e.g. detached, flat.
    •

    mistral_function_class

  • name: mistral_function_class
    •
  • type: string
    •
  • description: The mistral class for the function of the building e.g. residential, educational.
    •


    MISTRAL building class

    MISTRAL building class

    CALL TYPE: POST

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:


    • mistral address groups

    Derived groups for address classifications

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • mistral_class_group_id

  • name: mistral_class_group_id
    •
  • type: integer
    •
  • description: A unique id for the the address classification
    •

    group_name

  • name: group_name
    •
  • type: string
    •
  • description: Name of MISTRAL address group
    •


    MISTRAL building class stats per oa

    Census Output Area building class statistics

    CALL TYPE: POST

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • rows_updated

  • name: rows_updated
    •
  • type: numeric
    •
  • description: The number of rows updated. This may differ from the number submitted as some may have been unsuccessful.
    •

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

  • name:
  • type: numeric
    •
  • description:


    • mastermap sites

    Ordnance Survey MasterMap Sites layer data

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • id

  • name: id
    •
  • type: numeric
    •
  • description: A unique identifier for each records.
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature.
    •

    oa

  • name: oa
    •
  • type: string
    •
  • description: The Census Output Area the feature centroid falls in.
    •

    lad

  • name: lad
    •
  • type: string
    •
  • description: The Local Authority District the feature centroid falls in.
    •

    gor

  • name: gor
    •
  • type: string
    •
  • description: The Government Office Region the feature centroid falls in.
    •

    toid

  • name: toid
    •
  • type: string
    •
  • description: The Ordnance Survey unique identifier.
    •

    functionstaatus

  • name: functionstaatus
    •
  • type: string
    •
  • description: If the site is operational or not.
    •

    functiontheme

  • name: functiontheme
    •
  • type: string
    •
  • description: The theme underwhich the site operates e.g. Air transport, education, medical care etc.
    •

    function

  • name: function
    •
  • type: string
    •
  • description: A detailed description of the sites operation, a sub-class of the functiontheme.
    •

    primary_stakeholder

  • name: primary_stakeholder
    •
  • type: string
    •
  • description: The primary stakeholder if known of the site.
    •


    landparcel data

    Derived built-form land parcels from Ordnance Survey MasterMap

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • id

  • name: id
    •
  • type: numeric
    •
  • description: A unique identifier for each records.
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature.
    •

    lad

  • name: lad
    •
  • type: string
    •
  • description: The Local Authority District the feature (topographic area) centroid falls in.
    •

    gor

  • name: gor
    •
  • type: string
    •
  • description: The Government Office Region the feature (topographic area) centroid falls in.
    •

    res_buildings

  • name: res_buildings
    •
  • type: numeric
    •
  • description: The number of residential buildings in the land parcel (only present when with_building_stats set as true).
    •

    nonres_buildings

  • name: nonres_buildings
    •
  • type: numeric
    •
  • description: The number of non-residential buildings in the land parcel (only present when with_building_stats set as true).
    •

    mixed_buildings

  • name: mixed_buildings
    •
  • type: numeric
    •
  • description: The number of mixed use buildings (residential and non-residential) in the land parcel (only present when with_building_stats set as true).
    •

    mistral_class_n (where 0 < n > 14)

  • name: mistral_class_n (where 0 < n > 14)
    •
  • type: numeric
    •
  • description: The number of buildings where the predominant class is of the class type id in the column heading (1-13)(only present when with_building_stats set as true)..
    •


    topographic areas

    Ordnance Survey AddressBase Topographic Area data

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • id

  • name: id
    •
  • type: numeric
    •
  • description: A unique identifier for each records.
    •

    theme

  • name: theme
    •
  • type: string
    •
  • description: The general theme of the topographic area.
    •

    area

  • name: area
    •
  • type: numeric
    •
  • description: The size of the topographic area, square meters.
    •

    descriptive_group

  • name: descriptive_group
    •
  • type: string
    •
  • description: A detailed description of the theme of the area, a subclass of the theme attribute.
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature.
    •

    oa

  • name: oa
    •
  • type: string
    •
  • description: The census output area the feature (topographic area) centroid falls in.
    •

    lad

  • name: lad
    •
  • type: string
    •
  • description: The Local Authority District the feature (topographic area) centroid falls in.
    •

    gor

  • name: gor
    •
  • type: string
    •
  • description: The Government Office Region the feature (topographic area) centroid falls in.
    •


    topographic area class data

    Ordnance Survey MasterMap Topographic areas classification data

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • feature_code

  • name: feature_code
    •
  • type: string
    •
  • description: A classification code for the MasterMap topographic areas dataset.
    •

    descriptive_group

  • name: descriptive_group
    •
  • type: string
    •
  • description: The general theme of the feature.
    •

    feature_type

  • name: feature_type
    •
  • type: string
    •
  • description: A description of the type of feature e.g., Line, Area, Point, Text
    •

    descriptive_term

  • name: descriptive_term
    •
  • type: string
    •
  • description: A lower level more detailed characterisation of the feature. A sub-class of the descriptive group.
    •



    AddressBase building classes

    Ordnance Survey AddressBase building classes

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • id

  • name: id
    •
  • type: integer
    •
  • description: A unique id for the the address classification
    •

    addressbase_code

  • name: addressbase_code
    •
  • type: string
    •
  • description: AddressBase classification code for address location
    •

    title

  • name: title
    •
  • type: string
    •
  • description: A title/descriptor for the classification code
    •



    networks

    Data on networks, such as road, rail and utilities


    highways

    Network data sets

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:


    • open roads

    Network data sets

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:


    • list of networks

    Network list

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:


    • network size

    Network statistics

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • node_count

  • name: node_count
    •
  • type: numeric
    •
  • description: The number of nodes in the network.
    •

    edge_count

  • name: edge_count
    •
  • type: numeric
    •
  • description: The number of edges in the network.
    •


    network

    Network data sets

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature.
    •

    *

  • name: *
    •
  • type: *
    •
  • description: All fields part of the original data.
    •



    poi

    The Ordnance Survey Points of Interest (POI) dataset. Contains points for sites and locations from electricity substations to cash machines


    PoI classes

    Ordnance Survey Points of Interest classification codes

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • class_code

  • name: class_code
    •
  • type: string
    •
  • description: The classification code as assigned by Ordnance Survey to a feature.
    •

    class_text

  • name: class_text
    •
  • type: string
    •
  • description: The top level group the classification code falls within.
    •

    class_group

  • name: class_group
    •
  • type: string
    •
  • description: The secondary level group the classification code falls within. A sub-class of the class_text.
    •

    class_category

  • name: class_category
    •
  • type: string
    •
  • description: The lowest level descriptor for the classification code. A sub-class of the class_group.
    •


    text search for PoI class codes

    Ordnance Survey Points of Interest classification codes search

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • class_code

  • name: class_code
    •
  • type: string
    •
  • description: The classification code as assigned by Ordnance Survey to a feature.
    •

    class_text

  • name: class_text
    •
  • type: string
    •
  • description: The top level group the classification code falls within.
    •

    class_group

  • name: class_group
    •
  • type: string
    •
  • description: The secondary level group the classification code falls within. A sub-class of the class_text.
    •

    class_category

  • name: class_category
    •
  • type: string
    •
  • description: The lowest level descriptor for the classification code. A sub-class of the class_group.
    •


    PoI data

    Ordnance Survey MasterMap Points of Interest data

    CALL TYPE: GET

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned:

  • Fields in returned data:

    • toid

  • name: toid
    •
  • type: string
    •
  • description: The Ordnance Survey unique identifier.
    •

    oa

  • name: oa
    •
  • type: string
    •
  • description: The census output area code the feature falls within.
    •

    lad

  • name: lad
    •
  • type: string
    •
  • description: The Local Authority District the feature falls within.
    •

    gor

  • name: gor
    •
  • type: string
    •
  • description: The Government Office Region the feature falls within.
    •

    classification_code

  • name: classification_code
    •
  • type: string
    •
  • description: The classification code as assiged by Ordnance Survey for the feature.
    •

    geom

  • name: geom
    •
  • type: geometry
    •
  • description: The geometry of the feature.
    •


    analysis calls

    Run analysis between datasets on NISMOD-DB++


    networks

    Perform analysis over the networks already stored in NISMOD-DB++


    find path

    Find and return the path between two nodes

    CALL TYPE: POST

    Description:

  • Call parameters:

    • Required Parameters:


    Optional Parameters:

  • Data returned: