population

Documentation

Index

• type Area
• type AreaType
• type AuthTokens
• type Category
• type Client
  • func NewClient(apiURL string) (*Client, error)
  • func NewWithHealthClient(hcCli *health.Client) (*Client, error)
  • func (c *Client) Checker(ctx context.Context, check *healthcheck.CheckState) error
  • func (c *Client) GetArea(ctx context.Context, input GetAreaInput) (GetAreaResponse, error)
  • func (c *Client) GetAreaTypeParents(ctx context.Context, input GetAreaTypeParentsInput) (GetAreaTypeParentsResponse, error)
  • func (c *Client) GetAreaTypes(ctx context.Context, input GetAreaTypesInput) (GetAreaTypesResponse, error)
  • func (c *Client) GetAreas(ctx context.Context, input GetAreasInput) (GetAreasResponse, error)
  • func (c *Client) GetBaseVariable(ctx context.Context, input GetBaseVariableInput) (GetBaseVariableResponse, error)
  • func (c *Client) GetCategorisations(ctx context.Context, input GetCategorisationsInput) (GetCategorisationsResponse, error)
  • func (c *Client) GetDimensions(ctx context.Context, input GetDimensionsInput) (GetDimensionsResponse, error)
  • func (c *Client) GetParentAreaCount(ctx context.Context, input GetParentAreaCountInput) (int, error)
  • func (c *Client) GetPopulationTypes(ctx context.Context, input GetPopulationTypesInput) (GetPopulationTypesResponse, error)
• type Dimension
• type ErrorResp
  • func (e ErrorResp) Error() string
• type GetAreaInput
• type GetAreaResponse
• type GetAreaTypeParentsInput
• type GetAreaTypeParentsResponse
• type GetAreaTypesInput
• type GetAreaTypesResponse
• type GetAreasInput
• type GetAreasResponse
• type GetBaseVariableInput
• type GetBaseVariableResponse
• type GetCategorisationsInput
• type GetCategorisationsResponse
• type GetDimensionsInput
• type GetDimensionsResponse
• type GetParentAreaCountInput
• type GetPopulationTypesInput
• type GetPopulationTypesResponse
• type PaginationParams
• type PaginationResponse
• type PopulationType

Types

type Area

type Area struct {
	ID       string `json:"id"`
	Label    string `json:"label"`
	AreaType string `json:"area_type"`
}

Area is an area model with ID and Label

type AreaType

type AreaType struct {
	ID              string `json:"id"`
	Label           string `json:"label"`
	Description     string `json:"description"`
	TotalCount      int    `json:"total_count"`
	Hierarchy_Order int    `json:"hierarchy_order"`
}

AreaType is an area type model with ID and Label

type AuthTokens

type AuthTokens struct {
	UserAuthToken    string
	ServiceAuthToken string
}

type Category

