dp-xsd.3.1.1.source-code.sdp-schema-doc.html Maven / Gradle / Ivy
XML Schema Documentation
XML Schema Documentation
Printer-friendly Version
XML Instance Representation:
[ Expand All | Collapse All ]
Schema Component Representation:
[ Expand All | Collapse All ]
Table of Contents
-
Schema Document Properties
-
Global Declarations
-
Global Definitions
-
Complex Type: Avsender
-
Complex Type: AvsenderOrganisasjon
-
Complex Type: DokumentPakke
-
Complex Type: EpostVarsel
-
Complex Type: FysiskPostInfo
-
Complex Type: Melding
-
Complex Type: Mottaker
-
Complex Type: Repetisjoner
-
Complex Type: SmsVarsel
-
Complex Type: Varsler
-
Complex Type: Virksomhet
-
Complex Type: norsk-postadresse
-
Complex Type: utenlandsk-postadresse
-
Simple Type: LandkodeOrgnr
-
Simple Type: adresselinje
-
Simple Type: land
-
Simple Type: land-kode
-
Simple Type: norsk-postnummer
-
Simple Type: postmottaker-navn
-
Simple Type: poststed
Schema Document Properties
Target Namespace
http://begrep.difi.no/sdp/schema_v10
Version
1.0
Element and Attribute Namespaces
- Global element and attribute declarations belong to this schema's target namespace.
- By default, local element declarations belong to this schema's target namespace.
- By default, local attribute declarations have no namespace.
Schema Composition
- This schema imports schema(s) from the following namespace(s):
- http://www.w3.org/2001/04/xmlenc# (at w3/xenc-schema.xsd)
- http://begrep.difi.no (at oppslag/oppslagstjeneste-metadata-14-05.xsd)
Declared Namespaces
Prefix
Namespace
Default namespace
http://begrep.difi.no/sdp/schema_v10
xml
http://www.w3.org/XML/1998/namespace
enc
http://www.w3.org/2001/04/xmlenc#
difi
http://begrep.difi.no
xsd
http://www.w3.org/2001/XMLSchema
Schema Component Representation
Global Declarations
Element: melding
Name
melding
Type
Melding
Nillable
no
Abstract
no
XML Instance Representation
<melding>
<avsender> Avsender </avsender> [1]Start Choice [1]
<digitalMottaker> Mottaker </digitalMottaker> [1]<virkningsdato> xsd:date </virkningsdato> [0..1]<aapningskvittering> xsd:boolean </aapningskvittering> [0..1]<sikkerhetsnivaa> xsd:integer (value comes from list: {'3'|'4'}) </sikkerhetsnivaa> [0..1]<ikkeSensitivHoveddokumenttittel> xsd:string (length <= 100) </ikkeSensitivHoveddokumenttittel> [0..1]<varsler> Varsler </varsler> [0..1]<fysiskPostInfo> FysiskPostInfo </fysiskPostInfo> [1]End Choice
<dokumentPakke> DokumentPakke </dokumentPakke> [1]</melding>
Schema Component Representation
Global Definitions
Complex Type: Avsender
Super-types:
None
Sub-types:
None
Name
Avsender
Abstract
no
XML Instance Representation
<...>
<identifier> AvsenderOrganisasjon </identifier> [1]<avsenderId> xsd:string (length <= 100) </avsenderId> [0..1]<fakturaKonto> xsd:string (length <= 20) </fakturaKonto> [0..1]</...>
Schema Component Representation
Complex Type: AvsenderOrganisasjon
Super-types:
xsd:string < LandkodeOrgnr (by restriction) < AvsenderOrganisasjon (by extension)
Sub-types:
None
Name
AvsenderOrganisasjon
Abstract
no
XML Instance Representation
<...
authority="xsd:string (value comes from list: {'iso6523-actorid-upis'}) [0..1]">
LandkodeOrgnr
</...>
Schema Component Representation
Complex Type: DokumentPakke
Super-types:
None
Sub-types:
None
Name
DokumentPakke
Abstract
no
XML Instance Representation
<...>
<encryptedKey> enc:EncryptedKeyType </encryptedKey> [1]</...>
Schema Component Representation
Complex Type: EpostVarsel
Super-types:
None
Sub-types:
None
Name
EpostVarsel
Abstract
no
XML Instance Representation
<...>
<varselTekst> xsd:string (length <= 500) </varselTekst> [1]<repetisjoner> Repetisjoner </repetisjoner> [1]</...>
Schema Component Representation
Complex Type: FysiskPostInfo
Super-types:
None
Sub-types:
None
Name
FysiskPostInfo
Abstract
no
XML Instance Representation
<...>
Start Choice [1]
<norsk-mottakeradresse> norsk-postadresse </norsk-mottakeradresse> [1]<utenlandsk-mottakeradresse> utenlandsk-postadresse </utenlandsk-mottakeradresse> [1]End Choice
<posttype> xsd:string (pattern = A|B) </posttype> [0..1]<retur-postmottaker> postmottaker-navn </retur-postmottaker> [1]<returadresse> norsk-postadresse </returadresse> [1]</...>
Schema Component Representation
Complex Type: Melding
Super-types:
None
Sub-types:
None
Name
Melding
Abstract
no
XML Instance Representation
<...>
<avsender> Avsender </avsender> [1]Start Choice [1]
<digitalMottaker> Mottaker </digitalMottaker> [1]<virkningsdato> xsd:date </virkningsdato> [0..1]<aapningskvittering> xsd:boolean </aapningskvittering> [0..1]<sikkerhetsnivaa> xsd:integer (value comes from list: {'3'|'4'}) </sikkerhetsnivaa> [0..1]<ikkeSensitivHoveddokumenttittel> xsd:string (length <= 100) </ikkeSensitivHoveddokumenttittel> [0..1]<varsler> Varsler </varsler> [0..1]<fysiskPostInfo> FysiskPostInfo </fysiskPostInfo> [1]End Choice
<dokumentPakke> DokumentPakke </dokumentPakke> [1]</...>
Schema Component Representation
Complex Type: Mottaker
Super-types:
None
Sub-types:
None
Name
Mottaker
Abstract
no
XML Instance Representation
Schema Component Representation
Complex Type: Repetisjoner
Super-types:
None
Sub-types:
None
Name
Repetisjoner
Abstract
no
XML Instance Representation
<...>
<dagerEtter> xsd:nonNegativeInteger (value <= 30) </dagerEtter> [1..10]</...>
Schema Component Representation
Complex Type: SmsVarsel
Super-types:
None
Sub-types:
None
Name
SmsVarsel
Abstract
no
XML Instance Representation
<...>
<varselTekst> xsd:string (length <= 160) </varselTekst> [1]<repetisjoner> Repetisjoner </repetisjoner> [1]</...>
Schema Component Representation
Complex Type: Varsler
Super-types:
None
Sub-types:
None
Name
Varsler
Abstract
no
XML Instance Representation
<...>
<epostVarsel> EpostVarsel </epostVarsel> [0..1]<smsVarsel> SmsVarsel </smsVarsel> [0..1]</...>
Schema Component Representation
Complex Type: Virksomhet
Super-types:
None
Sub-types:
None
Name
Virksomhet
Abstract
no
XML Instance Representation
<...>
<sikkerDigitalPostAdresse> difi:SikkerDigitalPostAdresse </sikkerDigitalPostAdresse> [1]</...>
Schema Component Representation
Complex Type: norsk-postadresse
Super-types:
None
Sub-types:
None
Name
norsk-postadresse
Abstract
no
XML Instance Representation
<...>
<adresselinje1> adresselinje </adresselinje1> [0..1]<adresselinje2> adresselinje </adresselinje2> [0..1]<postnummer> norsk-postnummer </postnummer> [1]<poststed> poststed </poststed> [1]</...>
Schema Component Representation
Complex Type: utenlandsk-postadresse
Super-types:
None
Sub-types:
None
Name
utenlandsk-postadresse
Abstract
no
XML Instance Representation
<...>
<adresselinje1> adresselinje </adresselinje1> [1]<adresselinje2> adresselinje </adresselinje2> [0..1]<adresselinje3> adresselinje </adresselinje3> [0..1]<adresselinje4> adresselinje </adresselinje4> [0..1]Start Choice [1]
<land> land </land> [1]<land-kode> land-kode </land-kode> [1]End Choice
</...>
Schema Component Representation
Simple Type: LandkodeOrgnr
Super-types:
xsd:string < LandkodeOrgnr (by restriction)
Sub-types:
- AvsenderOrganisasjon (by extension)
Name
LandkodeOrgnr
Content
- Base XSD Type: string
- pattern = [0-9]{4}:[0-9]{1,20}
Schema Component Representation
Simple Type: adresselinje
Super-types:
xsd:string < adresselinje (by restriction)
Sub-types:
None
Name
adresselinje
Content
- Base XSD Type: string
- length <= 100
Schema Component Representation
Simple Type: land
Super-types:
xsd:string < land (by restriction)
Sub-types:
None
Name
land
Content
- Base XSD Type: string
- length <= 80
Schema Component Representation
Simple Type: land-kode
Super-types:
xsd:string < land-kode (by restriction)
Sub-types:
None
Name
land-kode
Content
- Base XSD Type: string
- length <= 2
Documentation
To-bokstavs landkode ihht ISO 3166-1 alpha-2 standarden.
(http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
Schema Component Representation
Simple Type: norsk-postnummer
Super-types:
xsd:string < norsk-postnummer (by restriction)
Sub-types:
None
Name
norsk-postnummer
Content
- Base XSD Type: string
Schema Component Representation
Simple Type: postmottaker-navn
Super-types:
xsd:string < postmottaker-navn (by restriction)
Sub-types:
None
Name
postmottaker-navn
Content
- Base XSD Type: string
- length <= 130
Schema Component Representation
Simple Type: poststed
Super-types:
xsd:string < poststed (by restriction)
Sub-types:
None
Name
poststed
Content
- Base XSD Type: string
- length <= 80
Schema Component Representation
Legend
Complex Type:
Schema Component Type
AusAddress
Schema Component Name
Super-types:
Address < AusAddress (by extension)
Sub-types:
- QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name
AusAddress
Abstract
no
The table above displays the properties of this schema component.
XML Instance Representation
The XML Instance Representation table above shows the schema component's content as an XML instance.
- The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
- Model group information are shown in gray, e.g. Start Choice ... End Choice.
- For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold.
- If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
- Otherwise, the type of the element/attribute is displayed.
- If the element/attribute's type is in the schema, a link is provided to it.
- For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.
- If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked, e.g. <postcode>.
Schema Component Representation
<complexTypename="AusAddress">
<complexContent>
<extensionbase="Address">
<sequence>
<elementname="state" type="AusStates"/>
<elementname="postcode">
<simpleType>
<restrictionbase="string">
<patternvalue="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attributename="country" type="string" fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
Glossary
Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.
All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.
Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.
Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.
Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.
Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.
Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.
Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.
Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.
Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.
Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.
Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.
Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.
Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).
Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.
Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.
Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.
Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.
Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.