wiki.b2bOptic.com

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

====== header (Header) ======

[[en:jobdata:version010604:structure|b2bOpticJobData]] -> header

{{:en:jobdata:version010604:images:header.png?nolink|Header}}

^ //[[en:jobdata:version010604:simpletypes:msgtypes|msgType]]// ^^
^ type | [[en:jobdata:version010604:simpletypes:msgtypes|MsgTypes]] |
^ use | optional |
^ default | REQUEST |
^ description |  |

^ //[[en:jobdata:version010604:simpletypes:msgstates|msgState]]// ^^
^ type | [[en:jobdata:version010604:simpletypes:msgstates|MsgStates]] |
^ use | optional |
^ default | NEW |
^ description |  |

^ //testIndicator// ^^
^ type | boolean |
^ use | optional |
^ default | false |
^ description | the orders are not productive, only for test |


^ customersOrderId ^^
^ type | string |
^ occurs | 1 |
^ description | internal id for this batch of orders assigned by the sender |

^ distributorsOrderId ^^
^ type | string |
^ occurs | 1 |
^ description | internal id for this batch of orders assigned by the distributor |

^ [[en:jobdata:version010604:complextypes:timestamps|timeStamps]] ^^
^ type | [[en:jobdata:version010604:complextypes:timestamps|TimeStamps]] |
^ occurs | 1..n |
^ description | list of timestamps |

^ remark ^^
^ type | string |
^ occurs | 0..1 |
^ description | comment by the sender to the whole batch of orders |

^ [[en:jobdata:version010604:complextypes:account:orderparties|orderParties]] ^^
^ type | [[en:jobdata:version010604:complextypes:account|Account]] |
^ occurs | 1..n |
^ description | serves as default, if nothing is specified in items section, these entries are used |

^ //[[en:jobdata:version010604:simpletypes:roles:header|role]] (attribute of orderParties)// ^^
^ type | [[en:jobdata:version010604:simpletypes:roles|Roles]] |
^ use | required |
^ description | at least ORIGINATOR is required, if not specified in items section |


^ [[en:jobdata:version010604:complextypes:software|software]] ^^
^ type | [[en:jobdata:version010604:complextypes:software|Software]] |
^ occurs | 1..n |
^ description | list of software programs that create or edit the content |

^ [[en:jobdata:version010604:complextypes:productcatalog|productCatalog]] ^^
^ type | [[en:jobdata:version010604:complextypes:productcatalog|ProductCatalog]] |
^ occurs | 0..1 |
^ description | product catalog that was used to select lenses and coatings |

^ portalOrderId ^^
^ type | string |
^ occurs | 1 |
^ description | retailer's order id |

<code xml>
<xs:complexType name="Header">
  <xs:sequence>
    <xs:element name="customersOrderId" type="xs:string"/>
    <xs:element name="distributorsOrderId" type="xs:string"/>
    <xs:element name="timeStamps" type="TimeStamps" maxOccurs="unbounded"/>
    <xs:element name="remark" type="xs:string" minOccurs="0"/>
    <xs:element name="orderParties" maxOccurs="unbounded">
      <xs:complexType>
        <xs:complexContent>
          <xs:extension base="Account">
            <xs:attribute name="role" type="Roles" use="required"/>
          </xs:extension>
        </xs:complexContent>
      </xs:complexType>
    </xs:element>
    <xs:element name="software" type="Software" maxOccurs="unbounded"/>
    <xs:element name="productCatalog" type="ProductCatalog" minOccurs="0"/>
    <xs:element name="portalOrderId" type="xs:string"/>
  </xs:sequence>
  <xs:attribute name="msgType" type="MsgTypes" use="optional" default="REQUEST"/>
  <xs:attribute name="msgState" type="MsgStates" use="optional" default="NEW"/>
  <xs:attribute name="testIndicator" type="xs:boolean" use="optional" default="false"/>
</xs:complexType>
</code>