Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
titlepost
 
Anchor
topslws
topslws

Service URLpostpush.asmx



Post Push Web Service Methods 


The following table lists supported methods in Post Push Web Service and provides a brief description of each method. For more detail on each method, click the method name.



Warning

To interact with any Web Services, developers must first use the Login method to create a

Status
subtletrue
colourRed
title Service Ticket
. Developers can send requests to other Web Service and methods using this
Status
subtletrue
colourRed
title Service Ticket
.




CreateSendList 

GetPostPushResult 
Anchor
getpush
getpush

Back to Top ^

<CreateSendList>Creates an empty Send List.
<GetPostPushResult>

Parameters


ParameterValue
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titlemandatory

pushIds
Group Name of the List

Status
colourGreen
titlemandatory

ListNameName of the list

Status
colourGreen
titlemandatory

Code Block
language
Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?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>
    <GetPostPushResult    <CreateSendList xmlns="http://ws.euromsg.com/sendlistpostpush">
      <serviceTicket>string</serviceTicket>
     <ServiceTicket>string</ServiceTicket> <pushIds>
        <string>string</string>
  <ListGroup>string</ListGroup>      <string>string</string>
      <ListName>string</ListName>
   </pushIds>
    </CreateSendList>GetPostPushResult>
    </soap:Body>
</soap:Envelope>
Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<If the request was successful, the
Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope     xmlns:soapxsi="http://schemaswww.xmlsoapw3.org/soap/envelope/"
   2001/XMLSchema-instance" xmlns:xsixsd="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsdsoap="http://wwwschemas.w3xmlsoap.org/soap/2001envelope/XMLSchema">
    <soap:Body>
    <GetPostPushResultResponse    <CreateSendListResponse xmlns="http://ws.euromsg.com/sendlistpostpush">
      <GetPostPushResultResult>
     <CreateSendListResult>   <PostPushList>
          <PostPushModel>
  <Code>00</Code>          <PushId>guid</PushId>
      <Message />     <EmpushToken>string</EmpushToken>
           <DetailedMessage <AppAlias>string</>AppAlias>
            <PushType>string</PushType>
   <CreatedListID>1686794</CreatedListID>         <TextMessage>string</TextMessage>
   </CreateSendListResult>         <<TargetUrl>string</CreateSendListResponse>TargetUrl>
     </soap:Body>
</soap:Envelope>
Tip
Status
subtletrue
colourRed
titleCode
parameter will return StatussubtletruecolourRedtitle00 as a response. In addition to that, the ID of the created list StatussubtletruecolourRedtitleCreatedListID is returned.

Error Parameters

CodeError MessageDescription9998No session. Please try re-logon.No active sessions found. Try login again.AddBulk  Anchoraddbulkaddbulk

Back to Top ^

<AddBulk>
Bulk adds to a Send List.

Parameters

ParameterValueServiceTicketServiceTicket obtained through Login

Status
colourGreen
titlemandatory

ListGroup

Group name of the List to add

Status
colourGreen
titlemandatory

ListNameName of the List

Status
colourGreen
titlemandatory

KeyReference Key Name. Member adding and updating will be done based on this field. Reference Key value must be specified in the DemograficData field

Status
colourGreen
titlemandatory

DemograficDataArrayOfEmKeyValue string defines the fields for the member

Status
colourGreen
titlemandatory

ForceInsertIf the member exists in the system and the value is true , the existing member is updated.

Status
colourGreen
titlemandatory

Note
Fields like First Name and Last Name are set through the Related Marketing Cloud platform.

Static Fields

