models

package

Go to main page

Versions in this module

v1

v1.102.0

Mar 6, 2026

v1.101.1

Feb 24, 2026

v1.101.0

Feb 19, 2026

v1.100.0

Feb 11, 2026

Changes in this version

type AuditEvent

+ Edition *Edition

+ Metadata *Metadata

v1.99.0

Feb 9, 2026

v1.98.0

Feb 3, 2026

Changes in this version

+ type Action string

+ const ActionCreate

+ const ActionDelete

+ const ActionRead

+ const ActionUpdate

+ type AuditEvent struct

+ Action Action

+ CreatedAt time.Time

+ Dataset *Dataset

+ RequestedBy RequestedBy

+ Resource string

+ Version *Version

+ func NewAuditEvent(requestedBy RequestedBy, action Action, resource string, dataset *Dataset, ...) (*AuditEvent, error)

+ type RequestedBy struct

+ Email string

+ ID string

v1.97.0

Feb 3, 2026

v1.96.0

Jan 15, 2026

v1.95.0

Jan 15, 2026

v1.94.0

Jan 13, 2026

Changes in this version

+ const ErrNoSpacesAllowedError

type QualityDesignation

+ const QualityDesignationNoAccreditation

v1.93.0

Dec 16, 2025

v1.92.1

Dec 15, 2025

v1.92.0

Dec 12, 2025

Changes in this version

+ const ErrEditionAlreadyExists

+ const ErrEditionAlreadyExistsDescription

+ const ErrEditionTitleAlreadyExists

+ const ErrEditionTitleAlreadyExistsDescription

v1.91.0

Nov 20, 2025

v1.90.0

Nov 6, 2025

v1.89.0

Nov 5, 2025

v1.88.0

Oct 28, 2025

Changes in this version

+ const ErrEditionNotFound

+ const ErrEditionNotFoundDescription

+ const ErrInvalidQueryParameterDescription

+ const ErrTypeNotStaticDescription

+ const ErrUnpublishedVersionAlreadyExistsDescription

v1.87.0

Oct 16, 2025

Changes in this version

type DatasetEdition

+ Description string

type Metadata

+ State string

v1.86.0

Sep 12, 2025

v1.85.0

Sep 5, 2025

v1.84.0

Aug 29, 2025

v1.83.0

Aug 8, 2025

v1.82.1

Jul 17, 2025

Changes in this version

+ const ErrInvalidTypeError

v1.82.0

Jul 10, 2025

Changes in this version

+ const ErrInvalidQueryParameter

+ const ErrInvalidType

+ type DatasetEdition struct

+ DatasetID string

+ Edition string

+ EditionTitle string

+ LatestVersion LinkObject

+ ReleaseDate string

+ State string

+ Title string

v1.81.2

Jun 16, 2025

Changes in this version

+ const ApprovedState

+ var ErrVersionStateDatasetTypeInvalid = errors.New("incorrect state for dataset type")

v1.81.1

Jun 19, 2025

v1.81.0

Jun 5, 2025

Changes in this version

+ const BodyCloseError

+ const BodyClosedFailedDescription

+ const BodyReadError

+ const BodyReadFailedDescription

+ const ErrDatasetNotFound

+ const ErrDatasetNotFoundDescription

+ const ErrMissingParameters

+ const ErrMissingParametersDescription

+ const ErrVersionAlreadyExists

+ const ErrVersionAlreadyExistsDescription

+ const ErrorMarshalFailedDescription

+ const ErrorUnmarshalFailedDescription

+ const InternalError

+ const InternalErrorDescription

+ const JSONMarshalError

+ const JSONUnmarshalError

+ const MissingConfigDescription

+ const MissingConfigError

+ const NotFoundError

+ const NotImplementedDescription

+ const NotImplementedError

+ const UnknownRequestTypeError

+ const WriteResponseError

+ const WriteResponseFailedDescription

+ type Error struct

+ Cause error

+ Code string

+ Description string

+ func NewError(ctx context.Context, cause error, code, description string) Error

+ func NewValidationError(ctx context.Context, code, description string) Error

