URI
<portal_uri>/feedback[.<format>]
Supported methods
Parent resource
Child resource
Introduction
The feedbackInfos resource contains the feedback list information. It supports querying the feedback list, adding new feedback, and batch deleting feedback.
Supported methods:
- GET:Queries the feedback list information.
- POST:Adds a new feedback.
- DELETE:Batch deletes feedback.
- HEAD: Checks whether the feedbackInfos resource exists or whether the permission can access the feedbackInfos resource.
Supported output formats:RJSON,JSON,XML.
Resource hierarchy
HTTP request methods
Perform an HTTP request on the following URI, using rjson output format as an example, where supermapiportal is the server name.
http://supermapiportal:8190/iportal/web/feedback.rjson
GET request
Queries the feedback list information.
Request parameters
If no parameters are set, the feedback information on the first page that the current user has permission to view is returned. After setting parameters, the user-specified feedback list information is returned. Request parameters must be included in the URI.
| Name | Type | Description |
| currentPage | int | Filters by page number. |
| keywords | String[] | Queries by keywords. |
| orderBy | FeedbackOrderBy | Sorts results in ascending/descending order. |
| orderType | OrderType | Filters by sort field. |
| pageSize | int | The page size. |
| replied | Boolean | Filters by whether a reply has been sent. |
| reviewStatus | ReviewStatus | Filters by review status. |
| userName | String | Filters by the feedback provider's username. |
Response structure
Performing a GET request on the feedbackInfos resource returns the feedback list information. It consists of the following fields:
| Field | Type | Description |
| currentPage | int | The current page number. |
| content | List<FeedbackInfo> | The page content. |
| pageSize | int | The page size. |
| searchParameter | SearchParameter | The search parameters for the current page. |
| total | int | The total number of records. |
| totalPage | int | The total number of pages. |
Response example
Performing a GET request on the feedbackInfos resource: http://localhost:8190/iportal/web/feedback.rjson. The rjson format resource representation is as follows:
{
"total": 2,
"totalPage": 1,
"pageSize": 9,
"searchParameter": {
"orderType": "ASC",
"keywords": null,
"replied": null,
"orderBy": null,
"pageSize": 9,
"reviewStatus": "PASSED",
"userName": null,
"currentPage": 1
},
"currentPage": 1,
"content": [
{
"replied": false,
"updateTime": 1589156955302,
"reviewer": null,
"userName": "admin",
"title": "test",
"reviewComments": null,
"content": "test",
"replyTime": null,
"reviewerNickname": null,
"createTime": 1589156955302,
"name": "admin",
"contactNumber": null,
"reviewStatus": "PASSED",
"id": 122398488,
"replier": null,
"replyContent": null,
"email": "wangzhe@supermap.com",
"reviewTime": null,
"replierNickname": null
},
{
"replied": false,
"updateTime": 1588941927741,
"reviewer": null,
"userName": "admin",
"title": "Mobile",
"reviewComments": null,
"content": "Mobile adaptation is not very good",
"replyTime": null,
"reviewerNickname": null,
"createTime": 1588941927741,
"name": "user",
"contactNumber": null,
"reviewStatus": "PASSED",
"id": 432329231,
"replier": null,
"replyContent": null,
"email": "",
"reviewTime": null,
"replierNickname": null
}
]
}
To retrieve feedback list with specific conditions, such as filtering by feedback title keywords, set keywords=["iPortal"]
For example, performing a request on the feedbackInfos resource: http://localhost:8190/iportal/web/feedback.rjson?keywords=["iPortal"] performing a GET request. The rjson format resource representation is as follows:
{
"total": 1,
"totalPage": 1,
"pageSize": 9,
"searchParameter": {
"orderType": "ASC",
"keywords": [
"iPortal"
],
"replied": null,
"orderBy": null,
"pageSize": 9,
"reviewStatus": "PASSED",
"userName": null,
"currentPage": 1
},
"currentPage": 1,
"content": [
{
"replied": true,
"updateTime": 1590563366467,
"reviewer": "admin",
"userName": "user",
"title": "iPortal Test",
"reviewComments": "Approved",
"content": "Have a Test",
"replyTime": 1592292396994,
"reviewerNickname": null,
"createTime": 1590563366467,
"name": "user",
"contactNumber": null,
"reviewStatus": "PASSED",
"id": 865402370,
"replier": "admin",
"replyContent": "support",
"email": "user@supermap.com",
"reviewTime": 1591175349421,
"replierNickname": null
}
]
}
POST request
Adds a new feedback.
Request parameters
When sending a request, the following parameters must be passed in the request body:
| Field | Type | Description |
| contactNumber | String | The contact number of the feedback provider. |
| content | String | The feedback content. |
| String | The email of the feedback provider. | |
| name | String | The name of the feedback provider. |
| title | String | The feedback title. |
Response structure
The returned resource representation structure is as follows:
| Field | Type | Description |
| newResourceID | String | The ID of the added feedback. |
| newResourceLocation | String | The URI of the added feedback. |
| succeed | boolean | Whether adding feedback was successful. |
Response example
Performing a POST request on the feedbackInfos resource: http://localhost:8190/iportal/web/feedback.rjson to add a new feedback. The request body is as follows:
{
"name": "user",
"email": "user@supermap.com",
"title": "Test",
"content": "test!"
}
The rjson format response is as follows:
{
"newResourceID": "1146584947",
"succeed": true,
"newResourceLocation": "http://rdc.ispeco.com/web/feedback/1146584947"
}
DELETE request
Deletes feedback. Supports batch deletion. The ID array of feedback to be deleted must be passed in the URL.
Response structure
The returned resource representation structure is as follows:
| Field | Type | Description |
| succeed | boolean | Whether deleting feedback was successful. |
| error | HttpError | Error information. This field is not returned if deleting feedback is successful. |
Response example
Performing a DELETE request on the feedbackInfos resource: http://localhost:8190/iportal/web/feedback.rjson?ids=[1,2] to batch delete two feedback items with IDs 1 and 2. The rjson format response is as follows:
{ "succeed": true}
HEAD request
Returns the same HTTP response headers as a GET request, but without the response entity. Metadata information contained in the response headers can be obtained without transferring the entire response content. Metadata includes media type, character encoding, content encoding, and content length.
HEAD requests can be used to determine whether the feedbackInfos resource exists or whether the client has permission to access the feedbackInfos resource. By performing a HEAD request on a URI with .<format>, you can also quickly determine whether the feedbackInfos resource supports the <format> format representation.
See