ssb_tbmd_apis.operations package¶

ssb_tbmd_apis.operations.operations_datadok module¶

Operations supported by the Datadok TBMD API.

datadok_codelist_by_id(codelist_id)¶

Rutinen skal returnere én kodeliste med alle attributter basert på gitt Id eller urn.

F.eks 228589 urn:ssb:codelist:datadok:228589.

Parameters:: codelist_id (int | str) – Id for the codelist.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

datadok_codelist_by_reference(codelist_ref)¶

Rutinen skal returnere én kodeliste med alle attributter basert på gitt Datadokreferanse for en filvariabel.

F.eks $FOB/person/arkiv/personfil/g2001/spes_reg_type

Parameters:: codelist_ref (str) – The path to check for datadok-files, usually using the dollar-stamme, and without file-extension.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

datadok_codelists()¶

Returnerer en oversikt over hvilke kodelister som finnes i Datadok.

Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

datadok_context_variable_by_id(var_id)¶

Rutinen skal returnere én filvariabel med alle attributter.

navn, beskrivelse, datatype, lengde, startposisjon, antall desimaler, verdiområde, kommentar, kodeliste basert på gitt variabel Id eller urn. F.eks 865507 eller urn:ssb:contextvariable:datadok:865507

Parameters:: var_id (int | str) – The ID of the context variable.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

datadok_context_variable_by_reference(var_ref)¶

Rutinen skal returnere én filvariabel med alle attributter.

navn, beskrivelse, datatype, lengde, startposisjon, antall desimaler, verdiområde, kommentar, kodeliste, basert på gitt datadokreferanse. F.eks. $FOB/person/arkiv/personfil/g2001/spes_reg_type

Parameters:: var_ref (str) – The file path, plus the variable name in the file.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

datadok_file_description_by_id(file_id)¶

Rutinen skal returnere én filbeskrivelse basert på gitt filbeskrivelse Id eller urn.

F.eks 1288400 eller urn:ssb:dataset:datadok:1288400

Parameters:: file_id (int | str) – The id the file.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

datadok_file_description_by_path(file_path)¶

Rutinen skal returnere én filbeskrivelse basert på gitt Datadok sti.

F.eks. $FOB/person/arkiv/personfil/g2001.

Parameters:: file_path (Path) – The path to check for datadok-files, usually using the dollar-stamme, and without file-extension.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

ssb_tbmd_apis.operations.operations_metadb module¶

Operations supported by the MetaDB TBMD API.

metadb_codelist_by_id(codelist_id)¶

Rutinen skal returnere én kodeliste basert på gitt kodeliste Id eller urn.

F.eks 10013 eller urn:ssb:codelist:metadb:10013

Parameters:: codelist_id (int | str) – Id for the codelist.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

metadb_codelists()¶

Rutinen skal returnere en oversikt over hvilke kodelister som finnes i metadb.

Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

metadb_context_variable_by_id(var_id)¶

Rutinen skal returnere én variabel med alle attributter.

Navn, fullt navn, datatype, lengde, desimaler, variabeltype, gyldig fra/til, datoformat, datering, endring, kodeliste og vardokreferanse. Basert på gitt variabel Id eller urn. Variablene må være godkjent for Internett.

F.eks 14739 eller urn:ssb:contextvariable:metadb:14739

Parameters:: var_id (int | str) – Id for the codelist.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

metadb_description_by_id(table_id)¶

Rutinen skal returnere én tabell med alle attributter.

Overtema, subtema, navn, beskrivelse, gyldig fra/til og alle variabler basert på gitt tabell Id eller urn.

Tabellen og variablene må være godkjent for Internett. F.eks tabell id 11518 eller urn:ssb:dataset:metadb:11518

Parameters:: table_id (int | str) – Id for the table.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

metadb_event_history_structure_by_id(project_id)¶

Rutinen skal returnere ett prosjekt med tilhørende overtema, subtema, tabeller og variabler basert på gitt prosjekt Id eller urn.

Gyldige prosjekt Id’er er 1001 og 1004. Gyldige urn’er er urn:ssb:project:metadb:1001 og urn:ssb:project:metadb:1004

Parameters:: project_id (int | str) – Id for the project.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

ssb_tbmd_apis.operations.operations_statbank module¶

Operations supported by the Statbank TBMD API.

statbank_meta_by_table_id(table_id)¶