+ func (e Error) Error() string

+ type ErrorResponse struct

+ Errors []Error

+ Headers map[string]string

+ Status int

+ func NewErrorResponse(statusCode int, headers map[string]string, errors ...Error) *ErrorResponse

+ type SuccessResponse struct

+ Body []byte

+ Headers map[string]string

+ Status int

+ func NewSuccessResponse(jsonBody []byte, statusCode int, headers map[string]string) *SuccessResponse

v1.80.0

May 15, 2025

v1.79.0

May 15, 2025

Changes in this version

type DownloadList

+ func (dl *DownloadList) ExtensionsMapping() map[*DownloadObject]string

type Metadata

+ func (m Metadata) ToString() string

v1.78.0

Apr 28, 2025

v1.77.0

Apr 25, 2025

v1.76.0

Apr 22, 2025

v1.75.0

Apr 11, 2025

Changes in this version

+ type StateUpdate struct

+ State string

v1.74.0

Apr 8, 2025

v1.73.0

Mar 25, 2025

v1.72.0

Mar 20, 2025

Changes in this version

type Edition

+ EditionTitle string

type Metadata

+ EditionTitle string

type Version

+ EditionTitle string

v1.71.0

Mar 17, 2025

Changes in this version

type Dataset

+ Topics []string

type EditableMetadata

+ Distributions *[]Distribution

+ LastUpdated time.Time

+ QualityDesignation QualityDesignation

+ Topics []string

type Edition

+ Alerts *[]Alert

+ DatasetID string

+ Distributions *[]Distribution

+ ReleaseDate string

+ UsageNotes *[]UsageNote

+ Version int

type Metadata

+ Edition string

+ ID string

+ Type string

v1.70.0

Mar 7, 2025

Changes in this version

+ type Distribution struct

+ ByteSize int64

+ DownloadURL string

+ Format DistributionFormat

+ MediaType DistributionMediaType

+ Title string

+ type DistributionFormat string

+ const DistributionFormatCSDB

+ const DistributionFormatCSV

+ const DistributionFormatCSVWMeta

+ const DistributionFormatSDMX

+ const DistributionFormatXLS

+ const DistributionFormatXLSX

+ func (f *DistributionFormat) IsValid() bool

+ func (f *DistributionFormat) UnmarshalJSON(data []byte) error

+ func (f DistributionFormat) MarshalJSON() ([]byte, error)

+ func (f DistributionFormat) String() string

+ type DistributionMediaType string

+ const DistributionMediaTypeCSDB

+ const DistributionMediaTypeCSV

+ const DistributionMediaTypeCSVWMeta

+ const DistributionMediaTypeSDMX

+ const DistributionMediaTypeXLS

+ const DistributionMediaTypeXLSX

+ func (mt *DistributionMediaType) IsValid() bool

+ func (mt *DistributionMediaType) UnmarshalJSON(data []byte) error

+ func (mt DistributionMediaType) MarshalJSON() ([]byte, error)

+ func (mt DistributionMediaType) String() string

type QualityDesignation

+ const QualityDesignationAccreditedOfficial

+ const QualityDesignationOfficialInDevelopment

+ func (qd QualityDesignation) String() string

type Version

+ Distributions *[]Distribution

+ QualityDesignation QualityDesignation

v1.69.0

Feb 3, 2025

v1.68.0

Jan 31, 2025

v1.67.0

Jan 27, 2025

Changes in this version

+ type AlertType string

+ const AlertTypeAlert

+ const AlertTypeCorrection

+ func (at *AlertType) UnmarshalJSON(data []byte) error

+ func (at AlertType) IsValid() bool

+ func (at AlertType) MarshalJSON() ([]byte, error)

+ func (at AlertType) String() string

type Dataset

+ Themes []string

type EditableMetadata

+ Themes []string

type Edition

+ QualityDesignation QualityDesignation

type Instance

+ Description string

+ NextRelease string

+ Themes []string

+ Title string

+ type QualityDesignation string

+ const QualityDesignationAccredited

+ const QualityDesignationExperimental

+ const QualityDesignationOfficial

