Service Web Service

Service

Click here for a complete list of operations.

GetMessages

Test

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

Parameter	Value
ewBusinessUser:
ewBusinessToken:
newOnly:
datefrom:
dateto:

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/GetMessages"

<?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>
    <GetMessages xmlns="http://wsclientapi.everyware.com/">
      <ewBusinessUser>string</ewBusinessUser>
      <ewBusinessToken>string</ewBusinessToken>
      <newOnly>int</newOnly>
      <datefrom>string</datefrom>
      <dateto>string</dateto>
    </GetMessages>
  </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>
    <GetMessagesResponse xmlns="http://wsclientapi.everyware.com/">
      <GetMessagesResult>
        <ResponseList>
          <MessageID>string</MessageID>
          <IndividualID>string</IndividualID>
          <DateAdded>string</DateAdded>
          <MessageText>string</MessageText>
          <DirectionName>string</DirectionName>
          <AddedByUserID>string</AddedByUserID>
          <AddedByIndividualID>string</AddedByIndividualID>
          <CustomerName>string</CustomerName>
          <EmployeeID>string</EmployeeID>
          <ExternalID>string</ExternalID>
          <EmployeeName>string</EmployeeName>
          <EmployeeAvatar>string</EmployeeAvatar>
          <MediaURL>string</MediaURL>
          <AllowPushNotifications>string</AllowPushNotifications>
          <PushNotificationToken>string</PushNotificationToken>
          <DeviceTypeID>string</DeviceTypeID>
          <EmployeePhoneNumber>string</EmployeePhoneNumber>
          <AssignedPhoneNumber>string</AssignedPhoneNumber>
          <RoutePhoneNumber>string</RoutePhoneNumber>
          <ExternalPhoneNumber>string</ExternalPhoneNumber>
          <Error>string</Error>
          <ErrorStack>string</ErrorStack>
          <Response>string</Response>
          <ResponseMessage>string</ResponseMessage>
        </ResponseList>
        <ResponseList>
          <MessageID>string</MessageID>
          <IndividualID>string</IndividualID>
          <DateAdded>string</DateAdded>
          <MessageText>string</MessageText>
          <DirectionName>string</DirectionName>
          <AddedByUserID>string</AddedByUserID>
          <AddedByIndividualID>string</AddedByIndividualID>
          <CustomerName>string</CustomerName>
          <EmployeeID>string</EmployeeID>
          <ExternalID>string</ExternalID>
          <EmployeeName>string</EmployeeName>
          <EmployeeAvatar>string</EmployeeAvatar>
          <MediaURL>string</MediaURL>
          <AllowPushNotifications>string</AllowPushNotifications>
          <PushNotificationToken>string</PushNotificationToken>
          <DeviceTypeID>string</DeviceTypeID>
          <EmployeePhoneNumber>string</EmployeePhoneNumber>
          <AssignedPhoneNumber>string</AssignedPhoneNumber>
          <RoutePhoneNumber>string</RoutePhoneNumber>
          <ExternalPhoneNumber>string</ExternalPhoneNumber>
          <Error>string</Error>
          <ErrorStack>string</ErrorStack>
          <Response>string</Response>
          <ResponseMessage>string</ResponseMessage>
        </ResponseList>
      </GetMessagesResult>
    </GetMessagesResponse>
  </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>
    <GetMessages xmlns="http://wsclientapi.everyware.com/">
      <ewBusinessUser>string</ewBusinessUser>
      <ewBusinessToken>string</ewBusinessToken>
      <newOnly>int</newOnly>
      <datefrom>string</datefrom>
      <dateto>string</dateto>
    </GetMessages>
  </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>
    <GetMessagesResponse xmlns="http://wsclientapi.everyware.com/">
      <GetMessagesResult>
        <ResponseList>
          <MessageID>string</MessageID>
          <IndividualID>string</IndividualID>
          <DateAdded>string</DateAdded>
          <MessageText>string</MessageText>
          <DirectionName>string</DirectionName>
          <AddedByUserID>string</AddedByUserID>
          <AddedByIndividualID>string</AddedByIndividualID>
          <CustomerName>string</CustomerName>
          <EmployeeID>string</EmployeeID>
          <ExternalID>string</ExternalID>
          <EmployeeName>string</EmployeeName>
          <EmployeeAvatar>string</EmployeeAvatar>
          <MediaURL>string</MediaURL>
          <AllowPushNotifications>string</AllowPushNotifications>
          <PushNotificationToken>string</PushNotificationToken>
          <DeviceTypeID>string</DeviceTypeID>
          <EmployeePhoneNumber>string</EmployeePhoneNumber>
          <AssignedPhoneNumber>string</AssignedPhoneNumber>
          <RoutePhoneNumber>string</RoutePhoneNumber>
          <ExternalPhoneNumber>string</ExternalPhoneNumber>
          <Error>string</Error>
          <ErrorStack>string</ErrorStack>
          <Response>string</Response>
          <ResponseMessage>string</ResponseMessage>
        </ResponseList>
        <ResponseList>
          <MessageID>string</MessageID>
          <IndividualID>string</IndividualID>
          <DateAdded>string</DateAdded>
          <MessageText>string</MessageText>
          <DirectionName>string</DirectionName>
          <AddedByUserID>string</AddedByUserID>
          <AddedByIndividualID>string</AddedByIndividualID>
          <CustomerName>string</CustomerName>
          <EmployeeID>string</EmployeeID>
          <ExternalID>string</ExternalID>
          <EmployeeName>string</EmployeeName>
          <EmployeeAvatar>string</EmployeeAvatar>
          <MediaURL>string</MediaURL>
          <AllowPushNotifications>string</AllowPushNotifications>
          <PushNotificationToken>string</PushNotificationToken>
          <DeviceTypeID>string</DeviceTypeID>
          <EmployeePhoneNumber>string</EmployeePhoneNumber>
          <AssignedPhoneNumber>string</AssignedPhoneNumber>
          <RoutePhoneNumber>string</RoutePhoneNumber>
          <ExternalPhoneNumber>string</ExternalPhoneNumber>
          <Error>string</Error>
          <ErrorStack>string</ErrorStack>
          <Response>string</Response>
          <ResponseMessage>string</ResponseMessage>
        </ResponseList>
      </GetMessagesResult>
    </GetMessagesResponse>
  </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/GetMessages?ewBusinessUser=string&ewBusinessToken=string&newOnly=string&datefrom=string&dateto=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"?>
<ArrayOfResponseList xmlns="http://wsclientapi.everyware.com/">
  <ResponseList>
    <MessageID>string</MessageID>
    <IndividualID>string</IndividualID>
    <DateAdded>string</DateAdded>
    <MessageText>string</MessageText>
    <DirectionName>string</DirectionName>
    <AddedByUserID>string</AddedByUserID>
    <AddedByIndividualID>string</AddedByIndividualID>
    <CustomerName>string</CustomerName>
    <EmployeeID>string</EmployeeID>
    <ExternalID>string</ExternalID>
    <EmployeeName>string</EmployeeName>
    <EmployeeAvatar>string</EmployeeAvatar>
    <MediaURL>string</MediaURL>
    <AllowPushNotifications>string</AllowPushNotifications>
    <PushNotificationToken>string</PushNotificationToken>
    <DeviceTypeID>string</DeviceTypeID>
    <EmployeePhoneNumber>string</EmployeePhoneNumber>
    <AssignedPhoneNumber>string</AssignedPhoneNumber>
    <RoutePhoneNumber>string</RoutePhoneNumber>
    <ExternalPhoneNumber>string</ExternalPhoneNumber>
    <Error>string</Error>
    <ErrorStack>string</ErrorStack>
    <Response>string</Response>
    <ResponseMessage>string</ResponseMessage>
  </ResponseList>
  <ResponseList>
    <MessageID>string</MessageID>
    <IndividualID>string</IndividualID>
    <DateAdded>string</DateAdded>
    <MessageText>string</MessageText>
    <DirectionName>string</DirectionName>
    <AddedByUserID>string</AddedByUserID>
    <AddedByIndividualID>string</AddedByIndividualID>
    <CustomerName>string</CustomerName>
    <EmployeeID>string</EmployeeID>
    <ExternalID>string</ExternalID>
    <EmployeeName>string</EmployeeName>
    <EmployeeAvatar>string</EmployeeAvatar>
    <MediaURL>string</MediaURL>
    <AllowPushNotifications>string</AllowPushNotifications>
    <PushNotificationToken>string</PushNotificationToken>
    <DeviceTypeID>string</DeviceTypeID>
    <EmployeePhoneNumber>string</EmployeePhoneNumber>
    <AssignedPhoneNumber>string</AssignedPhoneNumber>
    <RoutePhoneNumber>string</RoutePhoneNumber>
    <ExternalPhoneNumber>string</ExternalPhoneNumber>
    <Error>string</Error>
    <ErrorStack>string</ErrorStack>
    <Response>string</Response>
    <ResponseMessage>string</ResponseMessage>
  </ResponseList>
