Member Service

LIVE: https://api.relateddigital.com/resta/api/Member/InsertMemberDemography

ECOMM: https://api.relateddigital.com/reste/api/Member/InsertMemberDemography

LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/InsertMemberDemography

LIVEM: https://api.relateddigital.com/restm/api/Member/InsertMemberDemography

POST

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

{

"Key" : "",

"Value" : "",

"ForceUpdate" : false,

"DemographicData" :

      [

           { "Key" : "", "Value": ""},

           { "Key" : "", "Value": ""}

      ]

}

{

"MemberId": ""

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

00, 01, 06, 25, 43, 69, 99, 107

LIVE: https://api.relateddigital.com/resta/api/Member/UpdateMemberDemography

ECOMM: https://api.relateddigital.com/reste/api/Member/UpdateMemberDemography

LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/UpdateMemberDemography

LIVEM: https://api.relateddigital.com/restm/api/Member/UpdateMemberDemography

POST

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

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

Value(string): This is the value of the Key Column. If this value is sent in the wrong format, it will be ignored and the main process will not be interrupted.

ForceInsert(bool): If this flag is true, it inserts the member by using the demographic information provided. Otherwise, give Code not equal 00 back and put Not existing member in Message property of MemberResult object

DemographicData(KeyValue []): This is a KeyValue array. In short, keys and values that composes the demographic information.

{

"Key" : "",

"Value" : "",

"ForceInsert" : true,

"DemographicData" :

      [

           { "Key" : "", "Value": ""},

           { "Key" : "", "Value": ""}

      ]

}

{

"MemberId": ""

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

00, 01, 06, 43, 66, 69, 99, 107

LIVE: https://api.relateddigital.com/resta/api/Member/AddToSendLists

ECOMM: https://api.relateddigital.com/reste/api/Member/AddToSendLists

LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/AddToSendLists

LIVEM: https://api.relateddigital.com/restm/api/Member/AddToSendLists

POST

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

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

Value(string): This is the value of the Key Column. If this value is sent in the wrong format, it will be ignored and the main process will not be interrupted.

Move(bool): If Move is given True, the member will be removed from the old lists which are not specified in SendLists array. If Move is given False, the member will only be added to the specified lists.

SendLists(SendList []): The member specified by Key and Value pair will be added to these lists.

{

"Key" : "",

"Value" : "",

"Move" : false,

"SendLists" :

    [

       { "ListName" : "", "GroupName": ""},

       { "ListName" : "", "GroupName": ""}

    ]

}

{

"MemberId": ""

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

00, 01, 43, 66, 69, 99, 107

LIVE: https://api.relateddigital.com/resta/api/Member/QueryMemberId?Key=EMAIL&Value=test@test.com

ECOMM: https://api.relateddigital.com/reste/api/Member/QueryMemberId?Key=EMAIL&Value=test@test.com

LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/QueryMemberId?Key=EMAIL&Value=test@test.com

LIVEM: https://api.relateddigital.com/restm/api/Member/QueryMemberId?Key=EMAIL&Value=test@test.com

GET

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

Value(string): This is the value of the Key Column. If this value is sent in the wrong format, it will be ignored and the main process will not interrupted.

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

{

"MemberId": ""

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

00, 01,43,69, 99, 107

LIVE: https://api.relateddigital.com/resta/api/Member/QueryMemberDemography?Key=EMAIL&Value=test@test.com

ECOMM: https://api.relateddigital.com/reste/api/Member/QueryMemberDemography?Key=EMAIL&Value=test@test.com

LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/QueryMemberDemography?Key=EMAIL&Value=test@test.com

LIVEM: https://api.relateddigital.com/restm/api/Member/QueryMemberDemography?Key=EMAIL&Value=test@test.com

GET

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

Value(string): This is the value of the Key Column. If this value sent in the wrong format, it will be ignored and the main process will not be interrupted.

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

{

"DemographicData" :

      [

           { "Key" : "", "Value": ""},

           { "Key" : "", "Value": ""}

      ]

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

00, 01,43,69, 99, 107

LIVE: https://api.relateddigital.com/resta/api/Member/QuerySendLists?Key=EMAIL&Value=test@test.com

ECOMM: https://api.relateddigital.com/reste/api/Member/QuerySendLists?Key=EMAIL&Value=test@test.com

LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/QuerySendLists?Key=EMAIL&Value=test@test.com

LIVEM: https://api.relateddigital.com/restm/api/Member/QuerySendLists?Key=EMAIL&Value=test@test.com

GET

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

Value(string): This is the value of the Key Column. If this value sent in the wrong format, it will be ignored and the main process will not be interrupted.

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

{

"SendLists" :

    [

       { "ListName" : "", "GroupName": ""},

       { "ListName" : "", "GroupName": ""}

    ]

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

00, 01,43,69, 99, 107

LIVE: https://api.relateddigital.com/resta/api/Member/RemoveFromSendLists

ECOMM: https://api.relateddigital.com/reste/api/Member/RemoveFromSendLists

LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/RemoveFromSendLists

LIVEM: https://api.relateddigital.com/restm/api/Member/RemoveFromSendLists

DELETE

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

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

Value(string): This is the value of the Key Column. If this value sent in wrong format, it will be ignored and the main process will not be interrupted.

Move(bool): If the member is in no list after removal, this flag specifies whether the member should be completely deleted from the database or not. Use False if you do not want to delete the member.

SendLists(SendList []): The member specified by Key and Value pair will be removed from these lists.

{

"Key" : "",

"Value" : "",

"DeleteIfInNoList" : false,

"SendLists" :

    [

       { "ListName" : "", "GroupName": ""},

       { "ListName" : "", "GroupName": ""}

    ]

}

{

"MemberId": ""

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

00, 01,43,69, 99, 107,108

LIVE: https://api.relateddigital.com/resta/api/Member/AddToAllLists

ECOMM: https://api.relateddigital.com/reste/api/Member/AddToAllLists

LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/AddToAllLists

LIVEM: https://api.relateddigital.com/restm/api/Member/AddToAllLists

POST

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

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

Value(string): This is the value of the Key Column. If this value is sent in the wrong format, it will be ignored and the main process will not be interrupted.

{

"Key" : "",

"Value" : ""

}

{

"MemberId": ""

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

00, 01, 43, 69, 99, 107

LIVE: https://api.relateddigital.com/resta/api/Member/AddToWebLists

ECOMM: https://api.relateddigital.com/reste/api/Member/AddToWebLists

LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/AddToWebLists

LIVEM:https://api.relateddigital.com/restm/api/Member/AddToWebLists

POST

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

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

Value(string): This is the value of the Key Column. If this value is sent in the wrong format, it will be ignored and the main process will not be interrupted.

{

"Key" : "",

"Value" : ""

}

{

"MemberId": ""

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

00, 01, 43, 69, 99, 107

LIVE: https://api.relateddigital.com/resta/api/Member/SendOngoingEmail

ECOMM: https://api.relateddigital.com/reste/api/Member/SendOngoingEmail

LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/SendOngoingEmail

LIVEM: https://api.relateddigital.com/restm/api/Member/SendOngoingEmail

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

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

Value(string): This is the value of the Key Column. If this value sent in the wrong format, it will be ignored and the main process will not be interrupted.

ForceUpdate(bool): If this flag is true, it inserts the member by using the demographic information provided. Otherwise, give Code not equal 00 back and put Not existing member in Message property of MemberResult object

DemographicData(KeyValue []): This is a KeyValue array. In short, keys and values that composes the demographic information.

CampaignId(string): ID of the Campaign created on the RMC application. 

Note: The Campaign’s  “status” must be the "sent" or "relayed".

{

"Key":"",

"Value":" ",

"DemographicData" :

      [

           { "Key" : "", "Value": ""},

           { "Key" : "", "Value": ""}

      ],

"ForceUpdate":true,

"CampaignId":""

}

{

    "MemberId": "",

    "RecordId": "",(Email unique id)

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

00, 01,06, 12,25, 43, 69, 99, 107,113

LIVE: https://api.relateddigital.com/resta/api/Member/SendOngoingSms

ECOMM: https://api.relateddigital.com/reste/api/Member/SendOngoingSms

LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/SendOngoingSms

LIVEM:https://api.relateddigital.com/restm/api/Member/SendOngoingSms

POST

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

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

Value(string): This is the value of the Key Column. If this value sent in wrong format, it will be ignored and the main process will not be interrupted.

ForceUpdate(bool): If this flag is true, it inserts the member by using the demographic information provided. Otherwise, give Code not equal 00 back and put Not existing member in Message property of MemberResult object

DemographicData(KeyValue []): This is an KeyValue array. In short, keys and values that composes the demographic information.

CampaignId(string): ID of the Campaign created on the RMC application

GsmNo(string): GSM Number of the member who will receive the campaign

InsertMember(bool): If this flag is true, the specified member will be added into the database by using Key and Value pair.

{

"Key":"",

"Value":"",

"DemographicData":[{"Key":"","Value":""}],

"ForceUpdate":false,

"CampaignId":"",

"InsertMember":false,

 "GsmNo":

}

{

    "MemberId": "",

    "RecordId": "",(sms unique id)

    "Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

00, 01,06,10, 12,25, 40, 43, 69, 99, 107,113,122

LIVE: https://api.relateddigital.com/resta/api/Member/ChangeMemberPermissionByEmail

ECOMM: https://api.relateddigital.com/reste/api/Member/ChangeMemberPermissionByEmail

LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/ChangeMemberPermissionByEmail

LIVEM: https://api.relateddigital.com/restm/api/Member/ChangeMemberPermissionByEmail

POST

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

EmailAddress(string): Email Address of Member.

Status(string): The status of member. If value is empty, status won’t be changed. (Status can be A,P,X)

EmailPermit(string): Email permission of member. If value is empty, permission won’t be changed.( Permission can be L,Y,N,X)

GsmPermit(string): GSM permission of member. If value is empty, permission won’t be changed. ( Permission can be L,Y,N,X)

{

 "EmailAddress":"",

  "Status":"",

  "EmailPermit":"Y",

  "GsmPermit":"Y"

}

{

    "MemberIdList": [

        "0CDCA379BD8341468C2A28EC3DFCB"

    ],

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

00, 01,06, 69, 70, 95, 99, 102, 107

LIVE: https://api.relateddigital.com/resta/api/Member/CreatePushSubscription

ECOMM: https://api.relateddigital.com/reste/api/Member/CreatePushSubscription

LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/CreatePushSubscription

LIVEM: https://api.relateddigital.com/restm/api/Member/CreatePushSubscription

POST

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

PushToken(string): Push Token.

MemberID(string): Member ID (NULL OR NOT NULL)

Status(string): Token Status (Default A).( Permission can be A,I,X,P)

AppAlias(string): Customer Application Alias ( Only Push Application(s) with active status)

ForceUpdate(boolean) : If this flag is true, Token inserted else update existing token

{

 "PushToken":"",

  "MemberID":"",

  "Status":"",

"ForceUpdate":"false/true",

  "AppAlias":""

}

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

Status Code : 07 Application was not found with the specified App Alias.

Status Code : 138 Token does not found at system!

Status Code : 139 Can not insert duplicate token!

00, 01,06, 69, 70, 95, 99, 102, 107,07,138,139

LIVE: https://api.relateddigital.com/resta/api/member/QueryMemberCampaigns

ECOMM: https://api.relateddigital.com/reste/api/member/QueryMemberCampaigns

LIVEB: https://api.relateddigital.com/liveb_rest/api/member/QueryMemberCampaigns

LIVEM: https://api.relateddigital.com/restm/api/member/QueryMemberCampaigns

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

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

Value(string): This is the value of the Key Column. If this value sent in wrong format, it will be ignored and the main process will not be interrupted.

CampaignIds(string []):campaign id array. provide at most 10 campaigns,

{
"CampaignIds":["",""],

"Key":"",

"Value":"",

}

{
"Campaigns": [],
"Success": true,
"Errors": [],
"DetailedMessage": "",
"TransactionId": ""
}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

00, 99