+ func (qd *QualityDesignation) IsValid() bool

+ func (qd *QualityDesignation) UnmarshalJSON(data []byte) error

+ func (qd QualityDesignation) MarshalJSON() ([]byte, error)

v1.66.0

Nov 18, 2024

Changes in this version

type DatasetType

+ const Static

v1.65.0

Nov 13, 2024

v1.64.0

Oct 31, 2024

v1.63.0

Sep 4, 2024

v1.62.0

Feb 12, 2024

v1.61.0

Oct 30, 2023

v1.60.0

Sep 21, 2023

v1.59.0

Aug 17, 2023

v1.58.0

Jun 22, 2023

v1.57.1

Jun 9, 2023

v1.57.0

May 3, 2023

v1.56.1

Apr 25, 2023

v1.56.0

Apr 5, 2023

Changes in this version

type Dataset

+ func (d *Dataset) UpdateMetadata(metadata EditableMetadata)

+ type EditableMetadata struct

+ Alerts *[]Alert

+ CanonicalTopic string

+ Contacts []ContactDetails

+ Description string

+ Dimensions []Dimension

+ Keywords []string

+ LatestChanges *[]LatestChange

+ License string

+ Methodologies []GeneralDetails

+ NationalStatistic *bool

+ NextRelease string

+ Publications []GeneralDetails

+ QMI *GeneralDetails

+ RelatedContent []GeneralDetails

+ RelatedDatasets []GeneralDetails

+ ReleaseDate string

+ ReleaseFrequency string

+ Subtopics []string

+ Survey string

+ Title string

+ UnitOfMeasure string

+ UsageNotes *[]UsageNote

type Version

+ func (v *Version) UpdateMetadata(metadata EditableMetadata)

v1.55.0

Mar 20, 2023

Changes in this version

type Metadata

+ IsBasedOn *IsBasedOn

v1.54.0

Feb 17, 2023

Changes in this version

type Metadata

+ CanonicalTopic string

+ Subtopics []string

v1.53.0

Feb 17, 2023

Changes in this version

type DownloadList

+ XLSX *DownloadObject

v1.52.1

Nov 28, 2022

v1.52.0

Nov 23, 2022

v1.51.0

Nov 11, 2022

Changes in this version

type Instance

+ LowestGeography string

type Version

+ LowestGeography string

v1.50.0

Nov 1, 2022

Changes in this version

type Metadata

+ RelatedContent []GeneralDetails

v1.49.0

Oct 27, 2022

Changes in this version

type Dataset

+ RelatedContent []GeneralDetails

type Dimension

+ QualityStatementText string

+ QualityStatementURL string

v1.48.0

Oct 24, 2022

Changes in this version

type Dataset

+ CanonicalTopic string

+ Subtopics []string

+ Survey string

type DatasetType

+ const CantabularMultivariateTable

v1.46.0

Aug 4, 2022

Changes in this version

type Version

+ IsBasedOn *IsBasedOn

v1.45.0

Jun 27, 2022

v1.44.0

Jun 7, 2022

Changes in this version

type Dimension

+ IsAreaType bool

v1.43.0

Feb 7, 2022

Changes in this version

type DatasetType

+ const CantabularFlexibleTable

v1.42.0

Jan 11, 2022

Changes in this version

+ func ParseAndValidateVersionNumber(ctx context.Context, version string) (int, error)

type Metadata

+ DatasetLinks *DatasetLinks

+ Version int

v1.41.0

Dec 15, 2021

Changes in this version

type Version

+ ETag string

+ func (v *Version) Hash(extraBytes []byte) (string, error)

type VersionLinks

+ func (vl *VersionLinks) DeepCopy() *VersionLinks

v1.40.0

Dec 10, 2021

v1.39.0

Nov 26, 2021

Changes in this version

type Version

+ Type string

v1.38.0

Nov 9, 2021

Changes in this version

type DownloadList

+ TXT *DownloadObject

type Metadata

+ CSVHeader []string

v1.37.0

Sep 28, 2021

Changes in this version

type Metadata

+ AreaType string

+ Classifications string

+ Coverage string

+ Source string

