Skip to content

Zones Objects

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

Short Zone Object

{
  zone_id: Int
  zone_name: String
  adventure_type: AdventureType
  nearest_city: String
  coordinates: CoordinatesObject
}
Key Type Description
zone_id Int
zone_name String
adventure_type AdventureType
nearest_city String Formatted as City, State
coordinates CoordinatesObject

Zone Object

{
  zone_name: String
  id: Int
  adventure_type: AdventureType
  bio: String
  approach: String
  nearest_city: String
  date_created: Int
  creator: ShortUser
  coordinates: CoordinatesObject
  public: Boolean
  adventures: ShortAdventure[]
  zones: ShortZone[]
  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 ShortUser The information about the creator of the zone
coordinates CoordinatesObject
public Boolean A boolean describing if the zone is public or private
adventures ShortAdventure[] Describing each sub adventure
zones ShortZone[] describing each sub zone
breadcrumb BreadcrumbObject[]
images String[] An array of image urls

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