Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Status
colourGreen
titlePOST
 

Status
colourGreen
titlePOST
 
Anchor
topmws
topmws

General Information 

Member Web Service allow you to perform many operations:

Member Web Service allow you to perform many operations:

  • Add new members to existing lists
  • Update existing members 
  • Create inquiries about members
  • Create Push Subscription



Member Web Service Methods

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


MethodDescription
AddToAllListsAdds a specific user to all the lists.
AddToSendListsAdds a specific user to selected lists.
ChangeMemberPermissionByEmailUpdate the member's channel permissions The member is defined by Email.
CreatePushSubscriptionCreate a new push subscription or update existing one with Member ID, Token, App Alias and Status
InsertMemberDemographyInserts/Updates the member’s demographic information.
QueryCampaignsBetweenDatesShows the specific campaign information obtained by the member between selected dates.
QueryMemberDemographyLists the demographic areas for the member.
QueryMemberIDQueries 32-char ID of a member based on Key and Value pair.
QuerySendListsShows the lists that the specific member is included in.
RemoveFromSendListsRemoves a specific member from a specific list.
SendOngoingEMailUpdates member's demographic information, adds member if the member does not exist in the system and triggers an ongoing email campaign.
SendOngoingSmsUpdates member's demographic information, adds member if member does not exist in the system and send triggers an ongoing SMS campaign.
UpdateMemberDemographyUpdates member's demographic information.

 

 

Warning
QueryLastPermissionUpdateOfAMemberQueries a member's last permission update details.
QueryMembersWithPermissionUpdateQueries the members whose permissions are updated between a given date range.



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

 



AddToAllLists 
Anchor
addtoalllists
addtoalllists

Back to Top ^

<AddToAllLists>
Adds a specific user to all the lists.

Parameters

 


ParameterValue 
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

Key

This field must contain the account-specific primary key column (EMAIL,

MEMBER

KEY_ID

or a field name of your defined in RMC account management panel

).

Status
colourGreen
titleMANDATORY

ValueThe value of the field name specified in the Key field

Status
colourGreen
titleMANDATORY




Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"     xmlns:xsd="http://www.w3.org/2001/XMLSchema"     xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
    <soap<soap12:Body>
   
    <AddToAllLists xmlns="http://apiws.relateddigitaleuromsg.com/member">
            <ServiceTicket>string</ServiceTicket>
     
      <Key>string</Key>
     
      <Value>string</Value>
   
    </AddToAllLists>
 
  </soapsoap12:Body>
</soapsoap12:Envelope> Envelope>


Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope     xmlns:soapxmlns:xsi="http://schemaswww.xmlsoapw3.org/soap/envelope/"
   2001/XMLSchema-instance" xmlns:xsixsd="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsdsoap12="http://www.w3.org/2003/200105/XMLSchemasoap-envelope">
    <soap<soap12:Body>
   
    <AddToAllListsResponse xmlns="http://apiws.relateddigitaleuromsg.com/member">
            <AddToAllListsResult>
                <Code>00</Code><AddToAllListsResult />
                <Message />
                <DetailedMessage />
            </AddToAllListsResult>
        </AddToAllListsResponse>
    </soap:Body>
</soap:Envelope> </AddToAllListsResponse>
  </soap12:Body>
</soap12: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.
99No such member!Member does not exist in the system.
 



AddToSendLists 
Anchor
addtosendlist
addtosendlist

Back to Top ^

<AddToSendLists>
Adds a specific user to selected lists.

Parameters

 


ParameterValue 
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

KeyThis field must contain the account-specific primary key column (EMAIL, MEMBERKEY_ID or a field name of your defined in RMC account management panel).

Status
colourGreen
titleMANDATORY

ValueThe value of the field name specified in the Key field

Status
colourGreen
titleMANDATORY

SendListsYou can select multiple lists by using EmSendList string

Status
colourGreen
titleMANDATORY

MoveIf true, remove from the lists that are not specified in SendLists string

Status
colourGreen
titleMANDATORY




Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"     xmlns:xsd="http://www.w3.org/2001/XMLSchema"     xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
    <soap<soap12:Body>
  
     <AddToSendLists xmlns="http://apiws.relateddigitaleuromsg.com/member">
     
      <ServiceTicket>string</ServiceTicket>
     
      <Key>string</Key>
     
      <Value>string</Value>
      <SendLists>
     <SendLists>   <EmSendList>
          <ListName>string</ListName>
  <EmSendList>        <GroupName>string</GroupName>
            <ListName>string</ListName>
                    <GroupName>string</GroupName>
                </EmSendList>

               <EmSendList>
        
           <ListName>string</ListName>
                    <GroupName>string</GroupName>
     
          </EmSendList>
     
      </SendLists>
     
      <Move>boolean</Move>
 
      </AddToSendLists>
 
  </soapsoap12:Body>
</soapsoap12:Envelope>


Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope
    xmlns:soapxsi="http://schemaswww.xmlsoapw3.org/soap/envelope/"
   2001/XMLSchema-instance" xmlns:xsixsd="http://www.w3.org/2001/XMLSchema-instance"     xmlns:xsdsoap12="http://www.w3.org/2001/XMLSchema2003/05/soap-envelope">
    <soap<soap12:Body>
   
    <AddToSendListsResponse xmlns="http://apiws.relateddigitaleuromsg.com/member">
            <AddToSendListsResult>
                <Code>00</Code>
                <Message /<AddToSendListsResult />
                <DetailedMessage />
            </AddToSendListsResult>
        </AddToSendListsResponse>
 
  </soapsoap12:Body>
</soapsoap12: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.
99The list or lists you provided are not valid!The specified list was not found.
 





Anchor

InsertMemberDemography 

ChangeMemberPermissionByEmail

anchor

ChangeMemberPermissionByEmail

insertmember

ChangeMemberPermissionByEmail

insertmember


Back to Top ^

 

<InsertMemberDemography>
Inserts/Updates the member’s


demographic information
<ChangeMemberPermissionByEmail>
Update the member's channel permissions The member is defined by Email.


Parameters

 



