Skip to content

Instantly share code, notes, and snippets.

@KaraJoHo
Last active April 12, 2023 20:34
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save KaraJoHo/0d1df4b8eedb78f0d441616013db29fa to your computer and use it in GitHub Desktop.
Save KaraJoHo/0d1df4b8eedb78f0d441616013db29fa to your computer and use it in GitHub Desktop.
BE - Do Good Requests/Endpoints

Good Deeds

Request: get "/api/v1/good_deeds"

Response:

{
  "data": [{
    "id": “1”,
    "type": “good_deed",
    "attributes":{
        "deed_name": "Deed",
        "media_link": "www.image.com/picture",
        #statistics for metrics API
      }  
    }]
}

Request: get "/api/v1/random_acts"

Response:

{
  "data": {
    "id": “1”,
    "type": “random_acts",
    "attributes":{
        "deed_names": ["Deed 1", "Deed 2", "Deed 3"]
      }  
    }
}

Request: get "/api/v1/users

{
  "data": [{
    "id": “1”,
    "type": “users",
    "attributes":{ "name": "Joe"}  
    }]
}

Request: post "/api/v1/users/:id/good_deeds

{
  "deed_name": "Deed",
  “date”: "02-02-2024",
  "time": "10:00"
  "attendees": [{"user_id": 1}, {"user_id": 2}]
 }

Request: get "/api/v1/users/:id"

Response:

{
  "data": {
    "id": “1”,
    "type": “user",
    "attributes":{
    "name": "Sam", 
    "good_deeds": [{
            "data": {
            "id": “1”,
            "type": “good_deed",
            "attributes":{
                "deed_name": "Deed",
                "media_link": "www.image.com/picture",
                "notes”: “ex description”,
                “date”: "02-02-2024",
                "time": "10:00,
                "status": "completed", 
                "host_id": "9000"
              }  
            }
      }]
     }
    }
   }

Request: get "/api/v1/users/:id/good_deeds/:id"

Response:

{
  "data": {
        "id": "1",
        "type": "good_deeds",
        "attributes": {
                "deed_name": "Deed",
                “date”: "02-02-2024",
                "time": "10:00,
                "status": "in progress", 
                "attendees": [{"user_id": 1}, {"user_id": 2}]
              }  
            }
  }
}

Request: patch "/api/v1/users/:id/good_deeds/:id"

{
  "deed_name": "Deed",
  “date”: "02-02-2024",
  "time": "10:00"
  "notes": "Stuff and things",
  "media_link": "picture.jpg"
  "attendees": [{"user_id": 1}, {"user_id": 2}]
 }

Request: delete "/api/v1/users/:id/good_deeds/:id"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment