Communication API

• feedback
  • postCreate Feedback
  • getGet Feedbacks
  • patchUpdate Feedback
  • getGet Feedback
  • delDelete Feedback
  • patchUpdate Feedback Status
  • postCreate Vote User
  • delDelete Vote For Feedback
  • postCreate Feedback Comment
  • getGet Feedback Comment
  • patchUpdate Feedback Comment
  • delDelete Feedback Comment
• error
  • getReturn Internal Server Error

API docs by Redocly

SaaSus Communication API Schema (1.0.0)

SaaSus Communication API Schema

feedback

Feedback

Create Feedback

Create Feedback.

Authorizations:

Bearer

Request Body schema: application/json

user_id required	string (Uuid)
feedback_title required	string (Feedback Title)
feedback_description required	string (Feedback Content)

Responses

Production API Server

https://api.saasus.io/v1/communication/feedbacks

Request samples

• Payload

Content type

application/json

{

• "feedback_title": "保存ボタンの位置を変えてほしい",
• "feedback_description": "編集ダイアログの保存ボタンが押しにくいので、位置を変えてほしい"

}

Response samples

• 201
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "user_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "created_at": 1640995200,
• "status": 1,
• "feedback_title": "保存ボタンの位置を変えてほしい",
• "feedback_description": "編集ダイアログの保存ボタンが押しにくいので、位置を変えてほしい",
• "comments": [

  • {

    • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "created_at": 1640995200,
    • "body": "貴重なご意見ありがとうございます。"

    }

  ],
• "count": 1,
• "users": [

  • {

    • "user_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775"

    }

  ]

}

Get Feedbacks

Get the list of feedbacks.

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/communication/feedbacks

Response samples

• 200
• 500

Content type

application/json

{

• "feedbacks": [

  • {

    • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "user_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "created_at": 1640995200,
    • "status": 1,
    • "feedback_title": "保存ボタンの位置を変えてほしい",
    • "feedback_description": "編集ダイアログの保存ボタンが押しにくいので、位置を変えてほしい",
    • "comments": [

      • {

        • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
        • "created_at": 1640995200,
        • "body": "貴重なご意見ありがとうございます。"

        }

      ],
    • "count": 1,
    • "users": [

      • {

        • "user_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775"

        }

      ]

    }

  ]

}

Update Feedback

Edit feedback.

Authorizations:

Bearer

path Parameters

feedback_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775

Request Body schema: application/json

feedback_title required	string (Feedback Title)
feedback_description required	string (Feedback Content)

Responses

Production API Server

https://api.saasus.io/v1/communication/feedbacks/{feedback_id}

Request samples

• Payload

Content type

application/json

{

• "feedback_title": "保存ボタンの位置を変えてほしい",
• "feedback_description": "編集ダイアログの保存ボタンが押しにくいので、位置を変えてほしい"

}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

Get Feedback

Retrieve feedback.

Authorizations:

Bearer

path Parameters

feedback_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775

Responses

Production API Server

https://api.saasus.io/v1/communication/feedbacks/{feedback_id}

Response samples

• 200
• 404
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "user_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "created_at": 1640995200,
• "status": 1,
• "feedback_title": "保存ボタンの位置を変えてほしい",
• "feedback_description": "編集ダイアログの保存ボタンが押しにくいので、位置を変えてほしい",
• "comments": [

  • {

    • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "created_at": 1640995200,
    • "body": "貴重なご意見ありがとうございます。"

    }

  ],
• "count": 1,
• "users": [

  • {

    • "user_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775"

    }

  ]

}

Delete Feedback

Delete Feedback.

Authorizations:

Bearer

path Parameters

feedback_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775

Responses

Production API Server

https://api.saasus.io/v1/communication/feedbacks/{feedback_id}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

Update Feedback Status

Update Feedback Status.

Authorizations:

Bearer

path Parameters

feedback_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775

Request Body schema: application/json

status required

integer (Feedback Status)

Responses

Production API Server

https://api.saasus.io/v1/communication/feedbacks/{feedback_id}/status

Request samples

• Payload

Content type

application/json

{

• "status": 1

}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

Create Vote User

Vote for feedback.

Authorizations:

Bearer

path Parameters

feedback_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775

Request Body schema: application/json

user_id required

string (Uuid)

Responses

Production API Server

https://api.saasus.io/v1/communication/feedbacks/{feedback_id}/votes/users

Request samples

• Payload

Content type

application/json

{

• "user_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775"

}

Response samples

• 201
• 404
• 500

Content type

application/json

{

• "count": 1,
• "users": [

  • {

    • "user_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775"

    }

  ]

}

Delete Vote For Feedback

Cancel vote for feedback.

Authorizations:

Bearer

path Parameters

feedback_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775
user_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775

Responses

Production API Server

https://api.saasus.io/v1/communication/feedbacks/{feedback_id}/votes/users/{user_id}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

Create Feedback Comment

Post comment to feedback.

Authorizations:

Bearer

path Parameters

feedback_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775

Request Body schema: application/json

body required

string (Comment Content)

Responses

Production API Server

https://api.saasus.io/v1/communication/feedbacks/{feedback_id}/comments

Request samples

• Payload

Content type

application/json

{

• "body": "貴重なご意見ありがとうございます。"

}

Response samples

• 201
• 404
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "created_at": 1640995200,
• "body": "貴重なご意見ありがとうございます。"

}

Get Feedback Comment

Retrieve comment from feedback.

Authorizations:

Bearer

path Parameters

feedback_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775
comment_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775

Responses

Production API Server

https://api.saasus.io/v1/communication/feedbacks/{feedback_id}/comments/{comment_id}

Response samples

• 200
• 404
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "created_at": 1640995200,
• "body": "貴重なご意見ありがとうございます。"

}

Update Feedback Comment

Edit comment for feedback.

Authorizations:

Bearer

path Parameters

feedback_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775
comment_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775

Request Body schema: application/json

body required

string (Edited Content)

Responses

Production API Server

https://api.saasus.io/v1/communication/feedbacks/{feedback_id}/comments/{comment_id}

Request samples

• Payload

Content type

application/json

{

• "body": "貴重なご意見ありがとうございます。"

}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

Delete Feedback Comment

Delete comment for feedback.

Authorizations:

Bearer

path Parameters

feedback_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775
comment_id required	string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775

Responses

Production API Server

https://api.saasus.io/v1/communication/feedbacks/{feedback_id}/comments/{comment_id}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

error

Error for testing

Return Internal Server Error

This endpoint is used for testing purposes. Returns a server error with status code 500.

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/communication/errors/internal-server-error

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}