Field NameDescriptionEMAILEmail addressSTATUSMember Status. A: Active, P: PassiveEMAIL_PERMITEmail opt-in. Y: Yes, N: NoGSM_PERMITSMS opt-in. Y: Yes, N: NoFAX_PERMITFAX opt-in. Y: Yes, N: NoCALL_PERMITCall Center opt-in. Y: Yes, N: NoPRINT_PERMITPrint opt-in. Y: Yes, N: NoREFERRALReferral AddressREFERRAL_DOMAINReferral Domain
       <MediaUrl>string</MediaUrl>
            <Status>string</Status>
            <Created>dateTime</Created>
            <TakenForSent>dateTime</TakenForSent>
            <DsLastChange>dateTime</DsLastChange>
            <OpenTime>dateTime</OpenTime>
          </PostPushModel>
          <PostPushModel>
            <PushId>guid</PushId>
            <EmpushToken>string</EmpushToken>
            <AppAlias>string</AppAlias>
            <PushType>string</PushType>
            <TextMessage>string</TextMessage>
            <TargetUrl>string</TargetUrl>
            <MediaUrl>string</MediaUrl>
            <Status>string</Status>
            <Created>dateTime</Created>
            <TakenForSent>dateTime</TakenForSent>
            <DsLastChange>dateTime</DsLastChange>
            <OpenTime>dateTime</OpenTime>
          </PostPushModel>
        </PostPushList>
      </GetPostPushResultResult>
    </GetPostPushResultResponse>
  </soap:Body>
</soap:Envelope>
Tip

If the request was successful, the

Status
subtletrue
colourRed
titleCode
parameter will return
Status
subtletrue
colourRed
title00
as a response.

Error Parameters


CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.



GetPostPushResultByCreationDate 
Anchor
creation
creation

Back to Top ^

<GetPostPushResultByCreationDate>

Parameters


ParameterValue
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titlemandatory

BeginDate


Status
colourGreen
titlemandatory

EndDate

Status
colourGreen
titlemandatory

Page

Status
colourGreen
titlemandatory



Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?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>
        <AddBulk
            xmlns=<GetPostPushResultByCreationDate xmlns="http://ws.euromsg.com/sendlistpostpush">
        <serviceTicket>string</serviceTicket>
   <ServiceTicket>string</ServiceTicket>   <request>
         <ListGroup>string<<BeginDate>string</ListGroup>BeginDate>
            <ListName>string</ListName><EndDate>string</EndDate>
            <Key>string</Key><Page>int</Page>
      </request>
    </GetPostPushResultByCreationDate>
<DemograficData>                 <ArrayOfEmKeyValue>
     </soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?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>
    <GetPostPushResultByCreationDateResponse xmlns="http://ws.euromsg.com/postpush">
      <GetPostPushResultByCreationDateResult>
       <EmKeyValue> <PostPushList>
          <PostPushModel>
            <Key>string<<PushId>guid</Key>PushId>
            <EmpushToken>string</EmpushToken>
            <Value>string<<AppAlias>string</Value>AppAlias>
            <PushType>string</PushType>
       </EmKeyValue>     <TextMessage>string</TextMessage>
            <TargetUrl>string</TargetUrl>
  <EmKeyValue>          <MediaUrl>string</MediaUrl>
            <Status>string</Status>
 <Key>string</Key>           <Created>dateTime</Created>
             <Value>string<<TakenForSent>dateTime</Value>TakenForSent>
            <DsLastChange>dateTime</DsLastChange>
       </EmKeyValue>      <OpenTime>dateTime</OpenTime>
          </ArrayOfEmKeyValue>PostPushModel>
          <PostPushModel>
     <ArrayOfEmKeyValue>       <PushId>guid</PushId>
            <EmpushToken>string</EmpushToken>
<EmKeyValue>            <AppAlias>string</AppAlias>
            <Key>string<<PushType>string</Key>PushType>
            <TextMessage>string</TextMessage>
            <Value>string<<TargetUrl>string</Value>TargetUrl>
            <MediaUrl>string</MediaUrl>
       </EmKeyValue>     <Status>string</Status>
            <Created>dateTime</Created>
  <EmKeyValue>          <TakenForSent>dateTime</TakenForSent>
              <Key>string<<DsLastChange>dateTime</Key>DsLastChange>
            <OpenTime>dateTime</OpenTime>
           <Value>string<</Value>PostPushModel>
                    </EmKeyValue>
 </PostPushList>
              </ArrayOfEmKeyValue>GetPostPushResultByCreationDateResult>
            </DemograficData>
            <ForceInsert>boolean</ForceInsert>
  </GetPostPushResultByCreationDateResponse>
     </AddBulk>
    </soap:Body>
</soap:Envelope>
Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
Tip

If the request was successful, the

Status
subtletrue
colourRed
titleCode
 parameter will return
Status
subtletrue
colourRed
title00
as a response.

Error Parameters


CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.



GetPostPushResultByLastUpdate 
Anchor
update
update

