RosettaNet XML Message Guidelines
2A9_MG_V01_01_01_QueryTechnicalProductInformationQuery.htm (01-Nov-2001 12:00)
This document has been prepared by Si2, Inc. (http://www.si2.org)
in conformance with the RosettaNet methodology.
1 |
0..1 |
qd.key |
DTD attribute |
2 |
1 |
dict.identifier | |
3 |
1 |
query | |
4 |
0..1 |
|-- starting.at |
DTD attribute |
5 |
0..1 |
|-- max.records |
DTD attribute |
6 |
0..n |
|-- element | |
7 |
0..1 |
| |-- id |
DTD attribute |
8 |
0..1 |
| |-- dicRef |
DTD attribute |
9 |
1 |
| |-- name | |
10 |
0..n |
| |-- value | |
11 |
0..1 |
| | |-- type |
DTD attribute |
12 |
0..1 |
| | |-- ntol.abs |
DTD attribute |
13 |
0..1 |
| | |-- ntol.per |
DTD attribute |
14 |
0..1 |
| | |-- ptol.abs |
DTD attribute |
15 |
0..1 |
| | |-- ptol.per |
DTD attribute |
16 |
0..n |
|-- CharacteristicSet | |
17 |
0..1 |
| |-- id |
DTD attribute |
18 |
0..1 |
| |-- dicRef |
DTD attribute |
19 |
0..1 |
| |-- members |
DTD attribute |
20 |
1 |
| |-- name | |
21 |
0..1 |
|-- send.addl.info | |
22 |
1..n |
| |-- data.object | |
23 |
1 |
fromRole.PartnerRoleDescription | |
24 |
1 |
|-- ContactInformation | |
25 |
1 |
| |-- contactName | |
26 |
1 |
| |-- telephoneNumber.CommunicationsNumber | |
27 |
1 |
| |-- EmailAddress | |
28 |
1 |
|-- GlobalPartnerRoleclassificationCode | |
29 |
1 |
|-- PartnerDescription | |
30 |
1 |
| |-- GlobalPartnerclassificationCode | |
31 |
1 |
| |-- BusinessDescription | |
32 |
1 |
| | |-- GlobalBusinessIdentifier | |
33 |
1 |
| | |-- GlobalSupplyChainCode | |
34 |
1 |
toRole.PartnerRoleDescription | |
35 |
1 |
|-- GlobalPartnerRoleclassificationCode | |
36 |
1 |
|-- PartnerDescription | |
37 |
1 |
| |-- GlobalPartnerclassificationCode | |
38 |
1 |
| |-- BusinessDescription | |
39 |
1 |
| | |-- GlobalBusinessIdentifier | |
40 |
1 |
| | |-- GlobalSupplyChainCode | |
41 |
1 |
thisDocumentGenerationDateTime.DateTimeStamp | |
42 |
1 |
thisDocumentIdentifier.ProprietaryDocumentIdentifier | |
43 |
1 |
GlobalDocumentFunctionCode |
name |
Definition |
---|---|
contactName |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. |
fromRole |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. |
telephoneNumber |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. |
thisDocumentGenerationDateTime |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. |
thisDocumentIdentifier |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. |
toRole |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. |
name |
Definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BusinessDescription |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CharacteristicDefinition |
All semantics are specified in the EC Technical Dictionary Specification. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CharacteristicSet |
A set of elements and/or other CharacteristicsSets related to a
product.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
class |
All semantics are specified in the EC Technical Dictionary Specification. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ContactInformation |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ContentType |
All semantics are specified in the EC Technical Dictionary Specification. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ContentTypeRef |
A unique identifier that defines the category of information provided
by this PIO.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data.object |
The ObjectID of a PIO being requested. (NOTE: The ObjectId is
usually acquired by a
ProductInformationUser from the TOC PIO for a product.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description |
Information that characterizes or otherwise identifies this PIO. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dic.value |
All semantics are specified in the EC Technical Dictionary Specification. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EffectiveDate |
A date prior to which the information may not be valid, but after which it is valid, expressed in ISO 8601 format (YYYYMMDD). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
element |
The association of a product information characteristic name with a
value. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ec.dictionary.add |
A container for dictionary information referenced by the response but not contained in the standard Dictionary. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FileFormat |
All semantics are specified in the EC Technical Dictionary Specification. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FileFormatRef |
A unique identifier that defines the type data encoding for this PIO.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ModificationDate |
The last time a change was made, expressed in ISO 8601 format (YYYYMMDD). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name |
The name of a Characteristic, or CharacteristicSet related to a
product. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NoValueReason |
A qualifier specifying the reason for a null or empty value content.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ObjectId |
The identifier for a PIO unique in the namespace of the
ProductInformationDistributor.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ObjectName |
The Distributor name for the containing PIO. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
part.info |
A container grouping information related to a product. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PartnerDescription |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PartnerRoleDescription |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PIO |
Meta data describing a logical representation of a set of arbitrary data (whose semantics are defined in a Dictionary entry) related to a product. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PropertyDefinitionSet |
All semantics are specified in the EC Technical Dictionary Specification. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
qd.key |
An arbitrary identifier.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
query |
A request for product information, the content of which consists of
zero or more request specifications, each of which identifies the
information to be returned in a response for each product. Each request
specification may be one of: element, CharacteristicSet,or
send.addl.info. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
response |
Information for zero or more products that match the criteria specified
in the corresponding query. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
s.badquery |
The query does not conform to all applicable specifications. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
s.fail |
The supplier is unable to return a useful response due to supplier-side system or communication problems. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
s.nomatch |
There is no product information matching the query MatchCriteria. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
s.not.available |
The information requested may or may not exist, however, the ProductInformationDistributor declines to return it. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
s.reschedule.query |
A time -- expressed in ISO 8601 format according to section 5.4.1. of ISO 8601 (YCCYYMMDDThhmmssZ) -- at which the same query, if resent, would yield the data requested. (NOTE: This might be used if the query would result in a large amount of data that would be more successfully transmitted by the Distributor at a later time.) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
s.success |
Product information matching the query criteria is being returned in the <response>. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
send.addl.info |
A request for a product information object. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status |
An indicator confirming success or failure of the supplier's attempt to
process the query. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Supplier |
The DUNS of the creator of this PIO. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TargetSoftware |
An identifier for a tool that can be used to process this PIO. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TermDefinition |
All semantics are specified in the EC Technical Dictionary Specification. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type |
A qualifier describing the kind of measurement a value represents.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value |
The value associated with the containing element.
REMINDER: XML special characters in any content may need to be quoted (e.g., & as the character entity &).
Operators bind in order from left to right in an expression, except that innermost parentheses groups evaluate first, and NOT, LT, GT, LE, GE, bind tightest to the shortest expression on the right. The BNF for the expression syntax (single quotes to identify literal characters and [brackets] identify optional content) is:
EXAMPLES:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value.codes |
One or more enumerated values to be added to an existing value code
list. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Version |
An arbitrary identifier indicating a content revision level. |
name |
Definition |
Data Type |
Min |
Max |
Representation |
---|---|---|---|---|---|
CommunicationsNumber |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. |
||||
DateTimeStamp |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. |
||||
dicRef |
A reference to a dictionary entry.
|
String |
1 |
32 |
X(32) |
dict.identifier |
The unique identifier of the dictionary instance to which are compliant
the semantics of all elements in the contents of the containing query or
response that do not reference definitions in the local ec.dictionary.add.
|
String |
1 |
255 |
X(255) |
EmailAddress |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. |
||||
FreeFormText |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. |
||||
GlobalBusinessIdentifier |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. |
||||
GlobalDocumentFunctionCode |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. |
||||
GlobalPartnerClassificationCode |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. |
||||
GlobalPartnerRoleClassificationCode |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. |
||||
GlobalSupplyChainCode |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. |
||||
href |
A reference to the Content-Id attribute of a MIME attachment specified
as "cid:MIME_content-id_of_attachment" in accordance with RFC 2111
(http://rfc.fh-koeln.de/rfc/html/rfc2111.html).
|
ID |
1 |
128 |
X(128) |
id |
A unique XML identifier that may be the target of an IDREF reference from another element. |
ID |
1 |
32 |
X(32) |
Legal |
A URL (Uniform Resource Locator defined in accordance with RFC 2396 http://www.w3.org/Addressing) that defines terms, conditions, disclaimers, warnings, limitations, or other information related to the use of PIO. |
ID |
1 |
512 |
X(512) |
Location |
The URL (Uniform Resource Locator defined in accordance with RFC 2396 http://www.w3.org/Addressing) for this PIO, a request to which shall return only the PIO. |
ID |
1 |
512 |
X(512) |
members |
The ordered set of references to the elements and/or CharacteristicSets
in the current instance that are members of the
current CharacteristicSet.
|
IDREFS |
1 |
4096 |
X(4096) |
ProprietaryDocumentIdentifier |
All semantics conform to RosettaNet conventions and are specified in the Business Dictionary. |
||||
Reference |
A URL (Uniform Resource Locator defined in accordance with RFC 2396 http://www.w3.org/Addressing) related to this PIO. |
ID |
1 |
512 |
X(512) |
name |
Definition |
Data Type |
Min |
Max |
Representation |
Dimension |
---|---|---|---|---|---|---|
FileSize |
The size of an object. |
Integer |
1 |
12 |
9(12) |
bytes |
matched |
If specified, the number of products matching the criteria specifications in the query corresponding to the current response. |
Integer |
1 |
9 |
9(9) |
1 |
max.records |
A limit on the number of records that should be returned in a
response>. |
Integer |
1 |
9 |
9(9) |
1 |
ntol.abs |
A negative tolerance expressed as a non-negative real number to be subtracted from the current value. |
Real |
1 |
15 |
9(15) |
1 |
ntol.per |
A negative tolerance expressed as a non-negative percent of the current value. |
Integer |
1 |
15 |
9(15) |
% |
ptol.abs |
A positive tolerance expressed as a non-negative real number to be added to the current value. |
Real |
1 |
15 |
9(15) |
1 |
ptol.per |
A positive tolerance expressed as a non-negative percent of the current value. |
Integer |
1 |
15 |
9(15) |
% |
returned |
The total number of part.info instances in the current response.
|
Integer |
1 |
9 |
9(9) |
1 |
starting.at |
The ordinal position of the first product in the ordered set of all
products matching the match criteria specifications of a query,
independent of how many are actually returned in a response.
|
Integer |
1 |
9 |
9(9) |
1 |
Created by Si2, Inc.