XML Schema Documentation

Table of Contents

top

Changelog 

		
Date		Version		Author				Changelog
05-01-2015	1.0			r.vander.hoeven		Initial version
top

Schema Document Properties

Target Namespace None
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations have no namespace.
  • By default, local attribute declarations have no namespace.
Documentation Description: Document structure for the TA07 Technical acknowledgement (xml-out)

Declared Namespaces

Prefix Namespace
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
xsd http://www.w3.org/2001/XMLSchema
Schema Component Representation
<schema>
...
</schema>
top

Global Schema Components

Element: StandardBusinessDocument

Name StandardBusinessDocument
Type Locally-defined complex type
Nillable no
Abstract no
Documentation interchange wrapper
XML Instance Representation
<StandardBusinessDocument>
<StandardBusinessDocumentHeader> ... </StandardBusinessDocumentHeader> [1]
<documentContent> ... </documentContent> [1..*]
</StandardBusinessDocument>
Schema Component Representation
<element name="StandardBusinessDocument">
<complexType>
<sequence>
<element ref="documentContent" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
top

Element: technicalResponse

Name technicalResponse
Type Locally-defined complex type
Nillable no
Abstract no
XML Instance Representation
<technicalResponse>
<responseTypeCode> string (value comes from list: {'NA'|'AK'}
'NA':
'AK':) </responseTypeCode> [1]
The type of acknowledgment, coded
Can be NA or AK
<responseTypeReason> string </responseTypeReason> [0..99]
The reason of the acknowledgment.
</technicalResponse>
Schema Component Representation
<element name="technicalResponse">
<complexType>
<sequence>
<element name="responseTypeCode">
<simpleType>
<restriction base="string">
<enumeration value="NA"/>
<enumeration value="AK"/>
</restriction>
</simpleType>
</element>
<element name="responseTypeReason" maxOccurs="99" minOccurs="0">
<simpleType>
<restriction base="string"/>
</simpleType>
</element>
</sequence>
</complexType>
</element>
top

Element: StandardBusinessDocumentHeader

Name StandardBusinessDocumentHeader
Type StandardBusinessDocumentHeader
Nillable no
Abstract no
Documentation start header information
XML Instance Representation
<StandardBusinessDocumentHeader>
<HeaderVersion> 2.2 </HeaderVersion> [1]
Header Version 2.2
<Sender> Partner </Sender> [1]
identifier is fixed value = NLRTMPCS
<Receiver> Partner </Receiver> [1]
ID given by Portbase to identify the company
<DocumentIdentification> DocumentIdentification </DocumentIdentification> [1]
<Manifest> Manifest </Manifest> [0..1]
For future use
<BusinessScope> BusinessScope </BusinessScope> [0..1]
used for test
</StandardBusinessDocumentHeader>
Schema Component Representation
<element name="StandardBusinessDocumentHeader" type="StandardBusinessDocumentHeader"/>
top

Complex Type: StandardBusinessDocumentHeader

Super-types: None
Sub-types: None
Name StandardBusinessDocumentHeader
Abstract no
XML Instance Representation
<...>
<HeaderVersion> 2.2 </HeaderVersion> [1]
Header Version 2.2
<Sender> Partner </Sender> [1]
identifier is fixed value = NLRTMPCS
<Receiver> Partner </Receiver> [1]
ID given by Portbase to identify the company
<DocumentIdentification> DocumentIdentification </DocumentIdentification> [1]
<Manifest> Manifest </Manifest> [0..1]
For future use
<BusinessScope> BusinessScope </BusinessScope> [0..1]
used for test
</...>
Schema Component Representation
<complexType name="StandardBusinessDocumentHeader">
<sequence>
<element name="HeaderVersion" fixed="2.2"/>
<element name="Sender" type="Partner"/>
<element name="Receiver" type="Partner"/>
<element name="DocumentIdentification" type="DocumentIdentification"/>
<element name="Manifest" type="Manifest" minOccurs="0"/>
<element name="BusinessScope" type="BusinessScope" minOccurs="0"/>
</sequence>
</complexType>
top

Complex Type: Partner

Super-types: None
Sub-types: None
Name Partner
Abstract no
XML Instance Representation
<...>
<Identifier> PartnerIdentification </Identifier> [1]
Descriptor with information to identify the sending party.
<ContactInformation> ContactInformation </ContactInformation> [0..*]
Information about the contact for this document
</...>
Schema Component Representation
<complexType name="Partner">
<sequence>
<element name="Identifier" type="PartnerIdentification"/>
<element name="ContactInformation" type="ContactInformation" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
top

Complex Type: PartnerIdentification

