Field Description

Field Description

• DataAcquisitionProject
• Study
  • Release
• Survey
• DataSet
  • SubDataSet
• Variable
  • FilterDetails
  • GenerationDetails
  • Distribution
    • Statistics
    • Histogram
    • Missing
    • ValidResponse
• Question
• TechnicalRepresentation
• Instrument
• InstrumentAttachmentMetadata
• RelatedPublication

???

DataAcquisitionProject

Field	Description
id	IDs der Study werden händisch vergeben und aus dieser Tabelle entnommen

Study

Field	Description
id	Ist die gleiche wie die des DataAcquesitionProject (DAP)
dataAcquisitionProjectId	Ist die gleiche wie die der ID
title	Titel der Studie
description	Beschreibung der Studie
institution	Wer hat die Studie durchgeführt?
surveySeries	Zu welcher Erhebungsreihe gehört die Studie?
sponsor	Wer hat die Studie finanziert?
citationHint	Wie soll die Studie zitiert werden?
authors	Wer sind die Autoren?
accessWays	"download-cuf", "download-suf", "remote-desktop-suf", "onsite-suf", "not-accessible"
dataAvailability	DE: "Verfügbar", "In Aufbereitung", "Nicht Verfügbar" ; EN: "Available", "In preparation", "Not available"
surveyDesign	DE: "Querschnitt", "Panel" ; EN: "Cross-Section", "Panel"

Release

Field	Description
version	Hauptversionsnummer. Nebenversionsnummer. Revisionsnummer
doi	Die aktuelle DOI dieser Studie
date	Veröffentlichungsdatum in folgendem Format jjjj-mm-tt(z.B. 2011-12-23)
notes	Notizen was sich verändert hat seit der letzten Version

Survey

Field	Description
id	DAP-id + "-" + "sy" + "Durchnummerierung"
number	"Durchnummerierung"
title	Titel der Erhebung
fieldPeriod	Start- und Endzeitpunkt der Erhebung in folgendem Format jjjj-mm-tt (z.B. 2011-12-23)
population	Kurzbeschreibung der Grundgesamtheit
sample	Kurzbeschreibung der Stichprobe
surveyMethod	??
grossSampleSize	Bruttostichprobengröße (ganzzahlig)
sampleSize	Nettostichprobengröße (ganzzahlig)
responseRate	??

DataSet

Field	Description
id	DAP-id + "-" + "ds" + "Durchnummerierung"
number	"Durchnummerierung"
description	Kurzebeschreibung des Datensatzes
surveyNumbers	Nummern der zum Datensatz gehörenden Erhebungen

SubDataSet

Field	Description
name	Dateiname des "physikalischen" Datensatzes ohne Dateikürzel
description	Label des Datensatzes
type	DE: "Personendatensatz", "Episodendatensatz"; EN: "Personal Record", "Episode Record"
format	DE: "breit", "lang"; EN: "wide", "long"
accessWay	"download-cuf", "download-suf", "remote-desktop-suf", "onsite-suf"
numberOfObservations	??
numberOfAnalyzedVariables	??
dataSetNumber	Nummer des zugehöreigen Datensatzes

Variable

Field	Description
id	DAP-id + "-" + Name der Variable
dataType	DE: "string", "datum" oder"numerisch"; EN: "string", "date" oder "numeric"
scaleLevel	wenn dataType numerisch oder string, DE: "nominal", "ordinal" oder "kontinuierlich", EN: "nominal", "ordinal" oder "continous"; "ordinal" wenn dataType datum ???
name	Name der Variable
annotations	Anmerkungen zur Variablen
label	Variablenlabel
accessWays	"download-cuf", "download-suf", "remote-desktop-suf", "onsite-suf", "not-accessible"
surveyNumbers	Nummern der zugehörigen Surveys
panelIdentifier	??
indexInDataSet	??
dataSetNumber	Nummern der zugehörigen Datensätze
dataSetId	IDs der zugehörigen Datensätze
dataAcquisitionProjectId	IDs der Study werden händisch vergeben und aus dieser Tabelle entnommen

RelatedQuestion

Field	Description
instrumentNumber	Instrument Nummer, der zu der Variable gehörenden Frage.
questionNumber	Nummer, der zu der Variable gehörenden Frage.
relatedQuestionStrings	Text der den Frageinhalt der Variable darstellt. Also Fragetext der dazugehörigen Frage plus evtl. weitere Ausführungen wie beispielsweise der Itemtext (bei Itembatterien) oder die Antworttext (bei Mehrfachnennungen).

