Page Comparison

Status

colour	Green
title	POST

Anchor

	topmws
	topmws

Service URL	member.asmx

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:

Method	Description
AddToAllLists	Adds a specific user to all the lists.
AddToSendLists	Adds a specific user to selected lists.
ChangeMemberPermissionByEmail	Update the member's channel permissions The member is defined by Email.
CreatePushSubscription	Create a new push subscription or update existing one with Member ID, Token, App Alias and Status
InsertMemberDemography	Inserts/Updates the member’s demographic information.
QueryCampaignsBetweenDates	Shows the specific campaign information obtained by the member between selected dates.
QueryMemberDemography	Lists the demographic areas for the member.
QueryMemberID	Queries 32-char ID of a member based on Key and Value pair.
QuerySendLists	Shows the lists that the specific member is included in.
RemoveFromSendLists	Removes a specific member from a specific list.
SendOngoingEMail	Updates member's demographic information, adds member if the member does not exist in the system and triggers an ongoing email campaign.
SendOngoingSms	Updates member's demographic information, adds member if member does not exist in the system and triggers an ongoing SMS campaign.
UpdateMemberDemography	Updates member's demographic information.
QueryLastPermissionUpdateOfAMember	Queries a member's last permission update details.
QueryMembersWithPermissionUpdate	Queries 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


subtle	true
colour	Red
title	Service Ticket

. Developers can send requests to other Web Service and methods using this

Status


subtle	true
colour	Red
title	Service Ticket

AddToAllLists
Anchor
addtoalllists
addtoalllists

Back to Top ^

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

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	MANDATORY

Key

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

Status

colour	Green
title	MANDATORY

Value

The value of the field name specified in the Key field

Status

colour	Green
title	MANDATORY

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
        <AddToAllLists xmlns="http://api.relateddigital.com/member">
            <ServiceTicket>string</ServiceTicket>
            <Key>string</Key>
            <Value>string</Value>
        </AddToAllLists>
    </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
        <AddToAllListsResponse xmlns="http://api.relateddigital.com/member">
            <AddToAllListsResult>
                <Code>00</Code>
                <Message />
                <DetailedMessage />
            </AddToAllListsResult>
        </AddToAllListsResponse>
    </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

 Status
subtle true
colour Red
title 00

as a response.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	No 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

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	MANDATORY

Key

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

Status

colour	Green
title	MANDATORY

Value

The value of the field name specified in the Key field

Status

colour	Green
title	MANDATORY

SendLists

You can select multiple lists by using EmSendList string

Status

colour	Green
title	MANDATORY

Move

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

Status

colour	Green
title	MANDATORY

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
        <AddToSendLists xmlns="http://api.relateddigital.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>
    </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
        <AddToSendListsResponse xmlns="http://api.relateddigital.com/member">
            <AddToSendListsResult>
                <Code>00</Code>
                <Message />
                <DetailedMessage />
            </AddToSendListsResult>
        </AddToSendListsResponse>
    </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

 Status
subtle true
colour Red
title 00

as a response.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	The list or lists you provided are not valid!	The specified list was not found.

Anchor
ChangeMemberPermissionByEmail
ChangeMemberPermissionByEmail
ChangeMemberPermissionByEmail

Back to Top ^

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

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	MANDATORY

EmailValue

Email address

Status

colour	Green
title	MANDATORY

Status

Member Status A: Active , P: Passive

Status

colour	Green
title	MANDATORY

EmailPermit

Email opt-in Y: Yes, N: No

Status

colour	Green
title	MANDATORY

GsmPermit

SMS opt-in Y: Yes, N: No

Status

colour	Green
title	MANDATORY

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
    <ChangeMemberPermissionByEmail xmlns="http://ws.euromsg.com/member">
      <ServiceTicket>string</ServiceTicket>
      <EmailValue>string</EmailValue>
      <Status>string</Status>
      <EmailPermit>string</EmailPermit>
      <GsmPermit>string</GsmPermit>
    </ChangeMemberPermissionByEmail>
  </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
    <ChangeMemberPermissionByEmailResponse xmlns="http://ws.euromsg.com/member">
      <ChangeMemberPermissionByEmailResult />
      <MemberID>
        <string>string</string>
        <string>string</string>
      </MemberID>
    </ChangeMemberPermissionByEmailResponse>
  </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

 Status
subtle true
colour Red
title 00

as a response.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	No such member!	Member does not exist in the system.

AddToSendLists Anchoraddtosendlistaddtosendlist

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

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	MANDATORY

MemberID

MEMBER_ID

Status

colour	Green
title	MANDATORY

PushToken

Push Token

Status

colour	Green
title	MANDATORY

AppAlias

App Alias at Customer Push Application(s)

Status

colour	Green
title	MANDATORY

ForceUpdate

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