EMAIL, MEMBER_ID or a field name of your defined in RMC account management panelThe value of the field name specified in the Key field
ParameterValue 
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

Key
EmailValueEmail address

Status
colourGreen
titleMANDATORY

Value
StatusMember Status A: Active , P: Passive

Status
colourGreen
titleMANDATORY

DemograficDataDefine the fields for member with the EmKeyValue string EmailPermitEmail opt-in Y: Yes, N: No

Status
colourGreen
titleMANDATORY

ForceUpdateIf the member exists in the system and the value is  true , then the existing member is updatedGsmPermitSMS opt-in Y: Yes, N: No

Status
colourGreen
titleMANDATORY



Code Block
Note
Fields like First Name and Last Name are set through the RMC 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<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi
Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?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>
    <ChangeMemberPermissionByEmail xmlns="http://wwwws.w3euromsg.org/2001/XMLSchema-instance"com/member">
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  <ServiceTicket>string</ServiceTicket>
    <soap:Body>  <EmailValue>string</EmailValue>
      <InsertMemberDemography xmlns="http://api.relateddigital.com/member"><Status>string</Status>
            <ServiceTicket>string</ServiceTicket><EmailPermit>string</EmailPermit>
      <GsmPermit>string</GsmPermit>
     <Key>string<</Key>ChangeMemberPermissionByEmail>
  </soap12:Body>
</soap12:Envelope>


Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?xml         <Value>string</Value>
   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>
    <ChangeMemberPermissionByEmailResponse xmlns="http://ws.euromsg.com/member">
  <DemograficData>    <ChangeMemberPermissionByEmailResult />
      <MemberID>
    <EmKeyValue>    <string>string</string>
        <string>string</string>
       <Key>string<</Key>MemberID>
    </ChangeMemberPermissionByEmailResponse>
               <Value>string</Value>
                </EmKeyValue>
                <EmKeyValue>
                    <Key>string</Key>
                    <Value>string</Value>
                </EmKeyValue>
            </DemograficData>
            <ForceUpdate>boolean</ForceUpdate>
        </InsertMemberDemography>
    </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"
    </soap12:Body>
</soap12: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.
99No such member!Member does not exist in the system.



CreatePushSubscription 
Anchor
pushsubscription
pushsubscription

Back to Top ^

<CreatePushSubscription>
Create a new push subscription or update existing one with Member ID, Token, App Alias and Status.

Parameters


ParameterValue
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

MemberIDMEMBER_ID

Status
colourGreen
titleMANDATORY

PushTokenPush Token

Status
colourGreen
titleMANDATORY

AppAliasApp Alias at Customer Push Application(s)

Status
colourGreen
titleMANDATORY

ForceUpdateIf the token exists in the system and the value is  true , then the existing member is updated

Status
colourGreen
titleMANDATORY

Status

Token Status:

  • A = Active
  • I = Invalid
  • P = Passive
  • X = Expired

If ForceUpdate flag is false Status is not optional. Status is required for all other situations.

Status
colourBlue
titleCONDITIONAL




Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?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">
    <soap<soap12:Body>
    <PushSubscription    <InsertMemberDemographyResponse xmlns="http://apiws.relateddigitaleuromsg.com/member">
      <ServiceTicket>string</ServiceTicket>
     <InsertMemberDemographyResult> <PushToken>string</PushToken>
      <MemberID>string</MemberID>
      <AppAlias>string</AppAlias>
 <Code>00</Code>     <Status>string</Status>
      <ForceUpdate>boolean</ForceUpdate>
    <Message />
                <DetailedMessage />
         </PushSubscription>
  </InsertMemberDemographyResult>
            <MemberID>B04314B832A549A3B92A11153D1F7BA9</MemberID>
        </InsertMemberDemographyResponse>
    </soapsoap12:Body>
</soapsoap12:Envelope>


StatusIf the request was successful, the Red parameter will return as a response. In addition to that, field of the newly added or updated member will also be returned as a response.
Tip
Status
subtletrue
colour
Code Block
languagexml
title
Code
Status
subtletrue
colourRed
title00
Status
subtletrue
colourRed
titleMemberID

Error Parameters

 

 

CodeError MessageDescription9998No session. Please try re-logon.No active sessions found. Try login again.99Member already exists. No insertion will be done!If ForceUpdate is false and the member already exists in the system.

 

QueryCampaignsBetweenDates  Anchorquerycampaigndatesquerycampaigndates

Back to Top ^

<QueryCampaignsBetweenDates>
Shows the specific campaign information obtained by the member between selected dates.

Parameters

 

ParameterValue ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

KeyEMAIL, MEMBER_ID or a field name of your defined in RMC account management panel

Status
colourGreen
titleMANDATORY

ValueThe value of the field name specified in the Key field

Status
colourGreen
titleMANDATORY

BeginDateStart Date. yyyy-MM-dd HH:mm:ss or yyyyMMdd HH:mm:ss
RESPONSE EXAMPLE
linenumberstrue
<?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>
    <PushSubscriptionResponse xmlns="http://ws.euromsg.com/member">
      <PushSubscriptionResult />
      <Success>boolean</Success>
    </PushSubscriptionResponse>
  </soap12:Body>
</soap12:Envelope>


Tip

If the request was successful, the

Status
subtletrue
colourRed
titleCode
 parameter will return
Status
subtletrue
colourRed
title00
as a response. In addition to that,
Status
subtletrue
colourRed
titleSuccess
field of the newly added or updated token status will also be returned as a response.

Error Parameters


CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.
99No such member!A member matching the Key parameter value does not exist.




InsertMemberDemography 
Anchor
insertmember
insertmember

Back to Top ^


<InsertMemberDemography>
Inserts/Updates the member’s demographic information.

Parameters


ParameterValue
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

EndDateEnd Date. yyyy-MM-dd HH:mm:ss or yyyyMMdd HH:mm:ss
KeyThis field must contain the account-specific primary key column (EMAIL, KEY_ID).

Status
colourGreen
titleMANDATORY

Code Blocklanguagexml

ValueThe value of the field name specified in the Key field

Status
colourGreen
title

REQUEST EXAMPLE

