Service Web Service

Service

Click here for a complete list of operations.

ExternalAPIResponse

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
ewBusinessUser:
ewBusinessToken:
IsSuccess:
IsSent:
IndividualID:
ExternalAPIID:
ReturnMessage:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Service.asmx HTTP/1.1
Host: api.everyware.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://wsclientapi.everyware.com/ExternalAPIResponse"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ExternalAPIResponse xmlns="http://wsclientapi.everyware.com/">
      <ewBusinessUser>string</ewBusinessUser>
      <ewBusinessToken>string</ewBusinessToken>
      <IsSuccess>string</IsSuccess>
      <IsSent>string</IsSent>
      <IndividualID>string</IndividualID>
      <ExternalAPIID>string</ExternalAPIID>
      <ReturnMessage>string</ReturnMessage>
    </ExternalAPIResponse>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ExternalAPIResponseResponse xmlns="http://wsclientapi.everyware.com/">
      <ExternalAPIResponseResult>
        <ExternalResponse>
          <ExternalAPIID>string</ExternalAPIID>
          <IndividualID>string</IndividualID>
          <ReturnMessage>string</ReturnMessage>
          <Error>string</Error>
          <ErrorStack>string</ErrorStack>
        </ExternalResponse>
        <ExternalResponse>
          <ExternalAPIID>string</ExternalAPIID>
          <IndividualID>string</IndividualID>
          <ReturnMessage>string</ReturnMessage>
          <Error>string</Error>
          <ErrorStack>string</ErrorStack>
        </ExternalResponse>
      </ExternalAPIResponseResult>
    </ExternalAPIResponseResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Service.asmx HTTP/1.1
Host: api.everyware.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ExternalAPIResponse xmlns="http://wsclientapi.everyware.com/">
      <ewBusinessUser>string</ewBusinessUser>
      <ewBusinessToken>string</ewBusinessToken>
      <IsSuccess>string</IsSuccess>
      <IsSent>string</IsSent>
      <IndividualID>string</IndividualID>
      <ExternalAPIID>string</ExternalAPIID>
      <ReturnMessage>string</ReturnMessage>
    </ExternalAPIResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ExternalAPIResponseResponse xmlns="http://wsclientapi.everyware.com/">
      <ExternalAPIResponseResult>
        <ExternalResponse>
          <ExternalAPIID>string</ExternalAPIID>
          <IndividualID>string</IndividualID>
          <ReturnMessage>string</ReturnMessage>
          <Error>string</Error>
          <ErrorStack>string</ErrorStack>
        </ExternalResponse>
        <ExternalResponse>
          <ExternalAPIID>string</ExternalAPIID>
          <IndividualID>string</IndividualID>
          <ReturnMessage>string</ReturnMessage>
          <Error>string</Error>
          <ErrorStack>string</ErrorStack>
        </ExternalResponse>
      </ExternalAPIResponseResult>
    </ExternalAPIResponseResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /Service.asmx/ExternalAPIResponse?ewBusinessUser=string&ewBusinessToken=string&IsSuccess=string&IsSent=string&IndividualID=string&ExternalAPIID=string&ReturnMessage=string HTTP/1.1
Host: api.everyware.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfExternalResponse xmlns="http://wsclientapi.everyware.com/">
  <ExternalResponse>
    <ExternalAPIID>string</ExternalAPIID>
    <IndividualID>string</IndividualID>
    <ReturnMessage>string</ReturnMessage>
    <Error>string</Error>
    <ErrorStack>string</ErrorStack>
  </ExternalResponse>
  <ExternalResponse>
    <ExternalAPIID>string</ExternalAPIID>
    <IndividualID>string</IndividualID>
    <ReturnMessage>string</ReturnMessage>
    <Error>string</Error>
    <ErrorStack>string</ErrorStack>
  </ExternalResponse>
</ArrayOfExternalResponse>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /Service.asmx/ExternalAPIResponse HTTP/1.1
Host: api.everyware.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ewBusinessUser=string&ewBusinessToken=string&IsSuccess=string&IsSent=string&IndividualID=string&ExternalAPIID=string&ReturnMessage=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfExternalResponse xmlns="http://wsclientapi.everyware.com/">
  <ExternalResponse>
    <ExternalAPIID>string</ExternalAPIID>
    <IndividualID>string</IndividualID>
    <ReturnMessage>string</ReturnMessage>
    <Error>string</Error>
    <ErrorStack>string</ErrorStack>
  </ExternalResponse>
  <ExternalResponse>
    <ExternalAPIID>string</ExternalAPIID>
    <IndividualID>string</IndividualID>
    <ReturnMessage>string</ReturnMessage>
    <Error>string</Error>
    <ErrorStack>string</ErrorStack>
  </ExternalResponse>
</ArrayOfExternalResponse>