Super-types: string < PartnerIdentification (by extension)
Sub-types: None
Name PartnerIdentification
Abstract no
XML Instance Representation
<...
Authority="Portbase [1]">
string
</...>
Schema Component Representation
<complexType name="PartnerIdentification">
<simpleContent>
<extension base="string">
<attribute name="Authority" fixed="Portbase" use="required">
<simpleType>
<restriction base="string">
<maxLength value="35"/>
</restriction>
</simpleType>
</attribute>
</extension>
</simpleContent>
</complexType>
top

Complex Type: ContactInformation

Super-types: None
Sub-types: None
Name ContactInformation
Abstract no
XML Instance Representation
<...>
<Contact> string (length <= 35) </Contact> [0..1]
standard value is Service Desk
<EmailAddress> string (length <= 50) </EmailAddress> [0..1]
Standaard e-mail address form our Portbase Servicedesk
<FaxNumber> string (length <= 35) </FaxNumber> [0..1]
Standard fax number from our ServiceDesk
<TelephoneNumber> string (length <= 35) </TelephoneNumber> [0..1]
Standard phone number from our ServiceDesk
<ContactTypeIdentifier> string (length <= 35) </ContactTypeIdentifier> [0..1]
Role of the contact in this business process
Not Used
</...>
Schema Component Representation
<complexType name="ContactInformation" abstract="false">
<sequence>
<element name="Contact" minOccurs="0">
<simpleType>
<restriction base="string">
<maxLength value="35"/>
</restriction>
</simpleType>
</element>
<element name="EmailAddress" minOccurs="0">
<simpleType>
<restriction base="string">
<maxLength value="50"/>
</restriction>
</simpleType>
</element>
<element name="FaxNumber" minOccurs="0">
<simpleType>
<restriction base="string">
<maxLength value="35"/>
</restriction>
</simpleType>
</element>
<element name="TelephoneNumber" minOccurs="0">
<simpleType>
<restriction base="string">
<maxLength value="35"/>
</restriction>
</simpleType>
</element>
<element name="ContactTypeIdentifier" minOccurs="0">
<simpleType>
<restriction base="string">
<maxLength value="35"/>
</restriction>
</simpleType>
</element>
</sequence>
</complexType>
top

Complex Type: DocumentIdentification

Super-types: None
Sub-types: None
Name DocumentIdentification
Abstract no
XML Instance Representation
<...>
<Standard> standardBusinessDocument.xsd </Standard> [1]
<TypeVersion> string (length <= 35) </TypeVersion> [1]
<InstanceIdentifier> string (length <= 40) </InstanceIdentifier> [1]
<Type> Export shipment status message (out) </Type> [1]
<MultipleType> boolean </MultipleType> [0..1]
<CreationDateAndTime> dateTime </CreationDateAndTime> [1]
Descriptor which contains date and time of SBDH/document creation.
</...>
Schema Component Representation
<complexType name="DocumentIdentification">
<sequence>
<element name="Standard" type="string" fixed="standardBusinessDocument.xsd"/>
<element name="TypeVersion" default="1.0">
<simpleType>
<restriction base="string">
<maxLength value="35"/>
</restriction>
</simpleType>
</element>
<element name="InstanceIdentifier">
<simpleType>
<restriction base="string">
<maxLength value="40"/>
</restriction>
</simpleType>
</element>
<element name="Type" type="string" fixed="Export shipment status message (out)"/>
<element name="MultipleType" type="boolean" default="0" minOccurs="0"/>
<element name="CreationDateAndTime" type="dateTime"/>
</sequence>
</complexType>
top

Complex Type: Manifest

Super-types: None
Sub-types: None
Name Manifest
Abstract no
XML Instance Representation
<...>
<NumberOfItems> integer </NumberOfItems> [1]
<ManifestItem> ManifestItem </ManifestItem> [1..*]
</...>
Schema Component Representation
<complexType name="Manifest">
<sequence>
<element name="NumberOfItems" type="integer"/>
<element name="ManifestItem" type="ManifestItem" maxOccurs="unbounded"/>
</sequence>
</complexType>
top

Complex Type: ManifestItem

Super-types: None
Sub-types: None
Name ManifestItem
Abstract no
XML Instance Representation
<...>
<MimeTypeQualifierCode> MimeTypeQualifier </MimeTypeQualifierCode> [1]
<UniformResourceIdentifier> anyURI </UniformResourceIdentifier> [1]
<Description> string </Description> [0..1]
<LanguageCode> Language </LanguageCode> [0..1]
</...>
Schema Component Representation
<complexType name="ManifestItem">
<sequence>
<element name="MimeTypeQualifierCode" type="MimeTypeQualifier"/>
<element name="UniformResourceIdentifier" type="anyURI"/>
<element name="Description" type="string" minOccurs="0"/>
<element name="LanguageCode" type="Language" minOccurs="0"/>
</sequence>
</complexType>
top

