AND SITES GIS-Import FeatureCollection

Type: object

Description

This schema defines a GeoJSON FeatureCollection for the Advanced Network Design system, intended for importing site data into an AND project. It supports enumeration values as both strings and integers, accommodating various data representations for enhanced flexibility in data integration. The name of the geojson file to be imported is mandatory ‘sites.geojson’. Please consider that there are more schemas defining the single features of infrastructure and network.

Required Properties

  • type
  • features

Properties

The following properties are defined for this object:

  • type

    Type: string

    Allowed Values

    • "FeatureCollection"
  • features

    Type: array

    Items

    Each item in this array must adhere to the following schema:

    GeoJSON Feature: features

    Type: object

    Required Properties

    • type
    • properties
    • geometry

    Properties

    The following properties are defined for this object:

    • type

      Type: string

      Allowed Values

      • "Feature"
    • id

      Type: string

      Description

      the ID of external system which will be stored within ‘RefId’ property of instaciated AND Object

      Target: RefId of object

      Default Value

      The default value for this item is:

      null
    • properties

      Type: object

      Properties

      The following properties are defined for this object:

      • site_type

        Description

        Defines the type of site, such as ‘Single-family house (residential)’.

        Component-mapping: true

        Value-mapping: true

        Target: will be mapped into ObjAttribute::SiteType from SiteTypes.xml

        This item must also validate against exactly one of the following schemas:

        • Type: integer

          Allowed Values

          • 0
          • 1
          • 2
          • 3
          • 4
          • 5
          • 6
          • 7
          • 13
          • 14
          • 15
          • 23
          • 24
          • 25
          • 32
          • 33
          • 34
          • 35
          • 36
          • 37
          • 38
          • 39
          • 40
          • 48
          • 49
          • 50
          • 51
          • 52
          • 53
          • 54
          • 55
          • 56
          • 57
          • 58
          • 59
          • 60
          • 61
          • 62
          • 100
          • 101
          • 102
          • 103
          • 150
          • 152
          • 153
          • 154
          • 155
          • 160
          • 180
          • 182
          • 190
          • 200
          • 210
          • 220
          • 250
          • 252
          • 260
          • 270
          • 300
          • 350
          • 400
          • 410
          • 420

          Default Value

          The default value for this item is:

          0
        • Type: string

          Allowed Values

          • "ANY"
          • "RES"
          • "COM"
          • "PUB"
          • "TEC"
          • "IFSTRUCT"
          • "TOWER"
          • "TRANST"
          • "SRES"
          • "DRES"
          • "TRES"
          • "MDRES"
          • "ARES"
          • "HRES"
          • "OFB"
          • "SCOM"
          • "MCOM"
          • "MALL"
          • "MARKET"
          • "KIOSK"
          • "WAREH"
          • "FACTORY"
          • "INDUSTRY"
          • "FARM"
          • "HOTE"
          • "GOV"
          • "ADMIN"
          • "SCHOOL"
          • "UNI"
          • "KGN"
          • "CHURCH"
          • "HOSPITAL"
          • "TRAINST"
          • "TRANSPORT"
          • "GARAGE"
          • "AIRPORT"
          • "SPORTS"
          • "STADIUM"
          • "INFRA_B"
          • "INFRA_T"
          • "INFRA_TR"
          • "INFRA_TS"
          • "CABINET"
          • "MANHOLE"
          • "HANDHOLE"
          • "EARTHHOLE"
          • "TRENCHDIV"
          • "CLOSURE"
          • "MAST"
          • "POLE"
          • "WALLBOX"
          • "FLOOR"
          • "ROOM"
          • "FLAT"
          • "O_OFFICE"
          • "R_OFFICE"
          • "WALLBOX_IS"
          • "CABINET_IS"
          • "FRAME"
          • "CONST"
          • "RACK"
          • "SHELF"
          • "CASS"

          Default Value

          The default value for this item is:

          "site any"
      • logical_type

        Description

        Specifies the logical classification of the site like ‘Central Office’ or ‘Fiber Distribution Point’ for network topology purposes.

        Component-mapping: true

        Value-mapping: true

        Target: will be mapped into ObjAttribute::HierarchySpecifier from NHspecifiers.xml

        This item must also validate against exactly one of the following schemas:

        • Type: integer

          Allowed Values

          • 0
          • 80
          • 100
          • 105
          • 110
          • 120
          • 200
          • 300
          • 310
          • 320
          • 330
          • 500
          • 510
          • 550
          • 560
          • 600
          • 610
          • 620

          Default Value

          The default value for this item is:

          0
        • Type: string

          Allowed Values

          • "n/a"
          • "TI"
          • "RS"
          • "HE"
          • "POP"
          • "CO"
          • "MPOP"
          • "DP"
          • "FSP"
          • "FDP"
          • "FSDP"
          • "POI"
          • "RDP"
          • "BTP"
          • "BEP"
          • "FN"
          • "AP"
          • "PS"

          Default Value

          The default value for this item is:

          "n/a"
      • name

        Type: string

        Description

        the name of the site; can be a user-readable Building-Name or number

        Target: InstallationNumber of object

      • residential_units

        Type: number

        Description

        Number of residential units/apartments within this site

        Target: stored in triplet and summed up into ObjAttribute::MDUCount

      • commercial_units

        Type: number

        Description

        Number of commercial units within that site

        Target: stored in triplet and summed up into ObjAttribute::MDUCount

      • communal_units

        Type: number

        Description

        Number of communal units within this site/public building

        Target: stored in triplet and summed up into ObjAttribute::MDUCount

      • visual_reference_id

        Description

        Allows a mapping to a lib-symbol via mapping setup

        Component-mapping: true

        Target: only used for mapping - not stored

        This item must also validate against exactly one of the following schemas:

        • Type: integer

        • Type: string

      • owner

        Type: string

        Description

        The owner of that site

        Target: Is stored in DB. At begin of import all occuring owners (strings) will be collected and searched in DB by name. The existing ones mapped, the new ones added (with message)

      • is_private

        Type: boolean

        Description

        A private or communal/public owned site

        Target: Triplet or DaaVar, if the assignment is configured in the metadata

      • status

        Description

        the status of the site (enum)

        Value-mapping: true

        Target: will be mapped into ObjAttribute::State from States.xml

        This item must also validate against exactly one of the following schemas:

        • Type: integer

          Allowed Values

          • 50
          • 100
          • 200
          • 300
          • 400
          • 420
          • 440
          • 450
          • 480
          • 500
          • 600
          • 700
          • 800
          • 900

          Default Value

          The default value for this item is:

          50
        • Type: string

          Allowed Values

          • "n/a"
          • "inherit"
          • "Evaluation"
          • "Decision"
          • "Planning"
          • "Planned"
          • "Ordered"
          • "Booked"
          • "Interrupted"
          • "Building"
          • "Built"
          • "Operation"
          • "Standing Idle"
          • "Out of Order"

          Default Value

          The default value for this item is:

          "n/a"
      • color

        Type: string

        Description

        Color in RGBA format (e.g., ‘rgba(0, 0, 255, 1.0)’ for blue)

        Component-mapping: true

        Value-mapping: true

        Target: the rgb-value will be mapped to one of 127 fix colors of AND - Alpha channel will be ignored

        Examples

        The following are example values for this schema:

        • "rgba(0, 0, 255, 1.0)"
        • "rgb(0, 0, 255)"
      • layer

        Type: string

        Description

        Name of the layer where the site will be placed on

        Value-mapping: true

        Target: will be mapped into ObjAttribute::Layer - no automatic adding of not found layers

      • angle

        Type: number

        Description

        Angle for symbol (-180.0° to +359.99°)

        Target: ObjAttribute::angle - useful only for certain objects, e.g north arrow - may not be supported

      • levels

        Type: number

        Description

        Number of levels of the house

        Component-mapping: true

        Target: Triplet or DaaVar, if the assignment is configured in the metadata

      • height

        Type: number

        Description

        Height in meters

        Target: Triplet or DaaVar, if the assignment is configured in the metadata

      • shaftwalls

        Type: number

        Description

        Number of walls in the shaft

        Component-mapping: true

        Target: Triplet or DaaVar, if the assignment is configured in the metadata

      • has_power

        Type: boolean

        Description

        Electricity availability

        Component-mapping: true

        Target: Triplet or DaaVar, if the assignment is configured in the metadata

      • system_id

        Type: string

        Description

        Filter to technical system - will be used to assign to several projects/designs

        Target: Triplet or DaaVar, if the assignment is configured in the metadata

      • address_id

        Type: string

        Description

        Address reference ID - id addresses are provided separate then this can be used instead of address properties below; will become RefId in NDS-Addresses

        Target: RefId in NDS address - resulting new address ID in objects properties

      • zip

        Type: string

        Description

        Postal ZIP code

        Target: NDS address property

      • city

        Type: string

        Description

        Name of the town

        Target: NDS address property

      • street

        Type: string

        Description

        Street name

        Target: NDS address property

      • house_num

        Type: string

        Description

        House number (optional with appendix)

        Target: NDS address property

      • house_num_appendix

        Type: string

        Description

        House number appendix

        Target: NDS address property

      • parcel_number

        Type: string

        Description

        Parcel number

        Target: NDS address property

      • city_district

        Type: string

        Description

        City district name

        Target: NDS address property

      • region_name

        Type: string

        Description

        The name of the country region

        Target: NDS address property

      • address_type

        Description

        Postal address type (enum)

        Value-mapping: true

        Target: NDS address property after mapping the value - mapping is meta-data dependent as type is defined there

        This item must also validate against exactly one of the following schemas:

        • Type: string

          Allowed Values

          • "unknown"
          • "non postal"
          • "planned"
          • "postal address"
          • "obsolete"

          Default Value

          The default value for this item is:

          "postal address"
        • Type: integer

          Allowed Values

          • 0
          • 601
          • 610
          • 666
          • 699

          Default Value

          The default value for this item is:

          666
      • data

        Type: object

        Description

        customer defined additional information as json object

        Target: Triplet or DaaVar, if the assignment is configured in the metadata - will internally be handled as string

    • GeoJSON Point: geometry

      Type: object

      Description

      Specifies the central geographical coordinates of the site as a GeoJSON point, which represents the centre coordinates of the site symbol.

      Target: objects center coordinates

      Required Properties

      • type
      • coordinates

      Properties

      The following properties are defined for this object:

      • type

        Type: string

        Allowed Values

        • "Point"
      • coordinates

        Type: array

        Minimum number of items: 2

        Items

        Each item in this array must adhere to the following schema:

        coordinates

        Type: number