trail

POST file

POST /trail/{id}/file

Body Parameters

photos: string
gpx: string

Params

Name	Location	Type	Required	Description
id	path	string	yes	none
Content-Type	header	string	yes	none
body	body	object	no	none
» photos	body	string(binary)	no	none
» gpx	body	string(binary)	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

GET show

GET /trail/{id}

Params

Name	Location	Type	Required	Description
id	path	string	yes	none

Response Examples

200 Response

{
  "author": "string",
  "category": "string",
  "collectionId": "string",
  "collectionName": "string",
  "created": "2019-08-24T14:15:22Z",
  "date": "2019-08-24",
  "description": "string",
  "difficulty": "easy",
  "distance": 0,
  "duration": 0,
  "elevation_gain": 0,
  "gpx": "string",
  "id": "string",
  "lat": 0,
  "location": "string",
  "lon": 0,
  "name": "string",
  "photos": [
    "string"
  ],
  "public": true,
  "summit_logs": [
    "string"
  ],
  "thumbnail": 0,
  "updated": "2019-08-24T14:15:22Z",
  "waypoints": [
    "string"
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	OK	Inline
404	Not Found	Record Not Found	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	description
» author	string	true	none	none
» category	string	true	none	none
» collectionId	string	true	none	none
» collectionName	string	true	none	none
» created	string(date-time)	true	none	none
» date	string(date)	true	none	none
» description	string	true	none	none
» difficulty	string	true	none	none
» distance	number	true	none	none
» duration	number	true	none	none
» elevation_gain	number	true	none	none
» gpx	string	true	none	none
» id	string	true	none	none
» lat	number	true	none	none
» location	string	true	none	none
» lon	number	true	none	none
» name	string	true	none	none
» photos	[string]	true	none	none
» public	boolean	true	none	none
» summit_logs	[string]	true	none	none
» thumbnail	integer	true	none	none
» updated	string(date-time)	true	none	none
» waypoints	[string]	true	none	none

Enum

Name	Value
difficulty	easy
difficulty	moderate
difficulty	hard

HTTP Status Code 404

Name	Type	Required	Restrictions	description
» url	string	true	none	none
» status	integer	true	none	none
» response	object	true	none	none
»» code	integer	true	none	none
»» message	string	true	none	none
»» data	object	true	none	none
» isAbort	boolean	true	none	none
» originalError	object	true	none	none
»» url	string	true	none	none
»» status	integer	true	none	none
»» data	object	true	none	none
»»» code	integer	true	none	none
»»» message	string	true	none	none
»»» data	object	true	none	none
» name	string	true	none	none

POST update

POST /trail/{id}

Body Parameters

{
  "name": "string",
  "category": "string",
  "description": "string",
  "difficulty": "easy",
  "distance": 0,
  "duration": 0,
  "elevation_gain": 0,
  "lat": 0,
  "location": "string",
  "lon": 0,
  "public": true,
  "thumbnail": 0
}

Params

Name	Location	Type	Required	Description
id	path	string	yes	none
Content-Type	header	string	yes	none
body	body	object	no	none
» name	body	string	yes	none
» category	body	string	no	none
» description	body	string	no	none
» difficulty	body	string	no	none
» distance	body	number	no	none
» duration	body	number	no	none
» elevation_gain	body	number	no	none
» lat	body	number	no	none
» location	body	string	no	none
» lon	body	number	no	none
» public	body	boolean	no	none
» thumbnail	body	integer	no	none

Enum

Name	Value
» difficulty	easy
» difficulty	moderate
» difficulty	hard

Response Examples

200 Response

{
  "author": "string",
  "category": "string",
  "collectionId": "string",
  "collectionName": "string",
  "created": "2019-08-24T14:15:22Z",
  "date": "2019-08-24",
  "description": "string",
  "difficulty": "easy",
  "distance": 0,
  "duration": 0,
  "elevation_gain": 0,
  "expand": {
    "category": {
      "collectionId": "string",
      "collectionName": "string",
      "created": "string",
      "id": "string",
      "img": "string",
      "name": "string",
      "updated": "string"
    },
    "waypoints": [
      {
        "author": "string",
        "collectionId": "string",
        "collectionName": "string",
        "created": "string",
        "description": "string",
        "icon": "string",
        "id": "string",
        "lat": 0,
        "lon": 0,
        "name": "string",
        "photos": [
          "string"
        ],
        "updated": "string"
      }
    ]
  },
  "gpx": "string",
  "id": "string",
  "lat": 0,
  "location": "string",
  "lon": 0,
  "name": "string",
  "photos": [
    "string"
  ],
  "public": true,
  "summit_logs": [
    "string"
  ],
  "thumbnail": 0,
  "updated": "2019-08-24T14:15:22Z",
  "waypoints": [
    "string"
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	OK	Inline
404	Not Found	Record Not Found	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	description
» author	string	true	none	none
» category	string	true	none	none
» collectionId	string	true	none	none
» collectionName	string	true	none	none
» created	string(date-time)	true	none	none
» date	string(date)	true	none	none
» description	string	true	none	none
» difficulty	string	true	none	none
» distance	number	true	none	none
» duration	number	true	none	none
» elevation_gain	number	true	none	none
» expand	object	true	none	none
»» category	object	true	none	none
»»» collectionId	string	true	none	none
»»» collectionName	string	true	none	none
»»» created	string	true	none	none
»»» id	string	true	none	none
»»» img	string	true	none	none
»»» name	string	true	none	none
»»» updated	string	true	none	none
»» waypoints	[object]	true	none	none
»»» author	string	true	none	none
»»» collectionId	string	true	none	none
»»» collectionName	string	true	none	none
»»» created	string	true	none	none
»»» description	string	true	none	none
»»» icon	string	true	none	none
»»» id	string	true	none	none
»»» lat	number	true	none	none
»»» lon	number	true	none	none
»»» name	string	true	none	none
»»» photos	[string]	true	none	none
»»» updated	string	true	none	none
» gpx	string	true	none	none
» id	string	true	none	none
» lat	number	true	none	none
» location	string	true	none	none
» lon	number	true	none	none
» name	string	true	none	none
» photos	[string]	true	none	none
» public	boolean	true	none	none
» summit_logs	[string]	true	none	none
» thumbnail	integer	true	none	none
» updated	string(date-time)	true	none	none
» waypoints	[string]	true	none	none

Enum

Name	Value
difficulty	easy
difficulty	moderate
difficulty	hard

HTTP Status Code 404

Name	Type	Required	Restrictions	description
» url	string	true	none	none
» status	integer	true	none	none
» response	object	true	none	none
»» code	integer	true	none	none
»» message	string	true	none	none
»» data	object	true	none	none
» isAbort	boolean	true	none	none
» originalError	object	true	none	none
»» url	string	true	none	none
»» status	integer	true	none	none
»» data	object	true	none	none
»»» code	integer	true	none	none
»»» message	string	true	none	none
»»» data	object	true	none	none
» name	string	true	none	none

DELETE delete

DELETE /trail/{id}

Params

Name	Location	Type	Required	Description
id	path	string	yes	none

Response Examples

200 Response

{
  "acknowledged": true
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	OK	Inline
404	Not Found	Record Not Found	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	Title	description
» acknowledged	boolean	true	none		none

HTTP Status Code 404

Name	Type	Required	Restrictions	description
» url	string	true	none	none
» status	integer	true	none	none
» response	object	true	none	none
»» code	integer	true	none	none
»» message	string	true	none	none
»» data	object	true	none	none
» isAbort	boolean	true	none	none
» originalError	object	true	none	none
»» url	string	true	none	none
»» status	integer	true	none	none
»» data	object	true	none	none
»»» code	integer	true	none	none
»»» message	string	true	none	none
»»» data	object	true	none	none
» name	string	true	none	none

GET list

GET /trail

Response Examples

200 Response

{
  "page": 0,
  "perPage": 0,
  "totalItems": 0,
  "totalPages": 0,
  "items": [
    {
      "author": "string",
      "category": "string",
      "collectionId": "string",
      "collectionName": "string",
      "created": "string",
      "description": "string",
      "difficulty": "string",
      "distance": 0,
      "duration": 0,
      "elevation_gain": 0,
      "gpx": "string",
      "id": "string",
      "lat": 0,
      "location": "string",
      "lon": 0,
      "name": "string",
      "photos": [
        "string"
      ],
      "public": true,
      "summit_logs": [
        "string"
      ],
      "thumbnail": 0,
      "updated": "string",
      "waypoints": [
        "string"
      ]
    }
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	OK	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	description
» page	integer	true	none	none
» perPage	integer	true	none	none
» totalItems	integer	true	none	none
» totalPages	integer	true	none	none
» items	[object]	true	none	none
»» author	string	true	none	none
»» category	string	true	none	none
»» collectionId	string	true	none	none
»» collectionName	string	true	none	none
»» created	string	true	none	none
»» description	string	true	none	none
»» difficulty	string	true	none	none
»» distance	integer	true	none	none
»» duration	integer	true	none	none
»» elevation_gain	integer	true	none	none
»» gpx	string	true	none	none
»» id	string	true	none	none
»» lat	number	true	none	none
»» location	string	true	none	none
»» lon	number	true	none	none
»» name	string	true	none	none
»» photos	[string]	true	none	none
»» public	boolean	true	none	none
»» summit_logs	[string]	true	none	none
»» thumbnail	integer	true	none	none
»» updated	string	true	none	none
»» waypoints	[string]	true	none	none

PUT upload

PUT /trail/upload

Body Parameters

string

Params

Name	Location	Type	Required	Description
Content-Type	header	string	yes	none
body	body	string(binary)	no	none

Response Examples

200 Response

{
  "author": "string",
  "category": "string",
  "collectionId": "string",
  "collectionName": "string",
  "created": "2019-08-24T14:15:22Z",
  "date": "2019-08-24",
  "description": "string",
  "difficulty": "easy",
  "distance": 0,
  "duration": 0,
  "elevation_gain": 0,
  "gpx": "string",
  "id": "string",
  "lat": 0,
  "location": "string",
  "lon": 0,
  "name": "string",
  "photos": [
    "string"
  ],
  "public": true,
  "summit_logs": [
    "string"
  ],
  "thumbnail": 0,
  "updated": "2019-08-24T14:15:22Z",
  "waypoints": [
    "string"
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	OK	Inline
400	Bad Request	Bad Request	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	description
» author	string	true	none	none
» category	string	true	none	none
» collectionId	string	true	none	none
» collectionName	string	true	none	none
» created	string(date-time)	true	none	none
» date	string(date)	true	none	none
» description	string	true	none	none
» difficulty	string	true	none	none
» distance	number	true	none	none
» duration	number	true	none	none
» elevation_gain	number	true	none	none
» gpx	string	true	none	none
» id	string	true	none	none
» lat	number	true	none	none
» location	string	true	none	none
» lon	number	true	none	none
» name	string	true	none	none
» photos	[string]	true	none	none
» public	boolean	true	none	none
» summit_logs	[string]	true	none	none
» thumbnail	integer	true	none	none
» updated	string(date-time)	true	none	none
» waypoints	[string]	true	none	none

Enum

Name	Value
difficulty	easy
difficulty	moderate
difficulty	hard

HTTP Status Code 400

Name	Type	Required	Restrictions	description
» url	string	true	none	none
» status	integer	true	none	none
» response	object	true	none	none
»» message	string	true	none	none
» isAbort	boolean	true	none	none
» originalError	object	true	none	none
»» status	integer	true	none	none
»» response	object	true	none	none
»»» message	string	true	none	none
» name	string	true	none	none