Status

colour	Green
title	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.

Status

colour	Blue
title	CONDITIONAL

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?xml version="1.0" encoding="utf-8"?>
<?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>
    <PushSubscription xmlns="http://api.relateddigital.com/member">
      <ServiceTicket>string</ServiceTicket>
      <PushToken>string</PushToken>
      <MemberID>string</MemberID>
      <AppAlias>string</AppAlias>
      <Status>string</Status>
      <ForceUpdate>boolean</ForceUpdate>
    </PushSubscription>
  </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
    <PushSubscriptionResponse xmlns="http://api.relateddigital.com/member">
      <PushSubscriptionResult />
      <Success>boolean</Success>
    </PushSubscriptionResponse>
  </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status


subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response. In addition to that,

Status

subtle	true
colour	Red
title	Success

field of the newly added or updated token status will also be returned as a response.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	No 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

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	MANDATORY

Key

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

Status

colour	Green
title	MANDATORY

Value

The value of the field name specified in the Key field

Status

colour	Green
title	MANDATORY

DemograficData

Define the fields for member with the EmKeyValue string

Status

colour	Green
title	MANDATORY

ForceUpdate

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

Status

colour	Green
title	MANDATORY

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

Static Fields

Field Name	Description
EMAIL	Email address
STATUS	Member Status. A: Active, P: Passive
EMAIL_PERMIT	Email opt-in. Y: Yes, N: No
GSM_PERMIT	SMS opt-in. Y: Yes, N: No
FAX_PERMIT	FAX opt-in. Y: Yes, N: No
CALL_PERMIT	Call Center opt-in. Y: Yes, N: No
PRINT_PERMIT	Print opt-in. Y: Yes, N: No
REFERRAL	Referral Address
REFERRAL_DOMAIN	Referral Domain

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
        <InsertMemberDemography xmlns="http://api.relateddigital.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>
    </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
        <InsertMemberDemographyResponse xmlns="http://api.relateddigital.com/member">
            <InsertMemberDemographyResult>
                <Code>00</Code>
                <Message />
                <DetailedMessage />
            </InsertMemberDemographyResult>
            <MemberID>B04314B832A549A3B92A11153D1F7BA9</MemberID>
        </InsertMemberDemographyResponse>
    </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status


subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response. In addition to that,

Status


subtle	true
colour	Red
title	MemberID

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

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	Member 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

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	MANDATORY

Key

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

Status

colour	Green
title	MANDATORY

Value

The value of the field name specified in the Key field

Status

colour	Green
title	MANDATORY

BeginDate

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

Status

colour	Green
title	MANDATORY

EndDate

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

Status

colour	Green
title	MANDATORY

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
            <Key>string</Key>
            <Value>string</Value>
            <BeginDate>string</BeginDate>
            <EndDate>string</EndDate>
        </QueryCampaignsBetweenDates>
    </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
        <QueryCampaignsBetweenDatesResponse
            xmlns="http://api.relateddigital.com/member">
            <QueryCampaignsBetweenDatesResult>
                <Code>00</Code>
                <Message />
                <DetailedMessage />
            </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>
    </soap:Body>
</soap:Envelope>

Tip

If the request was successful,

Status

subtle	true
colour	Red
title	Code

the parameter will return

 Status
subtle true
colour Red
title 00

as a response.

Delivery Status

RD : Read, HU : hard-undelivered, SU : Soft Undelivered

Status

colour	Green
title	email

Delivery Status

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

Status

colour	Green
title	SMS

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	Not 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

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	MANDATORY

Key

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

Status

colour	Green
title	MANDATORY

Value

The value of the field name specified in the Key field

Status

colour	Green
title	MANDATORY

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
        <QueryMemberID xmlns="http://api.relateddigital.com/member">
            <ServiceTicket>string</ServiceTicket>
            <Key>string</Key>
            <Value>string</Value>
        </QueryMemberID>
    </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
        <QueryMemberIDResponse xmlns="http://api.relateddigital.com/member">
            <QueryMemberIDResult>
                <Code>00</Code>
                <Message />
                <DetailedMessage />
            </QueryMemberIDResult>
            <MemberID>D67C7F1655E34F3B8B1DA9BD55C8F4C8</MemberID>
        </QueryMemberIDResponse>
    </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status


subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response. In addition to that,

Status


subtle	true
colour	Red
title	MemberID

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

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	No 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

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	MANDATORY

Key

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

Status

colour	Green
title	MANDATORY

Value

The value of the field name specified in the Key field

Status

