Skip to main content

Survey API

Related to survey

Endpoints​

# Endpoints
POST
/app/survey/page
# 問卷分頁
PUT
/app/survey/{survey-user-id}/read
# 問卷設置已讀
GET
app/survey/has-new
# 是否有新問卷

Survey page​

問卷調查分頁

Request (PaginationAndSorting)​

POST /app/survey/page
{
  "pagination": {
    "page": 1,
    "size": 3,
    "totalItems": 1,
    "totalPages": 1
  },
  "sortings": [
    {
      "property": "createdAt",
      "direction": "DESC"
    }
  ]
}

Response (AppSurveyPageRespDTO)​

{
  "success": true,
  "message": "",
  "data": {
    "pagination": {
      "page": 1,
      "size": 10,
      "totalItems": 2,
      "totalPages": 1
    },
    "items": [
      {
        "surveyUserId": "610f0684-df3a-4222-9530-5fb8d6de6d7e",
        "title": "日常習慣調查2",
        "link": "http://www.google2.com.hk",
        "isRead": false,
        "sendAt": "2024-07-15T07:12:57.052481Z"
      }
    ]
  }
}

Survey read​

問卷設置已讀

Request​

PUT /app/survey/{survey-user-id}/read

Response​

{
  "success": true,
  "message": "",
  "data": null
}

Has new survey​

是否有新問卷

Request​

GET /app/survey/has-new

Response​

{
  "success": true,
  "message": "",
  "data": true
}

Resources​

Pagination​

properties
  • pagination
    Pagination
    required
    The required pagination class.
  • sortings
    Sortings[]
    The list of fields to be sorted, the order of the elements matter as it will affect how to resource is sorted.

AppSurveyPageRespDTO​

properties
  • surveyUserId
    string
    required
    發送問卷id
  • title
    string
    required
    問卷標題
  • link
    string
    required
    問卷地址
  • isRead
    boolean
    required
    就否已讀：true-是，false-否
  • sendAt
    datetime
    required
    問卷發送時間