MANDATORY

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> <QueryCampaignsBetweenDates xmlns="http://api.relateddigital.com/member"> <ServiceTicket>string</ServiceTicket>
DemograficDataDefine the fields for member with the EmKeyValue string

Status
colourGreen
titleMANDATORY

ForceUpdateIf the member exists in the system and the value is  true , then the existing member is updated

Status
colourGreen
titleMANDATORY


Note
Fields like First Name and Last Name are set through the RMC platform.


Info
titleInformation

When uploading member, format of GSM must be as below:

  • Format 1: 05351234567
  • Format 2: 5351234567
  • Format 3: 535.1234567

Static Fields


Field NameDescription
EMAILEmail address
STATUSMember Status. A: Active, P: Passive
EMAIL_PERMITEmail opt-in. Y: Yes, N: No
GSM_PERMITSMS opt-in. Y: Yes, N: No
FAX_PERMITFAX opt-in. Y: Yes, N: No
CALL_PERMITCall Center opt-in. Y: Yes, N: No
PRINT_PERMITPrint opt-in. Y: Yes, N: No
REFERRALReferral Address
REFERRAL_DOMAINReferral Domain




Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?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>
    <InsertMemberDemography xmlns="http://ws.euromsg.com/member">
      <ServiceTicket>string</ServiceTicket>
      <Key>string</Key>
      <Value>string</Value>
      <DemograficData>
 
<Value>string</Value>
       <EmKeyValue>
     
<BeginDate>string</BeginDate>
     <Key>string</Key>
       
<EndDate>string</EndDate>
   <Value>string</Value>
        </
QueryCampaignsBetweenDates>
EmKeyValue>
        
</soap:Body> </soap:Envelope> Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope
<EmKeyValue>
        
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  <Key>string</Key>
    
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
     
<soap:Body>
 <Value>string</Value>
       
<QueryCampaignsBetweenDatesResponse
 </EmKeyValue>
      
xmlns="http://api.relateddigital.com/member">
</DemograficData>
      <ForceUpdate>boolean</ForceUpdate>
    </InsertMemberDemography>
<QueryCampaignsBetweenDatesResult>
  
<Code>00</Code>
</soap12:Body>
</soap12:Envelope>


Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?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>
    
<Message /
<InsertMemberDemographyResponse xmlns="http://ws.euromsg.com/member">
      <InsertMemberDemographyResult />
      <MemberID>string</MemberID>
 
<DetailedMessage
 
/>
  </InsertMemberDemographyResponse>
  
</
QueryCampaignsBetweenDatesResult> <CampaignResults> <EmCampaignResult> <CampaignId>string</CampaignId> <CampaignName>string</CampaignName> <DeliveryStatus>string</DeliveryStatus> <DeliveryDate>string</DeliveryDate> <ChannelAddress>string</ChannelAddress> <ChannelType>string</ChannelType> <SentTime>string</SentTime> <Subject>string</Subject> <CampaignMessage>string</CampaignMessage> </EmCampaignResult> <EmCampaignResult> <CampaignId>string</CampaignId> <CampaignName>string</CampaignName> <DeliveryStatus>string</DeliveryStatus> <DeliveryDate>string</DeliveryDate> <ChannelAddress>string</ChannelAddress>
soap12:Body>
</soap12:Envelope>


Tip

If the request was successful, the

Status
subtletrue
colourRed
titleCode
 parameter will return
Status
subtletrue
colourRed
title00
as a response. In addition to that,
Status
subtletrue
colourRed
titleMemberID
field of the newly added or updated member will also be returned as a response.

Error Parameters


CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.
99Member already exists. No insertion will be done!If ForceUpdate is false and the member already exists in the system.



QueryCampaignsBetweenDates 
Anchor
querycampaigndates
querycampaigndates

Back to Top ^

<QueryCampaignsBetweenDates>
Shows the specific campaign information obtained by the member between selected dates.

Parameters


ParameterValue
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

KeyThis field must contain the account-specific primary key column (EMAIL, KEY_ID).

Status
colourGreen
titleMANDATORY

ValueThe value of the field name specified in the Key field

Status
colourGreen
titleMANDATORY

BeginDateStart Date. yyyy-MM-dd HH:mm:ss or yyyyMMdd HH:mm:ss

Status
colourGreen
titleMANDATORY

EndDateEnd Date. yyyy-MM-dd HH:mm:ss or yyyyMMdd HH:mm:ss

Status
colourGreen
titleMANDATORY




Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?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>
    <QueryCampaignsBetweenDates xmlns="http://ws.euromsg.com/member">
      <ServiceTicket>string</ServiceTicket>
      <Key>string</Key>
      <Value>string</Value>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
    </QueryCampaignsBetweenDates>
  </soap12:Body>
</soap12:Envelope>


<DeliveryDate>string</DeliveryDate>
          <ChannelAddress>string</ChannelAddress>
          <ChannelType>string</ChannelType>
          <SentTime>string</SentTime>
          <Subject>string</Subject>
          <CampaignMessage>string</CampaignMessage>
        </EmCampaignResult>
      </CampaignResults>
    </QueryCampaignsBetweenDatesResponse>
  </soap12:Body>
</soap12:Envelope>
Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?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>
    <QueryCampaignsBetweenDatesResponse xmlns="http://ws.euromsg.com/member">
      <QueryCampaignsBetweenDatesResult />
      <CampaignResults>
        <EmCampaignResult>
          <CampaignId>string</CampaignId>
      <ChannelType>string</ChannelType>    <CampaignName>string</CampaignName>
          <DeliveryStatus>string</DeliveryStatus>
          <SentTime>string<<DeliveryDate>string</SentTime>DeliveryDate>
          <ChannelAddress>string</ChannelAddress>
          <Subject>string<<ChannelType>string</Subject>ChannelType>
          <SentTime>string</SentTime>
          <CampaignMessage>string<<Subject>string</CampaignMessage>Subject>
          <CampaignMessage>string</CampaignMessage>
        </EmCampaignResult>
        <EmCampaignResult>
     </CampaignResults>     <CampaignId>string</CampaignId>
          <CampaignName>string</CampaignName>
          </QueryCampaignsBetweenDatesResponse><DeliveryStatus>string</DeliveryStatus>
          </soap:Body>
