Campaign Web Service

Campaign

Click here for a complete list of operations.

CreateWebPushCampaign

Create a web push campaign. If the campaign already exists, updates it.

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 /ecomm/campaign.asmx HTTP/1.1
Host: ws.euromsg.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.euromsg.com/campaign/CreateWebPushCampaign"

<?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>
    <CreateWebPushCampaign xmlns="http://ws.euromsg.com/campaign">
      <ServiceTicket>string</ServiceTicket>
      <WebPushCampaign>
        <CampaignID>string</CampaignID>
        <Name>string</Name>
        <Type>int</Type>
        <TextMessage>string</TextMessage>
        <AlternateTextMessage>string</AlternateTextMessage>
        <TargetUrl>string</TargetUrl>
        <AlternateTargetUrl>string</AlternateTargetUrl>
        <MediaUrl>string</MediaUrl>
        <AlternateMediaUrl>string</AlternateMediaUrl>
        <AlternateCustomParams>string</AlternateCustomParams>
        <ReportAdmins>string</ReportAdmins>
        <DeliveryDate>string</DeliveryDate>
        <DeliveryExpireDate>string</DeliveryExpireDate>
        <ReportExpireDate>string</ReportExpireDate>
        <FastListId>string</FastListId>
        <SpeedLimitation>string</SpeedLimitation>
        <DailyLimit>string</DailyLimit>
        <AbCustomization>string</AbCustomization>
        <CustomParams>string</CustomParams>
        <Application>
          <Name>string</Name>
          <Type>string</Type>
        </Application>
        <Classification1>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification1>
        <Classification2>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification2>
        <Classification3>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification3>
        <Classification4>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification4>
        <Classification5>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification5>
        <IsBadge>boolean</IsBadge>
        <IsMutableContent>boolean</IsMutableContent>
        <MulitpleApplications>
          <Application>
            <Name>string</Name>
            <Type>string</Type>
          </Application>
          <Application>
            <Name>string</Name>
            <Type>string</Type>
          </Application>
        </MulitpleApplications>
        <TimeToLive>int</TimeToLive>
      </WebPushCampaign>
    </CreateWebPushCampaign>
  </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>
    <CreateWebPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
      <CreateWebPushCampaignResult />
      <WebPushCampaign>
        <CampaignID>string</CampaignID>
        <Name>string</Name>
        <Type>int</Type>
        <TextMessage>string</TextMessage>
        <AlternateTextMessage>string</AlternateTextMessage>
        <TargetUrl>string</TargetUrl>
        <AlternateTargetUrl>string</AlternateTargetUrl>
        <MediaUrl>string</MediaUrl>
        <AlternateMediaUrl>string</AlternateMediaUrl>
        <AlternateCustomParams>string</AlternateCustomParams>
        <ReportAdmins>string</ReportAdmins>
        <DeliveryDate>string</DeliveryDate>
        <DeliveryExpireDate>string</DeliveryExpireDate>
        <ReportExpireDate>string</ReportExpireDate>
        <FastListId>string</FastListId>
        <SpeedLimitation>string</SpeedLimitation>
        <DailyLimit>string</DailyLimit>
        <AbCustomization>string</AbCustomization>
        <CustomParams>string</CustomParams>
        <Application>
          <Name>string</Name>
          <Type>string</Type>
        </Application>
        <Classification1>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification1>
        <Classification2>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification2>
        <Classification3>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification3>
        <Classification4>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification4>
        <Classification5>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification5>
        <IsBadge>boolean</IsBadge>
        <IsMutableContent>boolean</IsMutableContent>
        <MulitpleApplications>
          <Application>
            <Name>string</Name>
            <Type>string</Type>
          </Application>
          <Application>
            <Name>string</Name>
            <Type>string</Type>
          </Application>
        </MulitpleApplications>
        <TimeToLive>int</TimeToLive>
      </WebPushCampaign>
    </CreateWebPushCampaignResponse>
  </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 /ecomm/campaign.asmx HTTP/1.1
