Search

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Not: URL olarak HTTPS kullanabilirsiniz.

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:  Login aksiyonundan sonra alınan Service Ticket değeri.

Body

Key (string): Bu, EMAIL, MEMBER_ID veya geliştiricinin RMC yönetici panelini kullanarak yapılandırılmış olduğu gibi Ad, Soyadı gibi istediği herhangi bir sütun olabilir

Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez.

ForceUpdate (bool): Key ve Value değerleri mevcut bir üyeyi saptarsa, metod ekleme yapmak yerine varolanı güncellemeye / güncellememeye karar verir. Bu flag True değerini aldığında, sağlanan demografik bilgileri kullanarak üyeyi günceller..

DemographicData (KeyValue []): Bu bir KeyValue dizisidir. Kısacası, demografik bilgileri oluşturan Key ve Value değerleri.

Info
titleBilgilendirme

Üye yüklerken GSM formatı aşağıdaki gibi olmalıdır;

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

Eğer hesap yurt dışı gönderime açıksa bu durumda yükleme (ülke kodu).(mobil no) formatı olarak yapılmalıdır.

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


Panel
bgColor#f0f0f0

Bu Sayfadaki metodlar:

Table of Contents








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:  Login aksiyonundan sonra alınan Service Ticket değeri.

Body

Key (string): Bu, EMAIL, MEMBER_ID veya geliştiricinin RMC yönetici panelini kullanarak yapılandırılmış olduğu gibi Ad, Soyadı gibi istediği herhangi bir sütun olabilir

Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez.

ForceInsert (bool): Key ve Value değerleri mevcut bir üyeyi saptarsa, metod ekleme yapmak yerine varolanı güncellemeye / güncellememeye karar verir. Bu flag True değerini aldığında, sağlanan demografik bilgileri kullanarak üyeyi günceller..

DemographicData (KeyValue []): Bu bir KeyValue dizisidir. Kısacası, demografik bilgileri oluşturan Key ve Value değerleri.

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:  Login aksiyonundan sonra alınan Service Ticket değeri.

Body

Key (string): Bu, EMAIL, MEMBER_ID veya geliştiricinin RMC yönetici panelini kullanarak yapılandırılmış olduğu gibi Ad, Soyadı gibi istediği herhangi bir sütun olabilir

Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez.

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): Bu, EMAIL, MEMBER_ID veya geliştiricinin RMC yönetici panelini kullanarak yapılandırılmış olduğu gibi Ad, Soyadı gibi istediği herhangi bir sütun olabilir

Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez.

Header

Content-Type: application/json

Authorization:  Login aksiyonundan sonra alınan Service Ticket değeri.

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): Bu, EMAIL, MEMBER_ID veya geliştiricinin RMC yönetici panelini kullanarak yapılandırılmış olduğu gibi Ad, Soyadı gibi istediği herhangi bir sütun olabilir

Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez.

Header

Content-Type: application/json

Authorization:  Login aksiyonundan sonra alınan Service Ticket değeri.

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): Bu, EMAIL, MEMBER_ID veya geliştiricinin RMC yönetici panelini kullanarak yapılandırılmış olduğu gibi Ad, Soyadı gibi istediği herhangi bir sütun olabilir

Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez.

Header

Content-Type: application/json

Authorization:  Login aksiyonundan sonra alınan Service Ticket değeri.

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:  Login aksiyonundan sonra alınan Service Ticket değeri.

Body

Key (string): Bu, EMAIL, MEMBER_ID veya geliştiricinin RMC yönetici panelini kullanarak yapılandırılmış olduğu gibi Ad, Soyadı gibi istediği herhangi bir sütun olabilir

Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez.

Move (bool): Move True değeri aldığında, üye SendLists dizisinde belirtilmeyen eski listelerden kaldırılır. Move False değer aldığında, üye yalnızca belirtilen listelere eklenir.

SendLists (SendList []): Key ve Value çifti tarafından belirtilen üye(ler), burada belirtilen listelerden kaldırılacaktır.

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:  Login aksiyonundan sonra alınan Service Ticket değeri.

Body

Key (string): Bu, EMAIL, MEMBER_ID veya geliştiricinin RMC yönetici panelini kullanarak yapılandırılmış olduğu gibi Ad, Soyadı gibi istediği herhangi bir sütun olabilir

Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez.

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:  Login aksiyonundan sonra alınan Service Ticket değeri.

Body

Key (string): Bu, EMAIL, MEMBER_ID veya geliştiricinin RMC yönetici panelini kullanarak yapılandırılmış olduğu gibi Ad, Soyadı gibi istediği herhangi bir sütun olabilir

Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez.

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:  Login aksiyonundan sonra alınan Service Ticket değeri.

Body

Key (string): Bu, EMAIL, MEMBER_ID veya geliştiricinin RMC yönetici panelini kullanarak yapılandırılmış olduğu gibi Ad, Soyadı gibi istediği herhangi bir sütun olabilir

Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez.

ForceUpdate (bool): Key ve Value değerleri mevcut bir üyeyi saptarsa, metod ekleme yapmak yerine varolanı güncellemeye / güncellememeye karar verir. Bu flag True değerini aldığında, sağlanan demografik bilgileri kullanarak üyeyi günceller.

DemographicData (KeyValue []): Bu bir KeyValue dizisidir. Kısacası, demografik bilgileri oluşturan Key ve Value değerleri.

CampaignId (string): RMC arayüzünden oluşturulan kampanya ID'si. 

Note

Kampanya durumu "Gönderildi" veya "İletildi" olmalıdır.



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:  Login aksiyonundan sonra alınan Service Ticket değeri.

Body

Key (string): Bu, EMAIL, MEMBER_ID veya geliştiricinin RMC yönetici panelini kullanarak yapılandırılmış olduğu gibi Ad, Soyadı gibi istediği herhangi bir sütun olabilir

Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez.

ForceUpdate (bool): Key ve Value değerleri mevcut bir üyeyi saptarsa, metod ekleme yapmak yerine varolanı güncellemeye / güncellememeye karar verir. Bu flag True değerini aldığında, sağlanan demografik bilgileri kullanarak üyeyi günceller.

DemographicData (KeyValue []): Bu bir KeyValue dizisidir. Kısacası, demografik bilgileri oluşturan Key ve Value değerleri.

CampaignId (string): RMC arayüzünden oluşturulan kampanya ID'si. 

GsmNo (string): Kampanyanın iletileceği üyenin GSM numarası

InsertMember (bool): True değerini aldığında, belirtilen üye, Key ve Value çiftini kullanılarak veritabanına eklenir.

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:  Login aksiyonundan sonra alınan Service Ticket değeri.

Body

EmailAddress (string): Üyenin email adresi.

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:  Login aksiyonundan sonra alınan Service Ticket değeri.

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:  Login aksiyonundan sonra alınan Service Ticket değeri.

Body

Key (string): Bu, EMAIL, MEMBER_ID veya geliştiricinin RMC yönetici panelini kullanarak yapılandırılmış olduğu gibi Ad, Soyadı gibi istediği herhangi bir sütun olabilir

Value (string): Key kolonu için değer,. Bu değer yanlış biçimde gönderilirse, yok sayılır ve ana işlem kesilmez.

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




Ana Sayfa: RMC REST API