list
POST file
POST /list/{id}/file
Body Parameters
avatar: string
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
id | path | string | yes | none |
Content-Type | header | string | yes | none |
body | body | object | no | none |
» avatar | 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 /list/{id}
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
id | path | string | yes | none |
Response Examples
200 Response
{ "author": "string", "avatar": "string", "collectionId": "string", "collectionName": "string", "created": "2019-08-24T14:15:22Z", "description": "string", "expand": { "trails": [ { "author": "string", "category": "string", "collectionId": "string", "collectionName": "string", "created": "string", "date": "string", "description": "string", "difficulty": "string", "distance": 0, "duration": 0, "elevation_gain": 0, "expand": { "category": {}, "waypoints": [ null ] }, "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" ] } ] }, "id": "string", "name": "string", "trails": [ "string" ], "updated": "2019-08-24T14:15:22Z"}
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 |
---|---|---|---|---|---|
» author | string | true | none | none | |
» avatar | string | true | none | none | |
» collectionId | string | true | none | none | |
» collectionName | string | true | none | none | |
» created | string(date-time) | true | none | none | |
» description | string | true | none | none | |
» expand | object | true | none | none | |
»» trails | [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 | |
»»» date | string | true | none | none | |
»»» description | string | true | none | none | |
»»» difficulty | string | true | none | none | |
»»» distance | number | true | none | none | |
»»» duration | integer | 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 | true | none | none | |
»»» waypoints | [string] | true | none | none | |
» id | string | true | none | none | |
» name | string | true | none | none | |
» trails | [string] | true | none | none | |
» updated | string(date-time) | true | none | none |
HTTP Status Code 404
Name | Type | Required | Restrictions | Title | 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 /list/{id}
Body Parameters
{ "name": "string", "description": "string"}
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 |
» description | body | string | no | none |
Response Examples
200 Response
{ "author": "string", "avatar": "string", "collectionId": "string", "collectionName": "string", "created": "2019-08-24T14:15:22Z", "description": "string", "id": "string", "name": "string", "trails": [ "string" ], "updated": "2019-08-24T14:15:22Z"}
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 |
---|---|---|---|---|---|
» author | string | true | none | none | |
» avatar | string | true | none | none | |
» collectionId | string | true | none | none | |
» collectionName | string | true | none | none | |
» created | string(date-time) | true | none | none | |
» description | string | true | none | none | |
» id | string | true | none | none | |
» name | string | true | none | none | |
» trails | [string] | true | none | none | |
» updated | string(date-time) | true | none | none |
HTTP Status Code 404
Name | Type | Required | Restrictions | Title | 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 /list/{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 | Title | 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 /list
Response Examples
200 Response
[ { "author": "string", "avatar": "string", "collectionId": "string", "collectionName": "string", "created": "string", "description": "string", "id": "string", "name": "string", "trails": [ "string" ], "updated": "string", "expand": { "trails": [ { "author": "string", "category": "string", "collectionId": "string", "collectionName": "string", "created": "string", "description": "string", "difficulty": "string", "distance": 0, "duration": 0, "elevation_gain": 0, "expand": { "category": null, "waypoints": null }, "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 | Title | description |
---|---|---|---|---|---|
» author | string | true | none | none | |
» avatar | string | true | none | none | |
» collectionId | string | true | none | none | |
» collectionName | string | true | none | none | |
» created | string | true | none | none | |
» description | string | true | none | none | |
» id | string | true | none | none | |
» name | string | true | none | none | |
» trails | [string] | true | none | none | |
» updated | string | true | none | none | |
» expand | object | false | none | none | |
»» trails | [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 | |
»»» 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] | false | 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 | true | none | none | |
»»» waypoints | [string] | true | none | none |
PUT create
PUT /list
Body Parameters
{ "name": "string", "description": "string", "author": "string"}
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
body | body | object | no | none |
» name | body | string | yes | none |
» description | body | string | no | none |
» author | body | string | yes | none |
Response Examples
200 Response
{ "author": "string", "avatar": "string", "collectionId": "string", "collectionName": "string", "created": "2019-08-24T14:15:22Z", "description": "string", "id": "string", "name": "string", "trails": [ "string" ], "updated": "2019-08-24T14:15:22Z"}
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 | Title | description |
---|---|---|---|---|---|
» author | string | true | none | none | |
» avatar | string | true | none | none | |
» collectionId | string | true | none | none | |
» collectionName | string | true | none | none | |
» created | string(date-time) | true | none | none | |
» description | string | true | none | none | |
» id | string | true | none | none | |
» name | string | true | none | none | |
» trails | [string] | true | none | none | |
» updated | string(date-time) | true | none | none |
HTTP Status Code 400
Name | Type | Required | Restrictions | Title | 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 |