API for writing/retrieving COVID-19 data

API for writing/retrieving COVID-19 data

This API will be utilised by all applications that need to write/retrieve Ethiopia Covid19 data. E.g. covid19.et project will use it to retrieve data for dashboard and write data

Serverless REST API

This example demonstrates how to setup a RESTful Web Services allowing you to create, list, get, update and delete Community. DynamoDB is used to store the data. This is just an example and of course you could use any data storage as a backend.

Structure

This service has a separate directory for all the community operations. For each operation exactly one file exists e.g. handler/delete.js. In each of these files there is exactly one function which is directly attached to module.exports.

The idea behind the communities directory is that in case you want to create a service containing multiple resources e.g. users, notes, comments you could do so in the same service. While this is certainly possible you might consider creating a separate service for each resource. It depends on the use-case and your preference.

Use-cases

API for a Web Application
API for a Mobile Application

Setup

npm install

# To run locally
# ----
# Install MongoDB
brew install mongodb

# Start MongoDB daemon (keep this running)
mongod --dbpath <PROJECT DIRECTORY>mongo-db

# In a new terminal
npm run dev

Debug

In VSCODE: Activity Bar > Run > sls debug OR a shortcut is F5

Deploy

In order to deploy the endpoint simply run

serverless deploy

Testing

npm test

API Documentation https://documenter.getpostman.com/view/370266/SzYW3L6e?version=latest

Auth Flow

client_id = {value}
client_secret = {value}

Ping @Naod on Slack to get the values above

Generate base64 key by using the client_id and client_secret

$ echo -n 'client_id:client_secret' | openssl base64
Node example:
const AUTHORIZATION_KEY = Buffer.from('process.env.CLIENT_ID:process.env.CLIENT_SECRET').toString('base64')

Send a request to the auth endpoint to get an access token:

curl --location --request POST 'https://et-covid20.auth.us-east-2.amazoncognito.com/oauth2/token' \
--header 'Authorization: Basic abc123==' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials'

response body:

{
    "access_token": "long_token_value",
    "expires_in": 3600,
    "token_type": "Bearer"
}

Make a request to the API:

curl --location --request GET 'https://api.ethiopia-covid19.com/gateway/communities' \
--header 'Authorization: Bearer long_string' \
--header 'Content-Type: application/json'

Once you authenticate, use the Access Token as a Bearer authorization using Postman.

In case you expect a lot of traffic fluctuation we recommend to checkout this guide on how to auto scale DynamoDB https://aws.amazon.com/blogs/aws/auto-scale-dynamodb-with-dynamic-dynamodb/

Please note: This API supports the following types:

communities
passengers
medical-facilities
surveillance
community-report
toll-free

Data Structure

Community

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "firstName": "asdfa",
  "lastName": "asdf",
  "age": "5",
  "sex": "Male",
  "language": "",
  "region": "Addis Ababa",
  "subcityOrZone": "",
  "sefer": "",
  "woreda": "",
  "kebele": "",
  "houseNumber": "",
  "phoneNumber": "1231231",
  "latitude": 38.9071923,
  "longitude": -77.0368707,
  "fever": true,
  "cough": true,
  "shortnessOfBreath": true,
  "formStatus": "Incomplete",
  "travelHx": true,
  "haveSex": true,
  "animalMarket": true,
  "healthFacility": false,
  "occupation": "Merchant(Animal)",
  "dataSource": "bot"
  "fatigue": false
  "underlyingConditions": {
    "chronicLungDisease": false,
    "heartDisease": false,
    "liverDisease": false,
    "renalDisease": false,
    "autoimmuneDisease": false,
    "cancer": false,
    "diabetes": false,
    "hiv": false,
    "pregnancy": false,
  },
}

