Coordinates Validator API

Description

Validate a set of coordinates. For more information about the coordinate system and its restrictions, see this Wikipedia Article.

Endpoint

> GET https://api.jsonrepo.com/v1/compute/validator/coordinates

Headers

Field Description
api_key Required Your API Key

Parameters

Field Type Description
lat Float Required Coordinate latitude value ex. 27.9881
Precision: 14 Digits total
lon Float Required Coordinate longitude value ex. 86.9250
Precision: 14 Digits total

Response

A successful request will result in a populated payload field with the expected output.

A failed request will result in an error output as detailed in Error Rules. If the endpoint validation fails due to missing, badly formatted or invalid parameters, the endpoint will return HTTP code 400 along with a message detailing the error.

See the examples section for more information.

Request 1: Valid coordinates

  • Curl
// Validate a set of coordinates

curl -G \
https://api.jsonrepo.com/v1/compute/validator/coordinates \
-H "api_key: {YOUR_API_KEY_HERE}" \
--data-urlencode "lat=27.9881" \
--data-urlencode "lon=86.9250" 

Success Response

{
    "http_code": 200,
    "http_message": "Ok",
    "message": "Succeful validation",
    "payload": {
        "coordinates": {
            "latitude": "27.98810000",
            "longitude": "86.92500000",
            "is_valid": true
        }
    }
}

Request 2: Invalid coordinates

  • Curl
// Validate a set of coordinates

curl -G \
https://api.jsonrepo.com/v1/compute/validator/coordinates \
-H "api_key: {YOUR_API_KEY_HERE}" \
--data-urlencode "lat=27.9881" \
--data-urlencode "lon=186.9250" 

Success Response

{
    "http_code": 200,
    "http_message": "Ok",
    "message": "Successful execution",
    "payload": {
        "coordinates": {
            "latitude": "27.98810000",
            "longitude": "186.92500000",
            "is_valid": false
        }
    }
}

Error Response Examples

// Request with missing `lat` parameter

{
    "http_code": 400,
    "http_message": "Bad Request",
    "message": "Malformed request: `lat` parameter was not provided or does not contain a valid float value (max length 14).",
    "payload": []
}