Back to Top ^

<GetPostPushResultByLastUpdate>

Parameters


ParameterValue
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titlemandatory

BeginDate


Status
colourGreen
titlemandatory

EndDate

Status
colourGreen
titlemandatory

Page

Status
colourGreen
titlemandatory


Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?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>
    
<AddBulkResponse
<GetPostPushResultByLastUpdate xmlns="http://ws.euromsg.com/
sendlist
postpush">
      <serviceTicket>string</serviceTicket>
     
<AddBulkResult>
 <request>
        
<Code>00</Code>
<BeginDate>string</BeginDate>
        <EndDate>string</EndDate>
       
<Message
 <Page>int</
>
Page>
      </request>
    </GetPostPushResultByLastUpdate>
  </soap:Body>
<DetailedMessage />
</soap:Envelope>
Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?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>
    
<CreatedListID>0</CreatedListID>
<GetPostPushResultByLastUpdateResponse xmlns="http://ws.euromsg.com/postpush">
      <GetPostPushResultByLastUpdateResult>
    
</AddBulkResult>
    <PostPushList>
        
<DetailsResult>
  <PostPushModel>
            <PushId>guid</PushId>
 
<BulkDetailedResult>
           <EmpushToken>string</EmpushToken>
         
<Key>test1@sampledomain.com</Key>
   <AppAlias>string</AppAlias>
            <PushType>string</PushType>
    
<Code>00</Code>
        <TextMessage>string</TextMessage>
            
<Message
<TargetUrl>string</
>
TargetUrl>
            <MediaUrl>string</MediaUrl>
       
<DetailedMessage
 
/>
    <Status>string</Status>
            
<
<Created>dateTime</
BulkDetailedResult>
Created>
            <TakenForSent>dateTime</TakenForSent>
   
<BulkDetailedResult>
         <DsLastChange>dateTime</DsLastChange>
            
<Key>test2@sampledomain.com<
<OpenTime>dateTime</
Key>
OpenTime>
          </PostPushModel>
         
<Code>00</Code>
 <PostPushModel>
            <PushId>guid</PushId>
         
<Message
   <EmpushToken>string</
>
EmpushToken>
            <AppAlias>string</AppAlias>
           
<DetailedMessage
 
/>
<PushType>string</PushType>
            <TextMessage>string</TextMessage>
           
<
 <TargetUrl>string</
BulkDetailedResult>
TargetUrl>
            
</DetailsResult>
<MediaUrl>string</MediaUrl>
            
</AddBulkResponse>
<Status>string</Status>
            
</soap:Body> </soap:Envelope> TipIf the request was successful, the StatussubtletruecolourRedtitleCode parameter will return StatussubtletruecolourRedtitle00 as a response.

Error Parameters

Code
<Created>dateTime</Created>
            <TakenForSent>dateTime</TakenForSent>
            <DsLastChange>dateTime</DsLastChange>
            <OpenTime>dateTime</OpenTime>
          </PostPushModel>
        </PostPushList>
      </GetPostPushResultByLastUpdateResult>
    </GetPostPushResultByLastUpdateResponse>
  </soap:Body>
</soap:Envelope>
Tip

If the request was successful, the

Status
subtletrue
colourRed
titleCode
 parameter will return
Status
subtletrue
colourRed
title00
as a response.

Error Parameters

AddBulkFile  Anchoraddbulkfileaddbulkfile

Back to Top ^

<AddBulkFile>
Allows you to add all the members listed in a file to your RMC account in bulk.

Parameters

Parameter


CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.



PostTransactionalPush 
Anchor

99No such list!The specified List cannot be found.99Member is new. No update!If ForceInsert is false and the user does not exist in the system, this error is given.  The member is not added. To add the new member in the system the value of the ForceInsertparameter must be true.

posttrans
posttrans

Back to Top ^

<PostTransactionalPush>


Parameters


ParameterValue
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titlemandatory

ListGroupGroup name of the List to add Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?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> <AddBulkFile
ApplicationAlias

Status
colourGreen
titlemandatory

ListNameName of the List

Status
colourGreen
titlemandatory

Key

Reference Key Name. Member adding and updating shall be done based on this field

Status
colourGreen
titlemandatory

MapMaps the fields in the file with the system fields. E.g. EMAIL=email; COLUMN1=NameSurname; COLUMN2=KeyID

Status
colourGreen
titlemandatory

File

The file to upload

Status
colourGreen
titlemandatory

FileType

File Type - Must be in zip or csv format

Status
colourGreen
titlemandatory

NotificationEmail

A notification email will sent to this email address when the upload is completed

Status
colourGreen
titlemandatory

ClassificationName

MemberKey

MemberValue

message

Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?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>
    <PostTransactionalPush xmlns="http://ws.euromsg.com/postpush">
      <ServiceTicket>string</ServiceTicket>
      <ApplicationAlias>string</ApplicationAlias>
      <ClassificationName>string</ClassificationName>
      <MemberKey>string</MemberKey>
      <MemberValue>string</MemberValue>
      <message>
        
xmlns="http://ws.euromsg.com/sendlist">
<PushId>string</PushId>
        <Type>Image or Video or 
<ServiceTicket>string</ServiceTicket>
Text or Settings or Survey</Type>
        
<ListGroup>string<
<Text>string</
ListGroup>
Text>
        <TargetUrl>string</TargetUrl>
   
<ListName>string</ListName>
     <MediaUrl>string</MediaUrl>
        
<Key>string<
<MemberId>string</
Key>
MemberId>
        <SentTime>dateTime</SentTime>
    
<Map>string</Map>
    <PacketStatus>string</PacketStatus>
        
<File>base64Binary<
<MessageStatusCode>string</
File>
MessageStatusCode>
        <MessageStatus>string</MessageStatus>
    
<FileType>string</FileType>
    <CampId>string</CampId>
        
<NotificationEmail>string<
<CampName>string</
NotificationEmail>
CampName>
        
<
<ContentType>string</
AddBulkFile>
ContentType>
     
</soap:Body> </soap:Envelope> Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope
   <IsABCustomization>boolean</IsABCustomization>
        
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
<TextMessageA>string</TextMessageA>
       
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 <TextMessageB>string</TextMessageB>
    
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <EmpushToken>string</EmpushToken>
<soap:Body>
        <Params>string</Params>
<AddBulkFileResponse
        <AlternateMessage>string</AlternateMessage>
    
xmlns="http://ws.euromsg.com/sendlist">
    <SystemVariables>
        
<AddBulkFileResult>
  <anyType />
          <anyType />
 
<Code>00</Code>
       </SystemVariables>
        
<Message
<PromoTableId>string</
>
PromoTableId>
        
<DetailedMessage />
<CustomerId>string</CustomerId>
      
<ConversationID>EEFF123AE537442BBF9AD3231F812684</ConversationID>
</message>
    
<CreatedListID>0</CreatedListID>
</PostTransactionalPush>
  
</
AddBulkFileResult> </AddBulkFileResponse> </soap:Body> </
soap:Body>
</soap:Envelope>
TipIf the request was successful, the
Status
subtletrue
colourRed
titleCode
 parameter will return StatussubtletruecolourRedtitle00 as a response. In addition to that, the ID of the created list StatussubtletruecolourRedtitleCreatedListID is returned.

Error Parameters

CodeError MessageDescription9998No session. Please try re-logon.No active sessions found. Try login again.99Not a valid file type. It must be ZIP or CSV or TXT.Invalid file type. It must be in zip or csv formatQuerySendListMemberCount  Anchorquerymemcountquerymemcount

Back to Top ^

<QuerySendListMemberCount>

Shows the number of members in the send list.

Parameters

ParameterValueServiceTicketServiceTicket obtained through Login

Status
colourGreen
titlemandatory

ListIDList ID

Status
colourGreen
titlemandatory

<?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> <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <QuerySendListMemberCountResponse xmlns="http://ws.euromsg.com/sendlist"> <QuerySendListMemberCountResult>
Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?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>
    <PostTransactionalPushResponse xmlns="http://ws.euromsg.com/postpush">
      <PostTransactionalPushResult>
        <PushList>
          <EmPushMessageResultItem>
            <PushId>string</PushId>
      <QuerySendListMemberCount    </EmPushMessageResultItem>
        xmlns="http://ws.euromsg.com/sendlist">  <EmPushMessageResultItem>
          <ServiceTicket>string</ServiceTicket>  <PushId>string</PushId>
          <ListID>int</ListID>
 </EmPushMessageResultItem>
        </PushList>
      </QuerySendListMemberCount>PostTransactionalPushResult>
    </PostTransactionalPushResponse>
  </soap:Body>
</soap:Envelope>
Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
Tip

If the request was successful, the

Status
subtletrue
colourRed
titleCode
 parameter will return
Status
subtletrue
colourRed
title00
as a response.

Error Parameters


CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.



PostTransactionalPushWithToken 
Anchor
transtoken
transtoken

Back to Top ^

<PostTransactionalPushWithToken>


Parameters


ParameterValue
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titlemandatory

ApplicationAlias

Status
colourGreen
titlemandatory

ClassificationName

Status
colourGreen
titlemandatory

AuthToken

Status
colourGreen
titlemandatory

message

Status
colourGreen
titlemandatory



Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?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>
    <PostTransactionalPushWithToken xmlns="http://ws.euromsg.com/postpush">
      <ServiceTicket>string</ServiceTicket>
      <ApplicationAlias>string</ApplicationAlias>
    
<Code>00</Code>
  <ClassificationName>string</ClassificationName>
      <AuthToken>string</AuthToken>
      
<Message />
<message>
        <PushId>string</PushId>
       
<DetailedMessage
 
/>
<Type>Image or Video or Text or Settings or Survey</Type>
        
<CreatedListID>0<
<Text>string</
CreatedListID>
Text>
        <TargetUrl>string</TargetUrl>
   
</QuerySendListMemberCountResult>
     <MediaUrl>string</MediaUrl>
       
<MemberCount>0<
 <MemberId>string</
MemberCount>
MemberId>
        
</QuerySendListMemberCountResponse>
<SentTime>dateTime</SentTime>
        <PacketStatus>string</PacketStatus>
        <MessageStatusCode>string</MessageStatusCode>
        
</soap:Body> </soap:Envelope> TipIf the request was successful, the StatussubtletruecolourRedtitleCode parameter will return StatussubtletruecolourRedtitle00 as a response.

Error Parameters

CodeError MessageDescription9998No session. Please try re-logon.No active sessions found. Try login again.RemoveBulkFile  Anchorremovebulkfileremovebulkfile

Back to Top ^

<RemoveBulkFile>

Allows you to delete the members listed in a file in your RMC account.

Parameters

ParameterValueServiceTicketServiceTicket obtained through Login

Status
colourGreen
titlemandatory

ListGroupGroup name of the List

Status
colourGreen
titlemandatory

ListNameName of the list

Status
colourGreen
titlemandatory

KeyReference Key Name

Status
colourGreen
titlemandatory

Map

Maps the fields in the file with the system fields. E.g. EMAIL=email; COLUMN1=NameSurname ;COLUMN2=KeyID

Status
colourGreen
titlemandatory

FileFile to upload

Status
colourGreen
titlemandatory

FileTypeFile Type - Must be in zip or csv format

Status
colourGreen
titlemandatory

NotificationEmailA notification email will sent to this email address when the upload is completed

Status
colourGreen
titlemandatory

DeleteIfInNoList

If the member is not included in any lists, and the value is true, the user is deleted from the system completely

Status
colourGreen
titlemandatory

Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?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>
        <RemoveBulkFile xmlns="http://ws.euromsg.com/sendlist">
            <ServiceTicket>string</ServiceTicket>
            <ListGroup>string</ListGroup>
            <ListName>string</ListName>
            <Key>string</Key>
            <Map>string</Map>
            <File>base64Binary</File>
            <FileType>string</FileType>
            <NotificationEmail>string</NotificationEmail>
            <DeleteIfInNoList>boolean</DeleteIfInNoList>
        </RemoveBulkFile>
    </soap:Body>
</soap:Envelope>
Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <RemoveBulkFileResponse xmlns="http://ws.euromsg.com/sendlist">
            <RemoveBulkFileResult>
                <Code>00</Code>
                <Message />
                <DetailedMessage />
                <ConversationID>EEFF123AE537442BBF9AD3231F812684</ConversationID>
                <CreatedListID>0</CreatedListID>
            </RemoveBulkFileResult>
        </RemoveBulkFileResponse >
    </soap:Body>
