XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace http://standards.open-ip.org/PatentOfferings/20071127
Version 0.1
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
Documentation Open IP Patent Offering Metadata Format. Copyright 2007 Open-IP.org.

Declared Namespaces

Prefix Namespace
Default namespace http://standards.open-ip.org/PatentOfferings/20071127
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
pa info:ofi/fmt:xml:xsd:patent
xsd undefined
Schema Component Representation
<xs:schema targetNamespace="http://standards.open-ip.org/PatentOfferings/20071127" version="0.1" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="info:ofi/fmt:xml:xsd:patent" schemaLocation="http://www.openurl.info/registry/docs/xsd/info:ofi/fmt:xml:xsd:patent"/>
...
</xs:schema>
top

Global Declarations

Element: PatentOffering

Name PatentOffering
Type PatentOfferingType
Nillable no
Abstract no
Documentation Root element for patent offerings in the syndication network.
Diagram
XML Instance Representation
<PatentOffering
schemaVersion="xs:decimal [1] ?">
<OriginatorInfo> OriginatorInfoType </OriginatorInfo> [1] ?
<DocumentInfo> DocumentInfoType </DocumentInfo> [1] ?
<OfferStatus> xs:string (value comes from list: {'open'|'withdrawn'|'closed'}) </OfferStatus> [1] ?
<PatentAsset> PatentAssetType </PatentAsset> [1] ?
<Seller> SellerType </Seller> [1] ?
<MarketingTitle> xs:string (length <= 100) </MarketingTitle> [0..1] ?
<ExecutiveSummary> xs:string </ExecutiveSummary> [0..1] ?
<PortfolioID> xs:string </PortfolioID> [0..1] ?
<CategoryID> xs:string </CategoryID> [0..1] ?
<DealStructure> xs:string </DealStructure> [0..1] ?
<Encumbrances> xs:string </Encumbrances> [0..1] ?
<OfferOrPrice> xs:string </OfferOrPrice> [0..1] ?
<SEOTags> ArrayOfSEOTagsType </SEOTags> [0..1] ?
<MarketingImages> ArrayOfMarketingImagesType </MarketingImages> [0..1] ?
<Attachments> ArrayOfAttachmentsType </Attachments> [0..1] ?
<OriginatorNotes> xs:string </OriginatorNotes> [0..*] ?
</PatentOffering>
Schema Component Representation
<xs:element name="PatentOffering" type="PatentOfferingType"/>
top

Element: SyndicatedMessageEnvelope

Name SyndicatedMessageEnvelope
Type SyndicationMessageEnvelopeType
Nillable no
Abstract no
Diagram
XML Instance Representation
<SyndicatedMessageEnvelope
schemaVersion="xs:decimal [1]">
<TransmissionHeader> TransmissionHeaderType </TransmissionHeader> [1] ?
<SyndicatedPatentOffering> SyndicatedPatentOfferingType </SyndicatedPatentOffering> [0..*] ?
</SyndicatedMessageEnvelope>
Schema Component Representation
<xs:element name="SyndicatedMessageEnvelope" type="SyndicationMessageEnvelopeType"/>
top

Global Definitions

Complex Type: ArrayOfAttachmentsType

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

Complex Type: ArrayOfMarketingImagesType

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

Complex Type: ArrayOfSEOTagsType

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

Complex Type: AttachmentType

Super-types: None
Sub-types: None
Name AttachmentType
Abstract no
Diagram
XML Instance Representation
<...
contentType="xs:string [0..1]">
<AttachmentURL> xs:anyURI </AttachmentURL> [1]
</...>
Schema Component Representation
<xs:complexType name="AttachmentType">
<xs:sequence>
<xs:element name="AttachmentURL" type="xs:anyURI" minOccurs="1"/>
</xs:sequence>
<xs:attribute name="contentType" type="xs:string"/>
</xs:complexType>
top

Complex Type: ConfidentialProspectusType

Super-types: None
Sub-types: None
Name ConfidentialProspectusType
Abstract no
Diagram
XML Instance Representation
<...>
<ProspectusID> xs:string </ProspectusID> [1] ?
<PatentFilingStatus> xs:string (value comes from list: {'notFiled'|'applicationFiled'|'patentIssued'|'other'}) </PatentFilingStatus> [0..1] ?
<JurisdictionCountryCodes> list of: [ xs:string (length = 2) ] </JurisdictionCountryCodes> [0..1] ?
<TypeOfPatent> xs:string (value comes from list: {'utility'|'design'|'plant'|'other'}) </TypeOfPatent> [0..1] ?
<ProvisionalStatus> xs:string (value comes from list: {'provisional'|'nonProvisional'}) </ProvisionalStatus> [0..1] ?
</...>
Schema Component Representation
<xs:complexType name="ConfidentialProspectusType">
<xs:sequence>
<xs:element name="ProspectusID" type="xs:string"/>
<xs:element name="PatentFilingStatus" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="notFiled"/>
<xs:enumeration value="applicationFiled"/>
<xs:enumeration value="patentIssued"/>
<xs:enumeration value="other"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="JurisdictionCountryCodes" minOccurs="0">
<xs:simpleType>
<xs:list>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:length value="2"/>
</xs:restriction>
</xs:simpleType>
</xs:list>
</xs:simpleType>
</xs:element>
<xs:element name="TypeOfPatent" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="utility"/>
<xs:enumeration value="design"/>
<xs:enumeration value="plant"/>
<xs:enumeration value="other"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="ProvisionalStatus" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="provisional"/>
<xs:enumeration value="nonProvisional"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
top