Returnerer metadata fra tabell i statistikkbanken med gitt tabellid. F.eks 03886.

Parameters:: table_id (str | int) – The id of the table.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

statbank_meta_by_table_name(table_name)¶

Returnerer metadata fra tabell i statistikkbanken med gitt tabellnavn. F.eks Raadyr.

Parameters:: table_name (str) – The name of the table.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

statbank_table_ids_by_concept_variable_id(var_id)¶

Returnerer vardokreferanse og tilhørende tabeller i statistikkbanken til gitt vardok-id. F.eks 1756.

Parameters:: var_id (str) – The id of the concept variable.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

ssb_tbmd_apis.operations.operations_vardok module¶

Operations supported by the Vardok TBMD API.

vardok_codelist_by_id(codelist_id)¶

Rutinen skal returnere én kodeliste med gitt Id eller urn.

F.eks 46 eller urn:ssb:codelist:vardok:46

Parameters:: codelist_id (str | int) – The id of the codelist.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

vardok_codelists()¶

Rutinen skal returnere alle kodelistereferanser i Vardok.

Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

vardok_concept_variable_by_id(var_id)¶

Rutinen skal returnere én variabel med alle attributter.

Opprettet, sist endret, gyldig fra/til, navn, definisjon, statistisk enhet, intern kommentar, ekstern kommentar, sensitivitet, emnekode, kontaktperson, eierseksjon, statistikk, SSB kilde, ekstern kilde, ekstern referanse, stabasreferanse, beregning, id’er for lenkede variabler, datadokreferanser, kodelistereferanse.

Basert på gitt variabel Id eller urn. Variablene må være godkjent for bruk internt. F.eks 123 eller urn:ssb:conceptvariable:vardok:123

Parameters:: var_id (str | int) – The id of the variable.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

vardok_concept_variables_by_approved(internal=False)¶

Rutinen skal returnere alle variablene som er godkjent for bruk eksternt eller internt.

Nøkkelordene ‘internet’ må brukes for eksternt, og ‘internal’ for internt. OBS: Dette tar LANG tid.

Parameters:: internal (bool) – True if getting internal variables, False if external (internet).
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

vardok_concept_variables_by_external_source(var_id)¶

Rutinen skal returnere det samme som GetConceptVariablesById for en gitt ekstern kilde.

Basert på gitt variabel Id eller urn. Variablene må være godkjent for bruk internt. F.eks 123 eller urn:ssb:conceptvariable:vardok:123

Parameters:: var_id (str | int) – The id of the variable.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

vardok_concept_variables_by_internal_source(var_id)¶

Rutinen skal returnere det samme som GetConceptVariablesById for en oppgitt SSB-kilde.

Basert på gitt variabel Id eller urn. Variablene må være godkjent for bruk internt. F.eks 123 eller urn:ssb:conceptvariable:vardok:123

Parameters:: var_id (str | int) – The id of the variable.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

vardok_concept_variables_by_name_def(var_ref)¶

Rutinen skal returnere id og variabeldefinisjon (se 2.1) etter å ha foretatt et fritekstsøk i navn og definisjon på variabel.

Variablene må være godkjent for bruk internt

Parameters:: var_ref (str) – The text to search for.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

vardok_concept_variables_by_owner(section_id)¶

Rutinen skal returnere det samme som GetConceptVariableById for en oppgitt eierseksjon.

Parameters:: section_id (str | int) – The ID of the owning section.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

vardok_concept_variables_by_statistical_unit(statistical_unit)¶

Rutinen skal returnere det samme som GetConceptVariableById for en oppgitt telleenhet.

Parameters:: statistical_unit (str | int) – The ID of the statistical unit.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

vardok_concept_variables_by_subject_area(subject_area)¶

Rutinen skal returnere det samme som GetConceptVariableById for en oppgitt telleenhet.

Parameters:: subject_area (str | int) – The ID of the subject area.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict

vardok_version_by_concept_variable_id(variable_id)¶

Rutinen skal levere alle versjoner av en variabel med alle attributter basert på gitt variabel Id eller urn.

Versjoner av en variabel har samme navn, eier og statistisk enhet, men forskjellige gyldighetsperioder.

F.eks 2007 urn:ssb:conceptvariable:vardok:2007

Parameters:: variable_id (str | int) – The ID of the concept variable.
Returns:: The serialized zeep OrderedDict.
Return type:: OrderedDict