Class NcAddressType

A data type for a geophysical location described by postal information.

Inheritance

System.Object

NcAddressType

Implements

System.IEquatable<NcAddressType>

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: NiemTypes

Assembly: EidoLib.dll

Syntax

[DataContract]
public class NcAddressType : IEquatable<NcAddressType>

Properties

BuildingName

A name of a specific building at an address to distinguish it from other buildings at the same site. NIEM reference is nc:AddressBuildingName

Declaration

[DataMember(Name = "buildingName")]
public List<NcTextType> BuildingName { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcTextType>	A name of a specific building at an address to distinguish it from other buildings at the same site. NIEM reference is nc:AddressBuildingName

Category

A kind of address. NIEM reference is nc:AddressCategoryText

Declaration

[DataMember(Name = "category")]
public List<NcTextType> Category { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcTextType>	A kind of address. NIEM reference is nc:AddressCategoryText

CategoryCode

A kind of address. NIEM reference is nc:AddressCategoryCode

Declaration

[DataMember(Name = "categoryCode")]
public List<NcAddressCategoryCodeType> CategoryCode { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcAddressCategoryCodeType>	A kind of address. NIEM reference is nc:AddressCategoryCode

Context

ncAddressType JSON-LD context

Declaration

[DataMember(Name = "@context")]
public NcAddressType.ContextEnum? Context { get; set; }

Property Value

Type	Description
System.Nullable<NcAddressType.ContextEnum>	ncAddressType JSON-LD context

DeliveryPoint

A single place or unit at which mail is delivered. NIEM reference is nc:AddressDeliveryPointText

Declaration

[DataMember(Name = "deliveryPoint")]
public List<NcTextType> DeliveryPoint { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcTextType>	A single place or unit at which mail is delivered. NIEM reference is nc:AddressDeliveryPointText

DeliveryPointId

An identifier of a single place or unit at which mail is delivered. NIEM reference is nc:AddressDeliveryPointID

Declaration

[DataMember(Name = "deliveryPointId")]
public List<NiemXsstring> DeliveryPointId { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NiemXsstring>	An identifier of a single place or unit at which mail is delivered. NIEM reference is nc:AddressDeliveryPointID

Full

A complete address. NIEM reference is nc:AddressFullText

Declaration

[DataMember(Name = "full")]
public List<NcTextType> Full { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcTextType>	A complete address. NIEM reference is nc:AddressFullText

ItAugmentation

Additional information about an address. NIEM reference is it:AddressAugmentation

Declaration

[DataMember(Name = "itAugmentation")]
public List<ItAddressAugmentationType> ItAugmentation { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ItAddressAugmentationType>	Additional information about an address. NIEM reference is it:AddressAugmentation

JAugmentation

Additional information about a Address. NIEM reference is j:AddressAugmentation

Declaration

[DataMember(Name = "jAugmentation")]
public List<JAddressAugmentationType> JAugmentation { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<JAddressAugmentationType>	Additional information about a Address. NIEM reference is j:AddressAugmentation

LocationCityName

A name of a city or town. NIEM reference is nc:LocationCityName

Declaration

[DataMember(Name = "locationCityName")]
public List<NcProperNameTextType> LocationCityName { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcProperNameTextType>	A name of a city or town. NIEM reference is nc:LocationCityName

LocationCountry

A country, territory, dependency, or other such geopolitical subdivision of a location. NIEM reference is nc:LocationCountry

Declaration

[DataMember(Name = "locationCountry")]
public List<NcCountryType> LocationCountry { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcCountryType>	A country, territory, dependency, or other such geopolitical subdivision of a location. NIEM reference is nc:LocationCountry

LocationCountyCode

A county, parish, vicinage, or other such geopolitical subdivision of a state. NIEM reference is nc:LocationCountyCode

Declaration

[DataMember(Name = "locationCountyCode")]
public List<CensusUSCountyCodeType> LocationCountyCode { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<CensusUSCountyCodeType>	A county, parish, vicinage, or other such geopolitical subdivision of a state. NIEM reference is nc:LocationCountyCode

LocationCountyName

A name of a county, parish, vicinage, or other such geopolitical subdivision of a state. NIEM reference is nc:LocationCountyName

Declaration

[DataMember(Name = "locationCountyName")]
public List<NcProperNameTextType> LocationCountyName { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcProperNameTextType>	A name of a county, parish, vicinage, or other such geopolitical subdivision of a state. NIEM reference is nc:LocationCountyName

LocationPostalCode

An identifier of a post office-assigned zone for an address. NIEM reference is nc:LocationPostalCode

Declaration

[DataMember(Name = "locationPostalCode")]
public List<NiemXsstring> LocationPostalCode { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NiemXsstring>	An identifier of a post office-assigned zone for an address. NIEM reference is nc:LocationPostalCode

LocationPostalExtensionCode

An identifier of a smaller area within a post office-assigned zone for an address. NIEM reference is nc:LocationPostalExtensionCode

Declaration

[DataMember(Name = "locationPostalExtensionCode")]
public List<NiemXsstring> LocationPostalExtensionCode { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NiemXsstring>	An identifier of a smaller area within a post office-assigned zone for an address. NIEM reference is nc:LocationPostalExtensionCode

LocationRouteName

A name and number of a postal route. NIEM reference is nc:LocationRouteName

Declaration

[DataMember(Name = "locationRouteName")]
public List<NcTextType> LocationRouteName { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcTextType>	A name and number of a postal route. NIEM reference is nc:LocationRouteName

LocationState

A state, commonwealth, province, or other such geopolitical subdivision of a country. NIEM reference is nc:LocationState

Declaration

[DataMember(Name = "locationState")]
public List<NcStateType> LocationState { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcStateType>	A state, commonwealth, province, or other such geopolitical subdivision of a country. NIEM reference is nc:LocationState

LocationStreet

A road, thoroughfare or highway. NIEM reference is nc:LocationStreet

Declaration

[DataMember(Name = "locationStreet")]
public List<NcStreetType> LocationStreet { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcStreetType>	A road, thoroughfare or highway. NIEM reference is nc:LocationStreet

PrivateMailbox

A private mailbox within a company. NIEM reference is nc:AddressPrivateMailboxText

Declaration

[DataMember(Name = "privateMailbox")]
public List<NcTextType> PrivateMailbox { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcTextType>	A private mailbox within a company. NIEM reference is nc:AddressPrivateMailboxText

RecipientName

A name of a person, organization, or other recipient to whom physical mail may be sent. NIEM reference is nc:AddressRecipientName

Declaration

[DataMember(Name = "recipientName")]
public List<NcTextType> RecipientName { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcTextType>	A name of a person, organization, or other recipient to whom physical mail may be sent. NIEM reference is nc:AddressRecipientName

ScrAugmentation

Additional information about an address. NIEM reference is scr:AddressAugmentation

Declaration

[DataMember(Name = "scrAugmentation")]
public List<ScrAddressAugmentationType> ScrAugmentation { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ScrAddressAugmentationType>	Additional information about an address. NIEM reference is scr:AddressAugmentation

SecondaryUnit

A particular unit within a larger unit or grouping at a location. NIEM reference is nc:AddressSecondaryUnitText

Declaration

[DataMember(Name = "secondaryUnit")]
public List<NcTextType> SecondaryUnit { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcTextType>	A particular unit within a larger unit or grouping at a location. NIEM reference is nc:AddressSecondaryUnitText

UrbanizationName

An urbanization denotes an area, sector, or residential development within a geographic area. Commonly used in Puerto Rican urban areas, it is an important part of the addressing format, as it describes the location of a specific street whose name may occur multiple times within the same ZIP Code. NIEM reference is nc:AddressUrbanizationName

Declaration

[DataMember(Name = "urbanizationName")]
public List<NcTextType> UrbanizationName { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcTextType>	An urbanization denotes an area, sector, or residential development within a geographic area. Commonly used in Puerto Rican urban areas, it is an important part of the addressing format, as it describes the location of a specific street whose name may occur multiple times within the same ZIP Code. NIEM reference is nc:AddressUrbanizationName

Methods

Equals(NcAddressType)

Returns true if NcAddressType instances are equal

Declaration

public bool Equals(NcAddressType other)

Parameters

Type	Name	Description
NcAddressType	other	Instance of NcAddressType to be compared

Returns

Type	Description
System.Boolean	Boolean

Equals(Object)

Returns true if objects are equal

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	Object to be compared

Returns

Type	Description
System.Boolean	Boolean

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	Hash code

Overrides

System.Object.GetHashCode()

ToJson()

Returns the JSON string presentation of the object

Declaration

public string ToJson()

Returns

Type	Description
System.String	JSON string presentation of the object

ToString()

Returns the string presentation of the object

Declaration

public override string ToString()

Returns

Type	Description
System.String	String presentation of the object

Overrides

System.Object.ToString()

Operators

Equality(NcAddressType, NcAddressType)

Declaration

public static bool operator ==(NcAddressType left, NcAddressType right)

Parameters

Type	Name	Description
NcAddressType	left
NcAddressType	right

Returns

Type	Description
System.Boolean

Inequality(NcAddressType, NcAddressType)

Declaration

public static bool operator !=(NcAddressType left, NcAddressType right)

Parameters

Type	Name	Description
NcAddressType	left
NcAddressType	right

Returns

Type	Description
System.Boolean

Implements

System.IEquatable<T>