Documenting: bettertravaux.ovh API

Endpoints

/tasks

  • URL
    • http://api.bettertravaux.ovh/tasks
  • Methods
    • GET
  • URL Params
    • “start” – optional
      • Format: “YYYY-MM-DD”
      • Can be abbreviated (e.g. “YYYY-MM”)
    • “end” – optional
      • Format: “YYYY-MM-DD”
      • Can be abbreviated (e.g. “YYYY-MM”)
  • Success Response
    • 200
    • Content
      • List of task IDs
  • Error Response
    • 404 NOT FOUND
      • Content
        • None
      • Reason
        • No results found
    • 400 BAD REQUEST
      • Reason
        • check the date format
        • malformed URL
  • Sample calls

Call:

Result:

Call

Response

Call

Response

404 NOT FOUND

  •  Notes
    • The result is huge. You may want to set boundaries using “start” and “end”.

/task/:taskid:

  • URL
    • http://api.bettertravaux.ovh/task/:task:id
  • Methods
    • GET
  • Success Response
    • 200
    • Content
      • JSON response containing task and comments
  • Sample calls

Call:

Result:

/service/:service:

  • URL
    • http://api.bettertravaux.ovh/service/:service:
  • Methods
    • GET
  • Success Response
    • 200
    • Content
      • JSON response containing task IDs
  • Error Response
    • 404 NOT FOUND
      • Content
        • None
      • Reason
        • Search does not match any item
  • Sample calls

Call

Response

 

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.