+ TableID string

+ TablePopulation string

+ func CreateCantabularMetaDataDoc(datasetDoc *Dataset, versionDoc *Version, urlBuilder *url.Builder) *Metadata

v1.36.0

Sep 1, 2021

v1.35.0

Aug 24, 2021

v1.34.0

Aug 9, 2021

Changes in this version

type Dataset

+ IsBasedOn *IsBasedOn

type DatasetType

+ const CantabularBlob

+ const CantabularTable

type Dimension

+ NumberOfOptions *int

+ Variable string

type Edition

+ IsBasedOn *IsBasedOn

+ Type string

type Instance

+ ETag string

+ IsBasedOn *IsBasedOn

+ Type string

+ func (i *Instance) Hash(extraBytes []byte) (string, error)

+ type IsBasedOn struct

+ ID string

+ Type string

v1.33.0

Jul 22, 2021

v1.32.0

Jun 30, 2021

v1.31.0

Jun 29, 2021

Changes in this version

+ const FailedState

v1.30.0

Jun 17, 2021

Changes in this version

+ func ValidateVersionNumber(ctx context.Context, version string) (int, error)

v1.29.0

Apr 13, 2021

v1.28.0

Mar 30, 2021

Changes in this version

type CachedDimensionOption

+ Order *int

type DimensionOption

+ Order *int

type Version

+ DatasetID string

v1.27.0

Mar 8, 2021

Changes in this version

+ func CleanDataset(dataset *Dataset) error

v1.26.0

Mar 2, 2021

Changes in this version

type DatasetDimensionResults

+ Count int

+ Limit int

+ Offset int

+ TotalCount int

type DatasetResults

+ Count int

+ Limit int

+ Offset int

+ TotalCount int

type DatasetUpdateResults

+ Count int

+ Limit int

+ Offset int

+ TotalCount int

type EditionResults

+ Count int

+ Limit int

+ Offset int

+ TotalCount int

type EditionUpdateResults

+ Count int

+ Limit int

+ Offset int

+ TotalCount int

type InstanceResults

+ Count int

+ Limit int

+ Offset int

+ TotalCount int

type VersionResults

+ Count int

+ Limit int

+ Offset int

+ TotalCount int

v1.25.0

Dec 29, 2020

Changes in this version

+ func ValidateNomisURL(ctx context.Context, datasetType string, nomisURL string) (string, error)

type Dataset

+ NomisReferenceURL string

+ Type string

+ type DatasetType int

+ const Filterable

+ const Invalid

+ const Nomis

+ func GetDatasetType(datasetType string) (DatasetType, error)

+ func ValidateDatasetType(ctx context.Context, datasetType string) (*DatasetType, error)

+ func (dt DatasetType) String() string

type DimensionOptionResults

+ Count int

+ Limit int

+ Offset int

+ TotalCount int

v1.24.0

Nov 23, 2020

v1.23.0

Nov 2, 2020

Changes in this version

+ func ValidateDataset(ctx context.Context, dataset *Dataset) error

v1.22.0

Sep 29, 2020

v1.21.0

Aug 14, 2020

v1.20.0

May 7, 2020

v1.19.0

Apr 20, 2020

Changes in this version

+ const AssociatedState

+ const CompletedState

+ const CreatedState

+ const DetachedState

+ const EditionConfirmedState

+ const PublishedState

+ const SubmittedState

+ var ErrAssociatedVersionCollectionIDInvalid = errors.New("missing collection_id for association between version and a collection")

+ var ErrEditionLinksInvalid = errors.New("editions links do not exist")

+ var ErrPublishedVersionCollectionIDInvalid = errors.New("unexpected collection_id in published version")

+ var ErrVersionStateInvalid = errors.New(...)

+ func CheckState(docType, state string) error

+ func ValidateImportTask(task GenericTaskDetails) error

+ func ValidateInstanceState(state string) error

+ func ValidateStateFilter(filterList []string) error

+ func ValidateVersion(version *Version) error

+ type Alert struct

+ Date string

+ Description string

+ Type string

+ type BuildHierarchyTask struct

+ DimensionID string