</soap:Envelope>
Tip
If the request was successful, 
Status
subtletrue
colourRed
title


Tip

If the request was successful, 

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


Delivery StatusRD : Read, HU : hard-undelivered, SU : Soft Undelivered

Status
colourGreen
titleemail

Delivery StatusRelayed To Operator, Relayed To Gsm, Delivered, Error_Message, Unexpected Error

Status
colourGreen
titleSMS

Error Parameters

 


CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.
99Not a valid Date!The specified date format is invalid.
 



QueryMemberId 
Anchor
memberid
memberid

Back to Top ^

<QueryMemberID>
Queries 32-char ID of a member based on Key and Value pair.

Parameters

 


ParameterValue 
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

KeyThis field must contain the account-specific primary key column (EMAIL, MEMBERKEY_ID or a field name of your defined in RMC account management panel).

Status
colourGreen
titleMANDATORY

ValueThe value of the field name specified in the Key field

Status
colourGreen
titleMANDATORY




Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
    <soap<soap12:Body>
 
      <QueryMemberID xmlns="http://apiws.relateddigitaleuromsg.com/member">
     
      <ServiceTicket>string</ServiceTicket>
   
        <Key>string</Key>
            <Value>string</Value>

       </QueryMemberID>
 
  </soapsoap12:Body>
</soapsoap12:Envelope>


Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope
    xmlns:soapxsi="http://schemaswww.xmlsoapw3.org/soap/envelope/"
   2001/XMLSchema-instance" xmlns:xsixsd="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsdsoap12="http://www.w3.org/2003/200105/XMLSchemasoap-envelope">
    <soap<soap12:Body>
        <QueryMemberIDResponse xmlns<QueryMemberIDResponse xmlns="http://apiws.relateddigitaleuromsg.com/member">
            <QueryMemberIDResult>
                <Code>00</Code>
                <Message /<QueryMemberIDResult />
                <DetailedMessage />
            </QueryMemberIDResult>
            <MemberID>D67C7F1655E34F3B8B1DA9BD55C8F4C8</MemberID>
   <MemberID>string</MemberID>
    </QueryMemberIDResponse>
 
  </soapsoap12:Body>
</soapsoap12:Envelope>


Tip

If the request was successful, the

Status
subtletrue
colourRed
titleCode
 parameter will return
Status
subtletrue
colourRed
title00
as a response. In addition to that,
Status
subtletrue
colourRed
titleMemberID
field of the newly added or updated member will also be returned as a response.

Error Parameters

 


CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.
99No such member!A member matching the Key parameter value does not exist.
 



QuerySendLists 
Anchor
querysendlists
querysendlists

Back to Top ^

<QuerySendLists>
Shows the lists that the specific member is included in.

Parameters

 


ParameterValue 
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

KeyThis field must contain the account-specific primary key column (EMAIL, MEMBERKEY_ID or a field name of your defined in RMC account management panel).

Status
colourGreen
titleMANDATORY

ValueThe value of the field name specified in the Key field

Status
colourGreen
titleMANDATORY




Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
    <soap<soap12:Body>
  
     <QuerySendLists xmlns="http://apiws.relateddigitaleuromsg.com/member">
     
      <ServiceTicket>string</ServiceTicket>
    
       <Key>string</Key>
            <Value>string</Value>
 
      </QuerySendLists>
 
  </soapsoap12:Body>
</soapsoap12:Envelope>


Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope
    xmlns:soapxsi="http://schemaswww.xmlsoapw3.org/soap/envelope/"
   2001/XMLSchema-instance" xmlns:xsixsd="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsdsoap12="http://www.w3.org/2003/200105/XMLSchemasoap-envelope">
    <soap<soap12:Body>
  
     <QuerySendListsResponse             xmlns="http://apiws.relateddigitaleuromsg.com/member">
      <QuerySendListsResult />
    <QuerySendListsResult>  <Lists>
           <EmSendList>
  <Code>00</Code>                 <Message /><ListName>string</ListName>
                <DetailedMessage />
   <GroupName>string</GroupName>
        </QuerySendListsResult>
     EmSendList>
      <Lists>                 <EmSendList>
                    <ListName>E-Bülten<<ListName>string</ListName>
                    <GroupName>Genel</GroupName>
       <GroupName>string</GroupName>
        </EmSendList>
      </Lists>
    </QuerySendListsResponse>
    <EmSendList>
                    <ListName>Test Grubu</ListName>
                    <GroupName>Genel</GroupName>
                </EmSendList>
                <EmSendList>
                    <ListName>HelloList</ListName>
                    <GroupName>Genel</GroupName>
                </EmSendList>
            </Lists>
        </QuerySendListsResponse>
    </soap:Body>
</soap:Envelope>
Tip

If the request was successful, 

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

Error Parameters

 

 

CodeError MessageDescription9998No session. Please try re-logon.No active sessions found. Try login again.99No such member!A member matching the Key parameter value does not exist.

 

RemoveFromSendLists  Anchorremovefromremovefrom

Back to Top ^

<RemoveFromSendLists>Removes a specific member from a specific list.

Parameters

 

ParameterValue ServiceTicketServiceTicket obtained through Login
</soap12:Body>
</soap12:Envelope>


Tip

If the request was successful, 

Status
subtletrue
colourRed
titleCode
 the 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.
99No such member!A member matching the Key parameter value does not exist.



RemoveFromSendLists 
Anchor
removefrom
removefrom

Back to Top ^

<RemoveFromSendLists>
Removes a specific member from a specific list.

Parameters


ParameterValue
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

KeyThis field must contain the account-specific primary key column (EMAIL, KEY_ID).

Status
colourGreen
titleMANDATORY

ValueThe value of the field name specified in the Key field

Status
colourGreen
titleMANDATORY

SendListsThe name of the lists to remove the member from

Status
colourGreen
titleMANDATORY

KeyValueThe value of the field name specified in the Key field

Status
colourGreen
titleMANDATORY

