EyeLinkWeb Soap service

This is production service. Use https://soap.jzo.azure.virtii.com for testing.

WSDL specification

Methods

• UploadCustomFile Uploads order in b2bOptic format
• GetOrderObjectByOrderId Returns information about order
• SubmitOrderData Uploads order in OMA format

UploadCustomFile

Uploads order in b2bOptic format

Request Parameters

• username: username used to log in https://eyelink.pl
• password: password used to log in https://eyelink.pl
• data: xml order in b2boptic format
• refId: name of an application that performs the request. E.g. EyeLinkWeb

Request format

  POST /WebServices/fileupload.asmx HTTP/1.1
  Host: https://soap.eyelink.pl
  Content-Type: text/xml; charset=utf-8
  Content-Length: length
  SOAPAction: "https://soap.eyelink.pl/UploadCustomFile"
  
  <?xml version="1.0" encoding="utf-8"?>
  <soap:Envelope>
    <soap:Body>
      <UploadCustomFile>
        <username>string</username>
        <password>string</password>
        <data>string</data>
        <refId>string</refId>
      </UploadCustomFile>
    </soap:Body>
  </soap:Envelope>

Response Parameters

• Url: url to uploaded order
• UniqueId: order id which can be used in GetOrderObjectByOrderId method
• Status: OK / KO
  • OK: order has been validated and no errors found
  • KO: order has been validated and some errors found
• Error: an error message returned when any fields sent are invalid

Response format

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope>
  <soap:Body>
    <UploadCustomFileResponse>
      <UploadCustomFileResult>
        <Url>string</Url>
        <UniqueID>string</UniqueID>
        <Status>string</Status>
        <Error>string</Error>
      </UploadCustomFileResult>
    </UploadCustomFileResponse>
  </soap:Body>
</soap:Envelope>

GetOrderObjectByOrderId

Returns information about order

Request parameters

• username: username used to log in https://eyelink.pl
• password: password used to log in https://eyelink.pl
• orderId: unique id of order. Returned by UploadCustomFile method.

Request format

  POST /WebServices/fileupload.asmx
  Host: https://soap.eyelink.pl
  Content-Type: text/xml; charset=utf-8
  SOAPAction: "https://soap.eyelink.pl/GetOrderObjectByOrderId"
  
  <?xml version="1.0" encoding="utf-8"?>
  <soap:Envelope>
    <soap:Body>
      <GetOrderObjectByOrderId>
        <orderId>string</orderId>
        <username>string</username>
        <password>string</password>
      </GetOrderObjectByOrderId>
    </soap:Body>
  </soap:Envelope>

Response parameters

• Status: OK / KO
  • OK: order has been validated and no errors found
  • KO: order has been validated and some errors found
• Error: an error message returned when any fields sent are invalid

Response format

  <?xml version="1.0" encoding="utf-8"?>
  <soap:Envelope >
    <soap:Body>
      <GetOrderObjectByOrderIdResponse>
        <GetOrderObjectByOrderIdResult>
          <Status>string</Status>
          <Error>string</Error>
        </GetOrderObjectByOrderIdResult>
      </GetOrderObjectByOrderIdResponse>
    </soap:Body>
  </soap:Envelope>

SubmitOrderData

Uploads order in OMA format

Request Parameters

• loginInfo
  • username: username used to log in https://eyelink.pl
  • password: password used to log in https://eyelink.pl
  • refId: name of an application that performs the request. E.g. EyeLinkWeb
• rawData: base64Binary of OMA file wrapped in XML

Request format

  POST /WebServices/fileupload.asmx HTTP/1.1
  Host: https://soap.eyelink.pl
  Content-Type: text/xml; charset=utf-8
  Content-Length: length
  SOAPAction: "https://soap.eyelink.pl/SubmitOrderData"
  
  <?xml version="1.0" encoding="utf-8"?>
    <soap:Envelope>
      <soap:Body>
        <SubmitOrderData>
          <loginInfo>
            <userName>string</userName>
            <passWord>string</passWord>
            <refid>string</refid>
          </loginInfo>
          <rawData>base64Binary</rawData>
        </SubmitOrderData>
      </soap:Body>
    </soap:Envelope>
  

Response Parameters

• StartupUrl: url to uploaded order
• Success: indicates if import was successful
• UniqueId: order id which can be used in GetOrderObjectByOrderId method
• Error: an error message returned when any fields sent are invalid

Response format

    <?xml version="1.0" encoding="utf-8"?>
    <soap:Envelope >
      <soap:Body>
        <SubmitOrderDataResponse>
          <SubmitOrderDataResult>
            <StartupUrl>string</Url>
            <Success>boolean</Url>
            <UniqueID>string</UniqueID>
            <Error>string</Error>
          </SubmitOrderDataResult>
        </SubmitOrderDataResponse>
      </soap:Body>
    </soap:Envelope>