Skip to content

API Docs

Jump to bottom
Flomp edited this page Mar 22, 2024 · 1 revision

title: wanderer language_tabs:

  • shell: Shell
  • http: HTTP
  • javascript: JavaScript
  • ruby: Ruby
  • python: Python
  • php: PHP
  • java: Java
  • go: Go toc_footers: [] includes: [] search: true code_clipboard: true highlight_theme: darkula headingLevel: 2 generator: "@tarslib/widdershins v4.0.22"

wanderer

Base URLs:

Authentication

category

GET list

GET /category

Response Examples

200 Response

[
  {
    "collectionId": "string",
    "collectionName": "string",
    "created": "string",
    "id": "string",
    "img": "string",
    "name": "string",
    "updated": "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
» 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

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": "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
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
» 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

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 /trail/{id}

Body Parameters

{
  "name": "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

Response Examples

200 Response

{
  "author": "string",
  "category": "string",
  "collectionId": "string",
  "collectionName": "string",
  "created": "string",
  "description": "string",
  "difficulty": "string",
  "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": "string",
  "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 Title description
» 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] 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

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 /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 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 /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 Title 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

{
  "name": "string",
  "public": true,
  "difficulty": "string",
  "lat": 0,
  "lon": 0,
  "thumbnail": 0,
  "photos": [
    "string"
  ],
  "waypoints": [
    "string"
  ],
  "summit_logs": [
    "string"
  ],
  "expand": {
    "waypoints": [
      "string"
    ],
    "summit_logs": [
      "string"
    ]
  },
  "tags": [
    "string"
  ],
  "description": "string",
  "author": "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 Title description
» name string true none none
» public boolean true none none
» difficulty string true none none
» lat number true none none
» lon number true none none
» thumbnail integer true none none
» photos [string] true none none
» waypoints [string] true none none
» summit_logs [string] true none none
» expand object true none none
»» waypoints [string] true none none
»» summit_logs [string] true none none
» tags [string] true none none
» description string true none none
» author string 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
»» 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

user

POST file

POST /user/{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 /user/{id}

Params

Name Location Type Required Description
id path string yes none

Response Examples

200 Response

{
  "avatar": "string",
  "collectionId": "string",
  "collectionName": "string",
  "created": "string",
  "email": "string",
  "emailVisibility": true,
  "id": "string",
  "language": "string",
  "location": {
    "lat": 0,
    "lon": 0,
    "name": "string"
  },
  "token": "string",
  "unit": "string",
  "updated": "string",
  "username": "string",
  "verified": 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
» avatar string true none none
» collectionId string true none none
» collectionName string true none none
» created string true none none
» email string true none none
» emailVisibility boolean true none none
» id string true none none
» language string true none none
» location object true none none
»» lat number true none none
»» lon number true none none
»» name string true none none
» token string true none none
» unit string true none none
» updated string true none none
» username string true none none
» verified 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

POST update

POST /user/{id}

Body Parameters

{}

Params

Name Location Type Required Description
id path string yes none
Content-Type header string yes none
body body object no none

Response Examples

200 Response

{
  "avatar": "string",
  "collectionId": "string",
  "collectionName": "string",
  "created": "string",
  "email": "string",
  "emailVisibility": true,
  "id": "string",
  "language": "string",
  "location": {
    "lat": 0,
    "lon": 0,
    "name": "string"
  },
  "token": "string",
  "unit": "string",
  "updated": "string",
  "username": "string",
  "verified": 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
» avatar string true none none
» collectionId string true none none
» collectionName string true none none
» created string true none none
» email string true none none
» emailVisibility boolean true none none
» id string true none none
» language string true none none
» location object true none none
»» lat number true none none
»» lon number true none none
»» name string true none none
» token string true none none
» unit string true none none
» updated string true none none
» username string true none none
» verified 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

DELETE delete

DELETE /user/{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

PUT create

PUT /user

Body Parameters

{
  "username": "string",
  "password": "string",
  "passwordConfirm": "string",
  "email": "string"
}

Params

Name Location Type Required Description
body body object no none
» username body string yes none
» password body string yes none
» passwordConfirm body string yes none
» email body string yes none

Response Examples

200 Response

{
  "avatar": "string",
  "collectionId": "string",
  "collectionName": "string",
  "created": "string",
  "emailVisibility": true,
  "id": "string",
  "language": "string",
  "location": null,
  "token": "string",
  "unit": "string",
  "updated": "string",
  "username": "string",
  "verified": true
}

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
» avatar string true none none
» collectionId string true none none
» collectionName string true none none
» created string true none none
» emailVisibility boolean true none none
» id string true none none
» language string true none none
» location null true none none
» token string true none none
» unit string true none none
» updated string true none none
» username string true none none
» verified boolean 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
»»» passwordConfirm object true none none
»»»» code string true none none
»»»» message string true none none
»»» username object true none none
»»»» code string true none none
»»»» message string 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
»»»» passwordConfirm object true none none
»»»»» code string true none none
»»»»» message string true none none
»»»» username object true none none
»»»»» code string true none none
»»»»» message string true none none
» name string true none none

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

{}

Responses

HTTP Status Code Meaning Description Data schema
200 OK Success Inline

Responses Data Schema

POST update

POST /list/{id}

Body Parameters

{
  "name": "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

Response Examples

200 Response

{
  "author": "string",
  "avatar": "string",
  "collectionId": "string",
  "collectionName": "string",
  "created": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "trails": [
    "string"
  ],
  "updated": "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 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

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": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "trails": [
    "string"
  ],
  "updated": "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 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

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

waypoint

GET show

GET /waypoint/{id}

Params

Name Location Type Required Description
id path string yes none

Response Examples

200 Response

{
  "author": "string",
  "collectionId": "string",
  "collectionName": "string",
  "created": "string",
  "description": "string",
  "icon": "string",
  "id": "string",
  "lat": 0,
  "lon": 0,
  "name": "string",
  "photos": [
    "string"
  ],
  "updated": "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 Title description
» 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 integer true none none
» lon integer true none none
» name string true none none
» photos [string] true none none
» updated string 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 /waypoint/{id}

Body Parameters

{
  "name": "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

Response Examples

200 Response

{
  "author": "string",
  "collectionId": "string",
  "collectionName": "string",
  "created": "string",
  "description": "string",
  "icon": "string",
  "id": "string",
  "lat": 0,
  "lon": 0,
  "name": "string",
  "photos": [
    "string"
  ],
  "updated": "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 Title description
» 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 integer true none none
» lon integer true none none
» name string true none none
» photos [string] true none none
» updated string 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 /waypoint/{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 /waypoint

Response Examples

200 Response

[
  {
    "author": "string",
    "collectionId": "string",
    "collectionName": "string",
    "created": "string",
    "description": "string",
    "icon": "string",
    "id": "string",
    "lat": 0,
    "lon": 0,
    "name": "string",
    "photos": [
      "string"
    ],
    "updated": "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
» 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

PUT create

PUT /waypoint

Body Parameters

{
  "name": "string",
  "description": "string",
  "author": "string",
  "lat": 0,
  "lon": 0,
  "icon": "string"
}

Params

Name Location Type Required Description
body body object no none
» name body string no none
» description body string no none
» author body string yes none
» lat body integer yes none
» lon body integer yes none
» icon body string no none

Response Examples

200 Response

{
  "author": "string",
  "collectionId": "string",
  "collectionName": "string",
  "created": "string",
  "description": "string",
  "icon": "string",
  "id": "string",
  "lat": 0,
  "lon": 0,
  "name": "string",
  "photos": [
    "string"
  ],
  "updated": "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 Title description
» 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 integer true none none
» lon integer true none none
» name string true none none
» photos [string] true none none
» updated string 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

summit_log

GET show

GET /summit-log/{id}

Params

Name Location Type Required Description
id path string yes none

Response Examples

200 Response

{
  "collectionId": "string",
  "collectionName": "string",
  "created": "string",
  "date": "string",
  "id": "string",
  "text": "string",
  "updated": "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 Title description
» collectionId string true none none
» collectionName string true none none
» created string true none none
» date string true none none
» id string true none none
» text string true none none
» updated string 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 /summit-log/{id}

Body Parameters

{
  "name": "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

Response Examples

200 Response

{
  "collectionId": "string",
  "collectionName": "string",
  "created": "string",
  "date": "string",
  "id": "string",
  "text": "string",
  "updated": "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 Title description
» collectionId string true none none
» collectionName string true none none
» created string true none none
» date string true none none
» id string true none none
» text string true none none
» updated string 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 /summit-log/{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 /summit-log

Response Examples

200 Response

[
  {
    "collectionId": "string",
    "collectionName": "string",
    "created": "string",
    "date": "string",
    "id": "string",
    "text": "string",
    "updated": "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
» collectionId string false none none
» collectionName string false none none
» created string false none none
» date string false none none
» id string false none none
» text string false none none
» updated string false none none

PUT create

PUT /summit-log

Body Parameters

{
  "date": "string",
  "text": "string"
}

Params

Name Location Type Required Description
body body object no none
» date body string yes none
» text body string yes none

Response Examples

200 Response

{
  "collectionId": "string",
  "collectionName": "string",
  "created": "string",
  "date": "string",
  "id": "string",
  "text": "string",
  "updated": "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 Title description
» collectionId string true none none
» collectionName string true none none
» created string true none none
» date string true none none
» id string true none none
» text string true none none
» updated string 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

auth

POST login

POST /auth/login

Body Parameters

{
  "username": "string",
  "password": "string"
}

Params

Name Location Type Required Description
Content-Type header string yes none
body body object no none
» username body string yes none
» password body string yes none

Response Examples

200 Response

{
  "record": {
    "avatar": "string",
    "collectionId": "string",
    "collectionName": "string",
    "created": "string",
    "email": "string",
    "emailVisibility": true,
    "id": "string",
    "language": "string",
    "location": {
      "lat": 0,
      "lon": 0,
      "name": "string"
    },
    "token": "string",
    "unit": "string",
    "updated": "string",
    "username": "string",
    "verified": true
  },
  "token": "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 Title description
» record object true none none
»» avatar string true none none
»» collectionId string true none none
»» collectionName string true none none
»» created string true none none
»» email string true none none
»» emailVisibility boolean true none none
»» id string true none none
»» language string true none none
»» location object true none none
»»» lat number true none none
»»» lon number true none none
»»» name string true none none
»» token string true none none
»» unit string true none none
»» updated string true none none
»» username string true none none
»» verified boolean true none none
» token string 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
Clone this wiki locally