Host: ws.euromsg.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>
    <CreateWebPushCampaign xmlns="http://ws.euromsg.com/campaign">
      <ServiceTicket>string</ServiceTicket>
      <WebPushCampaign>
        <CampaignID>string</CampaignID>
        <Name>string</Name>
        <Type>int</Type>
        <TextMessage>string</TextMessage>
        <AlternateTextMessage>string</AlternateTextMessage>
        <TargetUrl>string</TargetUrl>
        <AlternateTargetUrl>string</AlternateTargetUrl>
        <MediaUrl>string</MediaUrl>
        <AlternateMediaUrl>string</AlternateMediaUrl>
        <AlternateCustomParams>string</AlternateCustomParams>
        <ReportAdmins>string</ReportAdmins>
        <DeliveryDate>string</DeliveryDate>
        <DeliveryExpireDate>string</DeliveryExpireDate>
        <ReportExpireDate>string</ReportExpireDate>
        <FastListId>string</FastListId>
        <SpeedLimitation>string</SpeedLimitation>
        <DailyLimit>string</DailyLimit>
        <AbCustomization>string</AbCustomization>
        <CustomParams>string</CustomParams>
        <Application>
          <Name>string</Name>
          <Type>string</Type>
        </Application>
        <Classification1>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification1>
        <Classification2>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification2>
        <Classification3>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification3>
        <Classification4>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification4>
        <Classification5>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification5>
        <IsBadge>boolean</IsBadge>
        <IsMutableContent>boolean</IsMutableContent>
        <MulitpleApplications>
          <Application>
            <Name>string</Name>
            <Type>string</Type>
          </Application>
          <Application>
            <Name>string</Name>
            <Type>string</Type>
          </Application>
        </MulitpleApplications>
        <TimeToLive>int</TimeToLive>
      </WebPushCampaign>
    </CreateWebPushCampaign>
  </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>
    <CreateWebPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
      <CreateWebPushCampaignResult />
      <WebPushCampaign>
        <CampaignID>string</CampaignID>
        <Name>string</Name>
        <Type>int</Type>
        <TextMessage>string</TextMessage>
        <AlternateTextMessage>string</AlternateTextMessage>
        <TargetUrl>string</TargetUrl>
        <AlternateTargetUrl>string</AlternateTargetUrl>
        <MediaUrl>string</MediaUrl>
        <AlternateMediaUrl>string</AlternateMediaUrl>
        <AlternateCustomParams>string</AlternateCustomParams>
        <ReportAdmins>string</ReportAdmins>
        <DeliveryDate>string</DeliveryDate>
        <DeliveryExpireDate>string</DeliveryExpireDate>
        <ReportExpireDate>string</ReportExpireDate>
        <FastListId>string</FastListId>
        <SpeedLimitation>string</SpeedLimitation>
        <DailyLimit>string</DailyLimit>
        <AbCustomization>string</AbCustomization>
        <CustomParams>string</CustomParams>
        <Application>
          <Name>string</Name>
          <Type>string</Type>
        </Application>
        <Classification1>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification1>
        <Classification2>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification2>
        <Classification3>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification3>
        <Classification4>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification4>
        <Classification5>
          <ClassificationLabel>string</ClassificationLabel>
          <ClassificationValue>string</ClassificationValue>
        </Classification5>
        <IsBadge>boolean</IsBadge>
        <IsMutableContent>boolean</IsMutableContent>
        <MulitpleApplications>
          <Application>
            <Name>string</Name>
            <Type>string</Type>
          </Application>
          <Application>
            <Name>string</Name>
            <Type>string</Type>
          </Application>
        </MulitpleApplications>
        <TimeToLive>int</TimeToLive>
      </WebPushCampaign>
    </CreateWebPushCampaignResponse>
  </soap12:Body>
</soap12:Envelope>