Service URL | sendlist.asmx |
---|
SendList web servisini kullanarak, toplu veri aktarımı, gönderim listesi yaratabilir veya mevcut gönderim listelerini hesabınızdan silebilirsiniz.
SendList web servisine ait aşağıda ki metodlar bulunmaktadır.
Method | Description |
---|
AddBulk | Bulk adds to a Send List. |
AddBulkFile | Bulk adds to a Send List via File Upload. |
CreateSendList | Creates a Send List. |
QuerySendListMemberCount | Returns Member Count in a given Send List. |
RemoveBulkFile | Bulk removes from a Send List or deletes members via File Upload. |
RemoveSendList | Removes a Send List. |
Note |
---|
|
Hesabınızdan üye silerken dikkatli olmanız gerekir. 2015 Mayıs ayında çıkan yasa gereği, üye geçmiş bilgilerini en az 1 yıl saklamanız gerekmektedir. |
Warning |
---|
|
Geliştiricinin her hangi bir web servis ile etkileşime geçebilmesi için, öncelikle Login
metodunu kullanarak bir Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Service Ticket |
alması gerekir. Diğer web servis ve metodlarına yaratmış olduğu bu değer ile istekte bulunabilir.
CreateSendList Anchor |
---|
createsendlist | createsendlist | <CreateSendList> |
---|
Boş bir gönderim listesi yaratır. |
Parametreler
Parametre | Değer | |
---|
ServiceTicket | Login aksiyonu ile elde edilen ServiceTicket | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListGroup | Listenin grup adı. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListName | Listenin adı.SendList Web Service allows you to perform many operations:
- Add data in bulk to your Send Lists
- Create Send Lists
- Remove existing Send Lists from your account
SendList Web Service Methods
The following table lists supported methods in SendList Web Service and provides a brief description of each method. Click on the method name for more information:
Note |
---|
We advise you to be careful when deleting a member from your account. As per the Law that came into force in May 2015, you must save member history information for minimum one year. |
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 |
---|
| . |
ChangeSendListName
Anchor |
---|
| ChangeSendListName |
---|
| ChangeSendListName |
---|
|
Back to Top ^
<Change Send List Name> |
---|
Changes list name. |
Parameters
language | xml |
---|
title | ORNEK REQUESTParameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
|
ListGroup | Group Name of the List | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListName | Name of the list | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
NewListName | New name of the list | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap<soap12:Body>
<CreateSendList xmlns<ChangeSendListName xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
<ListName>string</ListName>
<NewListName>string</NewListName>
</CreateSendList>ChangeSendListName>
</soapsoap12:Body>
</soapsoap12:Envelope>
|
Code Block |
---|
language | xml |
---|
title | ORNEK RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope
xmlns:soapxsi="http://schemaswww.xmlsoapw3.org/soap/envelope/"
xmlns:xsi2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsdsoap12="http://www.w3.org/2003/2001/XMLSchema"05/soap-envelope">
<soap<soap12:Body>
<ChangeSendListNameResponse <CreateSendListResponse xmlns="http://ws.euromsg.com/sendlist">
<ChangeSendListNameResult>
<CreateSendListResult> <ConversationID>string</ConversationID>
<Code>00</Code><CreatedListID>int</CreatedListID>
</ChangeSendListNameResult>
<Message /></ChangeSendListNameResponse>
<DetailedMessage />
<CreatedListID>1686794</CreatedListID>
</CreateSendListResult>
</CreateSendListResponse>
</soap:Body>
</soap</soap12:Body>
</soap12:Envelope> |
Tip |
---|
Başarılı istek durumunda If the request was successful, the <Code> parametresi parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
olarak cevap döner. Buna ek olarak yaratılan liste ID’si Status |
---|
|
subtle | true |
---|
colour | Red |
---|
title | CreatedListID |
döner.
Hata Parametreleri
Code | Message | DetailedMessage | AçıklamaError Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | | Login metodu çalıştırılmamış. Aktif oturum yok. |
AddBulk Anchor |
---|
addbulk | addbulk | <AddBulk> |
---|
Toplu bir şekilde üye eklemeye olanak verir. |
Parametreler
Parametre | Değer | |
---|
ServiceTicket | Login aksiyonu ile elde edilen ServiceTicket | No active sessions found. Try login again. |
CreateSendList
Anchor |
---|
| createsendlist |
---|
| createsendlist |
---|
|
Back to Top ^
<CreateSendList> |
---|
Creates an empty Send List. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListGroup |
Eklenecek listenin grup adı.Group Name of the List | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListName |
Listenin adı.Name of the list | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Key | Referans Key Adı. Bu alana göre üye ekleme veya güncelleme yapılacaktır. Referans Key’in değerini DemograficData alanında belirtilmesi gerekir. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
DemograficData | ArrayOfEmKeyValue dizisi ile üyeye ait alanlar belirlenir. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ForceInsert | Üye sistemde var ise, true değeri gönderilmesi durumunda, varolan üye güncellenir. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Note |
---|
Ad, Soyad gibi alanlar Related Marketing Cloud platformu üzerinden ayarlanır. |
Statik Alanlar
Alan Adı | Açıklama |
---|
EMAIL | Email adresi |
STATUS | Üye durumu. A : Aktif, P : Pasif |
EMAIL_PERMIT | Email izin durumu. Y : Evet, N : Hayır |
GSM_PERMIT | SMS izin durumu. Y : Evet, N : Hayır |
FAX_PERMIT | FAX izin durumu. Y : Evet, N : Hayır |
CALL_PERMIT | Call Center izin durumu. Y : Evet, N : Hayır |
PRINT_PERMIT | Print izin durumu. Y : Evet, N : Hayır |
REFERRAL | Referans adresi |
REFERRAL_DOMAIN | Referans domain Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CreateSendList xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
</CreateSendList>
</soap12:Body>
</soap12:Envelope> |
ORNEK REQUESTRESPONSE EXAMPLE | linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
|
<soap
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
xmlns:xsd="http://www.w3.org/2001/XMLSchema" |
soapschemasxmlsoap// <soap <AddBulk
<CreateSendListResponse xmlns="http://ws.euromsg.com/sendlist">
<CreateSendListResult>
|
<ServiceTicket>string</ServiceTicket> <ConversationID>string</ConversationID>
|
<ListGroup>string<ListGroup>CreatedListID>
</CreateSendListResult>
|
<ListName>string<ListName> <Key>string</Key>
<DemograficData>
<ArrayOfEmKeyValue>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
</ArrayOfEmKeyValue>
<ArrayOfEmKeyValue>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
</soap12:Body>
</soap12: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, the ID of the created list Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | CreatedListID |
---|
| is returned. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
AddBulk
Back to Top ^
<AddBulk> |
---|
Bulk adds to a Send List. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListGroup | Group name of the List to add | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListName | Name of the List | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Key | Reference Key Name. Member adding and updating will be done based on this field. Reference Key value must be specified in the DemograficData field | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
DemograficData | ArrayOfEmKeyValue string defines the fields for the member | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ForceInsert | If the member exists in the system and the value is true , the existing member is updated. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Note |
---|
Fields like First Name and Last Name are set through the Related Marketing Cloud 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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AddBulk xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
<Key>string</Key>
<DemograficData>
<ArrayOfEmKeyValue>
<EmKeyValue>
</ArrayOfEmKeyValue>
<Key>string</Key>
<Value>string</Value>
</DemograficData>EmKeyValue>
<EmKeyValue>
<ForceInsert>boolean</ForceInsert><Key>string</Key>
</AddBulk><Value>string</Value>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | ORNEK RESPONSE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:EnvelopeEmKeyValue>
</ArrayOfEmKeyValue>
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
<ArrayOfEmKeyValue>
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<EmKeyValue>
<soap:Body> <AddBulkResponse<Key>string</Key>
xmlns="http://ws.euromsg.com/sendlist"><Value>string</Value>
</EmKeyValue>
<AddBulkResult> <EmKeyValue>
<Code>00</Code> <Key>string</Key>
<Message <Value>string</>Value>
</EmKeyValue>
<DetailedMessage /> </ArrayOfEmKeyValue>
</DemograficData>
<CreatedListID>0<<ForceInsert>boolean</CreatedListID>ForceInsert>
</AddBulk>
</AddBulkResult>
<DetailsResult>
</soap12:Body>
</soap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AddBulkResponse xmlns="http://ws.euromsg.com/sendlist">
<BulkDetailedResult><AddBulkResult>
<ConversationID>string</ConversationID>
<CreatedListID>int</CreatedListID>
<Key>test1@sampledomain.com</Key> </AddBulkResult>
<DetailsResult>
<BulkDetailedResult>
<Code>00</Code> <Key>string</Key>
<Message <Code>string</>Code>
<Message>string</Message>
<DetailedMessage />
<DetailedMessage>string</DetailedMessage>
</BulkDetailedResult>
<BulkDetailedResult>
<BulkDetailedResult> <Key>string</Key>
<Code>string</Code>
<Key>test2@sampledomain.com</Key> <Message>string</Message>
<Code>00</Code><DetailedMessage>string</DetailedMessage>
</BulkDetailedResult>
</DetailsResult>
<Message </>AddBulkResponse>
<DetailedMessage />
</BulkDetailedResult>
</DetailsResult>
</AddBulkResponse>
</soap</soap12:Body>
</soapsoap12:Envelope> |
Tip |
---|
Başarılı istek durumunda parametresi If the request was successful, the | <Code> | parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
olarak cevap döner as a response.
Hata ParametreleriError Parameters
DetailedMessageAçıklama | 9998 | No session. Please try re-logon. |
| Login
metodu çalıştırılmamış. Aktif oturum yokNo active sessions found. Try login again. |
99 | No such list! |
| Belirtilen liste bulunamadıThe specified List cannot be found. |
99 | Member is new. No update! |
| false
ise ve kullanıcı sistemde yer almıyorsa alınan hatadır. Üye eklenmemiştir. Yeni üyeyi sistem eklemek için ForceInsert
parametresinin değeri true
olmalıdır.
AddBulkFile is false and the user does not exist in the system, this error is given. The member is not added. To add the new member in the system the value of the ForceInsertparameter must be true. |
AddBulkFile
<AddBulkFile> |
---|
Bir dosyada yer alan üyelerin toplu olarak Related Marketing Cloud hesabınıza yüklenmesini sağlar. |
Parametreler
Parametre | Değer | |
---|
ServiceTicket | Login
aksiyonu ile elde edilen ServiceTicket
Back to Top ^
<AddBulkFile> |
---|
Allows you to add all the members listed in a file to your RMC account in bulk. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListGroup |
Eklenecek listenin grup adı.Group name of the List to add | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListName |
Listenin adı.Name of the List | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Key |
Referans Adı. Bu alana göre üye ekleme veya güncelleme yapılacaktır.Name. Member adding and updating shall be done based on this field | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Map |
Dosyada ki alanların sistem alanları ile eşleştirilmesini yapar. ÖrnMaps the fields in the file with the system fields. E.g. EMAIL=email; COLUMN1=NameSurname; COLUMN2=KeyID |
. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
File |
Yüklenecek dosya.The file to upload | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FileType |
Dosya türü. zip
veya csv
olmalı.File Type - Must be in zip or csv format | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
NotificationEmail |
Yükleme işlemi bittiğinde, burada belirtilen email adresine bilgilendirme emaili gönderilir.A notification email will sent to this email address when the upload is completed | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | ORNEK REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap<soap12:Body>
<AddBulkFile
xmlns<AddBulkFile xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
<Key>string</Key>
<Map>string</Map>
<File>base64Binary</File>
<FileType>string</FileType>
<NotificationEmail>string</NotificationEmail>
<NotificationEmail>string</NotificationEmail>
<JobName>string</JobName>
</AddBulkFile>
</soapsoap12:Body>
</soapsoap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | ORNEK RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope
xmlns:soapxsi="http://schemaswww.xmlsoapw3.org/soap/envelope/"
xmlns:xsi2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsdsoap12="http://www.w3.org/2003/200105/XMLSchemasoap-envelope">
<soap<soap12:Body>
<AddBulkFileResponse
xmlns="http://ws.euromsg.com/sendlist">
<AddBulkFileResult>
<AddBulkFileResult> <ConversationID>string</ConversationID>
<CreatedListID>int</CreatedListID>
<Code>00</Code> </AddBulkFileResult>
</AddBulkFileResponse>
<Message />
<DetailedMessage />
<ConversationID>EEFF123AE537442BBF9AD3231F812684</ConversationID>
<CreatedListID>0</CreatedListID>
</AddBulkFileResult>
</AddBulkFileResponse>
</soap:Body>
</soap:Envelope> |
Tip |
Başarılı istek durumunda Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
parametresi Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
olarak cevap döner. Buna ek olarak yaratılan liste ID’si Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CreatedListID |
döner.
Hata Parametreleri
Code | Message | DetailedMessage | Açıklama |
---|
9998 | No session. Please try re-logon. | | Login metodu çalıştırılmamış. Aktif oturum yok. |
99 | Not a valid file type. It must be ZIP or CSV or TXT. | | |
QuerySendListMemberCount Anchor |
---|
querymemcount | querymemcount | <QuerySendListMemberCount> |
---|
Gönderim listesindeki kişi sayısını gösterir. |
Parametreler
Parametre | Değer | |
---|
ServiceTicket | Login
aksiyonu ile elde edilen ServiceTicket
</soap12:Body>
</soap12: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, the ID of the created list Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | CreatedListID |
---|
| is returned. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Not a valid file type. It must be ZIP or CSV or TXT. | Invalid file type. It must be in zip or csv format |
QuerySendListMemberCount
Anchor |
---|
| querymemcount |
---|
| querymemcount |
---|
|
Back to Top ^
<QuerySendListMemberCount> |
---|
Shows the number of members in the send list. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListID | List ID | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<QuerySendListMemberCount xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListID>int</ListID>
</QuerySendListMemberCount>
</soap12:Body>
</soap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<QuerySendListMemberCountResponse xmlns="http://ws.euromsg.com/sendlist">
<QuerySendListMemberCountResult>
<ConversationID>string</ConversationID>
<CreatedListID>int</CreatedListID>
</QuerySendListMemberCountResult>
<MemberCount>int</MemberCount>
</QuerySendListMemberCountResponse>
</soap12:Body>
</soap12: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. |
RemoveBulkFile
Anchor |
---|
| removebulkfile |
---|
| removebulkfile |
---|
|
Back to Top ^
<RemoveBulkFile> |
---|
Allows you to delete the members listed in a file in your RMC account. |
Parameters
Liste ID
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListGroup | Group name of the List | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListName | Name of the list | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Key | Reference Key Name | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Map | Maps the fields in the file with the system fields. E.g. EMAIL=email; COLUMN1=NameSurname ;COLUMN2=KeyID | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
File | File to upload | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FileType | File Type - Must be in zip or csv format | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
NotificationEmail | A notification email will sent to this email address when the upload is completed | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListID | DeleteIfInNoList | If the member is not included in any lists, and the value is true , the user is deleted from the system completely | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ORNEK REQUEST EXAMPLE | linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
|
<soap
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
xmlns:xsd="http://www.w3.org/2001/XMLSchema" |
soapschemasxmlsoapsoapenvelope/">
<soap:Body>
<QuerySendListMemberCount05/soap-envelope">
<soap12:Body>
|
xmlns="http://ws.euromsg.com/sendlist"> |
<ServiceTicket>string</ServiceTicket>
|
<ListID>int</ListID>
</QuerySendListMemberCount><ListGroup>string</ListGroup>
|
</soap:Body></soap:Envelope> Code Block |
---|
language | xml |
---|
title | ORNEK RESPONSE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope <ListName>string</ListName>
|
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"<Key>string</Key>
<Map>string</Map>
<File>base64Binary</File>
<FileType>string</FileType>
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"<NotificationEmail>string</NotificationEmail>
|
xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <DeleteIfInNoList>boolean</DeleteIfInNoList>
|
<soap:Body> </RemoveBulkFile>
</soap12:Body>
</soap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" |
<QuerySendListMemberCountResponseencoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http:// |
wseuromsgcom/sendlist">
<QuerySendListMemberCountResult>
<Code>00</Code>
<Message />
org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
|
<DetailedMessage />
<CreatedListID>0</CreatedListID>
<RemoveBulkFileResponse xmlns="http://ws.euromsg.com/sendlist">
|
</QuerySendListMemberCountResult> <MemberCount>0</MemberCount>
</QuerySendListMemberCountResponse><ConversationID>string</ConversationID>
|
</soap:Body>
</soap:Envelope> Tip |
Başarılı istek durumunda Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
parametresi Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
olarak cevap döner.Hata Parametreleri
Code | Message | DetailedMessage | Açıklama |
---|
9998 | No session. Please try re-logon. | | Login metodu çalıştırılmamış. Aktif oturum yok. |
RemoveBulkFile Anchor |
---|
removebulkfile | removebulkfile | <RemoveBulkFile> |
---|
Bir dosyada yer alan üyelerin seçilerek Related Marketing Cloud hesabınızdan silinmesini sağlar. |
Parametreler
Parametre | Değer | |
---|
ServiceTicket | Login aksiyonu ile elde edilen ServiceTicket | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListGroup | Liste grup adı. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListName | Listenin adı. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Key | Referans Key Adı. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Map | Dosyada ki alanların sistem alanları ile eşleştirilmesini yapar. Örn. EMAIL=email;COLUMN1=NameSurname;COLUMN2=KeyID. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
File | Yüklenecek dosya. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FileType | Dosya türü. zip
veya csv
olmalı. <CreatedListID>int</CreatedListID>
</RemoveBulkFileResult>
</RemoveBulkFileResponse>
</soap12:Body>
</soap12: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, the ID of the created list Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | CreatedListID |
---|
| is returned. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
RemoveSendList
Anchor |
---|
| removesendlist |
---|
| removesendlist |
---|
|
Back to Top ^
<RemoveSendList> |
---|
Deletes a Send List. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
NotificationEmail | Yükleme işlemi bittiğinde, burada belirtilen email adresine bilgilendirme emaili gönderilir.ListGroup | Group Name of the List | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
DeleteIfInNoList | Eğer üye hiç bir listede yer almıyorsa, true gönderilmesi durumunda, kullanıcıyı tamamen siler. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ORNEK REQUEST EXAMPLE | linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
|
<soap
="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RemoveBulkFile xmlns/XMLSchema-instance" xmlns:xsd="http:// |
wseuromsgcomsendlist>
<ServiceTicket>string</ServiceTicket>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
<Key>string</Key>
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
|
<Map>string</Map>
<File>base64Binary</File>
<FileType>string</FileType>
<RemoveSendList xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
|
<NotificationEmail>string</NotificationEmail> <ListGroup>string</ListGroup>
|
<DeleteIfInNoList>boolean</DeleteIfInNoList>
<ListName>string</ListName>
|
RemoveBulkFile>
soapsoapORNEK RESPONSE EXAMPLE | linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
|
<soap
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>
<RemoveBulkFileResponse xmlns/XMLSchema" xmlns:soap12="http:// |
wseuromsgcom/sendlist">
<RemoveBulkFileResult>
<Code>00</Code>
<Message />
org/2003/05/soap-envelope">
<soap12:Body>
|
<DetailedMessage /<RemoveSendListResponse xmlns="http://ws.euromsg.com/sendlist">
<RemoveSendListResult>
|
<ConversationID>EEFF123AE537442BBF9AD3231F812684<<ConversationID>string</ConversationID>
|
<CreatedListID>0<<CreatedListID>int</CreatedListID> |
RemoveBulkFileResult>
RemoveBulkFileResponse > soapsoapBaşarılı istek durumunda If the request was successful, the |
<Code> | parametresi parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
|
olarak cevap döner. Buna ek olarak yaratılan liste ID’si as a response. Aside from that, the returned |
CreatedListID dönerHata ParametreleriError Parameters
DetailedMessageAçıklama | Parametreler
Parametre | Değer | |
---|
ServiceTicket | Login aksiyonu ile elde edilen ServiceTicket | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListGroup | Listenin grup adı. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListName | Listenin adı. | 9998 | No session. Please try re-logon. |
| Login metodu çalıştırılmamış. Aktif oturum yok. |
RemoveSendList Anchor |
---|
removesendlist | removesendlist | <RemoveSendList> |
---|
Bir gönderim listesini siler. |
No active sessions found. Try login again. |
QuerySendList
Back to Top ^
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | ORNEK REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapxsd="http://schemaswww.xmlsoapw3.org/soap2001/envelope/XMLSchema"> <soap:Body>
<RemoveSendList xmlnsxmlns:soap12="http://wswww.euromsgw3.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListGroup>string</ListGroup>
org/2003/05/soap-envelope">
<soap12:Body>
<QuerySendLists xmlns="http://ws.euromsg.com/sendlist">
<ListName>string</ListName> <ServiceTicket>string</ServiceTicket>
</RemoveSendList>QuerySendLists>
</soapsoap12:Body>
</soapsoap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | ORNEK RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:soapxsd="http://schemaswww.xmlsoapw3.org/soap2001/envelope/"
XMLSchema" xmlns:xsisoap12="http://www.w3.org/2003/200105/XMLSchemasoap-instance"envelope">
<soap12:Body>
<QuerySendListsResponse xmlns:xsd="http://wwwws.w3euromsg.orgcom/2001/XMLSchemasendlist">
<soap:Body> <QuerySendListsResult>
<RemoveSendListResponse<SendLists>
<EmSendListResponse>
xmlns="http://ws.euromsg.com/sendlist"> <ListId>string</ListId>
<RemoveSendListResult> <ListName>string</ListName>
<Code>00</Code> <GroupName>string</GroupName>
<Message </>EmSendListResponse>
<EmSendListResponse>
<DetailedMessage /> <ListId>string</ListId>
<CreatedListID>0<<ListName>string</CreatedListID>ListName>
<<GroupName>string</RemoveSendListResult>GroupName>
</RemoveSendListResponse>EmSendListResponse>
</soap:Body>
</soap:Envelope> |
Tip |
Başarılı istek durumunda Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
parametresi Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
olarak cevap döner. Bunun dışında dönen Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 99 |
değerleri hata belirtir.
Hata Parametreleri
Code | Message | DetailedMessage | Açıklama |
---|
9998 | No session. Please try re-logon. | | Login metodu çalıştırılmamış. Aktif oturum yok. |
</SendLists>
</QuerySendListsResult>
</QuerySendListsResponse>
</soap12:Body>
</soap12: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. |
Parent Topic: SOAP Web Service