IntegrationServiceV4


Click here for a complete list of operations.

SubscribeEventWithSitesFilters

Subscribe to PeopleVox system events wits sites filters.

Test

The test form is only available for requests from the local machine.

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 /pvx-release-26.10.01.1/resources/integrationservicev4.asmx HTTP/1.1
Host: integration-eu.peoplevox.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.peoplevox.net/SubscribeEventWithSitesFilters"

<?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:Header>
    <UserSessionCredentials xmlns="http://www.peoplevox.net/">
      <UserId>int</UserId>
      <ClientId>string</ClientId>
      <SessionId>string</SessionId>
    </UserSessionCredentials>
  </soap:Header>
  <soap:Body>
    <SubscribeEventWithSitesFilters xmlns="http://www.peoplevox.net/">
      <eventType>AvailabilityChanges or SalesOrderStatusChanges or GoodsReceived or TrackingNumberReceived or IncrementalChanges or Returns or DespatchPackageTrackingNumberReceived or OnDespatchOrderReceived or DespatchPackageDespatched</eventType>
      <filter>string</filter>
      <sitesFilter>string</sitesFilter>
      <callbackUrl>string</callbackUrl>
      <encodeParameterData>boolean</encodeParameterData>
    </SubscribeEventWithSitesFilters>
  </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>
    <SubscribeEventWithSitesFiltersResponse xmlns="http://www.peoplevox.net/">
      <SubscribeEventWithSitesFiltersResult>
        <ResponseId>int</ResponseId>
        <TotalCount>int</TotalCount>
        <Detail>string</Detail>
        <Statuses>
          <IntegrationStatusResponse>
            <Reference>string</Reference>
            <Status>Error or Success</Status>
            <LineNo>int</LineNo>
            <Details>string</Details>
          </IntegrationStatusResponse>
          <IntegrationStatusResponse>
            <Reference>string</Reference>
            <Status>Error or Success</Status>
            <LineNo>int</LineNo>
            <Details>string</Details>
          </IntegrationStatusResponse>
        </Statuses>
        <ImportingQueueId>int</ImportingQueueId>
        <SalesOrdersToDespatchIds>
          <int>int</int>
          <int>int</int>
        </SalesOrdersToDespatchIds>
        <ErrorCode>string</ErrorCode>
      </SubscribeEventWithSitesFiltersResult>
    </SubscribeEventWithSitesFiltersResponse>
  </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 /pvx-release-26.10.01.1/resources/integrationservicev4.asmx HTTP/1.1
Host: integration-eu.peoplevox.net
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:Header>
    <UserSessionCredentials xmlns="http://www.peoplevox.net/">
      <UserId>int</UserId>
      <ClientId>string</ClientId>
      <SessionId>string</SessionId>
    </UserSessionCredentials>
  </soap12:Header>
  <soap12:Body>
    <SubscribeEventWithSitesFilters xmlns="http://www.peoplevox.net/">
      <eventType>AvailabilityChanges or SalesOrderStatusChanges or GoodsReceived or TrackingNumberReceived or IncrementalChanges or Returns or DespatchPackageTrackingNumberReceived or OnDespatchOrderReceived or DespatchPackageDespatched</eventType>
      <filter>string</filter>
      <sitesFilter>string</sitesFilter>
      <callbackUrl>string</callbackUrl>
      <encodeParameterData>boolean</encodeParameterData>
    </SubscribeEventWithSitesFilters>
  </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>
    <SubscribeEventWithSitesFiltersResponse xmlns="http://www.peoplevox.net/">
      <SubscribeEventWithSitesFiltersResult>
        <ResponseId>int</ResponseId>
        <TotalCount>int</TotalCount>
        <Detail>string</Detail>
        <Statuses>
          <IntegrationStatusResponse>
            <Reference>string</Reference>
            <Status>Error or Success</Status>
            <LineNo>int</LineNo>
            <Details>string</Details>
          </IntegrationStatusResponse>
          <IntegrationStatusResponse>
            <Reference>string</Reference>
            <Status>Error or Success</Status>
            <LineNo>int</LineNo>
            <Details>string</Details>
          </IntegrationStatusResponse>
        </Statuses>
        <ImportingQueueId>int</ImportingQueueId>
        <SalesOrdersToDespatchIds>
          <int>int</int>
          <int>int</int>
        </SalesOrdersToDespatchIds>
        <ErrorCode>string</ErrorCode>
      </SubscribeEventWithSitesFiltersResult>
    </SubscribeEventWithSitesFiltersResponse>
  </soap12:Body>
</soap12:Envelope>