+ type BuildSearchIndexTask struct

+ type CachedDimensionOption struct

+ Code string

+ CodeList string

+ InstanceID string

+ Label string

+ Name string

+ NodeID string

+ Option string

+ type Contact struct

+ Email string

+ ID string

+ LastUpdated time.Time

+ Name string

+ Telephone string

+ func CreateContact(reader io.Reader) (*Contact, error)

+ type ContactDetails struct

+ Email string

+ Name string

+ Telephone string

+ type Dataset struct

+ CollectionID string

+ Contacts []ContactDetails

+ Description string

+ ID string

+ Keywords []string

+ LastUpdated time.Time

+ License string

+ Links *DatasetLinks

+ Methodologies []GeneralDetails

+ NationalStatistic *bool

+ NextRelease string

+ Publications []GeneralDetails

+ Publisher *Publisher

+ QMI *GeneralDetails

+ RelatedDatasets []GeneralDetails

+ ReleaseFrequency string

+ State string

+ Theme string

+ Title string

+ URI string

+ UnitOfMeasure string

+ func CreateDataset(reader io.Reader) (*Dataset, error)

+ type DatasetDimensionResults struct

+ Items []Dimension

+ type DatasetLinks struct

+ AccessRights *LinkObject

+ Editions *LinkObject

+ LatestVersion *LinkObject

+ Self *LinkObject

+ Taxonomy *LinkObject

+ type DatasetResults struct

+ Items []*Dataset

+ type DatasetUpdate struct

+ Current *Dataset

+ ID string

+ Next *Dataset

+ type DatasetUpdateResults struct

+ Items []DatasetUpdate

+ type Dimension struct

+ Description string

+ HRef string

+ ID string

+ Label string

+ LastUpdated time.Time

+ Links DimensionLink

+ Name string

+ type DimensionLink struct

+ CodeList LinkObject

+ Options LinkObject

+ Version LinkObject

+ type DimensionNodeResults struct

+ Items []DimensionOption

+ type DimensionObject struct

+ HRef string

+ ID string

+ Label string

+ type DimensionOption struct

+ InstanceID string

+ Label string

+ LastUpdated time.Time

+ Links DimensionOptionLinks

+ Name string

+ NodeID string

+ Option string

+ type DimensionOptionLinks struct

+ Code LinkObject

+ CodeList LinkObject

+ Version LinkObject

+ type DimensionOptionResults struct

+ Items []PublicDimensionOption

+ type DimensionValues struct

+ Name string

+ Options []string

+ type DownloadList struct

+ CSV *DownloadObject

+ CSVW *DownloadObject

+ XLS *DownloadObject

+ func CreateDownloadList(reader io.Reader) (*DownloadList, error)

+ type DownloadObject struct

+ HRef string

+ Private string

+ Public string

+ Size string

+ type Edition struct

+ Edition string

+ ID string

+ LastUpdated time.Time

+ Links *EditionUpdateLinks

+ State string

+ type EditionResults struct

+ Items []*Edition

+ type EditionUpdate struct

+ Current *Edition

+ ID string

+ Next *Edition

+ func CreateEdition(host, datasetID, edition string) (*EditionUpdate, error)

+ func (ed *EditionUpdate) PublishLinks(ctx context.Context, host string, versionLink *LinkObject) error

+ func (ed *EditionUpdate) UpdateLinks(ctx context.Context, host string) error

+ type EditionUpdateLinks struct

+ Dataset *LinkObject

+ LatestVersion *LinkObject

+ Self *LinkObject

+ Versions *LinkObject

+ type EditionUpdateResults struct

+ Items []*EditionUpdate

+ type Event struct

+ Message string

+ MessageOffset string

+ Time *time.Time

+ Type string

+ func (e *Event) Validate() error

+ type GeneralDetails struct

+ Description string

+ HRef string

+ Title string

+ type GenericTaskDetails struct

+ DimensionName string

+ State string

+ type ImportObservationsTask struct

+ InsertedObservations int64

+ State string

+ type Instance struct

+ Alerts *[]Alert

+ CollectionID string

+ Dimensions []Dimension

