User Tools

Site Tools

Translations of this page:

en:lensrequest:version010000:structure

XML-Structure

Root-Element: b2bOpticRequest

In the root-element the location of the XSD at schema.b2boptic.com should be set, so the receiver could identify the version of XML. In next version it will be mandatory.

<b2bOpticRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://schema.b2boptic.com/b2boptic_lensrequest_1.0.0.xsd">
header
type Header
occurs 0..1
description usally not used
items
occurs 1
description main tag that include a list of request items
item (element of items)
occurs 1..n
description one request
parties (element of item)
type Account
occurs 1..n
description
role (attribute of parties)
type Roles
use required
description
referenceNo (element of item)
type string
occurs 1
description referenceNo that was send with the order
confirmedOrderId (element of item)
type string
occurs 1
description unique order id that was send by the server to the client
search (element of items)
occurs 1..n
description one search request
parties (element of search)
type Account
occurs 1..n
description
role (attribute of parties)
type Roles
use required
description
branchOffice (element of search)
type string
occurs 0..1
description
allBranchOffices (attribute of branchOffice)
type boolean
use optional
default false
description
referenceNo (element of search)
type string
occurs 0..1
description referenceNo that was send with the order
commercialCode (element of search)
type string
occurs 0..1
description
orderStatus (element of search)
type string
occurs 0..1
description the status of the order
values description
OPEN order ok and is waiting for production
PRODUCTION order is in production
COATING_TINTING order is in coating or tinting
COMPLETED order is completed but not dispatched
DISPATCHED order was dispatched and are on the way to the customer
ERROR
orderDate (element of search)
occurs 0..1
description the date when the order was received by server
start (element of orderDate)
type date
occurs 1
description
end (element of orderDate)
type date
occurs 1
description
deliveryDate (element of search)
occurs 0..1
description the date when the order where send to the customer
start (element of deliveryDate)
type date
occurs 1
description
end (element of deliveryDate)
type date
occurs 1
description
maximumHits (element of search)
type int
occurs 1
description maximum records that are returned
experimental
type anyType
occurs 0..n
description section for internal tests at development
  <xs:element name="b2bOpticRequest">
    <xs:complexType>
      <xs:sequence>
        <xs:element minOccurs="0" name="header" type="Header" />
        <xs:element name="items">
          <xs:complexType>
            <xs:choice>
              <xs:element maxOccurs="unbounded" name="item">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element maxOccurs="unbounded" name="parties">
                      <xs:complexType>
                        <xs:complexContent mixed="false">
                          <xs:extension base="Account">
                            <xs:attribute name="role" type="Roles" use="required" />
                          </xs:extension>
                        </xs:complexContent>
                      </xs:complexType>
                    </xs:element>
                    <xs:element name="referenceNo" type="xs:string" />
                    <xs:element name="confirmedOrderId" type="xs:string" />
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
              <xs:element maxOccurs="unbounded" name="search">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element maxOccurs="unbounded" name="parties">
                      <xs:complexType>
                        <xs:complexContent mixed="false">
                          <xs:extension base="Account">
                            <xs:attribute name="role" type="Roles" use="required" />
                          </xs:extension>
                        </xs:complexContent>
                      </xs:complexType>
                    </xs:element>
                    <xs:element minOccurs="0" name="branchOffice">
                      <xs:complexType>
                        <xs:simpleContent>
                          <xs:extension base="xs:string">
                            <xs:attribute default="false" name="allBranchOffices" type="xs:boolean" use="optional" />
                          </xs:extension>
                        </xs:simpleContent>
                      </xs:complexType>
                    </xs:element>
                    <xs:element minOccurs="0" name="referenceNo" type="xs:string" />
                    <xs:element minOccurs="0" name="commercialCode" type="xs:string" />
                    <xs:element minOccurs="0" name="orderStatus">
                      <xs:simpleType>
                        <xs:restriction base="xs:string">
                          <xs:enumeration value="OPEN" />
                          <xs:enumeration value="PRODUCTION" />
                          <xs:enumeration value="COATING_TINTING" />
                          <xs:enumeration value="COMPLETED" />
                          <xs:enumeration value="DISPATCHED" />
                          <xs:enumeration value="ERROR" />
                        </xs:restriction>
                      </xs:simpleType>
                    </xs:element>
                    <xs:element minOccurs="0" name="orderDate">
                      <xs:complexType>
                        <xs:sequence>
                          <xs:element name="start" type="xs:date" />
                          <xs:element name="end" type="xs:date" />
                        </xs:sequence>
                      </xs:complexType>
                    </xs:element>
                    <xs:element minOccurs="0" name="deliveryDate">
                      <xs:complexType>
                        <xs:sequence>
                          <xs:element name="start" type="xs:date" />
                          <xs:element name="end" type="xs:date" />
                        </xs:sequence>
                      </xs:complexType>
                    </xs:element>
                    <xs:element name="maximumHits" type="xs:int" />
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
            </xs:choice>
          </xs:complexType>
        </xs:element>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="experimental" type="xs:anyType" />
      </xs:sequence>
    </xs:complexType>
  </xs:element>
en/lensrequest/version010000/structure.txt · Last modified: 2013/06/05 11:23 by sebastianraring