Passengers

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "firstName": "asdfas",
  "middleName": "dasdfas",
  "lastName": "dasdfasd",
  "gender": "Female",
  "dateOfBirth": "0100-01-01",
  "nationality": "Åland Islands",
  "passportNo": "asdfasdfa",
  "travelFrom": "Algeria",
  "phoneNumber": "sdfasdfasdfasdf",
  "hotelName": "Ghion Hotel",
  "flightNumber": "asdfas",
  "seatNumber": "dfasdfasdf",
  "transitFrom": "Albania",
  "fever": true,
  "shortnessOfBreath": true,
  "cough": true,
  "dependents": [
    {
      "firstName": "asdfasdf",
      "middleName": "asdfasd",
      "lastName": "fasdfasd",
      "gender": "Female",
      "dateOfBirth": "",
      "nationality": "Albania",
      "passportNo": "asdfasdf",
      "seatNumber": "asdfasdfasda",
      "fever": true,
      "shortnessOfBreath": true,
      "cough": true,
      "travelFrom": "Algeria",
      "transitFrom": "Albania",
      "phoneNumber": "sdfasdfasdfasdf",
      "flightNumber": "asdfas",
      "selectedLanguage": "English"
    },
    {
      "firstName": "asdfa",
      "middleName": "sdfasdf",
      "lastName": "asdfasdfa",
      "gender": "Female",
      "dateOfBirth": "3333-03-02",
      "nationality": "Åland Islands",
      "passportNo": "asdfasdf",
      "seatNumber": "asdfasdf",
      "fever": true,
      "shortnessOfBreath": true,
      "cough": true,
      "travelFrom": "Algeria",
      "transitFrom": "Albania",
      "phoneNumber": "sdfasdfasdfasdf",
      "flightNumber": "asdfas",
      "selectedLanguage": "English"
    }
  ],
  "otherHotelName": "",
  "email": "[email protected]",
  "language": ""
  "fatigue": false
  "underlyingConditions": {
    "chronicLungDisease": false,
    "heartDisease": false,
    "liverDisease": false,
    "renalDisease": false,
    "autoimmuneDisease": false,
    "cancer": false,
    "diabetes": false,
    "hiv": false,
    "pregnancy": false,
  }, 
  "haveSex": false,
  "animalMarket": false
  "healthFacility": false 
}

Medical Facilities

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "nationality": "string",
  "email": "string",
  "sex": "string",
  "age": 0,
  "region": "string",
  "subcity": "string",
  "zone": "string",
  "woreda": "string",
  "kebele": "string",
  "houseNumber": "string",
  "phoneNumber": "string",
  "occupation": "string",
  "callDate": "2020-03-29T00:52:45.527Z",
  "callerType": "string",
  "fever": true,
  "cough": true,
  "headache": true,
  "runnyNose": true,
  "feelingUnwell": true,
  "shortnessOfBreath": true,
  "bodyPain": true,
  "travelHx": true,
  "haveSex": true,
  "animalMarket": true,
  "healthFacility": true,
  "receiverName": "string",
  "source": "string",
  "formStatus": "string"
  "fatigue": false
  "underlyingConditions": {
    "chronicLungDisease": false,
    "heartDisease": false,
    "liverDisease": false,
    "renalDisease": false,
    "autoimmuneDisease": false,
    "cancer": false,
    "diabetes": false,
    "hiv": false,
    "pregnancy": false,
  },
}

Toll Free

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "age": 26,
  "gender": "Male",
  "reportRegion": {
    "id": 1,
    "name": "string"
  },
  "region": {
    "id": 9,
    "name": "SNNP Regional State",
    "latitude": 9.005401,
    "longitude": 38.763611,
    "description": null,
    "createdAt": "2020-03-29T11:09:10+03:00",
    "updatedAt": "2020-03-29T11:09:10+03:00",
    "deletedAt": null
  },
  "zone": {
    "id": 1,
    "name": "string"
  },
  "woreda": {
    "id": 1,
    "name": "string"
  },
  "city": {
    "id": 1,
    "name": "string"
  },
  "subcity": {
    "id": 1,
    "name": "string"
  },
  "kebele": {
    "id": 1,
    "name": "string"
  },
  "createdBy": {
    "id": 1,
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "email": "[email protected]",
    "phoneNumber": "string",
    "region": {
      "id": 9,
      "name": "SNNP Regional State",
      "latitude": 9.005401,
      "longitude": 38.763611,
      "description": null,
      "createdAt": "2020-03-29T11:09:10+03:00",
      "updatedAt": "2020-03-29T11:09:10+03:00",
      "deletedAt": null
    },
    "role": {
      "id": 1,
      "name": "string"
    },
    "callCenter": {
      "id": 1,
      "name": "string"
    },
    "active": true,
    "emailVerifiedAt": null,
    "createdAt": "2020-03-29T11:09:10+03:00",
    "updatedAt": "2020-03-29T11:09:10+03:00",
    "deletedAt": null
  },
  "phoneNumber": "251911241285",
  "secondPhoneNumber": "string",
  "occupation": null,
  "callerType": null,
  "other": null,
  "reportType": "Sign-Symptom",
  "reportGroup": {
    "id": 1,
    "name": "string"
  },
  "description": null,
  "remark1": null,
  "remark2": null,
  "travelHx": true,
  "haveSex": true,
  "visitedAnimal": true,
  "visitedHf": false,
  "createdAt": "2020-03-29T11:09:10+03:00",
  "updatedAt": "2020-03-29T11:09:10+03:00",
  "deletedAt": null,
  "rumorTypes": []
}