Simple Type: MimeTypeQualifier

Super-types: string < MimeTypeQualifier (by restriction)
Sub-types: None
Name MimeTypeQualifier
Content
  • Base XSD Type: string
Documentation The MIME type as defined by IANA. Please refer to http://www.iana.org/assignments/media-types/ for a list of types.
Schema Component Representation
<simpleType name="MimeTypeQualifier">
<restriction base="string"/>
</simpleType>
top

Simple Type: Language

Super-types: string < Language (by restriction)
Sub-types: None
Name Language
Content
  • Base XSD Type: string
Documentation ISO 639-2; 1998 representation of Language name. Refer to http://www.loc.gov/standards/iso639-2/iso639jac.html to get the latest version of the standard.
Schema Component Representation
<simpleType name="Language">
<restriction base="string"/>
</simpleType>
top

Complex Type: BusinessScope

Super-types: None
Sub-types: None
Name BusinessScope
Abstract no
XML Instance Representation
<...>
<Scope> Scope </Scope> [0..*]
</...>
Schema Component Representation
<complexType name="BusinessScope">
<sequence>
<element name="Scope" type="Scope" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
top

Complex Type: Scope

Super-types: None
Sub-types: None
Name Scope
Abstract no
XML Instance Representation
<...>
<Type> string (value comes from list: {'test'|'production'}
'test':
'production':) </Type> [1]
test indicator
<InstanceIdentifier> string </InstanceIdentifier> [1]
<Identifier> string </Identifier> [0..1]
<ScopeInformation> ... </ScopeInformation> [0..*]
</...>
Schema Component Representation
<complexType name="Scope">
<sequence>
<group ref="ScopeAttributes"/>
<element ref="ScopeInformation" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
top

Model Group: ScopeAttributes

Name ScopeAttributes
XML Instance Representation
<Type> string (value comes from list: {'test'|'production'}
'test':
'production':) </Type> [1]
test indicator
<InstanceIdentifier> string </InstanceIdentifier> [1]
<Identifier> string </Identifier> [0..1]
Schema Component Representation
<group name="ScopeAttributes">
<sequence>
<element name="Type">
<simpleType>
<restriction base="string">
<enumeration value="test"/>
<enumeration value="production"/>
</restriction>
</simpleType>
</element>
<element name="InstanceIdentifier" type="string"/>
<element name="Identifier" type="string" minOccurs="0"/>
</sequence>
</group>
top

Element: ScopeInformation

Name ScopeInformation
Type anyType
Nillable no
Abstract yes
XML Instance Representation
<ScopeInformation> anyType </ScopeInformation>
Schema Component Representation
<element name="ScopeInformation" type="anyType" abstract="true"/>
top

Element: CorrelationInformation

  • This element can be used wherever the following element is referenced:
Name CorrelationInformation
Type CorrelationInformation
Nillable no
Abstract no
XML Instance Representation
<CorrelationInformation>
<RequestingDocumentCreationDateTime> dateTime </RequestingDocumentCreationDateTime> [0..1]
<RequestingDocumentInstanceIdentifier> string </RequestingDocumentInstanceIdentifier> [0..1]
<ExpectedResponseDateTime> dateTime </ExpectedResponseDateTime> [0..1]
</CorrelationInformation>
Schema Component Representation
<element name="CorrelationInformation" type="CorrelationInformation" substitutionGroup="ScopeInformation"/>
top

Complex Type: CorrelationInformation

Super-types: None
Sub-types: None
Name CorrelationInformation
Abstract no
XML Instance Representation
<...>
<RequestingDocumentCreationDateTime> dateTime </RequestingDocumentCreationDateTime> [0..1]
<RequestingDocumentInstanceIdentifier> string </RequestingDocumentInstanceIdentifier> [0..1]
<ExpectedResponseDateTime> dateTime </ExpectedResponseDateTime> [0..1]
</...>
Schema Component Representation
<complexType name="CorrelationInformation">
<sequence>
<element name="RequestingDocumentCreationDateTime" type="dateTime" minOccurs="0"/>
<element name="RequestingDocumentInstanceIdentifier" type="string" minOccurs="0"/>
<element name="ExpectedResponseDateTime" type="dateTime" minOccurs="0"/>
</sequence>
</complexType>
top

Element: BusinessService

  • This element can be used wherever the following element is referenced:
Name BusinessService
Type BusinessService
Nillable no
Abstract no
XML Instance Representation
<BusinessService>
<BusinessServiceName> string </BusinessServiceName> [0..1]
<ServiceTransaction> ServiceTransaction </ServiceTransaction> [0..1]
</BusinessService>
Schema Component Representation
<element name="BusinessService" type="BusinessService" substitutionGroup="ScopeInformation"/>
top

