Giter Club home page Giter Club logo

hackathons's Introduction

Homeless Services Hub

API

All API calls will receive responses of the following form:

{
  success: Boolean,
  data: {...}
}

The value of the data field is defined below for each endpoint.

Providers

GET /api/provider/{id?}

If id is null, an array of objects is returned, one for each provider in the database. If id is provided, only one object is returned. Returned objects are of the form:

{
  id: <Number>,
  name: <String>,
}

POST /api/provider/{id}

Used to create of update a provider record. Request must have the following parameters:

{
  name: <String>,
  ...
}

DELETE /api/provider/{id}

Used to delete a provider record.

Branches

GET /api/branch/{id?}

If id is null, an array of objects is returned, one for each branch. If id is provided, only one object is returned. Returned objects are of the form:

{
  id: <Number>,
  name: <String>
}

If id is null, the following query parameters are accepted to filter the results:

  • lat: Latitude of origin
  • lng: Longitude of origin
  • radius: Distance (km) from origin within which to return results
  • services: Type of services to return, comma separated list

POST /api/branch/{id?}

DELETE /api/branch/{id?}

GET    /api/provider/{name?}
POST   /api/provider/{name?}
DELETE /api/provider/{name?}

GET    /api/branch?radius=...&lat=...&lng=...&services=...
GET    /api/branch/{name?}
PUT    /api/branch/{name?}
POST   /api/branch/{name?}
DELETE /api/branch/{name?}

GET    /api/branch/{name?}/address
POST   /api/branch/{name?}/address

GET    /api/branch/{name?}/services
POST   /api/branch/{name?}/services

GET    /api/branch/{name?}/contacts
POST   /api/branch/{name?}/contacts

GET    /api/category/{name?}
POST   /api/category/{name?}

POST   /api/private/sms

Views

GET    /update/{id?}?token=...
GET    /create/{id?}?token=...

User Stories

schema

Database

Schema

schema

hackathons's People

Contributors

eliasmalik avatar jacktierney avatar tas12 avatar watsoalex avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.