# Locations

## Docs
- [Locations Specification](https://pm0ie6yjrk.apidog.io/doc-431993.md): 
- [Schema](https://pm0ie6yjrk.apidog.io/doc-502584.md): 

## API Docs
- [Find a location](https://pm0ie6yjrk.apidog.io/api-5556860.md): This is our most generic search. It will be `/search` you will pass it a query `?q=<string>` and it will perform an open search on the provider. You should also be able to pass it a `limit=<num>` to the limit the results. It should also be able to receive an optional `&county=<string>`  value to limit results to a known country.
- [Get auto suggest values](https://pm0ie6yjrk.apidog.io/api-5556861.md): Auto suggest is an attempt at suggesting place names, there requests will not pass to our provide and instead will perform a lookup directly on our elastic search instance. We should return the results form elastic verbatim. The endpoint for this search will be `/suggest?q=` 
- [Lookup a postcode](https://pm0ie6yjrk.apidog.io/api-5556862.md): This endpoint will only lookup postcodes, it will be on /postcode it will also receive a query ?q=<string>  and it will search for postcodes only using our postcodes index on elastic. It should returns the results verbatim. 
- [Lookup a known location](https://pm0ie6yjrk.apidog.io/api-5556863.md): This endpoint will receive a location hash and return that location. It will be on the endpoint /location/{location_hash} 
- [Create a batch job](https://pm0ie6yjrk.apidog.io/api-5556864.md): The batch endpoint will take a file hash then fetch and parse that file into locations. Upon receiving the file hash, it will create a job in our jobs table with the status `scheduled`  and return the hash of that job. There will be an additional endpoint to fetch the status of a job and then a further endpoint to fetch the results from a job, this endpoint should be paginated and limited to 500 records per page.
- [Gets the status of a batch job](https://pm0ie6yjrk.apidog.io/api-5556865.md): This requires an Admin JWT
- [Gets the parsed results for a job](https://pm0ie6yjrk.apidog.io/api-5556866.md): This endpoint required an Admin JWT
- [Gets a location from lat, long.](https://pm0ie6yjrk.apidog.io/api-5556867.md): 

## Schemas
- Schemas [Location](https://pm0ie6yjrk.apidog.io/schema-1390594.md): 
- Schemas [Point](https://pm0ie6yjrk.apidog.io/schema-1390595.md): 
- Schemas [Postcode](https://pm0ie6yjrk.apidog.io/schema-1390596.md): 
- Schemas [Job](https://pm0ie6yjrk.apidog.io/schema-1390597.md):