location

Documentation

Index

• type Areas
  • func GetAreas(suburbID int) (Areas, error)
  • func GetAreasWithContext(ctx context.Context, suburbID int) (Areas, error)
• type Cities
  • func GetCities(provinceID int) (Cities, error)
  • func GetCitiesWithContext(ctx context.Context, provinceID int) (Cities, error)
  • func GetOriginCities() (Cities, error)
  • func GetOriginCitiesWithContext(ctx context.Context) (Cities, error)
• type Countries
  • func GetCountries() (Countries, error)
  • func GetCountriesWithContext(ctx context.Context) (Countries, error)
• type Locations
  • func SearchLocation(substring string) (Locations, error)
  • func SearchLocationWithContext(ctx context.Context, substring string) (Locations, error)
• type Provinces
  • func GetProvinces() (Provinces, error)
  • func GetProvincesWithContext(ctx context.Context) (Provinces, error)
• type Suburbs
  • func GetSuburbs(cityID int) (Suburbs, error)
  • func GetSuburbsWithContext(ctx context.Context, cityID int) (Suburbs, error)

Types

type Areas

type Areas struct {
	Status string `json:"status"`
	Data   struct {
		Title   string `json:"title"`
		Content string `json:"content"`
		Rows    []struct {
			ID       int    `json:"id"`
			Name     string `json:"name"`
			Alias    string `json:"alias"`
			PostCode string `json:"postcode"`
		} `json:"rows"`
	} `json:"data"`
}

Areas struct contains response from API GetAreas.

func GetAreas

func GetAreas(suburbID int) (Areas, error)

GetAreas retrieves areas based on submitted suburb ID.

func GetAreasWithContext

func GetAreasWithContext(ctx context.Context, suburbID int) (Areas, error)

GetAreasWithContext retrieves areas based on submitted suburb ID.

type Cities

type Cities struct {
	Status string `json:"status"`
	Data   struct {
		Title   string `json:"title"`
		Content string `json:"content"`
		Rows    []struct {
			ID           int    `json:"id"`
			Name         string `json:"name"`
			ProvinceID   int    `json:"province_id"`
			ProvinceName string `json:"province_name"`
		} `json:"rows"`
	} `json:"data"`
}

Cities struct contains response from API GetCities.

func GetCities

func GetCities(provinceID int) (Cities, error)

GetCities retrieves cities based on province ID.

func GetCitiesWithContext

func GetCitiesWithContext(ctx context.Context, provinceID int) (Cities, error)

GetCitiesWithContext retrieves cities based on province ID with context.

func GetOriginCities

func GetOriginCities() (Cities, error)

GetOriginCities retrieves provinces in which Shipper provides pickup service.

func GetOriginCitiesWithContext

func GetOriginCitiesWithContext(ctx context.Context) (Cities, error)

GetOriginCitiesWithContext retrieves provinces in which Shipper provides pickup service with context.

type Countries

type Countries struct {
	Status string `json:"status"`
	Data   struct {
		Title   string `json:"title"`
		Content string `json:"content"`
		Rows    []struct {
			CountryName string `json:"country_name"`
			CountryID   int    `json:"country_id"`
		} `json:"rows"`
	} `json:"data"`
}

Countries struct contains response from API GetCountries.

func GetCountries

func GetCountries() (Countries, error)

GetCountries retrieves country data in a list.

func GetCountriesWithContext

func GetCountriesWithContext(ctx context.Context) (Countries, error)

GetCountriesWithContext retrieves country data in a list with context.

type Locations

type Locations struct {
	Status string `json:"status"`
	Data   struct {
		Title   string `json:"title"`
		Content string `json:"content"`
		Rows    []struct {
			AreaID       int    `json:"area_id"`
			AreaName     string `json:"area_name"`
			AreaAlias    string `json:"area_alias"`
			CityID       int    `json:"city_id"`
			CityName     string `json:"city_name"`
			Label        string `json:"label"`
			OrderList    int    `json:"order_list"`
			ProvinceID   int    `json:"province_id"`
			ProvinceName string `json:"province_name"`
			SuburbID     int    `json:"suburb_id"`
			SuburbName   string `json:"suburb_name"`
			SuburbAlias  string `json:"suburb_alias"`
			Value        string `json:"value"`
		} `json:"rows"`
	} `json:"data"`
}

Locations struct contains response from API SearchLocations.

func SearchLocation

func SearchLocation(substring string) (Locations, error)

SearchLocation retrieves every area, suburb, and city whose names include the submitted substring (including postcode).

func SearchLocationWithContext

func SearchLocationWithContext(ctx context.Context, substring string) (Locations, error)

SearchLocationWithContext retrieves every area, suburb, and city whose names include the submitted substring (including postcode) with context.

type Provinces

type Provinces struct {
	Status string `json:"status"`
	Data   struct {
		Title   string `json:"title"`
		Content string `json:"content"`
		Rows    []struct {
			ID   int    `json:"id"`
			Name string `json:"name"`
		} `json:"rows"`
	} `json:"data"`
}

Provinces struct contains response from API GetProvinces.

func GetProvinces

func GetProvinces() (Provinces, error)

GetProvinces retrieves all provinces in Indonesia in a list.

func GetProvincesWithContext

func GetProvincesWithContext(ctx context.Context) (Provinces, error)

GetProvincesWithContext retrieves all provinces in Indonesia in a list with context.

type Suburbs

type Suburbs struct {
	Status string `json:"status"`
	Data   struct {
		Title   string `json:"title"`
		Content string `json:"content"`
		Rows    []struct {
			ID    int    `json:"id"`
			Name  string `json:"name"`
			Alias string `json:"alias"`
		} `json:"rows"`
	} `json:"data"`
}

Suburbs struct contains response from API GetSuburbs.

func GetSuburbs

func GetSuburbs(cityID int) (Suburbs, error)

GetSuburbs retrieves suburbs based on submitted city ID.

func GetSuburbsWithContext

func GetSuburbsWithContext(ctx context.Context, cityID int) (Suburbs, error)

GetSuburbsWithContext retrieves suburbs based on submitted city ID with context.