SendListsThe name of the lists to remove the member from

Status
colourGreen
titleMANDATORY

DeleteIfInNoListIf true, after removing the member from the specified
DeleteIfInNoList
EMAIL, MEMBER_ID or a field name of your defined in RMC account management panel

Status
colourGreen
titleMANDATORY

If true, after removing the member from the specified list, if the member is not on any other lists, it is deleted from the database entirely

 

Status
colourGreen
titleMANDATORY




Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
    <soap<soap12:Body>
   
    <RemoveFromSendLists xmlns="http://apiws.relateddigitaleuromsg.com/member">
     
      <ServiceTicket>string</ServiceTicket>
      <Key>string</Key>
      <Key>string</Key>
            <Value>string</Value>
            <SendLists>
       
        <EmSendList>
   
                <ListName>string</ListName>

                   <GroupName>string</GroupName>
                </EmSendList>
      
         <EmSendList>
                    <ListName>string</ListName>
     
              <GroupName>string</GroupName>
       
        </EmSendList>
   
        </SendLists>
     
      <DeleteIfInNoList>boolean</DeleteIfInNoList>
   
    </RemoveFromSendLists>
 
  </soapsoap12:Body>
</soapsoap12:Envelope>


Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope
    xmlns:soapxsi="http://schemaswww.xmlsoapw3.org/soap/envelope/2001/XMLSchema-instance"     xmlns:xsixsd="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsdsoap12="http://www.w3.org/2003/200105/XMLSchemasoap-envelope">
    <soap<soap12:Body>
   
    <RemoveFromSendListsResponse             xmlns="http://apiws.relateddigitaleuromsg.com/member">
            <RemoveFromSendListsResult>
                <Code>00</Code><RemoveFromSendListsResult />
                <Message />
                <DetailedMessage />
            </RemoveFromSendListsResult>
        </RemoveFromSendListsResponse>
    </soap:Body>
</soap</RemoveFromSendListsResponse>
  </soap12:Body>
</soap12: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.
99No such member!A member matching the Key parameter value does not exist.
99The list or lists you provided are not valid!Invalid list name.
 



SendOngoingEmail 
Anchor
sendongoing
sendongoing

Back to Top ^

<SendOngoingEMail>
Updates member's demographic information, adds member if the member does not exist in the system and sends triggers an ongoing email campaign.

Parameters

 


ParameterValue
 

ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

KeyThis field must contain the account-specific primary key column (EMAIL,
MEMBER
KEY_ID
or a field name of your defined in RMC account management panel
).

Status
colourGreen
titleMANDATORY

ValueThe value of the field name specified in the Key field

Status
colourGreen
titleMANDATORY

DemograficDataDefines the fields for member with the EmKeyValue string

Status
colourGreen
titleMANDATORY

ForceUpdateIf the member exists in the system and the value is  true , then the existing member is updated

Status
colourGreen
titleMANDATORY

OngoingCampaignIdThe Ongoing Campaign ID to be sent to member

Status
colourGreen
titleMANDATORY


Note
Fields like First Name and Last Name are set through the RMC platform.

Static Fields

 


Field NameDescription
EMAILEmail address
STATUSMember Status. A: Active, P: Passive
EMAIL_PERMITEmail opt-in. Y: Yes, N: No
GSM_PERMITSMS opt-in. Y: Yes, N: No
FAX_PERMITFAX opt-in. Y: Yes, N: No
CALL_PERMITCall Center opt-in. Y: Yes, N: No
PRINT_PERMITPrint opt-in. Y: Yes, N: No
REFERRALReferral Address
REFERRAL_DOMAINReferral Domain



Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"     xmlns:xsd="http://www.w3.org/2001/XMLSchema"     xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
    <soap<soap12:Body>
  
     <SendOngoingEMail xmlns="http://apiws.relateddigitaleuromsg.com/member">
     
      <ServiceTicket>string</ServiceTicket>
     
      <Key>string</Key>
     
      <Value>string</Value>
      <DemograficData>
     <DemograficData>   <EmKeyValue>
          <Key>string</Key>
  <EmKeyValue>        <Value>string</Value>
            <Key>string</Key>
                    <Value>string</Value>
                </EmKeyValue>

               <EmKeyValue>
        
           <Key>string</Key>
                    <Value>string</Value>
     
          </EmKeyValue>
     
      </DemograficData>
     
      <ForceUpdate>boolean</ForceUpdate>
 
          <OngoingCampaignId>string</OngoingCampaignId>
   
    </SendOngoingEMail>
 
  </soapsoap12:Body>
</soapsoap12:Envelope>


tip
Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope
    xmlns:soapxsi="http://schemaswww.xmlsoapw3.org/soap/envelope/2001/XMLSchema-instance"     xmlns:xsixsd="http://www.w3.org/2001/XMLSchema-instance"     xmlns:xsdsoap12="http://www.w3.org/2003/200105/XMLSchemasoap-envelope">
    <soap<soap12:Body>
   
    <SendOngoingEMailResponse
            xmlns="http://apiws.relateddigitaleuromsg.com/member">
      <SendOngoingEMailResult />
    <SendOngoingEMailResult>  <MemberID>string</MemberID>
              <Code>99</Code><TransactionID>string</TransactionID>
                <Message>Online Campaign does not exist!</Message>SendOngoingEMailResponse>
                <DetailedMessage />
            </SendOngoingEMailResult>
            <MemberID />
            <TransactionID />
        </SendOngoingEMailResponse>
    </soap:Body>
</soap:Envelope>
</soap12:Body>
</soap12:Envelope>


Tip

If the request was successful, the

Status
subtletrue
colourRed
titleCode
 parameter will return
Status
subtletrue
colourRed
title00
as a response. In addition to that,
Status
subtletrue
colourRed
titleMemberID
field of the newly added or updated member will also be returned as a response.

Error Parameters

 


CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.
99Online Campaign does not exist!The campaign to trigger for the member was not found.
 



QueryMemberDemography 
Anchor
querymemb
querymemb

Back to Top ^

<QueryMemberDemography>
Lists the demographic areas for the member.

Parameters


 

