POST api/Common/OSRMMapGeoCode

No documentation available.

Request Information

Parameters

NameDescriptionAdditional information
GRequest
No documentation available.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "MapOptions": {
    "APIKey": "sample string 1",
    "SecretKey": "sample string 2",
    "ClientID": "sample string 3",
    "Signature": "sample string 4",
    "channel": "sample string 5",
    "units": "sample string 6",
    "mode": "sample string 7",
    "alternatives": true,
    "avoid": "sample string 9",
    "language": "sample string 10",
    "region": "sample string 11",
    "traffic_model": "sample string 12",
    "transit_mode": "sample string 13",
    "transit_routing_preference": "sample string 14",
    "optimize": true,
    "CacheEnabled": true,
    "result_type": "sample string 17",
    "LiveTrafficMode": true
  },
  "Street": "sample string 1",
  "City": "sample string 2",
  "OtherCity": "sample string 3",
  "State": "sample string 4",
  "PostCode": "sample string 5",
  "Country": "sample string 6",
  "Address": "sample string 7",
  "Latitude": "sample string 8",
  "Longitude": "sample string 9",
  "AppType": "sample string 10"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

text/plain

Sample:

Sample not available.

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:
{
  "GeoCodeResponse": {
    "results": [
      {
        "address_components": [
          {
            "long_name": "sample string 1",
            "short_name": "sample string 2",
            "types": [
              "sample string 1",
              "sample string 2",
              "sample string 3"
            ]
          },
          {
            "long_name": "sample string 1",
            "short_name": "sample string 2",
            "types": [
              "sample string 1",
              "sample string 2",
              "sample string 3"
            ]
          },
          {
            "long_name": "sample string 1",
            "short_name": "sample string 2",
            "types": [
              "sample string 1",
              "sample string 2",
              "sample string 3"
            ]
          }
        ],
        "formatted_address": "sample string 1",
        "geometry": {
          "bounds": {
            "northeast": {
              "lat": 1.1,
              "lng": 2.1
            },
            "southwest": {
              "lat": 1.1,
              "lng": 2.1
            }
          },
          "location": {
            "lat": 1.1,
            "lng": 2.1
          },
          "location_type": "sample string 1",
          "viewport": {
            "northeast": {
              "lat": 1.1,
              "lng": 2.1
            },
            "southwest": {
              "lat": 1.1,
              "lng": 2.1
            }
          }
        },
        "partial_match": true,
        "types": [
          "sample string 1",
          "sample string 2",
          "sample string 3"
        ]
      },
      {
        "address_components": [
          {
            "long_name": "sample string 1",
            "short_name": "sample string 2",
            "types": [
              "sample string 1",
              "sample string 2",
              "sample string 3"
            ]
          },
          {
            "long_name": "sample string 1",
            "short_name": "sample string 2",
            "types": [
              "sample string 1",
              "sample string 2",
              "sample string 3"
            ]
          },
          {
            "long_name": "sample string 1",
            "short_name": "sample string 2",
            "types": [
              "sample string 1",
              "sample string 2",
              "sample string 3"
            ]
          }
        ],
        "formatted_address": "sample string 1",
        "geometry": {
          "bounds": {
            "northeast": {
              "lat": 1.1,
              "lng": 2.1
            },
            "southwest": {
              "lat": 1.1,
              "lng": 2.1
            }
          },
          "location": {
            "lat": 1.1,
            "lng": 2.1
          },
          "location_type": "sample string 1",
          "viewport": {
            "northeast": {
              "lat": 1.1,
              "lng": 2.1
            },
            "southwest": {
              "lat": 1.1,
              "lng": 2.1
            }
          }
        },
        "partial_match": true,
        "types": [
          "sample string 1",
          "sample string 2",
          "sample string 3"
        ]
      },
      {
        "address_components": [
          {
            "long_name": "sample string 1",
            "short_name": "sample string 2",
            "types": [
              "sample string 1",
              "sample string 2",
              "sample string 3"
            ]
          },
          {
            "long_name": "sample string 1",
            "short_name": "sample string 2",
            "types": [
              "sample string 1",
              "sample string 2",
              "sample string 3"
            ]
          },
          {
            "long_name": "sample string 1",
            "short_name": "sample string 2",
            "types": [
              "sample string 1",
              "sample string 2",
              "sample string 3"
            ]
          }
        ],
        "formatted_address": "sample string 1",
        "geometry": {
          "bounds": {
            "northeast": {
              "lat": 1.1,
              "lng": 2.1
            },
            "southwest": {
              "lat": 1.1,
              "lng": 2.1
            }
          },
          "location": {
            "lat": 1.1,
            "lng": 2.1
          },
          "location_type": "sample string 1",
          "viewport": {
            "northeast": {
              "lat": 1.1,
              "lng": 2.1
            },
            "southwest": {
              "lat": 1.1,
              "lng": 2.1
            }
          }
        },
        "partial_match": true,
        "types": [
          "sample string 1",
          "sample string 2",
          "sample string 3"
        ]
      }
    ],
    "status": "sample string 1"
  },
  "IsSuccess": false,
  "FailureReason": "sample string 2"
}