Course

Parameter Type Description
id string (read only) The course's ID. This is a read only property. It is ignored during the save operation. The course's ID is determined by the REST endpoint.
name string (required) The course's display name.
distance Distance The course's distance.
surfaces string[]

A list of course's surface types. One or more of the following:

  • asphalt
  • concrete
  • grass
  • trail
  • track
  • treadmill
notes string The course's notes.
route Route The course's map data.
url string (readonly) This course's url on RunningAHEAD.com.

Route

The Route object defines the course's map.

Parameter Type Description
attributes RouteAttributes The route's attributes.
data string

The contents of a data file that defines the course's map. See the type property for data's format.

type string

The type property defines the contents of the data property. It can be one of the following:

  • gpx
  • tcx

The latitude and longitude data will be extracted from the data to create the route.

When you append the data, be sure to properly escape its contents. Characters such as ' (single quote), " double quote, \n (new line), and \t (tab) must be escaped.

RouteAttributes

Defines the attributes associated with the route.

Parameter Type Description
accessMode string

Defines the route's access mode. One of the following:

  • private: Only the user can see the route.
  • group: Users in the same group(s) as the user can see the user's maps.
  • public: Everyone can see the user's maps.
race Boolean true if the route is a race route.