Surveillance

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "nationality": "string",
  "email": "string",
  "sex": "string",
  "age": 0,
  "region": "string",
  "subcity": "string",
  "zone": "string",
  "woreda": "string",
  "kebele": "string",
  "houseNumber": "string",
  "phoneNumber": "string",
  "occupation": "string",
  "callDate": "2020-03-29T00:52:45.527Z",
  "callerType": "string",
  "fever": true,
  "cough": true,
  "headache": true,
  "runnyNose": true,
  "feelingUnwell": true,
  "shortnessOfBreath": true,
  "bodyPain": true,
  "travelHx": true,
  "haveSex": true,
  "animalMarket": true,
  "healthFacility": true,
  "receiverName": "string",
  "source": "string",
  "formStatus": "string"
}

Pagination

using _start and _limit to control response result.

Example: /communities?_start=0&_limit=2

Response body:

{
    "count": 2,
    "result": [
        {
            "_id": "5e84d29c524432000859ad59",
            "firstName": "Aster",
            "lastName": "Haylu",
            "age": 44,
            "sex": "Male",
            "createdAt": "2020-04-01T17:42:52.659Z",
            "updatedAt": "2020-04-01T17:42:52.659Z",
            "__v": 0
        },
        {
            "_id": "5e85630291dd5600082d94f6",
            "firstName": "Aster",
            "lastName": "Haylu",
            "age": 44,
            "sex": "Male",
            "createdAt": "2020-04-02T03:58:58.448Z",
            "updatedAt": "2020-04-02T03:58:58.448Z",
            "__v": 0
        }
    ]
}

Filtering

DocumentDB is MongoDB compatible.

Accept MongoDB query parameters through URI queries.

Aliased query parameters
Blacklisted query parameters
Whitelisted query parameters
Basic operators
- $eq
- $gt
- $gte
- $lt
- $lte
- $ne
- $in
- $nin
- $exists
- $regex
Parse string integers and floats to numbers
Parse string boolean to true/false booleans

operation	query string	query object
equal	`?foo=bar`	`{ foo: "bar" }`
unequal	`?foo=!bar`	`{ foo: { $ne: "bar" }}`
exists	`?foo=`	`{ foo: { $exists: true }}`
not exists	`?foo=!`	`{ foo: { $exists: false }}`
greater than	`?foo=>10`	`{ foo: { $gt: 10 }}`
less than	`?foo=<10`	`{ foo: { $lt: 10 }}`
greater than or equal to	`?foo=>=10`	`{ foo: { $gte: 10 }}`
less than or equal to	`?foo=<=10`	`{ foo: { $lte: 10 }}`
starts with	`?foo=^bar`	`{ foo: { $regex: "^bar", $options: "i" }}`
ends with	`?foo=$bar`	`{ foo: { $regex: "bar$", $options: "i" }}`
contains	`?foo=~bar`	`{ foo: { $regex: "bar", $options: "i" }}`
in array	`?foo[]=bar&foo[]=baz`	`{ foo: { $in: ['bar', 'baz'] }}`
not in array	`?foo[]=!bar&foo[]=!baz`	`{ foo: { $nin: ['bar', 'baz'] }}`

Scaling

AWS Lambda

By default, AWS Lambda limits the total concurrent executions across all functions within a given region to 100. The default limit is a safety limit that protects you from costs due to potential runaway or recursive functions during initial development and testing. To increase this limit above the default, follow the steps in To request a limit increase for concurrent executions.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Naod Yeheyes}
💻

_Abel
💻

_{Nati Abebe}
💻

_{Mike Endale}
💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Name		Name	Last commit message	Last commit date
Latest commit History 127 Commits
.vscode		.vscode
auth		auth
handlers		handlers
helpers		helpers
models		models
test		test
.all-contributorsrc		.all-contributorsrc
.eslintrc.yml		.eslintrc.yml
.gitignore		.gitignore
.nvmrc		.nvmrc
.prettierrc		.prettierrc
LICENSE		LICENSE
README.md		README.md
acrt_api_gateway.png		acrt_api_gateway.png
package-lock.json		package-lock.json
package.json		package.json
serverless.yml		serverless.yml
yarn.lock		yarn.lock

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

API for writing/retrieving COVID-19 data

Serverless REST API

Structure

Use-cases

Setup

Debug

Deploy

Testing

Auth Flow

Data Structure

Community

Passengers

Medical Facilities

Toll Free

Surveillance

Pagination

Filtering

Scaling

AWS Lambda

Contributors ✨

About

Releases

Packages

Contributors 8

Languages

License

africa-covid-19-response-toolkit/api

Folders and files

Latest commit

History

Repository files navigation

API for writing/retrieving COVID-19 data

Serverless REST API

Use-cases

Setup

Debug

Deploy

Testing

Community

Passengers

Medical Facilities

Toll Free

Surveillance

AWS Lambda

Contributors ✨

About

Topics

Resources

License

Stars

Watchers

Forks

Languages