AFCore/com.advantahealth.api.locations.model/LocationMarker

LocationMarker

data class LocationMarker(val id: Long, val globalId: String?, val legacyClubId: Long?, val name: String?, val description: String?, val position: LocationMarkerPosition?, val address: LocationMarkerAddress?, val classification: LocationMarkerClassification?, val amenities: List<String>, val brand: String?, val logoUrl: String?, val coverImageUrl: String?, val imageUrls: List<String>, val pinImageId: Long?, val pinImageUrl: String?, val phone: String?, val website: String?, val email: String?, val social: Map<String, String>, val hours: LocationMarkerHours?, val timezoneId: String?, val status: String?, val isVerified: Boolean, val geofenceRadiusMeters: Double?, val dwellThresholdMinutes: Int?, val supportsGuestPass: Boolean, val isFavorite: Boolean, val isBrandFavorite: Boolean, val isMuted: Boolean, val isReported: Boolean, val member: LocationMarkerMember?, val merchantId: Int?)

An advanced location marker returned by com.advantahealth.api.locations.Locations.getLocationsByViewPort or com.advantahealth.api.locations.Locations.getLocationsByRadius - the full place record behind a map pin.

Constructors

LocationMarker

constructor(id: Long, globalId: String?, legacyClubId: Long?, name: String?, description: String?, position: LocationMarkerPosition?, address: LocationMarkerAddress?, classification: LocationMarkerClassification?, amenities: List<String>, brand: String?, logoUrl: String?, coverImageUrl: String?, imageUrls: List<String>, pinImageId: Long?, pinImageUrl: String?, phone: String?, website: String?, email: String?, social: Map<String, String>, hours: LocationMarkerHours?, timezoneId: String?, status: String?, isVerified: Boolean, geofenceRadiusMeters: Double?, dwellThresholdMinutes: Int?, supportsGuestPass: Boolean, isFavorite: Boolean, isBrandFavorite: Boolean, isMuted: Boolean, isReported: Boolean, member: LocationMarkerMember?, merchantId: Int?)

Properties

address

val address: LocationMarkerAddress?

Address of the location, or null.

amenities

val amenities: List<String>

Amenity codes the location advertises.

brand

val brand: String?

Brand the location belongs to, or null.

classification

val classification: LocationMarkerClassification?

Type/category the location is filed under, or null.

coverImageUrl

val coverImageUrl: String?

Cover image URL, or null.

description

val description: String?

Optional description.

dwellThresholdMinutes

val dwellThresholdMinutes: Int?

Minimum dwell in minutes for a visit to count, or null.

val email: String?

Contact email, or null.

geofenceRadiusMeters

val geofenceRadiusMeters: Double?

Geofence radius in meters, or null.

globalId

val globalId: String?

Global id of the location as a GUID string, or null.

hours

val hours: LocationMarkerHours?

Operating hours, or null.

val id: Long

Canonical location id.

imageUrls

val imageUrls: List<String>

Additional gallery image URLs.

isBrandFavorite

val isBrandFavorite: Boolean

Whether the member has favorited this location's brand rather than the location itself.

isFavorite

val isFavorite: Boolean

Whether the current member has favorited this location. A muted favorite is deliberately NOT advertised as favorite, so a map can offer re-adding it.

isMuted

val isMuted: Boolean

Whether the current member has muted this location. Only meaningful when the request did not excludeMuted.

isReported

val isReported: Boolean

Whether the current member has an open problem report against this location.

isVerified

val isVerified: Boolean

Whether the location is verified.

legacyClubId

val legacyClubId: Long?

Id of the legacy VerifiedClubs record this location maps to, or null when there is none.

logoUrl

val logoUrl: String?

Brand logo URL, or null.

member

val member: LocationMarkerMember?

The member's relationship details when isFavorite is true (favorited or excluded); null for a muted-only or unrelated marker.

merchantId

val merchantId: Int?

Merchant id resolved server-side for retail markers, or null - decoded tolerantly, as the server has sent it both as a JSON number and as a numeric string.

name

val name: String?

Display name, or null.

phone

val phone: String?

Location phone number, or null.

pinImageId

val pinImageId: Long?

Raw id of the map pin image, or null.

pinImageUrl

val pinImageUrl: String?

Resolved URL of the map pin image, or null.