FilterDetails

Field	Description
expression	Regel die in der angegeben "Sprache" (.expressionLanguage) beschreibt welche Teilpopulation zu dieser Variable hingefiltert wurde. Hierbei werden auch verschachtelte Filterführung beachtet, zumindest wenn es eine PAPI-befragung war.
description	Verbalisierte Beschreibung des Variablenfilters
expressionLanguage	"Stata" oder "SpEL"

GenerationDetails

Field	Description
description	Beschreibung wie die Variable erzeugt wurde, wenn sie nicht direkt aus dem Fragebogen abgelesen werde kann. Ausführlichere Details wie diese Beschreibung auszusehen hat, bitte hier nachschauen ???
rule	Regel die in der angegeben "Sprache" (.ruleExpressionLanguage) beschreibt wie die Variable erzeugt wurde.t
ruleExpressionLanguage	"Stata" oder "R"

Distribution

Field	Description
totalAbsoluteFrequency	??
totalValidAbsoluteFrequency	??
totalValidRelativeFrequency	??

Statistics

Field	Description
minimum	??
maximum	??
median	??
firstQuartile	??
thirdQuartile	??

Histogram

Field	Description
numberOfBins
start

Missing

Field	Description
code	Mandatory, Unique within one variable
label	Max Length MEDIUM
absoluteFrequency	Mandatory
relativeFrequency	Mandatory
validRelativeFrequency	Mandatory

ValidResponse

Field	Description
label	Max Length LARGE
absoluteFrequency	Mandatory
relativeFrequency	Mandatory
validRelativeFrequency	Mandatory
value	Mandatory, Max Length SMALL, has to be numeric, if variable.dataType=numeric, has to be an ISO 8601 Date, if variable.dataType=date

Question

Field	Description
id	Mandatory, Max Length MEDIUM, Alphanumeric (with German Umlauts and ß) + "-", Pattern (dataAcquisitionProjectId + "-ins" + instrumentNumber + "-" + number) The number can contain dots
number	Mandatory, Max Length SMALL, unique within instrument
questionText	Mandatory, Max Length LARGE
instruction	Max Length LARGE
introduction	Max Length LARGE
type	Mandatory, de = "Single Choice" or "Offen" or "Mehrfachnennung" or "Itembatterie" or "Matrix", en = "Single Choice" or "Open" or "Multiple Choice" or "Item Set" or "Grid"
additionalQuestionText	Max Length X-LARGE
imageType	Mandatory, must be "png"
topic	Max Length LARGE
instrumentNumber	Mandatory

TechnicalRepresentation

Field	Description
type	Mandatory, Max Length SMALL
language	Mandatory, Max Length SMALL
source	Mandatory, Max Length X-LARGE

Instrument

Field	Description
id	Mandatory, Max Length MEDIUM, Alphanumeric (with German Umlauts and ß) + "-", Pattern (DataAcquisitionProjectId + "-" + "ins" + number)
number	Mandatory, unique within dataAcquisitionProject
title	Mandatory, Max Length MEDIUM
description	Mandatory, Max Length MEDIUM
type	Mandatory, one of the following: PAPI, CAPI, CATI, CAWI
surveyNumbers	Mandatory, Min size 1
dataAcquisitionProjectId	Mandatory

InstrumentAttachmentMetadata

Field	Description
instrumentId	Mandatory
instrumentNumber	Mandatory
dataAcquisitionProjectId	Mandatory
type	Mandatory, valid values in german: Fragebogen, Filterdiagramm, Variablenfragebogen, Sonstige. Valid values in english: Questionnaire, Question Flow, Variable Questionnaire, Other
title	Mandatory, Max Length MEDIUM
fileName	Mandatory

RelatedPublication

Field	Description
id	Mandatory, Max Length MEDIUM, no whitespace
sourceReference	Mandatory, Max Length LARGE
publicationAbstract	Max Length X-LARGE
doi	Max Length MEDIUM
sourceLink	valid url
title	Mandatory, Max Length MEDIUM
authors	Mandatory, Max Length LARGE
year	Mandatory, 1960 < year <= current year
abstractSource	Max Length LARGE