Search

Page tree
Skip to end of metadata
Go to start of metadata

On this Page:


Note: You can either use HTTPS for your requests.


InsertMemberDemography 

URL

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

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

Body

Key(string): This can be EMAIL, MEMBER_ID or any column the developer wants like Name, Surname as configured by using the RMC admin panel.

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 updates the member by using the demographic information provided. Otherwise, give Code not equal 00 back and put already 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.

Information

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

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

Sample Body

{

"Key" : "",

"Value" : "",

"ForceUpdate" : false,

"DemographicData" :

      [

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

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

      ]

}

Sample Response

{

"MemberId": ""

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

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


UpdateMemberDemography 

URL

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

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

Body

Key(string): This can be EMAIL, MEMBER_ID or any column the developer wants to use like Name, Surname as configured by using the RMC admin panel.

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.

Sample Body

{

"Key" : "",

"Value" : "",

"ForceInsert" : true,

"DemographicData" :

      [

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

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

      ]

}

Sample Response

{

"MemberId": ""

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

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


AddToSendLists 

URL

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

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

Body

Key(string): This can be EMAIL, MEMBER_ID or any column the developer wants to use like Name, Surname as configured by using the RMC admin panel.

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.

Sample Body

{

"Key" : "",

"Value" : "",

"Move" : false,

"SendLists" :

    [

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

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

    ]

}

Sample Response

{

"MemberId": ""

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

Error Code

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


QueryMemberId

URL

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

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

Http verb

GET

Parameters

Key(string): This can be EMAIL, MEMBER_ID or any column the developer wants to use like Name, Surname as configured by using the RMC admin panel

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.

Header

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

Body

 

Sample Body


Sample Response

{

"MemberId": ""

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

Error Code

00, 01,43,69, 99, 107


QueryMemberDemography

URL

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

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

Http verb

GET

Parameters

Key(string): This can be EMAIL, MEMBER_ID or any column the developer wants to use like Name, Surname as configured by using the RMC admin panel

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.

Header

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

Body

 

Sample Body


Sample Response

{

"DemographicData" :

      [

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

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

      ]

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

Error Code

00, 01,43,69, 99, 107


QuerySendLists

URL

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

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

Http verb

GET

Parameters

Key(string): This can be EMAIL, MEMBER_ID or any column the developer wants to use like Name, Surname as configured by using the RMC admin panel.

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.

Header

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

Body

 

Sample Body


Sample Response

{

"SendLists" :

    [

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

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

    ]

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

Error Code

00, 01,43,69, 99, 107


RemoveFromSendLists

URL

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

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

Http verb

DELETE

Parameters


Header

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

Body

Key(string): This can be EMAIL, MEMBER_ID or any column the developer wants to use like Name, Surname as configured by using the RMC admin panel.

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.

Sample Body

{

"Key" : "",

"Value" : "",

"DeleteIfInNoList" : false,

"SendLists" :

    [

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

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

    ]

}

Sample Response

{

"MemberId": ""

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

Error Code

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


AddToAllLists

URL

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

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

Body

Key(string): This can be EMAIL, MEMBER_ID or any column the developer wants to use like Name, Surname as configured by using the RMC admin panel.

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.

Sample Body

{

"Key" : "",

"Value" : ""

}

Sample Response

{

"MemberId": ""

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

Error Code

00, 01, 43, 69, 99, 107


AddToWebLists

URL

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

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

Body

Key(string): This can be EMAIL, MEMBER_ID or any column the developer wants to use like Name, Surname as configured by using the RMC admin panel.

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.

Sample Body

{

"Key" : "",

"Value" : ""

}

Sample Response

{

"MemberId": ""

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

Error Code

00, 01, 43, 69, 99, 107


SendOngoingEmail

URL

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

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

Body

Key(string): This can be EMAIL, MEMBER_ID or any column the developer wants to use like Name, Surname as configured by using the RMC admin panel

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".

Sample Body

{

"Key":"",

"Value":" ",

"DemographicData" :

      [

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

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

      ],

"ForceUpdate":true,

"CampaignId":""

}

Sample Response

{

    "MemberId": "",

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

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

Error Code

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


SendOngoingSms

URL

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

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

Body

Key(string): This can be EMAIL, MEMBER_ID or any column the developer wants to use like Name, Surname as configured by using the RMC admin panel.

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.

Sample Body

{

"Key":"",

"Value":"",

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

"ForceUpdate":false,

"CampaignId":"",

"InsertMember":false,

 "GsmNo":

}

Sample Response

{

    "MemberId": "",

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

    "Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

Error Code

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


ChangeMemberPermissionByEmail

URL

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

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

Body

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)

Sample Body

{

 "EmailAddress":"",

  "Status":"",

  "EmailPermit":"Y",

  "GsmPermit":"Y"

}

Sample Response

{

    "MemberIdList": [

        "0CDCA379BD8341468C2A28EC3DFCB"

    ],

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Successs Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Status Code: 404 Not Found

Error Code

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

CreatePushSubscription

URL

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

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket issued by the system after successful login

Body

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

Sample Body

{

 "PushToken":"",

  "MemberID":"",

  "Status":"",

"ForceUpdate":"false/true",

  "AppAlias":""

}

Sample Response

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

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!

Error Code

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

QueryMemberCampaigns 

URL

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

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

Body

Key(string): This can be EMAIL, MEMBER_ID or any column the developer wants to use like Name, Surname as configured by using the RMC admin panel.

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,


Sample Body

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

"Key":"",

"Value":"",


}


Sample Response

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

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 99



Parent Topic: RMC REST API


  • No labels