Complex Type: BusinessService

Super-types: None
Sub-types: None
Name BusinessService
Abstract no
XML Instance Representation
<...>
<BusinessServiceName> string </BusinessServiceName> [0..1]
<ServiceTransaction> ServiceTransaction </ServiceTransaction> [0..1]
</...>
Schema Component Representation
<complexType name="BusinessService">
<sequence>
<element name="BusinessServiceName" type="string" minOccurs="0"/>
<element name="ServiceTransaction" type="ServiceTransaction" minOccurs="0"/>
</sequence>
</complexType>
top

Complex Type: ServiceTransaction

Super-types: None
Sub-types: None
Name ServiceTransaction
Abstract no
XML Instance Representation
<...
TypeOf="TypeOfServiceTransaction [0..1]"
IsNonRepudiationRequired="string [0..1]"
IsAuthenticationRequired="string [0..1]"
TimeToPerform="string [0..1]"
TimeToAcknowldedgeReceipt="string [0..1]"
TimeToAcknowldedgeAcceptance="string [0..1]"/>
Schema Component Representation
<complexType name="ServiceTransaction">
<attribute name="TypeOf" type="TypeOfServiceTransaction" use="optional"/>
<attribute name="IsNonRepudiationRequired" type="string"/>
<attribute name="IsAuthenticationRequired" type="string"/>
<attribute name="TimeToPerform" type="string"/>
<attribute name="TimeToAcknowldedgeReceipt" type="string"/>
<attribute name="TimeToAcknowldedgeAcceptance" type="string"/>
</complexType>
top

Simple Type: TypeOfServiceTransaction

Super-types: string < TypeOfServiceTransaction (by restriction)
Sub-types: None
Name TypeOfServiceTransaction
Content
  • Base XSD Type: string
  • value comes from list: {'RequestingServiceTransaction'|'RespondingServiceTransaction'}
    'RequestingServiceTransaction':
    'RespondingServiceTransaction':
Schema Component Representation
<simpleType name="TypeOfServiceTransaction">
<restriction base="string">
<enumeration value="RequestingServiceTransaction"/>
<enumeration value="RespondingServiceTransaction"/>
</restriction>
</simpleType>
top

Element: documentContent

Name documentContent
Type documentContent
Nillable no
Abstract no
XML Instance Representation
<documentContent
totalNumberOfContentBodies="integer [0..1]">
<contentHeader> contentHeader </contentHeader> [1]
<contentBody> [1]
<technicalResponse> ... </technicalResponse> [1]
Start of the Customs document.
</contentBody>
</documentContent>
Schema Component Representation
<element name="documentContent" type="documentContent"/>
top

Complex Type: documentContent

Super-types: None
Sub-types: None
Name documentContent
Abstract no
XML Instance Representation
<...
totalNumberOfContentBodies="integer [0..1]">
<contentHeader> contentHeader </contentHeader> [1]
<contentBody> [1]
<technicalResponse> ... </technicalResponse> [1]
Start of the Customs document.
</contentBody>
</...>
Schema Component Representation
<complexType name="documentContent">
<sequence>
<element name="contentHeader" type="contentHeader"/>
<element name="contentBody">
<complexType>
<sequence>
<element ref="technicalResponse"/>
</sequence>
</complexType>
</element>
</sequence>
<attribute name="totalNumberOfContentBodies" type="integer" use="optional"/>
</complexType>
top

Complex Type: contentHeader

Super-types: None
Sub-types: None
Name contentHeader
Abstract no
XML Instance Representation
<...>
<contentType> Technical acknowledgement (out) </contentType> [1]
<contentVersion> string </contentVersion> [1]
<contentStandard> ECS_exportshipmentstatus.xsd </contentStandard> [1]
link to the XSD scheme of the content on the Port infolink site.
<contentReference> string </contentReference> [1]
<contentAction> response </contentAction> [1]
<previousContentReference> string </previousContentReference> [0..1]
only used when action not equal to original
</...>
Schema Component Representation
<complexType name="contentHeader">
<sequence>
<element name="contentType" type="string" fixed="Technical acknowledgement (out)"/>
<element name="contentVersion" type="string"/>
<element name="contentStandard" type="string" fixed="ECS_exportshipmentstatus.xsd"/>
<element name="contentReference" type="string"/>
<element name="contentAction" fixed="response"/>
<element name="previousContentReference" type="string" minOccurs="0"/>
</sequence>
</complexType>
top

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
<... country="Australia">
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice[1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1]?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

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.)
top

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.

top

Generated by xs3p (old link) . Last modified: