Skip to content

list

POST file

POST /list/{id}/file

Body Parameters

avatar: string

Params

NameLocationTypeRequiredDescription
idpathstringyesnone
Content-Typeheaderstringyesnone
bodybodyobjectnonone
» avatarbodystring(binary)nonone

Response Examples

200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET show

GET /list/{id}

Params

NameLocationTypeRequiredDescription
idpathstringyesnone

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 CodeMeaningDescriptionData schema
200OKOKInline
404Not FoundRecord Not FoundInline

Responses Data Schema

HTTP Status Code 200

NameTypeRequiredRestrictionsTitledescription
» authorstringtruenonenone
» avatarstringtruenonenone
» collectionIdstringtruenonenone
» collectionNamestringtruenonenone
» createdstring(date-time)truenonenone
» descriptionstringtruenonenone
» expandobjecttruenonenone
»» trails[object]truenonenone
»»» authorstringtruenonenone
»»» categorystringtruenonenone
»»» collectionIdstringtruenonenone
»»» collectionNamestringtruenonenone
»»» createdstringtruenonenone
»»» datestringtruenonenone
»»» descriptionstringtruenonenone
»»» difficultystringtruenonenone
»»» distancenumbertruenonenone
»»» durationintegertruenonenone
»»» elevation_gainnumbertruenonenone
»»» expandobjecttruenonenone
»»»» categoryobjecttruenonenone
»»»»» collectionIdstringtruenonenone
»»»»» collectionNamestringtruenonenone
»»»»» createdstringtruenonenone
»»»»» idstringtruenonenone
»»»»» imgstringtruenonenone
»»»»» namestringtruenonenone
»»»»» updatedstringtruenonenone
»»»» waypoints[object]truenonenone
»»»»» authorstringtruenonenone
»»»»» collectionIdstringtruenonenone
»»»»» collectionNamestringtruenonenone
»»»»» createdstringtruenonenone
»»»»» descriptionstringtruenonenone
»»»»» iconstringtruenonenone
»»»»» idstringtruenonenone
»»»»» latnumbertruenonenone
»»»»» lonnumbertruenonenone
»»»»» namestringtruenonenone
»»»»» photos[string]truenonenone
»»»»» updatedstringtruenonenone
»»» gpxstringtruenonenone
»»» idstringtruenonenone
»»» latnumbertruenonenone
»»» locationstringtruenonenone
»»» lonnumbertruenonenone
»»» namestringtruenonenone
»»» photos[string]truenonenone
»»» publicbooleantruenonenone
»»» summit_logs[string]truenonenone
»»» thumbnailintegertruenonenone
»»» updatedstringtruenonenone
»»» waypoints[string]truenonenone
» idstringtruenonenone
» namestringtruenonenone
» trails[string]truenonenone
» updatedstring(date-time)truenonenone

HTTP Status Code 404

NameTypeRequiredRestrictionsTitledescription
» urlstringtruenonenone
» statusintegertruenonenone
» responseobjecttruenonenone
»» codeintegertruenonenone
»» messagestringtruenonenone
»» dataobjecttruenonenone
» isAbortbooleantruenonenone
» originalErrorobjecttruenonenone
»» urlstringtruenonenone
»» statusintegertruenonenone
»» dataobjecttruenonenone
»»» codeintegertruenonenone
»»» messagestringtruenonenone
»»» dataobjecttruenonenone
» namestringtruenonenone

POST update

POST /list/{id}

Body Parameters

{
"name": "string",
"description": "string"
}

Params

NameLocationTypeRequiredDescription
idpathstringyesnone
Content-Typeheaderstringyesnone
bodybodyobjectnonone
» namebodystringyesnone
» descriptionbodystringnonone

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 CodeMeaningDescriptionData schema
200OKOKInline
404Not FoundRecord Not FoundInline

Responses Data Schema

HTTP Status Code 200

NameTypeRequiredRestrictionsTitledescription
» authorstringtruenonenone
» avatarstringtruenonenone
» collectionIdstringtruenonenone
» collectionNamestringtruenonenone
» createdstring(date-time)truenonenone
» descriptionstringtruenonenone
» idstringtruenonenone
» namestringtruenonenone
» trails[string]truenonenone
» updatedstring(date-time)truenonenone

HTTP Status Code 404

NameTypeRequiredRestrictionsTitledescription
» urlstringtruenonenone
» statusintegertruenonenone
» responseobjecttruenonenone
»» codeintegertruenonenone
»» messagestringtruenonenone
»» dataobjecttruenonenone
» isAbortbooleantruenonenone
» originalErrorobjecttruenonenone
»» urlstringtruenonenone
»» statusintegertruenonenone
»» dataobjecttruenonenone
»»» codeintegertruenonenone
»»» messagestringtruenonenone
»»» dataobjecttruenonenone
» namestringtruenonenone

DELETE delete

DELETE /list/{id}

Params

NameLocationTypeRequiredDescription
idpathstringyesnone

Response Examples

200 Response

{
"acknowledged": true
}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKOKInline
404Not FoundRecord Not FoundInline

Responses Data Schema

HTTP Status Code 200

NameTypeRequiredRestrictionsTitledescription
» acknowledgedbooleantruenonenone

HTTP Status Code 404

NameTypeRequiredRestrictionsTitledescription
» urlstringtruenonenone
» statusintegertruenonenone
» responseobjecttruenonenone
»» codeintegertruenonenone
»» messagestringtruenonenone
»» dataobjecttruenonenone
» isAbortbooleantruenonenone
» originalErrorobjecttruenonenone
»» urlstringtruenonenone
»» statusintegertruenonenone
»» dataobjecttruenonenone
»»» codeintegertruenonenone
»»» messagestringtruenonenone
»»» dataobjecttruenonenone
» namestringtruenonenone

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 CodeMeaningDescriptionData schema
200OKOKInline

Responses Data Schema

HTTP Status Code 200

NameTypeRequiredRestrictionsTitledescription
» authorstringtruenonenone
» avatarstringtruenonenone
» collectionIdstringtruenonenone
» collectionNamestringtruenonenone
» createdstringtruenonenone
» descriptionstringtruenonenone
» idstringtruenonenone
» namestringtruenonenone
» trails[string]truenonenone
» updatedstringtruenonenone
» expandobjectfalsenonenone
»» trails[object]truenonenone
»»» authorstringtruenonenone
»»» categorystringtruenonenone
»»» collectionIdstringtruenonenone
»»» collectionNamestringtruenonenone
»»» createdstringtruenonenone
»»» descriptionstringtruenonenone
»»» difficultystringtruenonenone
»»» distanceintegertruenonenone
»»» durationintegertruenonenone
»»» elevation_gainintegertruenonenone
»»» expandobjecttruenonenone
»»»» categoryobjecttruenonenone
»»»»» collectionIdstringtruenonenone
»»»»» collectionNamestringtruenonenone
»»»»» createdstringtruenonenone
»»»»» idstringtruenonenone
»»»»» imgstringtruenonenone
»»»»» namestringtruenonenone
»»»»» updatedstringtruenonenone
»»»» waypoints[object]falsenonenone
»»»»» authorstringtruenonenone
»»»»» collectionIdstringtruenonenone
»»»»» collectionNamestringtruenonenone
»»»»» createdstringtruenonenone
»»»»» descriptionstringtruenonenone
»»»»» iconstringtruenonenone
»»»»» idstringtruenonenone
»»»»» latnumbertruenonenone
»»»»» lonnumbertruenonenone
»»»»» namestringtruenonenone
»»»»» photos[string]truenonenone
»»»»» updatedstringtruenonenone
»»» gpxstringtruenonenone
»»» idstringtruenonenone
»»» latnumbertruenonenone
»»» locationstringtruenonenone
»»» lonnumbertruenonenone
»»» namestringtruenonenone
»»» photos[string]truenonenone
»»» publicbooleantruenonenone
»»» summit_logs[string]truenonenone
»»» thumbnailintegertruenonenone
»»» updatedstringtruenonenone
»»» waypoints[string]truenonenone

PUT create

PUT /list

Body Parameters

{
"name": "string",
"description": "string",
"author": "string"
}

Params

NameLocationTypeRequiredDescription
bodybodyobjectnonone
» namebodystringyesnone
» descriptionbodystringnonone
» authorbodystringyesnone

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 CodeMeaningDescriptionData schema
200OKOKInline
400Bad RequestBad RequestInline

Responses Data Schema

HTTP Status Code 200

NameTypeRequiredRestrictionsTitledescription
» authorstringtruenonenone
» avatarstringtruenonenone
» collectionIdstringtruenonenone
» collectionNamestringtruenonenone
» createdstring(date-time)truenonenone
» descriptionstringtruenonenone
» idstringtruenonenone
» namestringtruenonenone
» trails[string]truenonenone
» updatedstring(date-time)truenonenone

HTTP Status Code 400

NameTypeRequiredRestrictionsTitledescription
» urlstringtruenonenone
» statusintegertruenonenone
» responseobjecttruenonenone
»» codeintegertruenonenone
»» messagestringtruenonenone
»» dataobjecttruenonenone
» isAbortbooleantruenonenone
» originalErrorobjecttruenonenone
»» urlstringtruenonenone
»» statusintegertruenonenone
»» dataobjecttruenonenone
»»» codeintegertruenonenone
»»» messagestringtruenonenone
»»» dataobjecttruenonenone
» namestringtruenonenone