type Category struct {
	ID    string `json:"id"`
	Label string `json:"label"`
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a Cantabular Population Types API client

func NewClient

func NewClient(apiURL string) (*Client, error)

NewClient creates a new instance of Client with a given Population Type API URL

func NewWithHealthClient

func NewWithHealthClient(hcCli *health.Client) (*Client, error)

NewWithHealthClient creates a new instance of Client, reusing the URL and Clienter from the provided health check client

func (*Client) Checker

func (c *Client) Checker(ctx context.Context, check *healthcheck.CheckState) error

Checker calls recipe api health endpoint and returns a check object to the caller

func (*Client) GetArea

func (c *Client) GetArea(ctx context.Context, input GetAreaInput) (GetAreaResponse, error)

func (*Client) GetAreaTypeParents

func (c *Client) GetAreaTypeParents(ctx context.Context, input GetAreaTypeParentsInput) (GetAreaTypeParentsResponse, error)

func (*Client) GetAreaTypes

func (c *Client) GetAreaTypes(ctx context.Context, input GetAreaTypesInput) (GetAreaTypesResponse, error)

GetPopulationAreaTypes retrieves the Cantabular area-types associated with a dataset

func (*Client) GetAreas

func (c *Client) GetAreas(ctx context.Context, input GetAreasInput) (GetAreasResponse, error)

func (*Client) GetBaseVariable

func (c *Client) GetBaseVariable(ctx context.Context, input GetBaseVariableInput) (GetBaseVariableResponse, error)

func (*Client) GetCategorisations

func (c *Client) GetCategorisations(ctx context.Context, input GetCategorisationsInput) (GetCategorisationsResponse, error)

func (*Client) GetDimensions

func (c *Client) GetDimensions(ctx context.Context, input GetDimensionsInput) (GetDimensionsResponse, error)

func (*Client) GetParentAreaCount

func (c *Client) GetParentAreaCount(ctx context.Context, input GetParentAreaCountInput) (int, error)

func (*Client) GetPopulationTypes

func (c *Client) GetPopulationTypes(ctx context.Context, input GetPopulationTypesInput) (GetPopulationTypesResponse, error)

type Dimension

type Dimension struct {
	ID          string     `json:"id"`
	Label       string     `json:"label"`
	Description string     `json:"description"`
	Categories  []Category `json:"categories"`
	TotalCount  int        `json:"total_count"`
}

Dimension is an area-type model with ID and Label

type ErrorResp

type ErrorResp struct {
	Errors []string `json:"errors"`
}

ErrorResp represents an error response containing a list of errors

func (ErrorResp) Error

func (e ErrorResp) Error() string

type GetAreaInput

type GetAreaInput struct {
	AuthTokens
	PopulationType string
	AreaType       string
	Area           string
}

type GetAreaResponse

type GetAreaResponse struct {
	Area Area `json:"area"`
}

GetAreasResponse is the response object for GET /areas

type GetAreaTypeParentsInput

type GetAreaTypeParentsInput struct {
	AuthTokens
	PaginationParams
	PopulationType string
	AreaTypeID     string
}

type GetAreaTypeParentsResponse

type GetAreaTypeParentsResponse struct {
	PaginationResponse
	AreaTypes []AreaType `json:"items"`
}

GetAreaTypeParentsResponse is the response object for GET /areas

type GetAreaTypesInput

type GetAreaTypesInput struct {
	AuthTokens
	PaginationParams
	PopulationType string
}

type GetAreaTypesResponse

type GetAreaTypesResponse struct {
	PaginationResponse
	AreaTypes []AreaType `json:"items"`
}

GetAreaTypesResponse is the response object for GET /area-types

type GetAreasInput

type GetAreasInput struct {
	AuthTokens
	PaginationParams
	PopulationType string
	AreaTypeID     string
	Text           string
}

type GetAreasResponse

type GetAreasResponse struct {
	PaginationResponse
	Areas []Area `json:"items"`
}

GetAreasResponse is the response object for GET /areas

type GetBaseVariableInput

type GetBaseVariableInput struct {
	AuthTokens
	PopulationType string
	Variable       string
}

type GetBaseVariableResponse

type GetBaseVariableResponse struct {
	ID    string `json:"id"`
	Label string `json:"label"`
}

type GetCategorisationsInput

type GetCategorisationsInput struct {
	AuthTokens
	PaginationParams
	PopulationType string
	Dimension      string
}

type GetCategorisationsResponse

type GetCategorisationsResponse struct {
	PaginationResponse
	Items []Dimension `json:"items"`
}

type GetDimensionsInput

type GetDimensionsInput struct {
	AuthTokens
	PaginationParams
	PopulationType string
	SearchString   string
}

type GetDimensionsResponse

type GetDimensionsResponse struct {
	PaginationResponse
	Dimensions []Dimension `json:"items"`
}

GetDimensionsResponse is the response object for GetDimensions

type GetParentAreaCountInput

type GetParentAreaCountInput struct {
	AuthTokens
	PopulationType   string
	AreaTypeID       string
	ParentAreaTypeID string
	SVarID           string
	Areas            []string
}

GetParentAreaCountInput holds the required fields for GetParentAreaCount. SVarID stands for Supplentary Variable ID and is required when querying pre-build tables.

type GetPopulationTypesInput

type GetPopulationTypesInput struct {
	AuthTokens
}

type GetPopulationTypesResponse

type GetPopulationTypesResponse struct {
	Items []PopulationType `json:"items"`
}

type PaginationParams

type PaginationParams struct {
	Limit  int `json:"limit"`
	Offset int `json:"offset"`
}

type PaginationResponse

type PaginationResponse struct {
	PaginationParams
	Count      int `json:"count"`
	TotalCount int `json:"total_count"`
}

type PopulationType

type PopulationType struct {
	Name string `json:"name"`
}