Class PostalAddressFileKey
A class representing a WhenFresh Postal Address File Key.
Inherited Members
Namespace: WhenFresh.Api.Client.Models
Assembly: WhenFresh.Api.Client.dll
Syntax
public class PostalAddressFileKey : IComparable<PostalAddressFileKey>, IEquatable<PostalAddressFileKey>
Remarks
A WhenFresh-specific unique identifier for a PostalAddress.
Constructors
PostalAddressFileKey(string)
Initializes a new instance of the PostalAddressFileKey class.
Declaration
public PostalAddressFileKey(string postalAddressFileKey)
Parameters
Type | Name | Description |
---|---|---|
string | postalAddressFileKey | WhenFresh Postal Address File Key |
Remarks
A WhenFresh-specific unique identifier for a PostalAddress.
PostalAddressFileKey(uint)
Initializes a new instance of the PostalAddressFileKey class.
Declaration
public PostalAddressFileKey(uint uniqueDeliveryPointReferenceNumber)
Parameters
Type | Name | Description |
---|---|---|
uint | uniqueDeliveryPointReferenceNumber | Royal Mail Postal Address File (PAF) Unique Delivery Point Reference Number (UDPRN) |
Remarks
A WhenFresh-specific unique identifier for a PostalAddress.
PostalAddressFileKey(uint, uint)
Initializes a new instance of the PostalAddressFileKey class.
Declaration
public PostalAddressFileKey(uint uniqueDeliveryPointReferenceNumber, uint uniqueMultipleResidenceReferenceNumber)
Parameters
Type | Name | Description |
---|---|---|
uint | uniqueDeliveryPointReferenceNumber | Royal Mail Postal Address File (PAF) Unique Delivery Point Reference Number (UDPRN) |
uint | uniqueMultipleResidenceReferenceNumber | Royal Mail Multiple Residence Unique Multiple Residence Reference Number (UMRRN) |
Remarks
A WhenFresh-specific unique identifier for a PostalAddress.
Properties
UniqueDeliveryPointReferenceNumber
Royal Mail Postal Address File (PAF) Unique Delivery Point Reference Number (UDPRN).
Declaration
public uint UniqueDeliveryPointReferenceNumber { get; }
Property Value
Type | Description |
---|---|
uint |
Remarks
A WhenFresh-specific unique identifier for a PostalAddress.
UniqueMultipleResidenceReferenceNumber
Royal Mail Multiple Residence Unique Multiple Residence Reference Number (UMRRN).
Declaration
public uint? UniqueMultipleResidenceReferenceNumber { get; }
Property Value
Type | Description |
---|---|
uint? |
Remarks
A WhenFresh-specific unique identifier for a PostalAddress.
Methods
CompareTo(PostalAddressFileKey)
A class representing a WhenFresh Postal Address File Key.
Declaration
public int CompareTo(PostalAddressFileKey other)
Parameters
Type | Name | Description |
---|---|---|
PostalAddressFileKey | other |
Returns
Type | Description |
---|---|
int |
Remarks
A WhenFresh-specific unique identifier for a PostalAddress.
Equals(PostalAddressFileKey)
A class representing a WhenFresh Postal Address File Key.
Declaration
public bool Equals(PostalAddressFileKey other)
Parameters
Type | Name | Description |
---|---|---|
PostalAddressFileKey | other |
Returns
Type | Description |
---|---|
bool |
Remarks
A WhenFresh-specific unique identifier for a PostalAddress.
ToString()
A class representing a WhenFresh Postal Address File Key.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string |
Overrides
Remarks
A WhenFresh-specific unique identifier for a PostalAddress.