Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zepson-tech/mikoa-docs

Welcome to mikoa API documentation, the API is prepared to help make it easy fetch any region, districts,wards and streets. We are creating an online portal where users can help fill in missing data and it will be reflected after aproval by the moderation Team.
https://github.com/zepson-tech/mikoa-docs

mikoa tanzania tanzania-locations tanzania-regions-package

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/zepson-tech/mikoa-docs
Owner: Zepson-Tech
License: mit
Created: 2021-11-07T18:45:06.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2021-11-08T14:48:43.000Z (about 3 years ago)
Last Synced: 2023-03-04T00:47:49.509Z (almost 2 years ago)
Topics: mikoa, tanzania, tanzania-locations, tanzania-regions-package
Homepage: https://mikoa.kitivopoint.com/
Size: 13.7 KB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# TANZANIA MIKOA API

Welcome to mikoa API documentation, the API is prepared to help make it easy fetch any region,
districts,wards and streets.
We are creating an online portal where users can help fill in missing data and it will be reflected after aproval by the moderation Team.

## Acknowledgements

- [Zepson Technologies](http://zepson.co.tz/)

- [Alpha Olomi](https://github.com/alphaolomi)
- [Jordan Kelebu](https://github.com/Kalebu)

## Authors

- [@Zepson Technologies](https://github.com/Zepson-Technologies)
- [@pro-cms](https://github.com/pro-cms)

## API Reference

### BASE URL

```
BASE URL: https://mikoa.kitivopoint.com

```

#### Get all regions

```shell
GET /api/v1/regions
```

##### sample response

```json
[
{
"id": 1,
"name": "Shinyanga",
"code": "37",
"created_at": "2021-11-07T15:18:52.000000Z",
"updated_at": "2021-11-07T15:18:52.000000Z"
},
{
"id": 2,
"name": "Mara",
"code": "31",
"created_at": "2021-11-07T15:19:00.000000Z",
"updated_at": "2021-11-07T15:19:00.000000Z"
}

```

#### Get All Districts

```shell
GET /api/v1/districts
```
#### sample response

```json
[
{
"name": "Butiama",
"code": "312"
},
{
"name": "Rorya",
"code": "313"
}: "372"

```

#### Get all Wards

```shell
GET /api/v1/wards
```
#### sample response

```json
[
{
"name": "Mjini",
"code": 35
},
{
"name": "Kambarage",
"code": 12
}
]
```

#### Get All Streets

```shell
GET /api/v1/Streets
```
#### sample response

```json

{
"name":"Bugayambelele magharibi",
"code":"NULL"
}

```
#### filter district by regions

```shell
GET /api/v1/filter_districts_by_region
```

#### Sample response
```json
{
"id": 151,
"name": "Dodoma\ncbd",
"code": "411",
"region_id": 26,
"created_at": "2021-11-07T15:21:33.000000Z",
"updated_at": "2021-11-07T15:21:33.000000Z"
},
{
"id": 152,
"name": "Dodoma",
"code": "412",
"region_id": 26,
"created_at": "2021-11-07T15:21:33.000000Z",
"updated_at": "2021-11-07T15:21:33.000000Z"
}
```

#### filter ward by district

```shell
GET /api/v1/filter_wards_by_district
```

#### Sample response
```json
{
"id": 479,
"name": "Machame mashariki",
"code": 87,
"district_id": 19,
"created_at": "2021-11-07T15:19:11.000000Z",
"updated_at": "2021-11-07T15:19:11.000000Z"
},
{
"id": 480,
"name": "Machame narumu",
"code": 23,
"district_id": 19,
"created_at": "2021-11-07T15:19:11.000000Z",
"updated_at": "2021-11-07T15:19:11.000000Z"
}
```

#### filter Street by ward

```shell
GET /api/v1/filter_streets_by_ward
```

#### Sample response
```json
{
"id": 7221,
"name": "Kibaoni",
"code": 54,
"ward_id": 490,
"created_at": "2021-11-07T15:19:11.000000Z",
"updated_at": "2021-11-07T15:19:11.000000Z"
},
{
"id": 7222,
"name": "Bomani",
"code": 24,
"ward_id": 490,
"created_at": "2021-11-07T15:19:11.000000Z",
"updated_at": "2021-11-07T15:19:11.000000Z"
}
```

#### Get All regions with district

```shell
GET /api/v1/regions_with_districts
```

#### Sample response
```json
[
{
"id": 1,
"name": "Shinyanga",
"code": "37",
"created_at": "2021-11-07T15:18:52.000000Z",
"updated_at": "2021-11-07T15:18:52.000000Z",
"districts": [
{
"id": 1,
"name": "Shinyanga\ncbd",
"code": "371",
"region_id": 1,
"created_at": "2021-11-07T15:18:52.000000Z",
"updated_at": "2021-11-07T15:18:52.000000Z"
},
{
"id": 2,
"name": "Shinyanga",
"code": "372",
"region_id": 1,
"created_at": "2021-11-07T15:18:53.000000Z",
"updated_at": "2021-11-07T15:18:53.000000Z"
}

```

#### Get All district with ward

```shell
GET /api/v1/districts_with_wards
```

#### Sample response
```json
[
{
"id": 1,
"name": "Shinyanga\ncbd",
"code": "371",
"region_id": 1,
"created_at": "2021-11-07T15:18:52.000000Z",
"updated_at": "2021-11-07T15:18:52.000000Z",
"wards": [
{
"id": 1,
"name": "Mjini",
"code": 87,
"district_id": 1,
"created_at": "2021-11-07T15:18:52.000000Z",
"updated_at": "2021-11-07T15:18:52.000000Z"
},
{
"id": 2,
"name": "Kambarage",
"code": 855,
"district_id": 1,
"created_at": "2021-11-07T15:18:52.000000Z",
"updated_at": "2021-11-07T15:18:52.000000Z"
}

```

#### Get All ward with Street

```shell
GET /api/v1/wards_with_streets
```

#### Get total Regions

```shell
GET /api/v1/total_regions
```
#### sample response

```json
{
"total": 158
}
```

#### Get total Districts

```shell
GET /api/v1/total_districts
```
#### sample response

```json
{
"total": 3321
}
```

#### Get total Wards

```shell
GET /api/v1/total_wards
```

#### Get total Street

```shell
GET /api/v1/total_streets
```

#### total district by region

```shell
GET /api/v1/total_districts_by_region
```

#### total ward by district

```shell
GET /api/v1/total_wards_by_district
```

#### total street by ward

```shell
GET /api/v1/total_streets_by_ward
```