Communication API

• feedback
  • postフィードバックを起票
  • getフィードバックの一覧を取得
  • patchフィードバックの編集
  • getフィードバックの取得
  • delフィードバックを削除
  • patchフィードバックのステータス更新
  • postフィードバックへの投票
  • delフィードバックへの投票の取消
  • postフィードバックへのコメント投稿
  • getフィードバックへのコメント取得
  • patchフィードバックへのコメント編集
  • delフィードバックへのコメント削除
• error
  • getステータスコード500でサーバーエラーを返却

API docs by Redocly

SaaSus Communication API Schema (1.0.0)

SaaSus Communication API Schema

feedback

フィードバック

フィードバックを起票

フィードバックを起票します。

Authorizations:

Bearer

Request Body schema: application/json

user_id required	string (Uuid)
feedback_title required	string (フィードバックのタイトル)
feedback_description required	string (フィードバックの内容)

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"

    }

  ]

}

フィードバックの一覧を取得

フィードバックの一覧を取得します。

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"

        }

      ]

    }

  ]

}

フィードバックの編集

フィードバックの編集をします。

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_description required	string (フィードバックの内容)

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"

}

フィードバックの取得

フィードバックの取得をします。

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"

    }

  ]

}

フィードバックを削除

フィードバックを削除します。

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"

}

フィードバックのステータス更新

フィードバックのステータスを更新します。

Authorizations:

Bearer

path Parameters

feedback_id required

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

Request Body schema: application/json

status required

integer (フィードバックのステータス)

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"

}

フィードバックへの投票

フィードバックへの投票をします。

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"

    }

  ]

}

フィードバックへの投票の取消

フィードバックへの投票の取消をします。

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"

}

フィードバックへのコメント投稿

フィードバックへのコメントを投稿します。

Authorizations:

Bearer

path Parameters

feedback_id required

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

Request Body schema: application/json

body required

string (コメント内容)

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": "貴重なご意見ありがとうございます。"

}

フィードバックへのコメント取得

フィードバックへのコメントを取得します。

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": "貴重なご意見ありがとうございます。"

}

フィードバックへのコメント編集

フィードバックへのコメントを編集します。

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 (編集内容)

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"

}

フィードバックへのコメント削除

フィードバックへのコメントを削除します。

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

テスト用途のエラー

ステータスコード500でサーバーエラーを返却

テスト用途で使用するエンドポイントです。ステータスコード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"

}