en:webservice:version010000:structure:uploadordertoplatform
Table of Contents
UploadOrderToPlatform
request
manufacturer | |
---|---|
type | string |
occurs | 0..1 |
description | the supplier code (see company list) |
customerid | |
---|---|
type | string |
occurs | 1 |
description | the username that was given to the customer to access this webservice; usually this is the customer number |
username | |
---|---|
type | string |
occurs | 0..1 |
description | the username that was given to the customer to access this webservice; this is only used if a username and a customer number needs to be transmitted |
password | |
---|---|
type | string |
occurs | 1 |
description | the password that was given to the customer to access this webservice; this is transfered in plaintext |
b2bxmlorder | |
---|---|
type | string |
occurs | 1 |
description | the order in B2BOptic LensOrder 1.6.0 format; the xml document is included in a CDATA-section (http://www.w3.org/TR/REC-xml/#dt-cdsection) |
orderstatus | |
---|---|
type | Ws_OrderStatusType |
occurs | 1 |
description | status of the order in sender program |
<xsd:element name="UploadOrderToPlatform"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="b2b:Ws_AuthenticationType"> <xsd:sequence> <xsd:element name="b2bxmlorder" type="xsd:string" /> <xsd:element name="orderstatus" type="b2b:Ws_OrderStatusType" /> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> <xsd:complexType name="Ws_AuthenticationType"> <xsd:sequence> <xsd:element name="manufacturer" type="xsd:string" minOccurs="0" /> <xsd:element name="customerid" type="xsd:string" /> <xsd:element name="username" type="xsd:string" minOccurs="0" /> <xsd:element name="password" type="xsd:string" /> </xsd:sequence> </xsd:complexType>
response
url (part of choice) | |
---|---|
type | string |
occurs | 1 |
description | the URL to the web platform that is launched by the client in a internet browser and shown to the user. It may include all parameter that are necessary to open the platform with the uploaded order; URL syntax like in RFC3986 (http://www.ietf.org/rfc/rfc3986.txt) |
errorCode (part of choice) | |
---|---|
type | int |
occurs | 1 |
description | an error code from server |
errorText (part of choice) | |
---|---|
type | string |
occurs | 1 |
description | a description for the error by the server |
errorTextUser (part of choice) | |
---|---|
type | string |
occurs | 0..1 |
description | a error description text in native language of the user, that the client can display |
<xsd:element name="UploadOrderToPlatformResponse"> <xsd:complexType> <xsd:choice> <xsd:sequence> <xsd:element name="url" type="xsd:string" /> </xsd:sequence> <xsd:sequence> <xsd:element name="errorCode" type="xsd:int" /> <xsd:element name="errorText" type="xsd:string" /> <xsd:element name="errorTextUser" type="xsd:string" minOccurs="0" /> </xsd:sequence> </xsd:choice> </xsd:complexType> </xsd:element>
en/webservice/version010000/structure/uploadordertoplatform.txt · Last modified: 2013/06/05 10:11 by sebastianraring