</ArrayOfResponseList>

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/GetMessages HTTP/1.1
Host: api.everyware.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ewBusinessUser=string&ewBusinessToken=string&newOnly=string&datefrom=string&dateto=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfResponseList xmlns="http://wsclientapi.everyware.com/">
  <ResponseList>
    <MessageID>string</MessageID>
    <IndividualID>string</IndividualID>
    <DateAdded>string</DateAdded>
    <MessageText>string</MessageText>
    <DirectionName>string</DirectionName>
    <AddedByUserID>string</AddedByUserID>
    <AddedByIndividualID>string</AddedByIndividualID>
    <CustomerName>string</CustomerName>
    <EmployeeID>string</EmployeeID>
    <ExternalID>string</ExternalID>
    <EmployeeName>string</EmployeeName>
    <EmployeeAvatar>string</EmployeeAvatar>
    <MediaURL>string</MediaURL>
    <AllowPushNotifications>string</AllowPushNotifications>
    <PushNotificationToken>string</PushNotificationToken>
    <DeviceTypeID>string</DeviceTypeID>
    <EmployeePhoneNumber>string</EmployeePhoneNumber>
    <AssignedPhoneNumber>string</AssignedPhoneNumber>
    <RoutePhoneNumber>string</RoutePhoneNumber>
    <ExternalPhoneNumber>string</ExternalPhoneNumber>
    <Error>string</Error>
    <ErrorStack>string</ErrorStack>
    <Response>string</Response>
    <ResponseMessage>string</ResponseMessage>
  </ResponseList>
  <ResponseList>
    <MessageID>string</MessageID>
    <IndividualID>string</IndividualID>
    <DateAdded>string</DateAdded>
    <MessageText>string</MessageText>
    <DirectionName>string</DirectionName>
    <AddedByUserID>string</AddedByUserID>
    <AddedByIndividualID>string</AddedByIndividualID>
    <CustomerName>string</CustomerName>
    <EmployeeID>string</EmployeeID>
    <ExternalID>string</ExternalID>
    <EmployeeName>string</EmployeeName>
    <EmployeeAvatar>string</EmployeeAvatar>
    <MediaURL>string</MediaURL>
    <AllowPushNotifications>string</AllowPushNotifications>
    <PushNotificationToken>string</PushNotificationToken>
    <DeviceTypeID>string</DeviceTypeID>
    <EmployeePhoneNumber>string</EmployeePhoneNumber>
    <AssignedPhoneNumber>string</AssignedPhoneNumber>
    <RoutePhoneNumber>string</RoutePhoneNumber>
    <ExternalPhoneNumber>string</ExternalPhoneNumber>
    <Error>string</Error>
    <ErrorStack>string</ErrorStack>
    <Response>string</Response>
    <ResponseMessage>string</ResponseMessage>
  </ResponseList>
</ArrayOfResponseList>