locations

Documentation

Overview

Package locations implements the REST API locations endpoint.

Index

• func GetHandler(c *gin.Context)
• type GetReq
• type GetRes
• type GetResLocation

Functions

func GetHandler

func GetHandler(c *gin.Context)

GetHandler handles HTTP GET requests for locations/ endpoint.

Types

type GetReq

type GetReq struct {
	Lat    float64 `form:"lat" binding:"numeric,required"`
	Long   float64 `form:"long" binding:"numeric,required"`
	Radius float64 `form:"radius" binding:"omitempty,numeric"`
	Limit  int     `form:"limit" binding:"omitempty,numeric"`
}

GetReq represents the HTTP GET request for locations/ endpoint.

type GetRes

type GetRes struct {
	request.Response
	Locations []GetResLocation `json:"locations,omitempty"`
}

GetRes represents the HTTP GET response for locations/ endpoint.

type GetResLocation

type GetResLocation struct {
	Name      string   `json:"name,omitempty"`
	Status    string   `json:"status,omitempty"`
	Hours     string   `json:"hours,omitempty"`
	FoodItems []string `json:"foodItems,omitempty"`
	Address   string   `json:"address,omitempty"`
	Distance  float64  `json:"distance,omitempty"`
	MapLink   string   `json:"mapLink,omitempty"`
}

GetResLocation represents a location for GetRes.Locations slice.