colour	Green
title	MANDATORY

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <QuerySendLists xmlns="http://api.relateddigital.com/member">
            <ServiceTicket>string</ServiceTicket>
            <Key>string</Key>
            <Value>string</Value>
        </QuerySendLists>
    </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
        <QuerySendListsResponse
            xmlns="http://api.relateddigital.com/member">
            <QuerySendListsResult>
                <Code>00</Code>
                <Message />
                <DetailedMessage />
            </QuerySendListsResult>
            <Lists>
                <EmSendList>
                    <ListName>E-Bülten</ListName>
                    <GroupName>Genel</GroupName>
                </EmSendList>
                <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

subtle	true
colour	Red
title	Code

the parameter will return

 Status
subtle true
colour Red
title 00

as a response.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	No 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

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	MANDATORY

Key

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

Status

colour	Green
title	MANDATORY

Value

The value of the field name specified in the Key field

Status

colour	Green
title	MANDATORY

SendLists

The name of the lists to remove the member from

Status

colour	Green
title	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

Status

colour	Green
title	MANDATORY

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
        <RemoveFromSendLists xmlns="http://api.relateddigital.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>
    </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
        <RemoveFromSendListsResponse
            xmlns="http://api.relateddigital.com/member">
            <RemoveFromSendListsResult>
                <Code>00</Code>
                <Message />
                <DetailedMessage />
            </RemoveFromSendListsResult>
        </RemoveFromSendListsResponse>
    </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

 Status
subtle true
colour Red
title 00

as a response.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	No such member!	A member matching the Key parameter value does not exist.
99	The 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 triggers an ongoing email campaign.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	MANDATORY

Key

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

Status

colour	Green
title	MANDATORY

Value

The value of the field name specified in the Key field

Status

colour	Green
title	MANDATORY

DemograficData

Defines the fields for member with the EmKeyValue string

Status

colour	Green
title	MANDATORY

ForceUpdate

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

Status

colour	Green
title	MANDATORY

OngoingCampaignId

The Ongoing Campaign ID to be sent to member

Status

colour	Green
title	MANDATORY

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

Static Fields

Field Name	Description
EMAIL	Email address
STATUS	Member Status. A: Active, P: Passive
EMAIL_PERMIT	Email opt-in. Y: Yes, N: No
GSM_PERMIT	SMS opt-in. Y: Yes, N: No
FAX_PERMIT	FAX opt-in. Y: Yes, N: No
CALL_PERMIT	Call Center opt-in. Y: Yes, N: No
PRINT_PERMIT	Print opt-in. Y: Yes, N: No
REFERRAL	Referral Address
REFERRAL_DOMAIN	Referral Domain

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
        <SendOngoingEMail xmlns="http://api.relateddigital.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>
    </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
        <SendOngoingEMailResponse
            xmlns="http://api.relateddigital.com/member">
            <SendOngoingEMailResult>
                <Code>99</Code>
                <Message>Online Campaign does not exist!</Message>
                <DetailedMessage />
            </SendOngoingEMailResult>
            <MemberID />
            <TransactionID />
        </SendOngoingEMailResponse>
    </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status


subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response. In addition to that,

Status


subtle	true
colour	Red
title	MemberID

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

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	Online 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

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	MANDATORY

Key

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

Status

colour	Green
title	MANDATORY

Value

The value of the field name specified in the Key field

Status

colour	Green
title	MANDATORY

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

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
        <QueryMemberDemography xmlns="http://api.relateddigital.com/member">
            <ServiceTicket>string</ServiceTicket>
            <Key>string</Key>
            <Value>string</Value>
        </QueryMemberDemography>
    </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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://api.relateddigital.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

subtle	true
colour	Red
title	Code

the parameter will return

 Status
subtle true
colour Red
title 00

as a response.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	No 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 triggers an ongoing SMS campaign.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	MANDATORY

Key

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

Status

colour	Green
title	MANDATORY

Value

The value of the field name specified in the Key field

Status

colour	Green
title	MANDATORY

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

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
        <SendOngoingSms xmlns="http://api.relateddigital.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>
    </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
        <SendOngoingSmsResponse xmlns="http://api.relateddigital.com/member">
            <SendOngoingSmsResult>
                <Code>99</Code>
                <Message>Online Campaign does not exist!</Message>
                <DetailedMessage />
            </SendOngoingSmsResult>
            <MemberID />
            <TransactionID />
        </SendOngoingSmsResponse>
    </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status


subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response. In addition to that,

Status


subtle	true
colour	Red
title	MemberID

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

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	Online 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

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	MANDATORY

Key

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

Status

colour	Green
title	MANDATORY

Value

The value of the field name specified in the Key field

Status

colour	Green
title	MANDATORY

DemograficData

Defines the fields for member with the EmKeyValue string

Status

colour	Green
title	MANDATORY

ForceInsert

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

Status

colour	Green
title	MANDATORY

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

Static Fields

Alan Adı	Description
EMAIL	Email address
STATUS	Member Status. A: Active, P: Passive
EMAIL_PERMIT	Email opt-in. Y: Yes, N: No
GSM_PERMIT	SMS opt-in. Y: Yes, N: No
FAX_PERMIT	FAX opt-in. Y: Yes, N: No
CALL_PERMIT	Call Center opt-in. Y: Yes, N: No
PRINT_PERMIT	Print opt-in. Y: Yes, N: No
REFERRAL	Referral Address
REFERRAL_DOMAIN	Referral Domain

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
        <UpdateMemberDemography
            xmlns="http://api.relateddigital.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>
    </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
        <UpdateMemberDemographyResponse xmlns="http://api.relateddigital.com/member">
            <UpdateMemberDemographyResult>
                <Code>00</Code>
                <Message />
                <DetailedMessage />
            </UpdateMemberDemographyResult>
            <MemberID>DC932B81584943E2ADDBE828D2AAF990</MemberID>
        </UpdateMemberDemographyResponse>
    </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status


subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response. In addition to that,

Status


subtle	true
colour	Red
title	MemberID

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

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	Member 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

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	MANDATORY

Key

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

Status

colour	Green
title	MANDATORY

Value

The value of the field name specified in the Key field

Status

colour	Green
title	MANDATORY

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
    <QueryLastPermissionUpdateOfAMember xmlns="http://api.relateddigital.com/member">
      <ServiceTicket>string</ServiceTicket>
      <Key>string</Key>
      <Value>string</Value>
    </QueryLastPermissionUpdateOfAMember>
  </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
    <QueryLastPermissionUpdateOfAMemberResponse xmlns="http://api.relateddigital.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>
  </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

 Status
subtle true
colour Red
title 00

as a response.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	No 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

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	MANDATORY

BeginDate

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

Status

colour	Green
title	MANDATORY

EndDate

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

Status

colour	Green
title	MANDATORY

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
    <QueryMembersWithPermissionUpdate xmlns="http://api.relateddigital.com/member">
      <ServiceTicket>string</ServiceTicket>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
    </QueryMembersWithPermissionUpdate>
  </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
    <QueryMembersWithPermissionUpdateResponse xmlns="http://api.relateddigital.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>
  </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

 Status
subtle true
colour Red
title 00

as a response.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	No such member!	Member does not exist in the system.

Parent Topic: SOAP Web Service

...

Page Comparison

Versions Compared

Old Version 47

New Version 48

Key

General Information

Member Web Service Methods

AddToAllLists Anchoraddtoalllistsaddtoalllists

Parameters

Error Parameters

AddToSendLists Anchoraddtosendlistaddtosendlist

Parameters

Error Parameters

AnchorChangeMemberPermissionByEmailChangeMemberPermissionByEmailChangeMemberPermissionByEmail

Parameters

Error Parameters

CreatePushSubscription Anchorpushsubscriptionpushsubscription

Parameters

Error Parameters

InsertMemberDemography Anchorinsertmemberinsertmember

Parameters

Static Fields

Error Parameters

QueryCampaignsBetweenDates Anchorquerycampaigndatesquerycampaigndates

Parameters

Error Parameters

QueryMemberId Anchormemberidmemberid

Parameters

Error Parameters

QuerySendLists Anchorquerysendlistsquerysendlists

Parameters

Error Parameters

RemoveFromSendLists Anchorremovefromremovefrom

Parameters

Error Parameters

SendOngoingEmail Anchorsendongoingsendongoing

Parameters

Static Fields

Error Parameters

QueryMemberDemography Anchorquerymembquerymemb

Parameters

Error Parameters

SendOngoingSms Anchorsendonsmssendonsms

Parameters

Error Parameters

UpdateMemberDemography Anchorupdatedemupdatedem

Parameters

Static Fields

Error Parameters

QueryLastPermissionUpdateOfAMember

Parameters

Error Parameters

QueryMembersWithPermissionUpdate

Parameters

Error Parameters

AddToAllLists
Anchor
addtoalllists
addtoalllists

AddToSendLists
Anchor
addtosendlist
addtosendlist

Anchor
ChangeMemberPermissionByEmail
ChangeMemberPermissionByEmail
ChangeMemberPermissionByEmail

CreatePushSubscription
Anchor
pushsubscription
pushsubscription

InsertMemberDemography
Anchor
insertmember
insertmember

QueryCampaignsBetweenDates
Anchor
querycampaigndates
querycampaigndates

QueryMemberId
Anchor
memberid
memberid

QuerySendLists
Anchor
querysendlists
querysendlists

RemoveFromSendLists
Anchor
removefrom
removefrom

SendOngoingEmail
Anchor
sendongoing
sendongoing

QueryMemberDemography
Anchor
querymemb
querymemb

SendOngoingSms
Anchor
sendonsms
sendonsms

UpdateMemberDemography
Anchor
updatedem
updatedem