Retreive the status of a suggestion
Important note
This Map Product Comment Tracker API is unavailable on a Freemium or Pay As You Grow (PAYG) basis.
Click Request Access to contact our Sales team.
Purpose
This endpoint is used to retrieve the status of a suggestion.
Request data
HTTPS method: POST
- Constants and parameters enclosed in curly brackets { } must be replaced with their values.
- Please see the following Request parameters section with the required and optional parameters tables for these values. The generic URL format is as follows.
URL request ormat
https://{baseURL}/api/status
POST request body format
1{2 "feedbackId": "string",3 "originalId": "string"4}
Request parameters
The following table describes the parameters that can be used in a request.
- Either
feedbackId
ororiginalId
parameters must be used. If both are provided,feedbackId
takes preference.
Parameters | Description |
---|---|
| ID returned in the response after suggestion is submitted. |
| Internal ID used to track the status of the suggestion across the platform. |
Response data
Response body
The following JSON code block demonstrates a successful response from the API server.
1{2 "feedbackId": "string",3 "originalId": "string",4 "createdAt": "2023-11-16T09:09:35.145Z",5 "status": "NEW",6 "subStatus": "FIXED",7 "fixedIn": {8 "product": "string",9 "version": "string"10 },11 "comment": "string"12}
Response fields
The following table describes all of the fields that can appear in a response.
Primary fields | |
---|---|
Description | Description |
| Internal ID used to track the status of the suggestion across the platform. |
| ID returned in the response after suggestion is submitted |
| Indicates when the suggestion was submitted |
| Indicates the status of the suggestion. |
| Provides additional information regarding the status of the suggestion. |
| Indicates the map product and version in which the issue described in the suggestion was fixed. |
| Provides an additional comment regarding the status of the suggestion. |
Response codes
Code | Meaning and possible causes |
---|---|
| OK |
| Bad request:
|
| Forbidden:
|
Example
HTML Method: POST
https://suggestion.fdp.orbisplatform.com/api/status
1{2 "originalId" : "62e0118b-f2b3-4ee2-bb76-5cd79e6d7e82"3}
Response body example
1{2 "comment": "",3 "createdAt": "2023-11-14T11:19:40.118220933Z",4 "feedbackId": "f588f8da-9da5-481e-8d0c-0ed08eaf58e4",5 "fixedIn": {6 "product": "",7 "version": ""8 },9 "originalId": "62e0118b-f2b3-4ee2-bb76-5cd79e6d7e82",10 "status": "NEW",11 "subStatus": ""12}