LocationNomination

data class LocationNomination(val locationTypeId: Int, val name: String, val addressLine1: String, val city: String, val stateProvince: String, val postalCode: String, val clientId: Int? = null, val locationCategoryId: Int? = null, val managerName: String? = null, val description: String? = null, val addressLine2: String? = null, val countryCode: String? = null, val latitude: Double? = null, val longitude: Double? = null, val googlePlaceId: String? = null, val phone: String? = null, val phoneExtension: String? = null, val fax: String? = null, val email: String? = null, val websiteUrl: String? = null, val contactName: String? = null, val currentlyAMember: Boolean = false)

A new place nomination, sent with Locations.nominateLocation. Field requirements mirror the server contract: name, addressLine1, city, stateProvince, postalCode must be non-empty and locationTypeId must be a real type id (see getLocationTypes).

When the member picked a place from searchPlaces, copy the PlaceSuggestion: its placeId into googlePlaceId, its coordinates into latitude / longitude and its address into the address fields. In Swift, pass every argument (nil for the optional ones).

There is deliberately no brand id (the server resolves the brand from the nominated place) and no submitter id (the server takes it from the session).

Constructors

Link copied to clipboard
constructor(locationTypeId: Int, name: String, addressLine1: String, city: String, stateProvince: String, postalCode: String, clientId: Int? = null, locationCategoryId: Int? = null, managerName: String? = null, description: String? = null, addressLine2: String? = null, countryCode: String? = null, latitude: Double? = null, longitude: Double? = null, googlePlaceId: String? = null, phone: String? = null, phoneExtension: String? = null, fax: String? = null, email: String? = null, websiteUrl: String? = null, contactName: String? = null, currentlyAMember: Boolean = false)

Properties

Link copied to clipboard

Address line 1, max 200 chars.

Link copied to clipboard

Optional address line 2.

Link copied to clipboard

City, max 100 chars.

Link copied to clipboard

Optional client id override.

Link copied to clipboard

Optional contact name.

Link copied to clipboard

Optional ISO country code.

Link copied to clipboard

Whether the member already attends this place.

Link copied to clipboard

Optional description.

Link copied to clipboard

Optional contact email (validated server-side).

Link copied to clipboard
val fax: String?

Optional fax number.

Link copied to clipboard

Optional canonical place id from searchPlaces, so the nomination is stored against the real place instead of a typed name.

Link copied to clipboard

Optional latitude (-90..90); pair with longitude.

Link copied to clipboard

Optional category id, from getLocationCategories.

Link copied to clipboard

Id of the place type, from getLocationTypes.

Link copied to clipboard

Optional longitude (-180..180).

Link copied to clipboard

Optional manager name.

Link copied to clipboard

Display name of the place, max 200 chars.

Link copied to clipboard

Optional phone number.

Link copied to clipboard

Optional phone extension.

Link copied to clipboard

Postal code, max 20 chars.

Link copied to clipboard

State or province, max 50 chars.

Link copied to clipboard

Optional website URL.