Developer

Submit a structured suggestion

Service version: 1
Last edit: 2023.11.15

Purpose

This endpoint is used to submit a new structured map suggeston.

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

post
URL request format
https://{baseURL}/api/suggestion

POST request body format

post
POST request body format - JSON
1{
2  "feedbackType": "ADDRESS",
3  "operation": "ADD",
4  "attributes": {
5    "houseNumber": "1",
6    "street": "string",
7    "postcode": "string",
8    "landmark": "string",
9    "state": "string",
10    "province": "string",
11    "county": "string",
12    "district": "string",
13    "suburb": "string",
14    "unit": "string",
15    "city": "string",
16    "geometry": {
17      "wkt": "LINESTRING(73.843013 18.528474,73.843015 18.52858,73.843634 18.52973,73.843974 18.53035,73.844544 18.53139)"
18    },
19    "currentValuesInMap": {
20      "houseNumber": "string",
21      "street": "string",
22      "postcode": "string",
23      "landmark": "string",
24      "state": "string",
25      "province": "string",
26      "county": "string",
27      "district": "string",
28      "suburb": "string",
29      "unit": "string",
30      "city": "string",
31      "geometry": {
32        "wkt": "LINESTRING(73.843013 18.528474,73.843015 18.52858,73.843634 18.52973,73.843974 18.53035,73.844544 18.53139)"
33      }
34    }
35  },
36  "comment": "your comment",
37  "severity": "MEDIUM",
38  "language": "string",
39  "geometry": {
40    "wkt": "LINESTRING(73.843013 18.528474,73.843015 18.52858,73.843634 18.52973,73.843974 18.53035,73.844544 18.53139)"
41  },
42  "referenceId": "1a0f0693-97ef-4564-81a1-3903643966b4",
43  "featureId": "string",
44  "mapProduct": {
45    "name": "example name",
46    "version": "1.0.0.01"
47  },
48  "filesInfo": [
49    {
50      "url": "https://www.evidence.com/photo.jgp",
51      "key": "string",
52      "type": "image/png"
53    }
54  ],
55  "additionalFields": {}
56}

Request parameters

The following table describes the parameters that can be used in a request.

  • Required parameters must be used or the call will fail.
  • Optional parameters may be used.
  • The order of request parameters is not important.

Required parameters

Description

feedbackType
string

Category of the suggestion
Value: ADDRESS , POI, ROAD, SPEED_CAMERA, SPEED_RESTRICTION, TRUCK_RESTRICTION, TURN_RESTRICTION, OTHER

operation
string

Intent of the suggestion.
Value: ADD, UPDATE, DELETE

geometry
string

Exact point/area where the error is located on the map in the form of WKT.
Value: LOW, MEDIUM, HIGH, CRITICAL

Optional parameters

Description

attributes
string

Contains the old values (attribute value as currently seen on map) as well as the new values which the user wants to be rectified.
This field also contains the additionProperties field, which can contain any arbitrary fields covered in the already defined fields.
The content of this field needs to follow the appropriate schema depending on the feedbackType.


Please visit the API reference to see the schema for the corresponding feedbackType.

comment
string

Used to provide additional remarks by the user, with details which could help to solve this error.e.

severity
string

Severity of the suggestion.
Value: LOW, MEDIUM, HIGH, CRITICAL

language
string

Language used in the suggestion.

referenceId
string

This field can be used to add an identifier for this particular feedback.

mapProduct
object

Product name and version of the map on which the user experienced the error.

filesInfo
object

Contains a field to provide a direct url of the evidence, a key field which would uniquely identify this particular file and a type field for the appropriate MIME media type.

additionalFields
object

Allows the user to insert any other additional fields to be used in the suggstion.

Response data

Response body

The following JSON code block demonstrates a successful response from the API server.

Response body format - JSON
1{
2  "id": "string"
3}

Response fields

The following table describes all of the fields that can appear in a response.

Primary fields

Description

Description

id
object

The ID of the suggestion that was submitted. This field will internally be transformed as the originalId to be used to query its status.

Response codes

Code

Meaning and possible causes

200

OK

400

Bad request:

  • Invalid parameters

403

Forbidden:

  • API Key for provided customer ID is missing or invalid

Example

HTML Method: POST

get
URL request example
https://suggestion.fdp.orbisplatform.com/api/suggestion
get
POST request body example
1{
2  "feedbackType": "ADDRESS",
3  "operation": "ADD",
4  "attributes": {
5    "houseNumber": "12",
6    "street": "Example Street",
7    "geometry": {
8      "wkt": "LINESTRING(73.843013 18.528474,73.843015 18.52858,73.843634 18.52973,73.843974 18.53035,73.844544 18.53139)"
9    },
10    "currentValuesInMap": {
11      "houseNumber": "12",
12      "street": "Some Street",
13      "geometry": {
14          "wkt": "LINESTRING(73.843013 18.528474,73.843015 18.52858,73.843634 18.52973,73.843974 18.53035,73.844544 18.53139)"
15        }
16    }
17  },
18  "comment": "This is a demo",
19  "geometry": {
20    "wkt": "LINESTRING(73.843013 18.528474,73.843015 18.52858,73.843634 18.52973,73.843974 18.53035,73.844544 18.53139)"
21  },
22  "mapProduct": {
23    "name": "example name",
24    "version": "1.0.0.01"
25  }
26}

Response body example

Response body example - JSON
1{
2  "id": "544be2b6-81f9-4c16-a393-3499bc2f0f69"
3}