+ Downloads *DownloadList

+ Edition string

+ Events *[]Event

+ Headers *[]string

+ ImportTasks *InstanceImportTasks

+ InstanceID string

+ LastUpdated time.Time

+ LatestChanges *[]LatestChange

+ Links *InstanceLinks

+ ReleaseDate string

+ State string

+ Temporal *[]TemporalFrequency

+ TotalObservations *int

+ UniqueTimestamp bson.MongoTimestamp

+ Version int

+ type InstanceImportTasks struct

+ BuildHierarchyTasks []*BuildHierarchyTask

+ BuildSearchIndexTasks []*BuildSearchIndexTask

+ ImportObservations *ImportObservationsTask

+ type InstanceLinks struct

+ Dataset *LinkObject

+ Dimensions *LinkObject

+ Edition *LinkObject

+ Job *LinkObject

+ Self *LinkObject

+ Spatial *LinkObject

+ Version *LinkObject

+ type InstanceResults struct

+ Items []Instance

+ type LatestChange struct

+ Description string

+ Name string

+ Type string

+ type LinkObject struct

+ HRef string

+ ID string

+ type Metadata struct

+ Alerts *[]Alert

+ Contacts []ContactDetails

+ Description string

+ Dimensions []Dimension

+ Distribution []string

+ Downloads *DownloadList

+ Keywords []string

+ LatestChanges *[]LatestChange

+ License string

+ Links *MetadataLinks

+ Methodologies []GeneralDetails

+ NationalStatistic *bool

+ NextRelease string

+ Publications []GeneralDetails

+ Publisher *Publisher

+ QMI *GeneralDetails

+ RelatedDatasets []GeneralDetails

+ ReleaseDate string

+ ReleaseFrequency string

+ Temporal *[]TemporalFrequency

+ Theme string

+ Title string

+ URI string

+ UnitOfMeasure string

+ UsageNotes *[]UsageNote

+ func CreateMetaDataDoc(datasetDoc *Dataset, versionDoc *Version, urlBuilder *url.Builder) *Metadata

+ type MetadataLinks struct

+ AccessRights *LinkObject

+ Self *LinkObject

+ Spatial *LinkObject

+ Version *LinkObject

+ WebsiteVersion *LinkObject

+ type Observation struct

+ Dimensions map[string]*DimensionObject

+ Metadata map[string]string

+ Observation string

+ type ObservationLinks struct

+ DatasetMetadata *LinkObject

+ Self *LinkObject

+ Version *LinkObject

+ type ObservationsDoc struct

+ Dimensions map[string]Option

+ Limit int

+ Links *ObservationLinks

+ Observations []Observation

+ Offset int

+ TotalObservations int

+ UnitOfMeasure string

+ UsageNotes *[]UsageNote

+ func CreateObservationsDoc(rawQuery string, versionDoc *Version, datasetDoc *Dataset, ...) *ObservationsDoc

+ type Option struct

+ LinkObject *LinkObject

+ type PublicDimensionOption struct

+ Label string

+ Links DimensionOptionLinks

+ Name string

+ Option string

+ type Publisher struct

+ HRef string

+ Name string

+ Type string

+ type TemporalFrequency struct

+ EndDate string

+ Frequency string

+ StartDate string

+ type UsageNote struct

+ Note string

+ Title string

+ type Version struct

+ Alerts *[]Alert

+ CollectionID string

+ Dimensions []Dimension

+ Downloads *DownloadList

+ Edition string

+ Headers []string

+ ID string

+ LastUpdated time.Time

+ LatestChanges *[]LatestChange

+ Links *VersionLinks

+ ReleaseDate string

+ State string

+ Temporal *[]TemporalFrequency

+ UsageNotes *[]UsageNote

+ Version int

+ func CreateVersion(reader io.Reader) (*Version, error)

+ type VersionLinks struct

+ Dataset *LinkObject

+ Dimensions *LinkObject

+ Edition *LinkObject

+ Self *LinkObject

+ Spatial *LinkObject

+ Version *LinkObject

+ type VersionResults struct

+ Items []Version

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL