api.raml 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. #%RAML 0.8
  2. title: Tracking
  3. baseUri: http://dddsample.marcusoncode.se/tracking/{version}
  4. version: v1
  5. /cargos:
  6. /{trackingId}:
  7. uriParameters:
  8. trackingId:
  9. description: The tracking id of the cargo
  10. type: string
  11. get:
  12. description: A specific cargo
  13. responses:
  14. 200:
  15. body:
  16. application/json:
  17. example: |
  18. {
  19. "cargo": {
  20. "tracking_id": "B075CD13",
  21. "status_text": "Not received",
  22. "origin": "DEHAM",
  23. "destination": "SESTO",
  24. "eta": "2016-03-22T19:24:24.686283448Z",
  25. "next_expected_activity": "Next expected activity is to receive cargo in DEHAM.",
  26. "arrival_deadline": "2016-04-08T22:00:00Z",
  27. "events": null
  28. }
  29. }
  30. 404:
  31. body:
  32. application/json:
  33. example: |
  34. {
  35. "error": "unknown cargo"
  36. }