Member Web Service

POST 

General Information 


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 detailed 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 triggers an ongoing SMS campaign.
UpdateMemberDemographyUpdates member's demographic information.
QueryLastPermissionUpdateOfAMemberQueries a member's last permission update details.
QueryMembersWithPermissionUpdateQueries the members whose permissions are updated between a given date range.


To interact with any Web Services, developers must first use the Login method to create a SERVICE TICKET. Developers can send requests to other Web Service and methods using this SERVICE TICKET



AddToAllLists 

Back to Top ^

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

Key

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

MANDATORY

ValueThe value of the field name specified in the Key field

MANDATORY


REQUEST EXAMPLE
<?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>
    <AddToAllLists xmlns="http://ws.euromsg.com/member">
      <ServiceTicket>string</ServiceTicket>
      <Key>string</Key>
      <Value>string</Value>
    </AddToAllLists>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <AddToAllListsResponse xmlns="http://ws.euromsg.com/member">
      <AddToAllListsResult />
    </AddToAllListsResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00  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 

Back to Top ^

<AddToSendLists>
Adds a specific user to selected lists.

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

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

MANDATORY

ValueThe value of the field name specified in the Key field

MANDATORY

SendListsYou can select multiple lists by using EmSendList string

MANDATORY

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

MANDATORY


REQUEST EXAMPLE
<?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>
    <AddToSendLists xmlns="http://ws.euromsg.com/member">
      <ServiceTicket>string</ServiceTicket>
      <Key>string</Key>
      <Value>string</Value>
      <SendLists>
        <EmSendList>
          <ListName>string</ListName>
          <GroupName>string</GroupName>
        </EmSendList>
        <EmSendList>
          <ListName>string</ListName>
          <GroupName>string</GroupName>
        </EmSendList>
      </SendLists>
      <Move>boolean</Move>
    </AddToSendLists>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <AddToSendListsResponse xmlns="http://ws.euromsg.com/member">
      <AddToSendListsResult />
    </AddToSendListsResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00  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.





ChangeMemberPermissionByEmail


Back to Top ^


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


Parameters


ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

EmailValueEmail address

MANDATORY

StatusMember Status A: Active , P: Passive

MANDATORY

EmailPermitEmail opt-in Y: Yes, N: No

MANDATORY

GsmPermitSMS opt-in Y: Yes, N: No

MANDATORY

REQUEST EXAMPLE
<?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://ws.euromsg.com/member">
      <ServiceTicket>string</ServiceTicket>
      <EmailValue>string</EmailValue>
      <Status>string</Status>
      <EmailPermit>string</EmailPermit>
      <GsmPermit>string</GsmPermit>
    </ChangeMemberPermissionByEmail>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <ChangeMemberPermissionByEmailResponse xmlns="http://ws.euromsg.com/member">
      <ChangeMemberPermissionByEmailResult />
      <MemberID>
        <string>string</string>
        <string>string</string>
      </MemberID>
    </ChangeMemberPermissionByEmailResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00  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 

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

MANDATORY

MemberIDMEMBER_ID

MANDATORY

PushTokenPush Token

MANDATORY

AppAliasApp Alias at Customer Push Application(s)

MANDATORY

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

MANDATORY

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.

CONDITIONAL

REQUEST EXAMPLE
<?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>
    <PushSubscription xmlns="http://ws.euromsg.com/member">
      <ServiceTicket>string</ServiceTicket>
      <PushToken>string</PushToken>
      <MemberID>string</MemberID>
      <AppAlias>string</AppAlias>
      <Status>string</Status>
      <ForceUpdate>boolean</ForceUpdate>
    </PushSubscription>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>

If the request was successful, the CODE parameter will return 00 as a response. In addition to that, SUCCESS 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 

Back to Top ^

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

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

MANDATORY

ValueThe value of the field name specified in the Key field

MANDATORY

DemograficDataDefine the fields for member with the EmKeyValue string

MANDATORY

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

MANDATORY

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

Information

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
REQUEST EXAMPLE
<?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>
        <EmKeyValue>
          <Key>string</Key>
          <Value>string</Value>
        </EmKeyValue>
        <EmKeyValue>
          <Key>string</Key>
          <Value>string</Value>
        </EmKeyValue>
      </DemograficData>
      <ForceUpdate>boolean</ForceUpdate>
    </InsertMemberDemography>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <InsertMemberDemographyResponse xmlns="http://ws.euromsg.com/member">
      <InsertMemberDemographyResult />
      <MemberID>string</MemberID>
    </InsertMemberDemographyResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00 as a response. In addition to that, MEMBERID 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 

Back to Top ^

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

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

MANDATORY

ValueThe value of the field name specified in the Key field

MANDATORY

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

MANDATORY

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

MANDATORY


REQUEST EXAMPLE
<?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>
RESPONSE EXAMPLE
<?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>
          <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>
          <ChannelType>string</ChannelType>
          <SentTime>string</SentTime>
          <Subject>string</Subject>
          <CampaignMessage>string</CampaignMessage>
        </EmCampaignResult>
      </CampaignResults>
    </QueryCampaignsBetweenDatesResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, CODE the parameter will return 00  as a response.

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

EMAIL

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

SMS

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 

Back to Top ^

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

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

MANDATORY

ValueThe value of the field name specified in the Key field

MANDATORY

REQUEST EXAMPLE
<?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>
    <QueryMemberID xmlns="http://ws.euromsg.com/member">
      <ServiceTicket>string</ServiceTicket>
      <Key>string</Key>
      <Value>string</Value>
    </QueryMemberID>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <QueryMemberIDResponse xmlns="http://ws.euromsg.com/member">
      <QueryMemberIDResult />
      <MemberID>string</MemberID>
    </QueryMemberIDResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00 as a response. In addition to that, MEMBERID 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 

Back to Top ^

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

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

MANDATORY

ValueThe value of the field name specified in the Key field

MANDATORY

REQUEST EXAMPLE
<?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>
    <QuerySendLists xmlns="http://ws.euromsg.com/member">
      <ServiceTicket>string</ServiceTicket>
      <Key>string</Key>
      <Value>string</Value>
    </QuerySendLists>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <QuerySendListsResponse xmlns="http://ws.euromsg.com/member">
      <QuerySendListsResult />
      <Lists>
        <EmSendList>
          <ListName>string</ListName>
          <GroupName>string</GroupName>
        </EmSendList>
        <EmSendList>
          <ListName>string</ListName>
          <GroupName>string</GroupName>
        </EmSendList>
      </Lists>
    </QuerySendListsResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, CODE the parameter will return 00  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 

Back to Top ^

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

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

MANDATORY

ValueThe value of the field name specified in the Key field

MANDATORY

SendListsThe name of the lists to remove the member from

MANDATORY

DeleteIfInNoList

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

MANDATORY


REQUEST EXAMPLE
<?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>
    <RemoveFromSendLists xmlns="http://ws.euromsg.com/member">
      <ServiceTicket>string</ServiceTicket>
      <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>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <RemoveFromSendListsResponse xmlns="http://ws.euromsg.com/member">
      <RemoveFromSendListsResult />
    </RemoveFromSendListsResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00  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 

Back to Top ^

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

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

MANDATORY

ValueThe value of the field name specified in the Key field

MANDATORY

DemograficDataDefines the fields for member with the EmKeyValue string

MANDATORY

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

MANDATORY

OngoingCampaignIdThe Ongoing Campaign ID to be sent to member

MANDATORY

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
REQUEST EXAMPLE
<?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>
    <SendOngoingEMail 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>
      <ForceUpdate>boolean</ForceUpdate>
      <OngoingCampaignId>string</OngoingCampaignId>
    </SendOngoingEMail>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <SendOngoingEMailResponse xmlns="http://ws.euromsg.com/member">
      <SendOngoingEMailResult />
      <MemberID>string</MemberID>
      <TransactionID>string</TransactionID>
    </SendOngoingEMailResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00 as a response. In addition to that, MEMBERID 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 

Back to Top ^

<QueryMemberDemography>
Lists the demographic areas for the member.

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

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

MANDATORY

ValueThe value of the field name specified in the Key field

MANDATORY

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

REQUEST EXAMPLE
<?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>
    <QueryMemberDemography xmlns="http://ws.euromsg.com/member">
      <ServiceTicket>string</ServiceTicket>
      <Key>string</Key>
      <Value>string</Value>
    </QueryMemberDemography>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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://ws.euromsg.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>

If the request was successful, CODE the parameter will return 00  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 

Back to Top ^

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

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

MANDATORY

ValueThe value of the field name specified in the Key field

MANDATORY

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

REQUEST EXAMPLE
<?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>
    <SendOngoingSms 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>
      <InsertMember>boolean</InsertMember>
      <ForceUpdate>boolean</ForceUpdate>
      <OngoingCampaignId>string</OngoingCampaignId>
      <GsmNo>string</GsmNo>
    </SendOngoingSms>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>

If the request was successful, the CODE parameter will return 00 as a response. In addition to that, MEMBERID 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 

Back to Top ^

<UpdateMemberDemography>
Updates member's demographic information.

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

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

MANDATORY

ValueThe value of the field name specified in the Key field

MANDATORY

DemograficDataDefines the fields for member with the EmKeyValue string

MANDATORY

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

MANDATORY

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
REQUEST EXAMPLE
<?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>
RESPONSE EXAMPLE
<?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>

If the request was successful, the CODE parameter will return 00 as a response. In addition to that, MEMBERID 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.




QueryLastPermissionUpdateOfAMember 

Back to Top ^

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

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

MANDATORY

ValueThe value of the field name specified in the Key field

MANDATORY


REQUEST EXAMPLE
<?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>
RESPONSE EXAMPLE
<?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>
    <QueryLastPermissionUpdateOfAMemberResponse xmlns="http://ws.euromsg.com/member">
      <QueryLastPermissionUpdateOfAMemberResult />
      <MemberPermissionDetail>
        <KeyColumnValue>string</KeyColumnValue>
        <Email>string</Email>
        <GsmNo>string</GsmNo>
        <OldStatus>string</OldStatus>
        <NewStatus>string</NewStatus>
        <OldEmailPermit>string</OldEmailPermit>
        <NewEmailPermit>string</NewEmailPermit>
        <OldGsmPermit>string</OldGsmPermit>
        <NewGsmPermit>string</NewGsmPermit>
        <PermissionUpdateTime>dateTime</PermissionUpdateTime>
        <UpdateSource>string</UpdateSource>
        <StatusPermissionUpdateTime>dateTime</StatusPermissionUpdateTime>
        <StatusUpdateSource>string</StatusUpdateSource>
        <EmailPermitUpdateTime>dateTime</EmailPermitUpdateTime>
        <EmailPermitUpdateSource>string</EmailPermitUpdateSource>
        <GsmPermitUpdateTime>dateTime</GsmPermitUpdateTime>
        <GsmPermitUpdateSource>string</GsmPermitUpdateSource>
      </MemberPermissionDetail>
    </QueryLastPermissionUpdateOfAMemberResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00  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.



QueryMembersWithPermissionUpdate

Back to Top ^

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

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

MANDATORY

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

MANDATORY

REQUEST EXAMPLE
<?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> 
RESPONSE EXAMPLE
<?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>
    <QueryMembersWithPermissionUpdateResponse xmlns="http://ws.euromsg.com/member">
      <QueryMembersWithPermissionUpdateResult />
      <Members>
        <EmMemberPermissionLog>
          <KeyColumnValue>string</KeyColumnValue>
          <Email>string</Email>
          <GsmNo>string</GsmNo>
          <OldStatus>string</OldStatus>
          <NewStatus>string</NewStatus>
          <OldEmailPermit>string</OldEmailPermit>
          <NewEmailPermit>string</NewEmailPermit>
          <OldGsmPermit>string</OldGsmPermit>
          <NewGsmPermit>string</NewGsmPermit>
          <PermissionUpdateTime>dateTime</PermissionUpdateTime>
          <UpdateSource>string</UpdateSource>
          <StatusPermissionUpdateTime>dateTime</StatusPermissionUpdateTime>
          <StatusUpdateSource>string</StatusUpdateSource>
          <EmailPermitUpdateTime>dateTime</EmailPermitUpdateTime>
          <EmailPermitUpdateSource>string</EmailPermitUpdateSource>
          <GsmPermitUpdateTime>dateTime</GsmPermitUpdateTime>
          <GsmPermitUpdateSource>string</GsmPermitUpdateSource>
        </EmMemberPermissionLog>
        <EmMemberPermissionLog>
          <KeyColumnValue>string</KeyColumnValue>
          <Email>string</Email>
          <GsmNo>string</GsmNo>
          <OldStatus>string</OldStatus>
          <NewStatus>string</NewStatus>
          <OldEmailPermit>string</OldEmailPermit>
          <NewEmailPermit>string</NewEmailPermit>
          <OldGsmPermit>string</OldGsmPermit>
          <NewGsmPermit>string</NewGsmPermit>
          <PermissionUpdateTime>dateTime</PermissionUpdateTime>
          <UpdateSource>string</UpdateSource>
          <StatusPermissionUpdateTime>dateTime</StatusPermissionUpdateTime>
          <StatusUpdateSource>string</StatusUpdateSource>
          <EmailPermitUpdateTime>dateTime</EmailPermitUpdateTime>
          <EmailPermitUpdateSource>string</EmailPermitUpdateSource>
          <GsmPermitUpdateTime>dateTime</GsmPermitUpdateTime>
          <GsmPermitUpdateSource>string</GsmPermitUpdateSource>
        </EmMemberPermissionLog>
      </Members>
    </QueryMembersWithPermissionUpdateResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00  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.



Parent Topic: SOAP Web Service

Copyright 2020 Related Digital