A REST API for Ghana GPS addressing built with Django🐍🐍
# **GH-GPS-DJANGO-REST-API**
*A REST api for Ghana's Global Positioning System (GPS) written with Python Django 🐍🐍*
## **API Usage**
Get GhanaPostGPS Address from PlaceName or GPSName.
## Request
End Point URL:
gh-gps.herokuapp.com
Method: POST
Content-Type: application/json
### Payload
#### When using with a PlaceName
```json
{
"name": "KNUST Guesthouse"
}
```
#### When using with a GPSName
```json
{
"name": "AE-0147-4625"
}
```
## Response
1. When Address exists, it returns an address field which contains a list of Addresses
```json
{
"status": "Address found",
"address": [
{
"Place_Name": "KNUST Guesthouse",
"CenterLatitude": "5.5677456",
"CenterLongitude": "-0.1863609",
"Region": "Greater Accra",
"District": "Korley Klote",
"Area": "RINGWAY ESTATES",
"StreetName": "Nuumo Klotey Street",
"GPSName": "GA0315033",
"PostCode": "GA031",
"PlaceName": "KNUST Guesthouse, GA-031-5033, Korley Klote",
"Street": "KNUST Guesthouse, Nuumo Klotey Street"
}
],
"count": 1
}
```
2. No Address was found
```json
{
"status": "No Address found"
}
```
3. Encounter an error
```json
{
"error": "Request is missing name in the body"
}
```
Get GhanaPostGPS Address from Position (Latitude and Longitude)
## Request
End Point URL:
gh-gps.herokuapp.com
Method: POST
Content-Type: application/json
### Payload
```json
{
"lat": "6.1250",
"long": "-1.94872"
}
```
## Response
1. When Address exists, it returns an address field which contains a list of Addresses
```json
{
"status": "Address found",
"address": [
{
"GPSName": "AV31641332",
"Region": "Ashanti",
"District": "Amansie Central",
"PostCode": "AV3164",
"NLat": 6.12502457351701,
"SLat": 6.12497965404504,
"WLong": -1.94876026156099,
"Elong": -1.94871534579679,
"Area": ".",
"Street": ".[Unknown Street]",
"PlaceName": ""
}
],
"count": 1
}
```
2. No Address was found
```json
{
"status": "No Address found"
}
```
3. Encounter an error
```json
{
"error": "Request …