ProposedSiteLocation

Type: object

For proposing Locations for DER installation

No Additional Properties

Type: array

Array of PositionPoint objects

No Additional Items

Each item of this array must be:

Type: object

Set of spatial coordinates that determine a point, defined in the coordinate system specified in 'Location.CoordinateSystem'. Use a single position point instance to describe a point-oriented location. Use a sequence of position points to describe a line-oriented object (physical location of non-point oriented objects like cables or lines), or area of an object (like a substation or a geographical zone - in this case, have first and last position point with the same values).

No Additional Properties

Type: string

(if applicable) Z axis position.

Type: integer

Zero-relative sequence number of this group within a series of points; used when there is a need to express disjoint groups of points that are considered to be part of a single location.

Type: integer

Zero-relative sequence number of this point within a series of points.

Type: string

Pointer to CoordinateSystem object

Type: object

Main address of the location.

Type: object Default: null

Town detail.

Type: string Default: null

Name of the state or province.

Type: string Default: null

Town code.

Type: string Default: null

Name of the country.

Type: string Default: null

Town name.

Type: string Default: null

Town section. For example, it is common for there to be 36 sections per township.

Type: object Default: null

Street detail.

Type: string Default: null

(if applicable) Third line of a free form address.

Type: string Default: null

Number of the apartment or suite.

Type: string Default: null

The identification by name or number, expressed as text, of the floor in the building as part of this address.

Type: string Default: null

First line of a free form address or some additional address information (for example a mail stop).

Type: string Default: null

(if applicable) In certain cases the physical location of the place of interest does not have a direct point of entry from the street, but may be located inside a larger structure such as a building, complex, office block, apartment, etc.

Type: boolean Default: null

True if this street is within the legal geographical boundaries of the specified town (default).

Type: string Default: null

(if applicable) Utilities often make use of external reference systems, such as those of the town-planner's department or surveyor general's mapping system, that allocate global reference codes to streets.

Type: string Default: null

Prefix to the street name. For example: North, South, East, West.

Type: string Default: null

Type of street. Examples include: street, circle, boulevard, avenue, road, drive, etc.

Type: string Default: null

Name of the street.

Type: string Default: null

(if applicable) Second line of a free form address.

Type: string Default: null

Designator of the specific location on the street.

Type: string Default: null

Suffix to the street name. For example: North, South, East, West.

Type: object Default: null

Status of this address.

Type: string Default: null

Status value at 'dateTime'; prior status changes may have been kept in instances of activity records associated with the object to which this status applies.

Type: string Default: null

Pertinent information regarding the current 'value', as free form text.

Type: string Default: null

Reason code or explanation for why an object went to the current status 'value'.

Type: string Default: null

Date and time for which status 'value' applies.

Type: string Default: null

The language in which the address is specified, using ISO 639-1 two digit language code.

Type: string Default: null

Postal code for the address.

Type: string Default: null

Post office box.

Type: object or number

Land area available for PV and/or Wind development

Type: enum (of string) Default: "m2"

nan

