en:lensrequest:version010000:structure
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| en:lensrequest:version010000:structure [2013/06/03 14:18] – created sebastianraring | en:lensrequest:version010000:structure [2013/06/05 11:23] (current) – sebastianraring | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== XML-Structure ====== | ||
| + | |||
| + | |||
| + | ===== Root-Element: | ||
| + | |||
| + | 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. | ||
| + | <code xml> | ||
| + | < | ||
| + | </ | ||
| + | |||
| + | ^ [[en: | ||
| + | ^ type | [[en: | ||
| + | ^ 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 | | ||
| + | |||
| + | ^ [[en: | ||
| + | ^ type | [[en: | ||
| + | ^ 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 | | ||
| + | |||
| + | ^ [[en: | ||
| + | ^ type | [[en: | ||
| + | ^ 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 | | ||
| + | |||
| + | <code xml> | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||