Documentation ¶
Index ¶
- type ErrorRepresentation
- type FieldedAddress
- type FieldedAddressRequest
- type FormattedAddress
- type FormattedAddressRequest
- type GeographicAddress
- type GeographicAddressRequestBuyerInput
- type GeographicAddressSellerResponse
- type GeographicAddressValidation
- type GeographicAddressValidationCreate
- type GeographicLocation
- type GeographicPoint
- type GeographicSubAddress
- type GeographicSubAddressRequest
- type ReferencedAddress
- type SubUnit
- type ValidationResult
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ErrorRepresentation ¶
type ErrorRepresentation struct { // it provides a link to the schema describing a REST resource. AtSchemaLocation string `json:"@schemaLocation,omitempty"` // The class type of a REST resource. AtType string `json:"@type,omitempty"` // Application related code (as defined in the API or from a common list) // Required: true Code *int32 `json:"code"` // Text that provide more details and corrective actions related to the error. This can be shown to a client user. Message string `json:"message,omitempty"` // Text that explains the reason for error. This can be shown to a client user. // Required: true Reason *string `json:"reason"` // url pointing to documentation describing the error ReferenceError string `json:"referenceError,omitempty"` // http error code extension like 400-2 Status string `json:"status,omitempty"` }
ErrorRepresentation Class used to describe API response error
swagger:model ErrorRepresentation
func (*ErrorRepresentation) MarshalBinary ¶
func (m *ErrorRepresentation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ErrorRepresentation) UnmarshalBinary ¶
func (m *ErrorRepresentation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type FieldedAddress ¶
type FieldedAddress struct { // City that the address is in City string `json:"city,omitempty"` // Country that the address is in Country string `json:"country,omitempty"` // geographic sub adress GeographicSubAdress []*GeographicSubAddress `json:"geographicSubAdress"` // Unique identifier of the address ID string `json:"id,omitempty"` // "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi-rural in nature." [ANZLIC-STREET], or a suburb "a bounded locality within a city, town or shire principally of urban character " [ANZLICSTREET]. Locality string `json:"locality,omitempty"` // The four-digit extension on an American postal code, what comes after the hyphen when specified. PostCodeExtension string `json:"postCodeExtension,omitempty"` // Descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also known as zipcode) Postcode string `json:"postcode,omitempty"` // The State or Province that the address is in StateOrProvince string `json:"stateOrProvince,omitempty"` // Name of the street or other street type StreetName string `json:"streetName,omitempty"` // Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses StreetNr string `json:"streetNr,omitempty"` // Last number in a range of street numbers allocated to a property StreetNrLast string `json:"streetNrLast,omitempty"` // Last street number suffix for a ranged address StreetNrLastSuffix string `json:"streetNrLastSuffix,omitempty"` // The first street number suffix StreetNrSuffix string `json:"streetNrSuffix,omitempty"` // A modifier denoting a relative direction StreetSuffix string `json:"streetSuffix,omitempty"` // Alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf StreetType string `json:"streetType,omitempty"` }
FieldedAddress A type of Address that has a discrete field and value for each type of boundary or identifier down to the lowest level of detail. For example “street number” is one field, “street name” is another field, etc.
swagger:model FieldedAddress
func (*FieldedAddress) MarshalBinary ¶
func (m *FieldedAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FieldedAddress) UnmarshalBinary ¶
func (m *FieldedAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type FieldedAddressRequest ¶
type FieldedAddressRequest struct { // City that the address is in City string `json:"city,omitempty"` // Country that the address is in Country string `json:"country,omitempty"` // geographic sub address GeographicSubAddress *GeographicSubAddressRequest `json:"geographicSubAddress,omitempty"` // "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi-rural in nature." [ANZLIC-STREET], or a suburb "a bounded locality within a city, town or shire principally of urban character " [ANZLICSTREET]. Locality string `json:"locality,omitempty"` // The four-digit extension on an American postal code, what comes after the hyphen when specified. PostCodeExtension string `json:"postCodeExtension,omitempty"` // Descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also known as zipcode) Postcode string `json:"postcode,omitempty"` // The State or Province that the address is in StateOrProvince string `json:"stateOrProvince,omitempty"` // Name of the street or other street type StreetName string `json:"streetName,omitempty"` // Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses StreetNr string `json:"streetNr,omitempty"` // Last number in a range of street numbers allocated to a property StreetNrLast string `json:"streetNrLast,omitempty"` // Last street number suffix for a ranged address StreetNrLastSuffix string `json:"streetNrLastSuffix,omitempty"` // The first street number suffix StreetNrSuffix string `json:"streetNrSuffix,omitempty"` // A modifier denoting a relative direction StreetSuffix string `json:"streetSuffix,omitempty"` // Alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf StreetType string `json:"streetType,omitempty"` }
FieldedAddressRequest A type of Address that has a discrete field and value for each type of boundary or identifier down to the lowest level of detail. For example “street number” is one field, “street name” is another field, etc. This structure is used in the request addressValidation only
swagger:model FieldedAddressRequest
func (*FieldedAddressRequest) MarshalBinary ¶
func (m *FieldedAddressRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FieldedAddressRequest) UnmarshalBinary ¶
func (m *FieldedAddressRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type FormattedAddress ¶
type FormattedAddress struct { // The first address line in a formatted address // Required: true AddrLine1 *string `json:"addrLine1"` // The second address line in a formatted address AddrLine2 string `json:"addrLine2,omitempty"` // City that the address is in City string `json:"city,omitempty"` // Country that the address is in Country string `json:"country,omitempty"` // Unique identifier of the address ID string `json:"id,omitempty"` // "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi-rural in nature." [ANZLIC-STREET], or a suburb "a bounded locality within a city, town or shire principally of urban character " [ANZLICSTREET]. Locality string `json:"locality,omitempty"` // The four-digit extension on an American postal code, what comes after the hyphen when specified. PostCodeExtension string `json:"postCodeExtension,omitempty"` // Descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also known as zipcode) Postcode string `json:"postcode,omitempty"` // The State or Province that the address is in StateOrProvince string `json:"stateOrProvince,omitempty"` }
FormattedAddress A type of Address that has discrete fields for each type of boundary or identifier with the exception of street and more specific location details, which are combined into a maximum of two strings based on local postal addressing conventions
swagger:model FormattedAddress
func (*FormattedAddress) MarshalBinary ¶
func (m *FormattedAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FormattedAddress) UnmarshalBinary ¶
func (m *FormattedAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type FormattedAddressRequest ¶
type FormattedAddressRequest struct { // The first address line in a formatted address // Required: true AddrLine1 *string `json:"addrLine1"` // The second address line in a formatted address AddrLine2 string `json:"addrLine2,omitempty"` // City that the address is in City string `json:"city,omitempty"` // Country that the address is in Country string `json:"country,omitempty"` // "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi-rural in nature." [ANZLIC-STREET], or a suburb "a bounded locality within a city, town or shire principally of urban character " [ANZLICSTREET]. Locality string `json:"locality,omitempty"` // The four-digit extension on an American postal code, what comes after the hyphen when specified. PostCodeExtension string `json:"postCodeExtension,omitempty"` // Descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also known as zipcode) Postcode string `json:"postcode,omitempty"` // The State or Province that the address is in StateOrProvince string `json:"stateOrProvince,omitempty"` }
FormattedAddressRequest A type of Address that has discrete fields for each type of boundary or identifier with the exception of street and more specific location details, which are combined into a maximum of two strings based on local postal addressing conventions
swagger:model FormattedAddressRequest
func (*FormattedAddressRequest) MarshalBinary ¶
func (m *FormattedAddressRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FormattedAddressRequest) UnmarshalBinary ¶
func (m *FormattedAddressRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicAddress ¶
type GeographicAddress struct { // Technical attribute to extend this class AtSchemaLocation string `json:"@schemaLocation,omitempty"` // Technical attribute to extend this class AtType string `json:"@type,omitempty"` // This attribute specifies if a Buyer must use one of the known existing Service Sites at this location for any Products delivered to this Address. For example, if a particular building owner mandated that all interconnects be done in a shared Public Meet-Me-Room, this attribute would be set to False for that Address. AllowsNewSite bool `json:"allowsNewSite,omitempty"` // fielded address FieldedAddress *FieldedAddress `json:"fieldedAddress,omitempty"` // formatted address FormattedAddress *FormattedAddress `json:"formattedAddress,omitempty"` // geographic location GeographicLocation *GeographicLocation `json:"geographicLocation,omitempty"` // This attribute specifies if that Address contains Service Sites that are public such as Meet-Me-Rooms at an interconnect location or a shared telecom room in the basement of a multi-tenant building. HasPublicSite bool `json:"hasPublicSite,omitempty"` // Unique identifier of the address ID string `json:"id,omitempty"` // referenced address ReferencedAddress *ReferencedAddress `json:"referencedAddress,omitempty"` }
GeographicAddress An address is a structured textual way of describing how to find a Property in an urban area (country properties are often defined differently)
swagger:model GeographicAddress
func (*GeographicAddress) MarshalBinary ¶
func (m *GeographicAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicAddress) UnmarshalBinary ¶
func (m *GeographicAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicAddressRequestBuyerInput ¶
type GeographicAddressRequestBuyerInput struct { // fielded address FieldedAddress *FieldedAddressRequest `json:"fieldedAddress,omitempty"` // formatted address FormattedAddress *FormattedAddressRequest `json:"formattedAddress,omitempty"` }
GeographicAddressRequestBuyerInput Structure used by the buyer to request geographic address validation
swagger:model GeographicAddressRequestBuyerInput
func (*GeographicAddressRequestBuyerInput) MarshalBinary ¶
func (m *GeographicAddressRequestBuyerInput) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicAddressRequestBuyerInput) UnmarshalBinary ¶
func (m *GeographicAddressRequestBuyerInput) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicAddressSellerResponse ¶
type GeographicAddressSellerResponse struct { // Technical attribute to extend this class AtSchemaLocation string `json:"@schemaLocation,omitempty"` // Technical attribute to extend this class AtType string `json:"@type,omitempty"` // This attribute specifies if a Buyer must use one of the known existing Service Sites at this location for any Products delivered to this Address. For example, if a particular building owner mandated that all interconnects be done in a shared Public Meet-Me-Room, this attribute would be set to False for that Address. AllowsNewSite bool `json:"allowsNewSite,omitempty"` // fielded address FieldedAddress *FieldedAddress `json:"fieldedAddress,omitempty"` // formatted address FormattedAddress *FormattedAddress `json:"formattedAddress,omitempty"` // This attribute specifies if that Address contains Service Sites that are public such as Meet-Me-Rooms at an interconnect location or a shared telecom room in the basement of a multi-tenant building HasPublicSite bool `json:"hasPublicSite,omitempty"` // Unique identifier of the address ID string `json:"id,omitempty"` // For each Address returned, this attribute specifies if the Seller believes this is the best match to the Buyer specified Address. Setting this to TRUE also represents that the Seller believes this is likely a direct match to the Buyer Specified Address. // Required: true IsBestMatch *bool `json:"isBestMatch"` }
GeographicAddressSellerResponse An address is a structured textual way of describing how to find a Property in an urban area (country properties are often defined differently)
swagger:model GeographicAddressSellerResponse
func (*GeographicAddressSellerResponse) MarshalBinary ¶
func (m *GeographicAddressSellerResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicAddressSellerResponse) UnmarshalBinary ¶
func (m *GeographicAddressSellerResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicAddressValidation ¶
type GeographicAddressValidation struct { // Unique identifier of the Address Validation (Not an address id !!) ID string `json:"id,omitempty"` // requested address // Required: true RequestedAddress *GeographicAddressRequestBuyerInput `json:"requestedAddress"` // Date when the address validation is performed // Format: date-time ValidationDate strfmt.DateTime `json:"validationDate,omitempty"` // validation result ValidationResult ValidationResult `json:"validationResult,omitempty"` // verified address VerifiedAddress []*GeographicAddressSellerResponse `json:"verifiedAddress"` }
GeographicAddressValidation Resource used to support a request for a validation address : check if a geographic address described by values attributes exists) If exist, id is provided if not, alternate address(es) could be provided
swagger:model GeographicAddressValidation
func (*GeographicAddressValidation) MarshalBinary ¶
func (m *GeographicAddressValidation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicAddressValidation) UnmarshalBinary ¶
func (m *GeographicAddressValidation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicAddressValidationCreate ¶
type GeographicAddressValidationCreate struct { // requested address // Required: true RequestedAddress *GeographicAddressRequestBuyerInput `json:"requestedAddress"` }
GeographicAddressValidationCreate Structure used to describe a geographic address validation request
swagger:model GeographicAddressValidation_Create
func (*GeographicAddressValidationCreate) MarshalBinary ¶
func (m *GeographicAddressValidationCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicAddressValidationCreate) UnmarshalBinary ¶
func (m *GeographicAddressValidationCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicLocation ¶
type GeographicLocation struct { // geographic point // Required: true GeographicPoint []*GeographicPoint `json:"geographicPoint"` // Unique Identifier of a GeographicLocation ID string `json:"id,omitempty"` // The spatial reference system used to determine the coordinates // Required: true SpatialRef *string `json:"spatialRef"` }
GeographicLocation A set of coordinates (typically including latitude and longitude) that describes a particular location on earth.
swagger:model GeographicLocation
func (*GeographicLocation) MarshalBinary ¶
func (m *GeographicLocation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicLocation) UnmarshalBinary ¶
func (m *GeographicLocation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicPoint ¶
type GeographicPoint struct { // The latitude expressed in decimal degrees format // Required: true Latitude *string `json:"latitude"` // The longitude expressed in decimal degrees format // Required: true Longitude *string `json:"longitude"` }
GeographicPoint A geometric point on earth, which can include a latitude, longitude, and elevation in “decimal degrees” format.
swagger:model GeographicPoint
func (*GeographicPoint) MarshalBinary ¶
func (m *GeographicPoint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicPoint) UnmarshalBinary ¶
func (m *GeographicPoint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicSubAddress ¶
type GeographicSubAddress struct { // Technical attribute to extend this class AtSchemaLocation string `json:"@schemaLocation,omitempty"` // Technical attribute to extend this class AtType string `json:"@type,omitempty"` // Allows for buildings that have well-known names BuildingName string `json:"buildingName,omitempty"` // Unique Identifier of the subAddress ID string `json:"id,omitempty"` // Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2 LevelNumber string `json:"levelNumber,omitempty"` // Describes level types within a building LevelType string `json:"levelType,omitempty"` // Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office PrivateStreetName string `json:"privateStreetName,omitempty"` // Private streets numbers internal to a private street PrivateStreetNumber string `json:"privateStreetNumber,omitempty"` // sub unit SubUnit []*SubUnit `json:"subUnit"` }
GeographicSubAddress It is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.
swagger:model GeographicSubAddress
func (*GeographicSubAddress) MarshalBinary ¶
func (m *GeographicSubAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicSubAddress) UnmarshalBinary ¶
func (m *GeographicSubAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicSubAddressRequest ¶
type GeographicSubAddressRequest struct { // Technical attribute to extend this class AtSchemaLocation string `json:"@schemaLocation,omitempty"` // Technical attribute to extend this class AtType string `json:"@type,omitempty"` // Allows for buildings that have well-known names BuildingName string `json:"buildingName,omitempty"` // Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2 LevelNumber string `json:"levelNumber,omitempty"` // Describes level types within a building LevelType string `json:"levelType,omitempty"` // Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office PrivateStreetName string `json:"privateStreetName,omitempty"` // Private streets numbers internal to a private street PrivateStreetNumber string `json:"privateStreetNumber,omitempty"` // sub unit SubUnit []*SubUnit `json:"subUnit"` }
GeographicSubAddressRequest It is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.
swagger:model GeographicSubAddressRequest
func (*GeographicSubAddressRequest) MarshalBinary ¶
func (m *GeographicSubAddressRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicSubAddressRequest) UnmarshalBinary ¶
func (m *GeographicSubAddressRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ReferencedAddress ¶
type ReferencedAddress struct { // Unique identifier of the address ID string `json:"id,omitempty"` // Id of a reference address // Required: true ReferenceID *string `json:"referenceId"` // Type of a reference address // Required: true ReferenceType *string `json:"referenceType"` }
ReferencedAddress A globally unique identifier controlled by a generally accepted independent administrative authority that specifies a fixed geographical location.
swagger:model ReferencedAddress
func (*ReferencedAddress) MarshalBinary ¶
func (m *ReferencedAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ReferencedAddress) UnmarshalBinary ¶
func (m *ReferencedAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SubUnit ¶
type SubUnit struct { // The discriminator used for the subunit, often just a simple number but may also be a range. // Required: true SubUnitIdentifier *string `json:"subUnitIdentifier"` // The type of subunit e.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF. // Required: true SubUnitType *string `json:"subUnitType"` }
SubUnit Sub Unit structure is used to describe several subUnits with a geographical subAddress.
swagger:model SubUnit
func (*SubUnit) MarshalBinary ¶
MarshalBinary interface implementation
func (*SubUnit) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ValidationResult ¶
type ValidationResult string
ValidationResult Validation Result
swagger:model ValidationResult
const ( // ValidationResultSuccess captures enum value "success" ValidationResultSuccess ValidationResult = "success" // ValidationResultFails captures enum value "fails" ValidationResultFails ValidationResult = "fails" // ValidationResultPartial captures enum value "partial" ValidationResultPartial ValidationResult = "partial" )
Source Files ¶
- error_representation.go
- fielded_address.go
- fielded_address_request.go
- formatted_address.go
- formatted_address_request.go
- geographic_address.go
- geographic_address_request_buyer_input.go
- geographic_address_seller_response.go
- geographic_address_validation.go
- geographic_address_validation_create.go
- geographic_location.go
- geographic_point.go
- geographic_sub_address.go
- geographic_sub_address_request.go
- referenced_address.go
- sub_unit.go
- validation_result.go