User Tools

Site Tools


en:webservice:version010000:structure:downloadorderfromplatform

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
en:webservice:version010000:structure:downloadorderfromplatform [2013/05/31 13:55] sebastianraringen:webservice:version010000:structure:downloadorderfromplatform [2013/06/05 10:12] (current) sebastianraring
Line 1: Line 1:
 +====== DownloadOrderFromPlatform ======
  
 +===== request =====
 +
 +^ manufacturer ^^
 +^ type | string |
 +^ occurs | 0..1 |
 +^ description | the supplier code (see [[en:companies:index|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 |
 +
 +^ referenceNo ^^
 +^ type | string |
 +^ occurs | 1 |
 +^ description | the value of [[en:lensorder:version010600:complextypes:item|referenceNo]] (b2boptic -> items -> item) of the order that was send by the client with [[en:webservice:version010000:structure:uploadordertoplatform|UploadOrderToPlatform]] |
 +
 +<code xml>
 +<xsd:element name="DownloadOrderFromPlatform">
 +  <xsd:complexType>
 +    <xsd:complexContent>
 +      <xsd:extension base="b2b:Ws_AuthenticationType">
 +        <xsd:sequence>
 +          <xsd:element name="referenceNo" type="xsd:string" />
 +        </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>
 +</code>
 +
 +===== response =====
 +
 +^ b2bxmlorder (part of choice) ^^
 +^ type | string |
 +^ occurs | 1 |
 +^ description | the order in [[en:lensorder:version010600:index|B2BOptic LensOrder 1.6.0]] format; the xml document is included in a CDATA-section ([[http://www.w3.org/TR/REC-xml/#dt-cdsection]]) |
 +
 +^ b2bxmlinfo (part of choice) ^^
 +^ type | string |
 +^ occurs | 1 |
 +^ description | the status info about the order in [[en:lensinfo:version000300:index|B2BOptic LensInfo 0.3.0]] format; the xml document is included in a CDATA-section ([[http://www.w3.org/TR/REC-xml/#dt-cdsection]]) |
 +
 +^ 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 |
 +
 +<code xml>
 +<xsd:element name="DownloadOrderFromPlatformResponse">
 +  <xsd:complexType>
 +    <xsd:choice>
 +      <xsd:sequence>
 +        <xsd:element name="b2bxmlorder" type="xsd:string" />
 +        <xsd:element name="b2bxmlinfo" 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>
 +</code>
en/webservice/version010000/structure/downloadorderfromplatform.txt · Last modified: 2013/06/05 10:12 by sebastianraring