Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 645 Bytes

get_walk.md

File metadata and controls

31 lines (19 loc) · 645 Bytes

Walks

Retrieve a walk

GET /walks/:walkID

Description

Retrieves a walk from the database, given a walk ID.

Authorization

  • A JWT for a registered user must be supplied in the Authorization field of the request header.
  • The token must be supplied in the format JWT 'token'

Parameters

  • walkID: ObjectID (required)

Success response:

  • Code: 200 OK
  • Content: A success flag and the retrieved walk

Errors

  • 400 Bad Request – walkID not of type ObjectID
  • 401 Unauthorized – no/invalid JWT provided
  • 404 Not Found – a walk with ID walkID could not be found in the database