| Method and Path | Description | ||
|---|---|---|---|
| GET | /segments | Search all segments |
|
| GET | /segments/boundingbox | Search all segments within a bounding box |
|
| POST | /segments | ||
| PUT | /segments | ||
| Method and Path | Description | ||
|---|---|---|---|
| GET | /segmentRatings | ||
| POST | /segmentRatings | ||
| DELETE | /segmentRatings | ||
The level of dedication of the segment to cycling
| Name | Value | Description |
|---|---|---|
| shared | shared | A shared road for cars and bikes (road shoulder)
|
| dedicatedLane | dedicatedLane | A dedicated bike lane on the road
|
| bikePath | bikePath | A completely isolated bike lane (a natural barrier from road traffic)
|
The surface type of a segment (road type)
| Name | Value | Description |
|---|---|---|
| gravel | gravel | Road consisting of small rocks
|
| asphalt | asphalt | Road consisting of paved asphalt
|
| dirt | dirt | Road consisting of cleared dirt
|
The type of user (user or admin)
| Name | Value | Description |
|---|---|---|
| user | user | A standard consumer of the service
|
| admin | admin | An administrator of the application
|
Interfaces: None
A routable path on a map - not necessarily a segment
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| polyline | string | Yes | - |
|
| distance | double | Yes | - |
|
Interfaces: None
A longitudinal or latitudinal coordatine
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| lat | double | Yes | - |
|
| lng | double | Yes | - |
|
Interfaces: None
A segment of road which will be rated and tagged
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| id | uuid | Yes | - |
|
| name | string | No | - |
|
| description | string | No | - |
|
| polyline | string | Yes | - |
|
| created_by | uuid | Yes | - | The user who created the segment
|
| hidden | boolean | Yes | - | Whether a segment is user visible or not
|
Interfaces: None
Form the client uses to create a segment
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| name | string | No | - |
|
| description | string | No | - |
|
| polylines | [string] | Yes | - |
|
| surfaceRating | integer | Yes | - |
|
| trafficRating | integer | Yes | - |
|
| surfaceType | surfaceType | Yes | - |
|
| pathType | pathType | Yes | - |
|
Interfaces: None
A rating that is supplied with the segment
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| id | uuid | Yes | - |
|
| segmentId | uuid | Yes | - |
|
| userId | uuid | Yes | - |
|
| trafficRating | integer | Yes | - |
|
| surfaceRating | integer | Yes | - |
|
| surfaceType | surfaceType | Yes | - |
|
| pathType | pathType | Yes | - |
|
| createdAt | date-time-iso8601 | Yes | - |
|
| updatedAt | date-time-iso8601 | Yes | - |
|
| deletedAt | date-time-iso8601 | No | - |
|
Interfaces: None
Form to modify an existing segment
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| name | string | No | - |
|
| description | string | No | - |
|
| surfaceRating | integer | No | - |
|
| trafficRating | integer | No | - |
|
| surfaceType | surfaceType | No | - |
|
| pathType | pathType | No | - |
|
Interfaces: None
A user of the service
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| id | uuid | Yes | - |
|
| firstName | string | Yes | - |
|
| lastName | string | Yes | - |
|
| string | Yes | - |
|
|
| city | string | No | - |
|
| province | string | No | - |
|
| country | string | No | - |
|
| birthdate | date-time-iso8601 | No | - |
|
| sex | string | No | - |
|
| role | userRole | Yes | - |
|
| stravaToken | string | Yes | - | Strava API token
|
| createdAt | date-time-iso8601 | Yes | - |
|
| updatedAt | date-time-iso8601 | Yes | - |
|
| deletedAt | date-time-iso8601 | No | - |
|
Interfaces: None
A form to update attributes about a user
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| birthdate | date-time-iso8601 | No | - |
|
| sex | string | No | - |
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| name | string | Yes | - | Name of this service
|
| version | string | Yes | - | Version of this service
|
| scalaVersion | string | Yes | - | Version of Scala used to build this service
|
| sbtVersion | string | Yes | - | Version of SBT used to build this service
|