Complex Type: DocumentInfoType

Super-types: None
Sub-types: None
Name DocumentInfoType
Abstract no
Diagram
XML Instance Representation
<...>
<RevisionDateTime> xs:dateTime </RevisionDateTime> [1] ?
<RevisionNumber> xs:positiveInteger </RevisionNumber> [0..1] ?
<AuthorName> xs:string </AuthorName> [0..1] ?
<InternalFileID> xs:string </InternalFileID> [0..1] ?
</...>
Schema Component Representation
<xs:complexType name="DocumentInfoType">
<xs:sequence>
<xs:element name="RevisionDateTime" type="xs:dateTime"/>
<xs:element name="RevisionNumber" type="xs:positiveInteger" minOccurs="0"/>
<xs:element name="AuthorName" type="xs:string" minOccurs="0"/>
<xs:element name="InternalFileID" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: MarketingImageType

Super-types: None
Sub-types: None
Name MarketingImageType
Abstract no
Diagram
XML Instance Representation
<...
contentType="anySimpleType [0..1]">
<MarketingImageURL> xs:anyURI </MarketingImageURL> [1]
</...>
Schema Component Representation
<xs:complexType name="MarketingImageType">
<xs:sequence>
<xs:element name="MarketingImageURL" type="xs:anyURI"/>
</xs:sequence>
<xs:attribute name="contentType"/>
</xs:complexType>
top

Complex Type: OriginatorInfoType

Super-types: None
Sub-types: None
Name OriginatorInfoType
Abstract no
Diagram
XML Instance Representation
<...>
<Originator> xs:string </Originator> [1] ?
<OriginatorID> xs:positiveInteger </OriginatorID> [1] ?
</...>
Schema Component Representation
<xs:complexType name="OriginatorInfoType">
<xs:sequence>
<xs:element name="Originator" type="xs:string"/>
<xs:element name="OriginatorID" type="xs:positiveInteger"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: PatentAssetType

Super-types: None
Sub-types: None
Name PatentAssetType
Abstract no
Diagram
XML Instance Representation
<...>
Start Choice [1]
<Patent> pa:patentType </Patent> [1] ?
<ConfidentialProspectus> ConfidentialProspectusType </ConfidentialProspectus> [1] ?
End Choice
</...>
Schema Component Representation
<xs:complexType name="PatentAssetType">
<xs:choice>
<xs:element name="Patent" type="pa:patentType"/>
<xs:element name="ConfidentialProspectus" type="ConfidentialProspectusType"/>
</xs:choice>
</xs:complexType>
top

Complex Type: PatentOfferingType

Super-types: None
Sub-types: None
Name PatentOfferingType
Abstract no
Diagram
XML Instance Representation
<...
schemaVersion="xs:decimal [1] ?">
<OriginatorInfo> OriginatorInfoType </OriginatorInfo> [1] ?
<DocumentInfo> DocumentInfoType </DocumentInfo> [1] ?
<OfferStatus> xs:string (value comes from list: {'open'|'withdrawn'|'closed'}) </OfferStatus> [1] ?
<PatentAsset> PatentAssetType </PatentAsset> [1] ?
<Seller> SellerType </Seller> [1] ?
<MarketingTitle> xs:string (length <= 100) </MarketingTitle> [0..1] ?
<ExecutiveSummary> xs:string </ExecutiveSummary> [0..1] ?
<PortfolioID> xs:string </PortfolioID> [0..1] ?
<CategoryID> xs:string </CategoryID> [0..1] ?
<DealStructure> xs:string </DealStructure> [0..1] ?
<Encumbrances> xs:string </Encumbrances> [0..1] ?
<OfferOrPrice> xs:string </OfferOrPrice> [0..1] ?
<SEOTags> ArrayOfSEOTagsType </SEOTags> [0..1] ?
<MarketingImages> ArrayOfMarketingImagesType </MarketingImages> [0..1] ?
<Attachments> ArrayOfAttachmentsType </Attachments> [0..1] ?
<OriginatorNotes> xs:string </OriginatorNotes> [0..*] ?
</...>
Schema Component Representation
<xs:complexType name="PatentOfferingType">
<xs:sequence>
<xs:element name="OriginatorInfo" type="OriginatorInfoType"/>
<xs:element name="DocumentInfo" type="DocumentInfoType"/>
<xs:element name="OfferStatus">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="open"/>
<xs:enumeration value="withdrawn"/>
<xs:enumeration value="closed"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="PatentAsset" type="PatentAssetType"/>
<xs:element name="Seller" type="SellerType"/>
<xs:element name="MarketingTitle" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="100"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="ExecutiveSummary" type="xs:string" minOccurs="0"/>
<xs:element name="PortfolioID" type="xs:string" minOccurs="0"/>
<xs:element name="CategoryID" type="xs:string" minOccurs="0"/>
<xs:element name="DealStructure" type="xs:string" minOccurs="0"/>
<xs:element name="Encumbrances" type="xs:string" minOccurs="0"/>
<xs:element name="OfferOrPrice" type="xs:string" minOccurs="0"/>
<xs:element name="SEOTags" type="ArrayOfSEOTagsType" minOccurs="0"/>
<xs:element name="MarketingImages" type="ArrayOfMarketingImagesType" minOccurs="0"/>
<xs:element name="Attachments" type="ArrayOfAttachmentsType" minOccurs="0"/>
<xs:element name="OriginatorNotes" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="schemaVersion" type="xs:decimal" use="required"/>
</xs:complexType>
top