</soap:Envelope>
TipIf the request was successful, the
Status
subtletrue
colourRed
titleCode
 parameter will return StatussubtletruecolourRedtitle00 as a response. In addition to that, the ID of the created list StatussubtletruecolourRedtitleCreatedListID is returned.

Error Parameters

CodeError MessageDescription9998No session. Please try re-logon.No active sessions found. Try login again.RemoveSendList  Anchorremovesendlistremovesendlist

Back to Top ^

<RemoveSendList>
Deletes a Send List.

Parameters

ParameterValueServiceTicketServiceTicket obtained through Login

Status
colourGreen
titlemandatory

ListGroupGroup Name of the List

Status
colourGreen
titlemandatory

ListNameName of the List

Status
colourGreen
titlemandatory

Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?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>
        <RemoveSendList xmlns="http://ws.euromsg.com/sendlist">
            <ServiceTicket>string</ServiceTicket>
            <ListGroup>string</ListGroup>
            <ListName>string</ListName>
        </RemoveSendList>
    </soap:Body>
</soap:Envelope>
Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <RemoveSendListResponse
            xmlns="http://ws.euromsg.com/sendlist">
            <RemoveSendListResult>
                <Code>00</Code>
                <Message />
                <DetailedMessage />
                <CreatedListID>0</CreatedListID>
            </RemoveSendListResult>
        </RemoveSendListResponse>
    </soap:Body>
</soap:Envelope>
TipIf the request was successful, the StatussubtletruecolourRedtitleCode parameter will return StatussubtletruecolourRedtitle00 as a response. Aside from that, the returned StatussubtletruecolourRedtitle99 values indicates errors.

Error Parameters

CodeError MessageDescription9998No session. Please try re-logon.No active sessions found. Try login again.QuerySendList  Anchorquerysendquerysend

Back to Top ^

<QuerySendList>

Query Send Lists of customer.

Parameters

ParameterValueServiceTicketServiceTicket obtained through Login

Status
colourGreen
titlemandatory

Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?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> <QuerySendLists xmlns="http://ws.euromsg.com/sendlist"> <ServiceTicket>string</ServiceTicket> </QuerySendLists>
<MessageStatus>string</MessageStatus>
        <CampId>string</CampId>
        <CampName>string</CampName>
        <ContentType>string</ContentType>
        <IsABCustomization>boolean</IsABCustomization>
        <TextMessageA>string</TextMessageA>
        <TextMessageB>string</TextMessageB>
        <EmpushToken>string</EmpushToken>
        <Params>string</Params>
        <AlternateMessage>string</AlternateMessage>
        <SystemVariables>
          <anyType />
          <anyType />
        </SystemVariables>
        <PromoTableId>string</PromoTableId>
        <CustomerId>string</CustomerId>
      </message>
    </PostTransactionalPushWithToken>
  </soap:Body>
</soap:Envelope>
Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?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> <QuerySendListsResponse xmlns="http://ws.euromsg.com/sendlist"> <QuerySendListsResult> <SendLists> <EmSendListResponse>
.org/soap/envelope/">
  <soap:Body>
    
<ListId>string</ListId>
<PostTransactionalPushWithTokenResponse xmlns="http://ws.euromsg.com/postpush">
      <PostTransactionalPushWithTokenResult>
     
<ListName>string</ListName>
   <PushList>
         
<GroupName>string</GroupName>
 <EmPushMessageResultItem>
         
</EmSendListResponse>
   <PushId>string</PushId>
       
<EmSendListResponse>
   
<ListId>string</ListId>
</EmPushMessageResultItem>
          
<ListName>string</ListName>
<EmPushMessageResultItem>
            
<GroupName>string<
<PushId>string</
GroupName>
PushId>
          </
EmSendListResponse>
EmPushMessageResultItem>
        </
SendLists>
PushList>
      </
QuerySendListsResult>
PostTransactionalPushWithTokenResult>
    </
QuerySendListsResponse>
PostTransactionalPushWithTokenResponse>
  </soap:Body>
</soap:Envelope>
Tip

If the request was successful, the

Status
subtletrue
colourRed
titleCode
 parameter will return
Status
subtletrue
colourRed
title00
as a response.


Error Parameters


CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.



Parent Topic: SOAP Web Service