Feedback
Get Feedback
- Endpoint:
GET /feedback/{id}
- Allowed for:
user that has created the feedback
Curl example :
$ curl -X GET 'http://api-v2.mycrm.com/feedback/123456789ABCD'
- JSON response:
Name | Type | Read-only | Comment |
---|---|---|---|
id | string | yes | Id of the feedback |
object | array | yes | Composed by keys namespace and id , it refers to the object that the feedback is related to |
tags | array | yes | A list of tags |
location | string | yes | The location related to the floor plan |
location_tree | array | yes | The location tree related to the floor plan |
Get Feedback List
- Endpoint:
GET /feedback
- Allowed for:
anyone
- Filters :
Name | Comment | Value |
---|---|---|
namespace | the type of the feedback | ex: floor_plan |
id | id of the object related to the type | ex: 1 |
Curl example :
$ curl -X GET 'http://api-v2.mycrm.com/feedback?filters[namespace]=floor_plan&filters[id]=1'
- JSON response example:
{
"feedback": {
"tags": [
"bad_quality",
"bad_orientation"
],
"location": "are.3.5800",
"location_tree": [
"are.0.6",
"are.1.310",
"are.2.1997",
"are.3.5800"
],
"id": "0123456789ABCDEFGHIJKLMN",
"object": {
"namespace": "floor_plan",
"id": 1
}
}
}
Create Feedback
- Endpoint:
POST /feedback
- Allowed for:
anyone
- JSON request
Name | Type | Mandatory | Comment |
---|---|---|---|
tags | array | yes | List of tags |
floor_plan | integer | yes | Id of the floor plan |
- JSON response:
This endpoint will return a Feedback.
Update Feedback
- Endpoint:
PUT /feedback/{id}
- Allowed for:
user that has created the feedback
- JSON request
Name | Type | Mandatory | Comment |
---|---|---|---|
tags | array | yes | List of tags |