Skip to content

Latest commit

 

History

History
83 lines (73 loc) · 2.16 KB

GET_id.md

File metadata and controls

83 lines (73 loc) · 2.16 KB

Fetch a specific intervention record

API endpoint that represents a single intervention record

  • URL Endpoint: /api/v1/interventions/{id}

  • Method: GET

  • URL Params:

    Name Type Required Description
    id integer The intervention's id
  • Header Options:

    • Authorization: Bearer access_token
  • Request Body: None

  • Success Response

    • Code: 200 OK
    • Content:
      {
        "status": 200,
        "data": [
          {
            "id": 1,
            "creadedOn": "Fri Nov 30 2018 11:15:34 GMT+0100 (West Africa Standard Time)",
            "type": "intervention",
            "location": "-42.7871,138.0694",
            "title": "Intervention title",
            "comment": "Temporibus dolores nobis nisi sapiente modi qui corrupti cum fuga. Est omnis nostrum in. Quis quo corrupti.",
            "images": [
              "https://via.placeholder.com/650x450",
              "https://via.placeholder.com/650x450"
            ],
            "videos": [
              "https://via.placeholder.com/sample-video.mp4",
            ],
            "status": "draft"
          }
        ]
      }
  • Error Response

    • Code: 404 NOT FOUND
    • Content:
        {
          "status": 404,
          "error": "Resource not found"
        }
  • Usage Sample:

    GET https://irepot.herokuapp.com/api/v1/interventions/1
    HTTP/1.1
    Accept: application/json
    Authorization: Bearer {access_token}
    
    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
      "status": 200,
      "data": [
        {
          "id": 1,
          "creadedOn": "Fri Nov 30 2018 11:15:34 GMT+0100 (West Africa Standard Time)",
          "type": "intervention",
          "location": "-42.7871,138.0694",
          "title": "Intervention title",
          "comment": "Temporibus dolores nobis nisi sapiente modi qui corrupti cum fuga. Est omnis nostrum in. Quis quo corrupti.",
          "images": [
            "https://via.placeholder.com/650x450",
            "https://via.placeholder.com/650x450"
          ],
          "status": "draft"
        }
      ]
    }