Skip to content

Zones Objects

Andrew Maclean edited this page Jun 24, 2024 · 11 revisions

Zone Object

{
  zone_name: String,
  id: Int,
  adventure_type: AdventureType,
  bio: String,
  approach: String,
  nearest_city: String,
  date_created: Int,
  creator_id: Int,
  creator_name: String,
  creator_email: String,
  creator_picture_url: String,
  coordinates: CoordinatesObject,
  public: Boolean,
  adventures: SubAdventure[],
  zones: SubZone[],
  breadcrumb: BreadcrumbObject[],
  images: String[]
}
Key Type Description
zone_name String
id Int
adventure_type AdventureType Zone adventure type
bio String
approach String A description of the approach path to the given zone
nearest_city String
date_created Int A js timestamp denoting when the zone was created
creator_id Int Maps to a user id that created the adventure
creator_name String Formatted as first_name last_name of the user that created this adventure
creator_email String The email from the user account that created the adventure
creator_picture_url String A url string of the user that created this adventure
coordinates CoordinatesObject
public Boolean A boolean describing if the zone is public or private
adventures AdventureObject[] Describing each sub adventure
zones ZoneObject[] describing each sub zone
breadcrumb BreadcrumbObject[]
images String[] An array of image urls

Short Zone Object

{
  zone_name: String,
  zone_id: Int,
  adventure_type: AdventureType,
  bio: String,
  nearest_city: String,
  coordinates: CoordinatesObject
}
Key Type Description
zone_name String
zone_id Int
adventure_type AdventureType
coordinates CoordinatesObject

Sub-adventure Object

{
  adventure_type: AdventureType,
  adventure_name: String,
  adventure_id: Int,
  public: Boolean,
  path: GeoJSONCoordinateObject[],
  coordinates: CoordinatesObject
}
Key Type Description
adventure_type AdventureType Zone adventure type
adventure_id Int Correlates to the id of the adventure
public Boolean A boolean describing if the adventure is public or private
path GeoJSONCoordinate[]
coordinates Coordinates

Sub-zone Object

{
  adventure_type: AdventureType,
  zone_name: String,
  zone_id: Int,
  public: Boolean,
  coordinates: CoordinatesObject
}
Key Type Description
adventure_type AdventureType Zone adventure type
zone_id Int Correlates to the id of the zone
public Boolean A boolean describing if the zone is public or private
coordinates Coordinates

Breadcrumb Object

{
  adventure_type: AdventureType,
  name: String,
  id: Int,
  category_type: CategoryType
}
Key Type Description
adventure_type AdventureType Zone adventure type
id Int Correlates to the id of the zone or adventure
name Boolean The name of the zone or adventure
category_type CategoryType Describes an adventure or zone

Category Type

enum('adventure' | 'zone')

Description:
Differentiating between an adventure and a zone

Clone this wiki locally