User Platform Feedback

Endpoints for interacting with users Feedback

STAGING_URL: https://switch-api-staging.herokuapp.com
LIVE_URL: https://switchapi.azurewebsites.net

Get all Feedbacks

GET https://switch-api-staging.herokuapp.com/user/feedbacks

This endpoint allows you get the list of feedbacks from users

Headers

Name	Type	Description
auth_token	string	The format for auth_token is Bearer token_string

200

{
    "message": "your feedback submissions were retrieved successfully",
    "data": [
        {
            "id": 6,
            "topic": "failed transaction",
            "message": "Hi, I was debited but the transaction didn't go through",
            "feedback_type": "bug_report",
            "image_url": "",
            "created_at": "2019-01-16T14:27:23.426Z",
            "updated_at": "2019-01-16T14:27:23.426Z"
        }
    ]
}

401

{
    "message": "Invalid token",
    "error_code": "INVALID_TOKEN"
}

Create Feedback

POST https://switch-api-staging.herokuapp.com/user/feedbacks

This endpoint allows you to create a feedback

Headers

Name	Type	Description
auth_token	string	The format for auth_token is Bearer token_string

Request Body

Name	Type	Description
image_url	string	link to image for feedback
feedback_type	string	type of feedback can either be bug_report or feature_request
message	string	feedback message
topic	string	topic of feedback

200

{
    "message": "feedback submitted successfully",
    "data": {
        "id": 6,
        "topic": "failed transaction",
        "message": "Hi, I was debited but the transaction didn't go through",
        "feedback_type": "bug_report",
        "image_url": "",
        "created_at": "2019-01-16T14:27:23.426Z",
        "updated_at": "2019-01-16T14:27:23.426Z"
    }
}

401 unathorized user

{
    "message": "Invalid token",
    "error_code": "INVALID_TOKEN"
}

422

{
    "message": "submission unsuccessful, please check your input",
    "errors": {
        "feedback_type": [
            "can't be blank"
        ]
    }
}

Get Feedback by Id

GET https://switch-api-staging.herokuapp.com/user/feedbacks/:id

This endpoint returns a specific feedback using it's id

Path Parameters

Name	Type	Description
id	string	the id of the feedback

Headers

Name	Type	Description
auth_token	string	The format for auth_token is Bearer token_string

200

{
    "message": "feedback retrieved successfully",
    "data": {
            "id": 6,
            "topic": "failed transaction",
            "message": "Hi, I was debited but the transaction didn't go through",
            "feedback_type": "bug_report",
            "image_url": "",
            "created_at": "2019-01-16T14:27:23.426Z",
            "updated_at": "2019-01-16T14:27:23.426Z"
        }
    }