Giter Club home page Giter Club logo

checker's Introduction

=============== Spelling Checker

This is an spelling corrector and also provides autocompletion for states, cities and streets.

Use the API


Get suggestions for a state

  • URL

/suggestState/{site}/{state}

  • Method

"GET"

  • URL PARAMETERS

Required:

* site: this is the site id. (MLA)

* state: key word to get suggestions.
  • SUCCESS RESPONSE

Code: 200

This will return a list of suggestions with the following structure.

  [{"name":"stateSuggestion1","hashCode":"658176199"},{"name":"stateSuggestion2","hashCode":"658176198"}]

Get suggestions for a city

  • URL

/suggestCity/{site}/{stateHash}/{city}

  • Method

"GET"

  • URL PARAMETERS

Required:

* site: this is the site id. (MLA)

* stateHash: hash that represents the state where to get suggestions for the city.

* city: key word to get suggestions.
  • SUCCESS RESPONSE

Code: 200

This will return a list of suggestions with the following structure.

  [{"name":"cityCuggestion1","hashCode":"1818586562"},{"name":"cityCuggestion2","hashCode":"1818586563"}]

Get suggestions for a street

  • URL

/suggestStreet/{site}/{stateHash}/{cityHash}/{street}

  • Method

"GET"

  • URL PARAMETERS

Required:

* site: this is the site id. (MLA)

* stateHash: hash that represents the state where to get suggestions for the city.

* cityHash: hash that represents the city where to get suggestions for the street.

* street: key word to get suggestions.
  • SUCCESS RESPONSE

Code: 200

This will return a list of suggestions with the following structure.

  [{"name":"streetCuggestion1"},{"name":"streetCuggestion2"}]

  • NOTES

If the collection where you are trying to get states, cities or streets does not existit will retrun an empty list. The same as if it doesn't have any object.

  • Questions?

Ask [email protected]

Pull requests are welcome

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.