Must be one of:

  • "JPerkg"
  • "NPerm"
  • "WPerW"
  • "JPermol"
  • "WPerm2sr"
  • "V"
  • "A2h"
  • "JPerK"
  • "m3Perkg"
  • "HzPerHz"
  • "T"
  • "Vh"
  • "tonne"
  • "JPerm2"
  • "CPerkg"
  • "VPerHz"
  • "ohm"
  • "K"
  • "m3Compensated"
  • "lx"
  • "lPerh"
  • "APerm"
  • "charPers"
  • "katPerm3"
  • "Pas"
  • "ohmPerm"
  • "radPers2"
  • "Btu"
  • "WPers"
  • "h"
  • "lPerl"
  • "l"
  • "As"
  • "cosPhi"
  • "W"
  • "count"
  • "PaPers"
  • "onePerHz"
  • "m3Pers"
  • "KPers"
  • "Vs"
  • "m2Pers"
  • "Ah"
  • "deg"
  • "mPers2"
  • "lm"
  • "d"
  • "JPerkgK"
  • "m"
  • "min"
  • "dB"
  • "Gy"
  • "Nm"
  • "JPerm3"
  • "sPers"
  • "Q"
  • "rev"
  • "N"
  • "Bq"
  • "WPermK"
  • "GyPers"
  • "HPerm"
  • "molPerkg"
  • "molPerm3"
  • "Wb"
  • "VPerm"
  • "WPerm2"
  • "kn"
  • "CPerm2"
  • "anglemin"
  • "Oe"
  • "kgm"
  • "character"
  • "APerA"
  • "A2s"
  • "Qh"
  • "JPers"
  • "Hz"
  • "rad"
  • "kat"
  • "degC"
  • "bar"
  • "M"
  • "molPermol"
  • "kgPerJ"
  • "J"
  • "HzPers"
  • "WPersr"
  • "anglesec"
  • "F"
  • "Mx"
  • "ha"
  • "SPerm"
  • "gal"
  • "mmHg"
  • "m2"
  • "mPers"
  • "V2h"
  • "m3"
  • "G"
  • "H"
  • "mol"
  • "rotPers"
  • "VAh"
  • "mPerm3"
  • "onePerm"
  • "V2"
  • "WPerA"
  • "Pa"
  • "kgPerm3"
  • "CPerm3"
  • "Sv"
  • "S"
  • "JPermolK"
  • "ft3"
  • "Wh"
  • "radPers"
  • "ohmm"
  • "kgm2"
  • "m3Perh"
  • "dBm"
  • "VA"
  • "A2"
  • "s"
  • "therm"
  • "VArh"
  • "cd"
  • "VPerV"
  • "gPerg"
  • "kg"
  • "A"
  • "m3Uncompensated"
  • "ppm"
  • "FPerm"
  • "C"
  • "sr"
  • "none"
  • "VPerVAr"
  • "VAr"
  • "VPerVA"
  • "lPers"

Type: enum (of string) Default: "none"

nan

Must be one of:

  • "f"
  • "c"
  • "G"
  • "d"
  • "z"
  • "p"
  • "y"
  • "h"
  • "Y"
  • "a"
  • "none"
  • "k"
  • "m"
  • "n"
  • "E"
  • "da"
  • "T"
  • "M"
  • "P"
  • "Z"
  • "micro"

Type: number Default: null

nan

Type: string

(if applicable) Reference to geographical information source, often external to the utility.

Type: object

Phone number.

Type: string Default: null

Main (local) part of this telephone number.

Type: string Default: null

(if applicable) Prefix used when calling an international number.

Type: string Default: null

Phone number according to International Telecommunication Union (ITU) E.164.

Type: string Default: null

City code.

Type: string Default: null

(if applicable) Extension for this telephone number.

Type: string Default: null

Country code.

Type: string Default: null

(if applicable) Area or region code.

Type: string Default: null

(if applicable) Dial out code, for instance to call outside an enterprise.

Type: object

Electronic address.

Type: string Default: null

World wide web address.

Type: string Default: null

User ID needed to log in, which can be for an individual person, an organisation, a location, etc.

Type: string Default: null

MAC (Media Access Control) address.

Type: string Default: null

Password needed to log in.

Type: string Default: null

Alternate email address.

Type: string Default: null

Address on local area network.

Type: string Default: null

Primary email address.

Type: string Default: null

Radio address.

Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

Type: string

Classification by utility's corporate standards and practices, relative to the location itself (e.g., geographical, functional accounting, etc., not a given property that happens to exist at that location).

Type: object

Secondary address of the location. For example, PO Box address may have different ZIP code than that in the 'mainAddress'.

Same definition as Location.mainAddress

Type: object

Additional phone number.

Same definition as Location.phone1

Type: string

(if applicable) Direction that allows field crews to quickly find a given asset. For a given location, such as a street address, this is the relative direction in which to find the asset. For example, a streetlight may be located at the 'NW' (northwest) corner of the customer's site, or a usage point may be located on the second floor of an apartment building.

Type: object

Status of this location.

Same definition as status

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.