ParameterValue 
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

KeyThis field must contain the account-specific primary key column (EMAIL, MEMBERKEY_ID or a field name of your defined in RMC account management panel).

Status
colourGreen
titleMANDATORY

ValueThe value of the field name specified in the Key field

Status
colourGreen
titleMANDATORY


Note

Fields like First Name and Last Name are set through the RMC platform.




Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
    <soap<soap12:Body>
        <QueryMemberDemography xmlns<QueryMemberDemography xmlns="http://apiws.relateddigitaleuromsg.com/member">
            <ServiceTicket>string</ServiceTicket>

           <Key>string</Key>
     
      <Value>string</Value>
   
    </QueryMemberDemography>
 
  </soapsoap12:Body>
</soapsoap12: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>
        <QueryMemberDemographyResponse             xmlns="http://apiws.relateddigitaleuromsg.com/member">
            <QueryMemberDemographyResult>
                <Code>00</Code>
                <Message />
                <DetailedMessage />
            </QueryMemberDemographyResult>
            <DemograficData>
                <EmKeyValue>
                    <Key>MEMBER_ID</Key>
                    <Value>B04314B832A549A3B92A11153D1F7BA9</Value>
                </EmKeyValue>
                <EmKeyValue>
                    <Key>EMAIL</Key>
                    <Value>test1@sampledomain.com</Value>
                </EmKeyValue>
                <EmKeyValue>
                    <Key>STATUS</Key>
                    <Value>A</Value>
                </EmKeyValue>
                <EmKeyValue>
                    <Key>EMAIL_PERMIT</Key>
                    <Value>L</Value>
                </EmKeyValue>
                <EmKeyValue>
                    <Key>GSM_PERMIT</Key>
                    <Value>L</Value>
                </EmKeyValue>
                <EmKeyValue>
                    <Key>FAX_PERMIT</Key>
                    <Value>Y</Value>
                </EmKeyValue>
                <EmKeyValue>
                    <Key>CALL_PERMIT</Key>
                    <Value>Y</Value>
                </EmKeyValue>
                <EmKeyValue>
                    <Key>PRINT_PERMIT</Key>
                    <Value>Y</Value>
                </EmKeyValue>
                <EmKeyValue>
                    <Key>REFERRAL</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>REFERRAL_DOMAIN</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>CREATED</Key>
                    <Value>5.1.2016 12:29:37</Value>
                </EmKeyValue>
                <EmKeyValue>
                    <Key>CREATED_BY</Key>
                    <Value>SM</Value>
                </EmKeyValue>
                <EmKeyValue>
                    <Key>UPDATED</Key>
                    <Value>11.1.2016 21:31:05</Value>
                </EmKeyValue>
                <EmKeyValue>
                    <Key>UPDATED_BY</Key>
                    <Value>WS</Value>
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Adiniz</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Soyadiniz</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Mesleğiniz</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>İş_Telefonunuz</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Ev_Telefonunuz</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Cep_Telefonunuz</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Faks_Numaranız</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Doğum_Tarihiniz</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Doğum_Yeriniz</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Adresiniz</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Yaşadığınız_Şehir</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_1</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_2</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_3</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_4</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_5</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_6</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_7</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_8</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_9</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_10</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_11</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_12</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_13</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_14</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_15</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_16</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_17</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_18</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_19</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_20</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_21</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_22</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_23</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_24</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_25</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_26</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_27</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_28</Key>
                    <Value />
                </EmKeyValue>
                <EmKeyValue>
                    <Key>Değiştirilebilir_Alan_29</Key>
                    <Value />
                </EmKeyValue>
            </DemograficData>
        </QueryMemberDemographyResponse>
    </soap:Body>
</soap:Envelope>


Tip

If the request was successful, 

Status
subtletrue
colourRed
titleCode
 the 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.
99No such member!A member matching the Key parameter value does not exist.
 



SendOngoingSms 
Anchor
sendonsms
sendonsms

Back to Top ^

<SendOngoingSms>
Updates member's demographic information, adds member if member does not exist in the system and send triggers an ongoing SMS campaign.

Parameters

 


ParameterValue 
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

KeyThis field must contain the account-specific primary key column (EMAIL, MEMBERKEY_ID or a field name of your defined in RMC account management panel).

Status
colourGreen
titleMANDATORY

ValueThe value of the field name specified in the Key field

Status
colourGreen
titleMANDATORY


Note

Fields like First Name and Last Name are set through the RMC platform.



Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
    <soap<soap12:Body>
   
    <SendOngoingSms xmlns="http://apiws.relateddigitaleuromsg.com/member">
            <ServiceTicket>string<<ServiceTicket>string</ServiceTicket>

           <Key>string</Key>
  
         <Value>string</Value>
     
      <DemograficData>
       
        <EmKeyValue>

                   <Key>string</Key>
     
              <Value>string</Value>
        </EmKeyValue>
       </EmKeyValue> <EmKeyValue>
          <Key>string</Key>
    <EmKeyValue>      <Value>string</Value>
        </EmKeyValue>
     <Key>string< </Key>DemograficData>
      <InsertMember>boolean</InsertMember>
      <ForceUpdate>boolean</ForceUpdate>
      <Value>string<<OngoingCampaignId>string</Value>OngoingCampaignId>
      <GsmNo>string</GsmNo>
    </SendOngoingSms>
   </soap12:Body>
</EmKeyValue>
            </DemograficData>
            <InsertMember>boolean</InsertMember>
            <ForceUpdate>boolean</ForceUpdate>
            <OngoingCampaignId>string</OngoingCampaignId>
            <GsmNo>string</GsmNo>
        </SendOngoingSms>
    </soap:Body>
</soapsoap12:Envelope>


Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?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>
    <SendOngoingSmsResponse xmlns="http://ws.euromsg.com/member">
      <SendOngoingSmsResult />
      <MemberID>string</MemberID>
      <TransactionID>string</TransactionID>
    </SendOngoingSmsResponse>
  </soap12:Body>
</soap12:Envelope>


Tip

If the request was successful, the

Status
subtletrue
colourRed
titleCode
 parameter will return
Status
subtletrue
colourRed
title00
as a response. In addition to that,
Status
subtletrue
colourRed
titleMemberID
field of the newly added or updated member will also be returned as a response.

Error Parameters


CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.
99Online Campaign does not exist!The campaign to trigger for the member was not found.



UpdateMemberDemography 
Anchor
updatedem
updatedem

Back to Top ^

<UpdateMemberDemography>
Updates member's demographic information.

Parameters


ParameterValue
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

KeyThis field must contain the account-specific primary key column (EMAIL, KEY_ID).

Status
colourGreen
titleMANDATORY

ValueThe value of the field name specified in the Key field

Status
colourGreen
titleMANDATORY

DemograficDataDefines the fields for member with the EmKeyValue string

Status
colourGreen
titleMANDATORY

ForceInsertIf the member does not exist in the system and the value is  true , then the member is added

Status
colourGreen
titleMANDATORY


Note

Fields like First Name and Last Name are set through the RMC platform.

Static Fields


Alan AdıDescription
EMAILEmail address
STATUSMember Status. A: Active, P: Passive
EMAIL_PERMITEmail opt-in. Y: Yes, N: No
GSM_PERMITSMS opt-in. Y: Yes, N: No
FAX_PERMITFAX opt-in. Y: Yes, N: No
CALL_PERMITCall Center opt-in. Y: Yes, N: No
PRINT_PERMITPrint opt-in. Y: Yes, N: No
REFERRALReferral Address
REFERRAL_DOMAINReferral Domain




Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?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>
    <UpdateMemberDemography xmlns="http://ws.euromsg.com/member">
      <ServiceTicket>string</ServiceTicket>
      <Key>string</Key>
      <Value>string</Value>
      <DemograficData>
        <EmKeyValue>
          <Key>string</Key>
          <Value>string</Value>
        </EmKeyValue>
        <EmKeyValue>
          <Key>string</Key>
          <Value>string</Value>
        </EmKeyValue>
      </DemograficData>
      <ForceInsert>boolean</ForceInsert>
    </UpdateMemberDemography>
  </soap12:Body>
</soap12:Envelope>


Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?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>
    <UpdateMemberDemographyResponse xmlns="http://ws.euromsg.com/member">
      <UpdateMemberDemographyResult />
      <MemberID>string</MemberID>
    </UpdateMemberDemographyResponse>
  </soap12:Body>
</soap12:Envelope>


Tip

If the request was successful, the

Status
subtletrue
colourRed
titleCode
 parameter will return
Status
subtletrue
colourRed
title00
as a response. In addition to that,
Status
subtletrue
colourRed
titleMemberID
field of the newly added or updated member will also be returned as a response.

Error Parameters


CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.
99Member is new. No update!ForceInsert is false and the member does not exist in the system.





Anchor
queryupdate
queryupdate

QueryLastPermissionUpdateOfAMember 

Back to Top ^

<QueryLastPermissionUpdateOfAMember>
Queries a member's last permission update details.

Parameters


ParameterValue
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

KeyThis field must contain the account-specific primary key column (EMAIL, KEY_ID).

Status
colourGreen
titleMANDATORY

ValueThe value of the field name specified in the Key field

Status
colourGreen
titleMANDATORY




Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?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>
    <QueryLastPermissionUpdateOfAMember xmlns="http://ws.euromsg.com/member">
      <ServiceTicket>string</ServiceTicket>
      <Key>string</Key>
      <Value>string</Value>
    </QueryLastPermissionUpdateOfAMember>
  </soap12:Body>
</soap12:Envelope>


Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:soap
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://
schemas
www.
xmlsoap
w3.org/2003/05/soap
/
-envelope
/"
">
  <soap12:Body>
    <QueryLastPermissionUpdateOfAMemberResponse xmlns
:xsi
="http://
www.w3.org/2001/XMLSchema-instance"
ws.euromsg.com/member">
      <QueryLastPermissionUpdateOfAMemberResult />
      <MemberPermissionDetail>
        <KeyColumnValue>string</KeyColumnValue>
        
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Email>string</Email>
       
<soap:Body>
 <GsmNo>string</GsmNo>
       
<SendOngoingSmsResponse
 
xmlns="http://api.relateddigital.com/member">
<OldStatus>string</OldStatus>
        <NewStatus>string</NewStatus>
      
<SendOngoingSmsResult>
  <OldEmailPermit>string</OldEmailPermit>
        <NewEmailPermit>string</NewEmailPermit>
     
<Code>99</Code>
   <OldGsmPermit>string</OldGsmPermit>
        <NewGsmPermit>string</NewGsmPermit>
    
<Message>Online
 
Campaign
 
does
 
not
 
exist!<
<PermissionUpdateTime>dateTime</
Message>
PermissionUpdateTime>
        <UpdateSource>string</UpdateSource>
       
<DetailedMessage
 <StatusPermissionUpdateTime>dateTime</
>
StatusPermissionUpdateTime>
        <StatusUpdateSource>string</StatusUpdateSource>
   
</SendOngoingSmsResult>
     <EmailPermitUpdateTime>dateTime</EmailPermitUpdateTime>
       
<MemberID
 <EmailPermitUpdateSource>string</
>
EmailPermitUpdateSource>
        <GsmPermitUpdateTime>dateTime</GsmPermitUpdateTime>
       
<TransactionID
 <GsmPermitUpdateSource>string</
>
GsmPermitUpdateSource>
      </MemberPermissionDetail>
    </
SendOngoingSmsResponse>
QueryLastPermissionUpdateOfAMemberResponse>
  
</
soap
soap12:Body>
</
soap
soap12:Envelope>


Tip

If the request was successful,

the

the 

Status
subtletrue
colourRed
titleCode

 parameter

 parameter will

return

return 

Status
subtletrue
colourRed
title00

as a response. In addition to that, StatussubtletruecolourRedtitleMemberID field of the newly added or updated member will also be returned

  as a response.

Error Parameters

 


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

login again.99Online Campaign does not exist!The campaign to trigger for the member was not found.

 

UpdateMemberDemography  Anchorupdatedemupdatedem

Back to Top ^

<UpdateMemberDemography>Updates member's demographic information.

Parameters

 

ParameterValue ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

KeyEMAIL, MEMBER_ID or a field name of your defined in RMC account management panel

Status
colourGreen
titleMANDATORY

ValueThe value of the field name specified in the Key field

Status
colourGreen
titleMANDATORY

DemograficDataDefines the fields for member with the EmKeyValue stringIf the member does not exist in the system and the value is  true , then the member is added
login again.
99No such member!Member does not exist in the system.



Anchor
queryperm
queryperm

QueryMembersWithPermissionUpdate

Back to Top ^

<QueryMembersWithPermissionUpdate>
Queries the members whose permissions are updated between a given date range.

Parameters


ParameterValue
ServiceTicketServiceTicket obtained through Login

Status
colourGreen
titleMANDATORY

ForceInsert

 

Alan AdıDescriptionEMAILEmail 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
BeginDateStart Date. yyyy-MM-dd HH:mm:ss or yyyyMMdd HH:mm:ss

Status
colourGreen
titleMANDATORY

Note

Fields like First Name and Last Name are set through the RMC platform.

Static Fields

EndDateEnd Date. yyyy-MM-dd HH:mm:ss or yyyyMMdd HH:mm:ss

Status
colourGreen
titleMANDATORY




Code Block
languagexml
titleREQUEST EXAMPLE
linenumberstrue
<?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>
    <QueryMembersWithPermissionUpdate xmlns="http://ws.euromsg.com/member">
      <ServiceTicket>string</ServiceTicket>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
    </QueryMembersWithPermissionUpdate>
  </soap12:Body>
</soap12:Envelope> 


Code Block
languagexml
title
REQUEST
RESPONSE EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<soap
<soap12:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:
soap
soap12="http://
schemas
www.
xmlsoap
w3.org/2003/05/soap
/
-envelope
/
">
  
<soap
<soap12:Body>
    
<UpdateMemberDemography
<QueryMembersWithPermissionUpdateResponse xmlns="http://
api
ws.
relateddigital.com/member"
euromsg.com/member">
      <QueryMembersWithPermissionUpdateResult />
      <Members>
     
<ServiceTicket>string</ServiceTicket>
   <EmMemberPermissionLog>
          
<Key>string<
<KeyColumnValue>string</
Key>
KeyColumnValue>
          <Email>string</Email>
  
<Value>string</Value>
        <GsmNo>string</GsmNo>
     
<DemograficData>
     <OldStatus>string</OldStatus>
          <NewStatus>string</NewStatus>
<EmKeyValue>
          <OldEmailPermit>string</OldEmailPermit>
          
<Key>string<
<NewEmailPermit>string</
Key>
NewEmailPermit>
          <OldGsmPermit>string</OldGsmPermit>
         
<Value>string<
 <NewGsmPermit>string</
Value>
NewGsmPermit>
          <PermissionUpdateTime>dateTime</PermissionUpdateTime>
     
</EmKeyValue>
     <UpdateSource>string</UpdateSource>
          <StatusPermissionUpdateTime>dateTime</StatusPermissionUpdateTime>
<EmKeyValue>
          <StatusUpdateSource>string</StatusUpdateSource>
          
<Key>string<
<EmailPermitUpdateTime>dateTime</
Key>
EmailPermitUpdateTime>
          <EmailPermitUpdateSource>string</EmailPermitUpdateSource>
         
<Value>string</Value>
 <GsmPermitUpdateTime>dateTime</GsmPermitUpdateTime>
          <GsmPermitUpdateSource>string</GsmPermitUpdateSource>
        </
EmKeyValue>
EmMemberPermissionLog>
        <EmMemberPermissionLog>
     
</DemograficData>
     <KeyColumnValue>string</KeyColumnValue>
       
<ForceInsert>boolean</ForceInsert>
   <Email>string</Email>
     
</UpdateMemberDemography>
     
</soap:Body> </soap:Envelope> Code Block
languagexml
titleRESPONSE EXAMPLE
linenumberstrue
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope
<GsmNo>string</GsmNo>
          
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
<OldStatus>string</OldStatus>
          <NewStatus>string</NewStatus>
          
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
<OldEmailPermit>string</OldEmailPermit>
      
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <NewEmailPermit>string</NewEmailPermit>
<soap:Body>
         
<UpdateMemberDemographyResponse
 
xmlns="http://api.relateddigital.com/member">
<OldGsmPermit>string</OldGsmPermit>
          <NewGsmPermit>string</NewGsmPermit>
    
<UpdateMemberDemographyResult>
      <PermissionUpdateTime>dateTime</PermissionUpdateTime>
          
<Code>00</Code>
<UpdateSource>string</UpdateSource>
          <StatusPermissionUpdateTime>dateTime</StatusPermissionUpdateTime>
        
<Message
  <StatusUpdateSource>string</
>
StatusUpdateSource>
          <EmailPermitUpdateTime>dateTime</EmailPermitUpdateTime>
         
<DetailedMessage
 <EmailPermitUpdateSource>string</
>
EmailPermitUpdateSource>
          <GsmPermitUpdateTime>dateTime</GsmPermitUpdateTime>
  
</UpdateMemberDemographyResult>
        <GsmPermitUpdateSource>string</GsmPermitUpdateSource>
     
<MemberID>DC932B81584943E2ADDBE828D2AAF990</MemberID>
   </EmMemberPermissionLog>
      </
UpdateMemberDemographyResponse>
Members>
    </QueryMembersWithPermissionUpdateResponse>
  </
soap
soap12:Body>
</
soap
soap12:Envelope>


Tip

If the request was successful,

the

the 

Status
subtletrue
colourRed
titleCode

 parameter

 parameter will

return

return 

Status
subtletrue
colourRed
title00
  as a response.

In addition to that, Statussubtletrue

colourRedtitleMemberID field of the newly added or updated member will also be returned as a response.

Error Parameters

 ForceInsert is false and the member


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

Member is new. No update!
No such member!Member does not exist in the system.

 

 




Parent Topic: SOAP Web Service