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	Mandatory, Max Length SMALL, Alphanumeric (with German Umlauts and ß)

Study

Field	Description
id	Mandatory, Max Length SMALL, Alphanumeric (with German Umlauts and ß)
dataAcquisitionProjectId	Mandatory, equal to id
title	Mandatory, Max Length LARGE
description	Mandatory, Max Length LARGE
institution	Mandatory, Max Length MEDIUM
surveySeries	Max Length MEDIUM
sponsor	Max Length MEDIUM
citationHint	Max Length LARGE
authors	Max Length MEDIUM
accessWays	Mandatory, Must only contain "download-cuf", "download-suf", "remote-desktop-suf", "onsite-suf", "not-accessible"
dataAvailability	Mandatory, Must only contain DE: "Verfügbar", "In Aufbereitung", "Nicht Verfügbar" and for EN: "Available", "In preparation", "Not available"
surveyDesign	Mandatory, Must only contain DE: "Querschnitt", "Panel" and for EN: "Cross-Section", "Panel"

Release

Field	Description
version	Mandatory, Max Length SMALL, Numeric + "."
doi	Max Length MEDIUM
date	Mandatory
notes	Max Length LARGE

Survey

Field	Description
id	Mandatory, Max Length MEDIUM, Alphanumeric (with German Umlauts and ß) + "-", Pattern (DataAcquisitionProjectId + "-" + "sy" + survey.number)
number	Mandatory, unique within dataAcquisitionProject
title	Max Length MEDIUM
fieldPeriod	Mandatory, start before end, Date Format is yyyy-MM-dd (e.g. 2011-12-23)
population	Mandatory, Max Length LARGE
sample	Mandatory, Max Length LARGE
surveyMethod	Mandatory, Max Length MEDIUM
grossSampleSize	Mandatory
sampleSize	Mandatory
responseRate	Mandatory

DataSet

Field	Description
id	Mandatory, Max Length MEDIUM, Alphanumeric (with German Umlauts and ß) + "-", Pattern (dataAcquisitionProjectId + "-" + "ds" + dataSet.number)
number	Mandatory, unique within dataAcquisitionProject
description	Max Length LARGE
surveyNumbers	Mandatory, Min Size 1
subDataSets	Mandatory, Min Size 1, subDataSets.accessway has to unique within dataSet
type	Mandatory, de = "Personendatensatz", "Episodendatensatz", en = "Personal Record", "Episode Record"
format	de = "breit", "lang", en = "wide", "long"

SubDataSet

Field	Description
name	Mandatory, Max Length SMALL
description	Mandatory, Max Length MEDIUM
accessWay	Mandatory, Must only contain one of "download-cuf", "download-suf", "remote-desktop-suf", "onsite-suf"

Variable

Field	Description
id	Mandatory, Max Length MEDIUM, Alphanumeric (with German Umlauts and ß) + "-" + "_", Pattern (DataAcquisitionProjectId + "-" + "ds" + variable.dataSetNumber + "-" + variable name)
dataType	Mandatory, de = "string", "datum" or "numerisch", en = "string", "date" or "numeric"
scaleLevel	Mandatory if dataType is numeric or date, de = "nominal" or "ordinal" or "kontinuierlich", en = "nominal" or "ordinal" or "continous", must "ordinal" on a date data type
name	Mandatory, Max Length SMALL, Unique within data set, Alphanumeric (english) + "_" and must not start with a number
annotations	Max Length LARGE
label	Max Length Medium, either de or en must be present
accessWays	Mandatory, Min Size 1, Must only contain "download-cuf", "download-suf", "remote-desktop-suf", "onsite-suf", "not-accessible"
surveyNumbers	Mandatory, Min Size 1
panelIdentifier	Max Length MEDIUM, Alphanumeric (with German Umlauts and ß) + "-" + "_", Pattern (DataAcquisitionProjectId + "-" + "ds" + "dataSetNumber" + "-" + string)
indexInDataSet	Mandatory, unique within data set
dataSetNumber	Mandatory
dataSetId	Mandatory
dataAcquisitionProjectId	Mandatory

RelatedQuestion

Field	Description
instrumentNumber	Mandatory
questionNumber	Mandatory, Max Length SMALL
relatedQuestionStrings	Max Length LARGE

FilterDetails

Field	Description
expression	Mandatory, Max Length MEDIUM
description	Max Length LARGE
expressionLanguage	Mandatory, either "Stata" or "SpEL"

GenerationDetails

Field	Description
description	Max Length X-LARGE
rule	Mandatory, if there is a ruleExpressionLanguage, max Length LARGE, either rule or description(.de or .en) must be set or all can be set
ruleExpressionLanguage	Mandatory, if there is a rule, either "Stata" or "R"

Distribution

Field	Description
totalAbsoluteFrequency	Mandatory
totalValidAbsoluteFrequency	Mandatory
totalValidRelativeFrequency	Mandatory

Statistics

Field	Description
minimum	Max Length SMALL, has to be numeric, if variable.dataType=numeric, has to be an ISO 8601 Date, if variable.dataType=date
minimum	Max Length SMALL, has to be numeric, if variable.dataType=numeric, has to be an ISO 8601 Date, if variable.dataType=date
median	Max Length SMALL, has to be numeric, if variable.dataType=numeric, has to be an ISO 8601 Date, if variable.dataType=date
firstQuartile	Max Length SMALL, has to be numeric, if variable.dataType=numeric, has to be an ISO 8601 Date, if variable.dataType=date
thirdQuartile	Max Length SMALL, has to be numeric, if variable.dataType=numeric, has to be an ISO 8601 Date, if variable.dataType=date

Histogram

No validation rules are applied apart from the fact that each attribute must be a number.

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