Documentation
¶
Index ¶
- type Area
- type AreaType
- type Category
- type Dimension
- type GetAreaResponse
- type GetAreaTypeParentsRequest
- type GetAreaTypeParentsResponse
- type GetAreaTypesRequest
- type GetAreaTypesResponse
- type GetAreasRequest
- type GetAreasResponse
- type GetBaseVariableRequest
- type GetBaseVariableResponse
- type GetCategorisationsRequest
- type GetCategorisationsResponse
- type GetDimensionsRequest
- type GetDimensionsResponse
- type GetPopulationTypesResponse
- type PaginationResponse
- type PopulationType
- type PopulationTypes
- type QueryParams
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Area ¶ added in v1.3.2
type Area struct {
ID string `json:"id"`
Label string `json:"label"`
AreaType string `json:"area_type"`
}
Area is an area model with ID, Label, and area-type
type AreaType ¶ added in v1.2.0
type AreaType struct {
ID string `json:"id"`
Label string `json:"label"`
TotalCount int `json:"total_count"`
}
AreaType is an area-type model with ID and Label
type Dimension ¶ added in v1.8.0
type Dimension struct {
ID string `json:"id"`
Label string `json:"label"`
TotalCount int `json:"total_count"`
}
Dimension is an area-type model with ID and Label
type GetAreaResponse ¶ added in v1.7.0
type GetAreaResponse struct {
Area Area `json:"area"`
}
GetAreaResponse is the response object for GET /areas
type GetAreaTypeParentsRequest ¶ added in v1.8.0
type GetAreaTypeParentsRequest struct {
QueryParams
PopulationType string
AreaType string
}
type GetAreaTypeParentsResponse ¶ added in v1.3.2
type GetAreaTypeParentsResponse struct {
PaginationResponse
AreaTypes []AreaType `json:"items"`
}
type GetAreaTypesRequest ¶ added in v1.8.0
type GetAreaTypesRequest struct {
QueryParams
PopulationType string
}
type GetAreaTypesResponse ¶ added in v1.2.0
type GetAreaTypesResponse struct {
PaginationResponse
AreaTypes []AreaType `json:"items"`
}
GetAreaTypesResponse is the response object for GET /area-types
type GetAreasRequest ¶ added in v1.2.0
type GetAreasRequest struct {
QueryParams
Category string `schema:"q"`
}
GetAreasRequest defines the schema for the GET /areas query parameter
func (*GetAreasRequest) Valid ¶ added in v1.7.0
func (r *GetAreasRequest) Valid() error
type GetAreasResponse ¶ added in v1.2.0
type GetAreasResponse struct {
PaginationResponse
Areas []Area `json:"items"`
}
GetAreasResponse is the response object for GET /areas
type GetBaseVariableRequest ¶ added in v1.13.0
type GetBaseVariableResponse ¶ added in v1.13.0
type GetCategorisationsRequest ¶ added in v1.9.0
type GetCategorisationsRequest struct {
QueryParams
PopulationType string
Variable string
}
type GetCategorisationsResponse ¶ added in v1.9.0
type GetCategorisationsResponse struct {
PaginationResponse
Items []Category `json:"items"`
}
type GetDimensionsRequest ¶ added in v1.8.0
type GetDimensionsRequest struct {
QueryParams
PopulationType string
SearchText string `schema:"q"`
}
type GetDimensionsResponse ¶ added in v1.8.0
type GetDimensionsResponse struct {
PaginationResponse
Dimensions []Dimension `json:"items"`
}
GetAreaTypesResponse is the response object for GET /dimensions
type GetPopulationTypesResponse ¶ added in v1.2.0
type GetPopulationTypesResponse struct {
PaginationResponse
PopulationTypes
}
type PaginationResponse ¶ added in v1.8.0
type PopulationType ¶
type PopulationType struct {
Name string `json:"name"`
}
type PopulationTypes ¶
type PopulationTypes struct {
Items []PopulationType `json:"items"`
}
func NewPopulationTypes ¶
func NewPopulationTypes(names []string) PopulationTypes
type QueryParams ¶ added in v1.7.0
func (*QueryParams) Valid ¶ added in v1.7.0
func (q *QueryParams) Valid() error
Click to show internal directories.
Click to hide internal directories.