Complex Type: SellerType

Super-types: None
Sub-types: None
Name SellerType
Abstract no
Diagram
XML Instance Representation
<...>
<ContactSellerURL> xs:anyURI </ContactSellerURL> [1] ?
</...>
Schema Component Representation
<xs:complexType name="SellerType">
<xs:sequence>
<xs:element name="ContactSellerURL" type="xs:anyURI"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: SyndicatedPatentOfferingType

Super-types: None
Sub-types: None
Name SyndicatedPatentOfferingType
Abstract no
Diagram
XML Instance Representation
<...>
<SyndicationHeader> SyndicationHeaderType </SyndicationHeader> [1] ?
<PatentOffering> ... </PatentOffering> [1]
</...>
Schema Component Representation
<xs:complexType name="SyndicatedPatentOfferingType">
<xs:sequence>
<xs:element name="SyndicationHeader" type="SyndicationHeaderType"/>
<xs:element ref="PatentOffering" minOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: SyndicationHeaderType

Super-types: None
Sub-types: None
Name SyndicationHeaderType
Abstract no
Diagram
XML Instance Representation
<...>
<Syndicator> xs:string </Syndicator> [1] ?
<ReceivedBySyndicatorDateTime> xs:dateTime </ReceivedBySyndicatorDateTime> [1] ?
</...>
Schema Component Representation
<xs:complexType name="SyndicationHeaderType">
<xs:sequence>
<xs:element name="Syndicator" type="xs:string"/>
<xs:element name="ReceivedBySyndicatorDateTime" type="xs:dateTime"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: SyndicationMessageEnvelopeType

Super-types: None
Sub-types: None
Name SyndicationMessageEnvelopeType
Abstract no
Documentation Top-level root element produced by the Open-IP.org syndication service.
Diagram
XML Instance Representation
<...
schemaVersion="xs:decimal [1]">
<TransmissionHeader> TransmissionHeaderType </TransmissionHeader> [1] ?
<SyndicatedPatentOffering> SyndicatedPatentOfferingType </SyndicatedPatentOffering> [0..*] ?
</...>
Schema Component Representation
<xs:complexType name="SyndicationMessageEnvelopeType">
<xs:sequence>
<xs:element name="TransmissionHeader" type="TransmissionHeaderType"/>
<xs:element name="SyndicatedPatentOffering" type="SyndicatedPatentOfferingType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="schemaVersion" type="xs:decimal" use="required"/>
</xs:complexType>
top

Complex Type: TransmissionHeaderType

Super-types: None
Sub-types: None
Name TransmissionHeaderType
Abstract no
Diagram
XML Instance Representation
<...>
<CreationDateTime> xs:dateTime </CreationDateTime> [1] ?
</...>
Schema Component Representation
<xs:complexType name="TransmissionHeaderType">
<xs:sequence>
<xs:element name="CreationDateTime" type="xs:dateTime"/>
</xs:sequence>
</xs:complexType>
top

Simple Type: SEOTagType

Super-types: xs:string < SEOTagType (by restriction)
Sub-types: None
Name SEOTagType
Content
  • Base XSD Type: string
Diagram
Schema Component Representation
<xs:simpleType name="SEOTagType">
<xs:restriction base="xs:string"/>
</xs:simpleType>
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
<complexType name="AusAddress">
<complexContent>
<extension base="Address">
<sequence>
<element name="state" type="AusStates"/>
<element name="postcode">
<simpleType>
<restriction base="string">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="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