The #1 Fastest Growing Customer Service Software. Comm100 Marketing API Guide. Copyright 2011 Comm100. All Rights Reserved.

Transcription

1 The #1 Fastest Growing Customer Service Software Comm100 Marketing API Guide Copyright 2011 Comm100. All Rights Reserved.

2 Comm100 Marketing API Guide 1 Introduction Comm100 Marketing application programming interfaces (APIs) allow your business/organization to expand upon the newsletter functionality provided by Comm100 Marketing software. In particular, APIs allow you to receive data from and send data to Comm100 Marketing, making integration with other solutions simple. You can manage your contact lists and s within the software you use everyday. To access and use Comm100 Marketing APIs, you need to: Sign up for a Comm100 site account and activate Comm100 Marketing; (Click here to sign up now) Possess some software development knowledge; Adhere to Comm100's Terms and Conditions and Comm100 Marketing request limits. No matter your programming language is ASP, JSP, PHP or any others, you can successfully call Comm100 Marketing APIs. You are allowed 500 requests in a 24 hour period. If you exceed the maximum requests, you will get an error notification and please contact Comm100 support team if you need any further help.

3 2 Methods name Contact GetAllContacts GetContactById GetContactBy Address AddContact UpdateContact DeleteContactById DeleteContactBy Address Mailing List GetAllMailingLists AddMailingList AddMailingList ClearMailingList GetAllMembersOfMailingList AddAContactToMailingList AddMultipleContactsToMailingList DeleteAContactFromMailingList DeleteMultipleContactsFromMailingList GetMemberByMailingListIdAndContactId GetMemberByMailingListIdAnd Address UnsubscribeFromMailingList UnsubscribeFromAllMailingList GetAll s Get ById Add Update ScheduleOrSend Delete Description Listing all contacts Obtaining a contact by the Contact Id Obtaining a contact by contact's address Adding a contact Updating a contact's information Deleting a contact by the Contact Id Deleting a contact by contact's address Listing all mailing lists Adding a mailing list Updating the information of a mailing list Deleting a mailing list Listing all members of a specific mailing list Adding a contact to a specific mailing list Adding multiple contacts to a specific mailing list Deleting a contact from a specific mailing list Deleting multiple contacts from a specific mailing list Obtaining a member's information by the mailing list Id and the contact Id Obtaining a member's information by the mailing list Id and the address Unsubscribe a contact from a specific mailing list Unsubscribe a contact from all mailing lists Listing all newsletters you created Obtaining a newsletter by Id Creating a newsletter Updating the information of a specific newsletter Scheduling the send time or sending out a newsletter immediately Deleting a specific newsletter

4 2.1 GetAllContacts You can get a list of the information of your contacts in your site account Syntax Public ContactsOutPut GetAllContacts() Input Output ContactsOutput Error Error Contact[] Contacts Parameters Contact: A business or an individual that you want to communicate with and track in Comm100 modules. Contact Int Id string Address string FirstName string LastName int Age EnumGender Gender EnumGender Male Female It's a Secret string Occupation string Organization string Title string Phone string Mobile string Fax string HomePage string Interests string Address1 string Address2 string City string StateOrProvince; string Country string ZipOrPostalCode string JoinTime string Source

5 Id: The unique Id of a contact. Address: Contact's address. FirstName: The first name of a contact. LastName: The last name of a contact. Age: Contact's age. Gender: Contact's gender. (EnumGender is an enumerated type provided for your direct use.) EnumGender Male Female It's asecret Occupation: Contact's Occupation. Organization: The organization which a contact works for. Title: Contact's title. Phone: Contact's phone number Mobile: Contact's mobile number Fax: Contact's fax number. HomePage: Contact's company home page Interests: Contact's Interests. Address1: Contact's Address Address2: Contact's Address City: The city in which Contact locates. StateOrProvince: The state or province in which Contact locates. Country: The country in which Contact locates. ZipOrPostalCode: The zip/postal code of Contact's location. JoinTime: The time when Contact is added in your Comm100 account. Source: From where Contact is added into your Comm100 account. Error: A struct consisting of error code and error message Error int ErrorCode //error code (No error is detected when it's 0.) string ErrorMessage //error message (detailed error information) Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1

6 Host: localhost SOAPAction: " <soap:header> <CredentialSoapHeader xmlns=" <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader> </soap:header> <GetAllContacts xmlns=" /> HTTP/ OK <GetAllContactsResponse xmlns=" <GetAllContactsResult> <Error> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </Error> <Contacts> <Contact> <Id>int</Id> < Address>string</ Address> <FirstName>string</FirstName> <LastName>string</LastName> <Age>int</Age> <Gender>Male or Female or ItsaSecret</Gender> <Occupation>string</Occupation> <Organization>string</Organization> <Title>string</Title> <Phone>string</Phone> <Mobile>string</Mobile> <Fax>string</Fax> <HomePage>string</HomePage> <Interests>string</Interests> <Address1>string</Address1> <Address2>string</Address2> <City>string</City>

7 <StateOrProvince>string</StateOrProvince> <Country>string</Country> <ZipOrPostalCode>string</ZipOrPostalCode> <JoinTime>string</JoinTime> <Source>string</Source> </Contact> <Contact> <Id>int</Id> < Address>string</ Address> <FirstName>string</FirstName> <LastName>string</LastName> <Age>int</Age> <Gender>Male or Female or ItsaSecret</Gender> <Occupation>string</Occupation> <Organization>string</Organization> <Title>string</Title> <Phone>string</Phone> <Mobile>string</Mobile> <Fax>string</Fax> <HomePage>string</HomePage> <Interests>string</Interests> <Address1>string</Address1> <Address2>string</Address2> <City>string</City> <StateOrProvince>string</StateOrProvince> <Country>string</Country> <ZipOrPostalCode>string</ZipOrPostalCode> <JoinTime>string</JoinTime> <Source>string</Source> </Contact> </Contacts> </GetAllContactsResult> </GetAllContactsResponse> Examples C# // Authenticity Verification: please provide an Comm100 site account with administrative permission. CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; ContactsOutput tmpo = tmp marketingapi.getallcontacts();

8 2.2 GetContactById You can obtain a contact's detailed information by the Contact Id Syntax Public ContactOutput GetContactById(int contactid) Input int contactid Output ContactOutput Error Error Contact Contact Parameters contactid: The unique number of a contact. Contact: A business or an individual that you want to communicate with or track in your Comm100 modules.

9 Contact Int Id string Address string FirstName string LastName int Age EnumGender Gender EnumGender Male Female It's asecret string Occupation string Organization string Title string Phone string Mobile string Fax string HomePage string Interests string Address1 string Address2 string City string StateOrProvince; string Country string ZipOrPostalCode string JoinTime string Source Id: The unique Id of a contact. Address: Contact's address. FirstName: The first name of a contact. LastName: The last name of a contact. Age: Contact's age. Gender: Contact's gender. (EnumGender is an enumerated type provided for your direct use.) EnumGender Male Female It's asecret

10 Occupation: Contact's Occupation. Organization: The organization which a contact works for. Title: Contact's title. Phone: Contact's phone number Mobile: Contact's mobile number Fax: Contact's fax number. HomePage: Contact's company home page Interests: Contact's Interests. Address1: Contact's Address Address2: Contact's Address City: The city in which Contact locates. StateOrProvince: The state or province in which Contact locates. Country: The country in which Contact locates. ZipOrPostalCode: The zip/postal code of Contact's location. JoinTime: The time when Contact is added in your Comm100 account. Source: From where Contact is added into your Comm100 account. Error: A struct consisting of error code and error message Error int ErrorCode //error code (No error is detected when it's 0.) string ErrorMessage //error message (detailed error information) Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1 Host: localhost SOAPAction: " <soap:header> <CredentialSoapHeader xmlns=" <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader> </soap:header>

11 <GetContactById xmlns=" <contactid>int</contactid> </GetContactById> HTTP/ OK <GetContactByIdResponse xmlns=" <GetContactByIdResult> <Error> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </Error> <Contact> <Id>int</Id> < Address>string</ Address> <FirstName>string</FirstName> <LastName>string</LastName> <Age>int</Age> <Gender>Male or Female or ItsaSecret</Gender> <Occupation>string</Occupation> <Organization>string</Organization> <Title>string</Title> <Phone>string</Phone> <Mobile>string</Mobile> <Fax>string</Fax> <HomePage>string</HomePage> <Interests>string</Interests> <Address1>string</Address1> <Address2>string</Address2> <City>string</City> <StateOrProvince>string</StateOrProvince> <Country>string</Country> <ZipOrPostalCode>string</ZipOrPostalCode> <JoinTime>string</JoinTime> <Source>string</Source> </Contact> </GetContactByIdResult> </GetContactByIdResponse>

12 2.2.6 Examples C# // Authenticity Verification: please provide an Comm100 site account with administrative permission CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; ContactOutput tmpo = tmp marketingapi. GetContactById (contactid as int); 2.3 GetContactBy Address You can obtain a contact's detailed information by Contact's address Syntax Public ContactOutput GetContactBy Address(string address) Input string address Output ContactOutput Error Error Contact Contact Parameters address: The address of a contact. Contact: A business or an individual that you want to communicate with or track in your Comm100 modules.

13 Contact Int Id string Address string FirstName string LastName int Age EnumGender Gender EnumGender Male Female It's asecret string Occupation string Organization string Title string Phone string Mobile string Fax string HomePage string Interests string Address1 string Address2 string City string StateOrProvince; string Country string ZipOrPostalCode string JoinTime string Source Id: The unique Id of a contact. Address: Contact's address. FirstName: The first name of a contact. LastName: The last name of a contact. Age: Contact's age. Gender: Contact's gender. (EnumGender is an enumerated type provided for your direct use.) EnumGender Male Female It's asecret

14 Occupation: Contact's Occupation. Organization: The organization which a contact works for. Title: Contact's title. Phone: Contact's phone number Mobile: Contact's mobile number Fax: Contact's fax number. HomePage: Contact's company home page Interests: Contact's Interests. Address1: Contact's Address Address2: Contact's Address City: The city in which Contact locates. StateOrProvince: The state or province in which Contact locates. Country: The country in which Contact locates. ZipOrPostalCode: The zip/postal code of Contact's location. JoinTime: The time when Contact is added in your Comm100 account. Source: From where Contact is added into your Comm100 account. Error: A struct consisting of error code and error message Error int ErrorCode //error code (No error is detected when it's 0.) string ErrorMessage //error message (detailed error information) Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1 Host: localhost SOAPAction: " <soap:header> <CredentialSoapHeader xmlns=" <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader> </soap:header>

15 <GetContactBy Address xmlns=" < address>string</ address> </GetContactBy Address> HTTP/ OK <GetContactBy AddressResponse xmlns=" <GetContactBy AddressResult> <Error> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </Error> <Contact> <Id>int</Id> < Address>string</ Address> <FirstName>string</FirstName> <LastName>string</LastName> <Age>int</Age> <Gender>Male or Female or ItsaSecret</Gender> <Occupation>string</Occupation> <Organization>string</Organization> <Title>string</Title> <Phone>string</Phone> <Mobile>string</Mobile> <Fax>string</Fax> <HomePage>string</HomePage> <Interests>string</Interests> <Address1>string</Address1> <Address2>string</Address2> <City>string</City> <StateOrProvince>string</StateOrProvince> <Country>string</Country> <ZipOrPostalCode>string</ZipOrPostalCode> <JoinTime>string</JoinTime> <Source>string</Source> </Contact> </GetContactBy AddressResult> </GetContactBy AddressResponse>

16 2.3.6 Examples C# // Authenticity Verification: please provide an Comm100 site account with administrative permission CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; ContactOutput tmpo = tmp marketingapi. GetContactBy Address ( address as string); 2.4 AddContact You can create a new contact in your Comm100 account Syntax Public IntValue AddContact(string , string firstname, string lastname, int age, EnumGender gender, string occupation, string organization, string title, string phone, string mobile, string fax, string homepage, string interests, string address1, string address2,string city, string stateorprovince, string country, string ziporpostalcode) Input string , string firstname, string lastname, int age, EnumGender gender, string occupation, string organization, string title, string phone, string mobile, string fax, string homepage, string interests, string address1, string address2,string city, string stateorprovince, string country, string ziporpostalcode Output IntValue Error Error int Value

17 2.4.4 Parameters The address of a contact FirstName: The first name of a contact LastName: The last name of a contact Age: The age of a contact Gender: Contact's gender. (EnumGender is an enumerated type provided for your direct use.) EnumGender Male Female It's asecret Occupation: Contact's Occupation. Organization: The organization which a contact works for. Title: Contact's title. Phone: Contact's phone number Mobile: Contact's mobile number Fax: Contact's fax number. HomePage: Contact's company home page Interests: Contact's Interests. Address1: Contact's Address Address2: Contact's Address City: The city in which Contact locates. StateOrProvince: The state or province in which Contact locates. Country: The country in which Contact locates. ZipOrPostalCode: The zip/postal code of Contact's location. JoinTime: The time when Contact is added in your Comm100 account. Source: From where Contact is added into your Comm100 account. Value: The unique Id of a contact Error: A struct consisting of error code and error message Error int ErrorCode //error code (No error is detected when it's 0.) string ErrorMessage //error message (detailed error information)

18 2.4.5 Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1 Host: localhost SOAPAction: " <soap:header> <CredentialSoapHeader xmlns=" <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader> </soap:header> <AddContact xmlns=" < >string</ > <firstname>string</firstname> <lastname>string</lastname> <age>int</age> <gender>male or Female or ItsaSecret</gender> <occupation>string</occupation> <organization>string</organization> <title>string</title> <phone>string</phone> <mobile>string</mobile> <fax>string</fax> <homepage>string</homepage> <interests>string</interests> <address1>string</address1> <address2>string</address2> <city>string</city> <stateorprovince>string</stateorprovince> <country>string</country> <ziporpostalcode>string</ziporpostalcode> </AddContact> HTTP/ OK

19 <AddContactResponse xmlns=" <AddContactResult> <Error> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </Error> <Value>int</Value> </AddContactResult> </AddContactResponse> Examples C# //Authenticity Verification: please provide an Comm100 site account with administrative permission CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; IntValue tmpi = tmp marketingapi. AddContact ( as string, firstname as string, lastname as string, age as int, gender as EnumGender, occupation as string, organization as string, title as string, phone as string, mobile as string, fax as string, homepage as string, interests as string, address1 as string, address2 as string, city as string, stateorprovince as string, country as string, ziporpostalcode as string); 2.5 UpdateContact You can modify and update a contact's information Syntax public Error UpdateContact(int contactid, string , string displayname, string firstname, string lastname, int age, EnumGender gender, string occupation, string organization, string title, string phone, string mobile, string fax, string homepage, string interests, string address1, string address2, string city, string stateorprovince, string country, string ziporpostalcode)

20 2.5.2 Input int contactid, string , string displayname, string firstname, string lastname, int age, EnumGender gender, string occupation, string organization, string title, string phone, string mobile, string fax, string homepage, string interests, string address1, string address2, string city, string stateorprovince, string country, string ziporpostalcode Output Error int ErrorCode string ErrorMessage Parameters contactid: The unique Id of a contact. Contact's address. firstname: The first name of a contact. lastname: The last name of a contact. age: Contact's age. Gender: Contact's gender. (EnumGender is an enumerated type provided for your direct use.) EnumGender Male Female It's asecret occupation: Contact's Occupation. organization: The organization which a contact works for. title: Contact's title. phone: Contact's phone number mobile: Contact's mobile number fax: Contact's fax number. homepage: Contact's company home page interests: Contact's Interests. address1: Contact's Address address2: Contact's Address city: The city in which Contact locates. stateorprovince: The state or province in which Contact locates. country: The country in which Contact locates. ziporpostalcode: The zip/postal code of Contact's location.

21 jointime: The time when Contact is added in your Comm100 account. source: From where Contact is added into your Comm100 account. ErrorCode: Error Code ; No error is detected when it's 0. ErrorMessage: Detailed error information Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1 Host: localhost SOAPAction: " <soap:header> <CredentialSoapHeader xmlns=" <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader> </soap:header> <UpdateContact xmlns=" <contactid>int</contactid> < >string</ > <displayname>string</displayname> <firstname>string</firstname> <lastname>string</lastname> <age>int</age> <gender>string</gender> <occupation>string</occupation> <organization>string</organization> <title>string</title> <phone>string</phone> <mobile>string</mobile> <fax>string</fax> <homepage>string</homepage> <interests>string</interests> <address1>string</address1> <address2>string</address2> <city>string</city> <stateorprovince>string</stateorprovince> <country>string</country> <ziporpostalcode>string</ziporpostalcode>

22 </UpdateContact> HTTP/ OK <UpdateContactResponse xmlns=" <UpdateContactResult> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </UpdateContactResult> </UpdateContactResponse> Examples C# //Authenticity Verification: please provide an Comm100 site account with administrative permission CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; IntValue tmpi = tmp marketingapi. AddContact (contactid as int, as string, displayname as string, firstname as string, lastname as string, age as int, gender as EnumGender, occupation as string, organization as string, title as string, phone as string, mobile as string, fax as string, homepage as string, interests as string, address1 as string, address2 as string, city as string, stateorprovince as string, country as string, ziporpostalcode as string); 2.6 DeleteContactById You can remove a contact by the Contact Id.

23 Removing a contact doesn't mean that this contact unsubscribed from receiving s. It means the contact simply does not exist in your contact list. And you can add him/her back to your Comm100 account. However, this API should not be used if the contact has opted out of receiving all s. Instead, you must unsubscribe this contact Syntax Public Error DeleteContactById(int contactid) Input int contactid Output Error int ErrorCode string ErrorMessage Parameters contactid: The unique Id of a contact ErrorCode: Error Code ; No error is detected when it's 0. ErrorMessage: Detailed error information Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1 Host: localhost SOAPAction: " <soap:header> <CredentialSoapHeader xmlns=" <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader>

24 </soap:header> <DeleteContactById xmlns=" <contactid>int</contactid> </DeleteContactById> HTTP/ OK <DeleteContactByIdResponse xmlns=" <DeleteContactByIdResult> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </DeleteContactByIdResult> </DeleteContactByIdResponse> Examples C# //Authenticity Verification: please provide an Comm100 site account with administrative permission CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; Error tmpe = tmp marketingapi. DeleteContactById(contactId as int);

25 2.7 DeleteContactBy Address You can remove a contact by the Contact Id. Removing a contact doesn't mean that this contact unsubscribed from receiving s. It means the contact simply does not exist in your contact list. And you can add him/her back to your Comm100 account. However, this API should not be used if the contact has opted out of receiving all s. Instead, you must unsubscribe this contact Syntax Public Error DeleteContactBy Address(string address) Input string address Output Error int ErrorCode string ErrorMessage Parameters address: The address of a contact ErrorCode: Error Code ; No error is detected when it's 0. ErrorMessage: Detailed error information Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1 Host: localhost SOAPAction: "

26 <soap:header> <CredentialSoapHeader xmlns=" <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader> </soap:header> <DeleteContactBy Address xmlns=" < address>string</ address> </DeleteContactBy Address> HTTP/ OK <DeleteContactBy AddressResponse xmlns=" <DeleteContactBy AddressResult> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </DeleteContactBy AddressResult> </DeleteContactBy AddressResponse> Examples C# //Authenticity Verification: please provide an Comm100 site account with administrative permission CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; Error tmpe = tmp marketingapi. DeleteContactBy Address ( address as string);

27 2.8 GetAllMailingLists You can get a list of the information of your mailing lists in your site account Syntax Public MailingListsOutput GetAllMailingLists() Input Output MailingListsOutput Error Error MailingList[] mailinglists Parameters MailingList: A collection of names and addresses which you use to send newsletter to multiple recipients. MailingList int Id string Name string Description Id: The unique number of a mailing list. Name: The name of a mailing list. Description: The description of a mailing list. Error: A struct consisting of error code and error message Error int ErrorCode //error code (No error is detected when it's 0.) string ErrorMessage //error message (detailed error information)

28 2.8.5 Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1 Host: localhost SOAPAction: " <soap:header> <CredentialSoapHeader xmlns=" <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader> </soap:header> <GetAllMailingLists xmlns=" /> HTTP/ OK <GetAllMailingListsResponse xmlns=" <GetAllMailingListsResult> <Error> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </Error> <MailingLists> <MailingList> <Id>int</Id> <Name>string</Name> <Description>string</Description> </MailingList> <MailingList> <Id>int</Id> <Name>string</Name> <Description>string</Description> </MailingList> </MailingLists>

29 </GetAllMailingListsResult> </GetAllMailingListsResponse> Examples C# // Authenticity Verification: please provide an Comm100 site account with administrative permission CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; MailingListOutput tmpo = tmp marketingapi. GetAllMailingLists (); 2.9 AddMailingList You can create a new contact in your Comm100 account Syntax Public IntValue AddMailingList(string name, string desctiption) Input string name, string desctiption Output IntValue Error Error int Value

30 2.9.4 Parameters Name: The name of a mailing list. Description: The description of a mailing list. Value: The unique Id of a contact. Error: A struct consisting of error code and error message. Error int ErrorCode //error code (No error is detected when it's 0.) string ErrorMessage //error message (detailed error information) Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1 Host: localhost SOAPAction: " <soap:header> <CredentialSoapHeader xmlns=" <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader> </soap:header> <AddMailingList xmlns=" <name>string</name> <description>string</description> </AddMailingList> HTTP/ OK

31 <AddMailingListResponse xmlns=" <AddMailingListResult> <Error> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </Error> <Value>int</Value> </AddMailingListResult> </AddMailingListResponse> Examples C# // Authenticity Verification: please provide an Comm100 site account with administrative permission CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; IntValue tmpi = tmp marketingapi.addmailinglist(name as string, description as string); 2.10 Updat ingList You can update the information of a mailing list Syntax Public Error Updat ingList(int mailinglistid, string name, string description) Input int mailinglistid, string name, string description Output

32 Error int ErrorCode string ErrorMessage Parameters MailingListId: The unique number of a mailing list. Name: The name of mailing list. Description: The description of a mailing list. ErrorCode: Error Code ; No error is detected when it's 0. ErrorMessage: Detailed error information Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1 Host: localhost SOAPAction: " <soap:header> <CredentialSoapHeader xmlns=" <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader> </soap:header> <Updat ingList xmlns=" <mailinglistid>int</mailinglistid> <name>string</name> <description>string</description> </Updat ingList>

33 HTTP/ OK <Updat ingListResponse xmlns=" <Updat ingListResult> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </Updat ingListResult> </Updat ingListResponse> Examples C# // Authenticity Verification: please provide an Comm100 site account with administrative permission CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; Error tmpe = tmp marketingapi.updat inglist (Id as int, name as string, description as string); 2.11 ClearMailingList You can clear all the information of a mailing list. However, the members belongs to this mailing list won't be removed from the contact list Syntax Public Error ClearMailingList(int mailinglistid)

34 Input int mailinglistid Output Error int ErrorCode string ErrorMessage Parameters MailingListId: The unique number of a mailing list. ErrorCode: Error Code ; No error is detected when it's 0. ErrorMessage: Detailed error information Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1 Host: localhost SOAPAction: " <soap:header> <CredentialSoapHeader xmlns=" <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader> </soap:header> <ClearMailingList xmlns=" <mailinglistid>int</mailinglistid> </ClearMailingList> HTTP/ OK

35 <ClearMailingListResponse xmlns=" <ClearMailingListResult> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </ClearMailingListResult> </ClearMailingListResponse> Examples C# // Authenticity Verification: please provide an Comm100 site account with administrative permission CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; Error tmpe = tmp marketingapi.clearmailinglist (mailinglistid as int); 2.12 GetAllMembersOfMailingList You can have a list of members belongs to a specific mailing list Syntax Public MembersOutput GetAllMembersOfMailingList(int mailinglistid) Input int mailinglistid

36 Output MembersOutput Error Error Memeber[] Members Parameters Member: A subscribed contact/user belongs to a certain mailing list. Member int MailingListId int UserOrContactId string Address string FirstName string LastName int Age EnumGender Gender EnumGender Male Female It's a Secret string Occupation string Organization string Title string Phone string Mobile string Fax string HomePage string Interests string Address1 string Address2 string City string StateOrProvince string Country string ZipOrPostalCode string JoinTime string Source string Status

37 MailingListId: The unique Id of a mailing list. UserorContactId: The unique Id of a user or a contact. Address: The address of a subscribed member. FirstName: The first name of a subscribed member. LastName: The last name of a subscribed member. Age: The age of a subscribed member. Gender: The gender of a subscribed member. Occupation: The occupation of a subscribed member. Organization: The organization which a subscribed member works for. Title: The title of a subscribed member. Phone: The phone number of a subscribed member. Mobile: The mobile number of a subscribed member. Fax: The fax number subscribed member. HomePage: Member's company home page of Interests: Member's Interests. Address1: Member 's Address Address2: Member's Address City: The city in which a subscribed member locates. StateOrProvince: The state or province in which a subscribed member locates. Country: The country in which a subscribed member locates. ZipOrPostalCode: The zip/postal code of a subscribed member 's location. JoinTime: The time when a subscribed member is added in your Comm100 account. Source: From where a subscribed member is added into your Comm100 account. Status: The status of a member in a specific mailing list. Error: A struct consisting of error code and error message Error int ErrorCode //error code (No error is detected when it's 0.) string ErrorMessage //error message (detailed error information) Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1 Host: localhost

38 SOAPAction: " <soap:header> <CredentialSoapHeader xmlns=" <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader> </soap:header> <GetAllMembersOfMailingList xmlns=" <mailinglistid>int</mailinglistid> </GetAllMembersOfMailingList> HTTP/ OK <GetAllMembersOfMailingListResponse xmlns=" <GetAllMembersOfMailingListResult> <Error> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </Error> <Members> <Member> <MailingListId>int</MailingListId> <UserOrContactId>int</UserOrContactId> < Address>string</ Address> <FirstName>string</FirstName> <LastName>string</LastName> <Age>int</Age> <Gender> Male or Female or ItsaSecret</Gender> <Occupation>string</Occupation> <Organization>string</Organization> <Title>string</Title> <Phone>string</Phone> <Mobile>string</Mobile> <Fax>string</Fax> <HomePage>string</HomePage> <Interests>string</Interests> <Address1>string</Address1> <Address2>string</Address2> <City>string</City>

39 <StateOrProvince>string</StateOrProvince> <Country>string</Country> <ZipOrPostalCode>string</ZipOrPostalCode> <JoinTime>string</JoinTime> <Source>string</Source> <Status>string</Status> </Member> <Member> <MailingListId>int</MailingListId> <UserOrContactId>int</UserOrContactId> < Address>string</ Address> <FirstName>string</FirstName> <LastName>string</LastName> <Age>int</Age> <Gender> Male or Female or ItsaSecret</Gender> <Occupation>string</Occupation> <Organization>string</Organization> <Title>string</Title> <Phone>string</Phone> <Mobile>string</Mobile> <Fax>string</Fax> <HomePage>string</HomePage> <Interests>string</Interests> <Address1>string</Address1> <Address2>string</Address2> <City>string</City> <StateOrProvince>string</StateOrProvince> <Country>string</Country> <ZipOrPostalCode>string</ZipOrPostalCode> <JoinTime>string</JoinTime> <Source>string</Source> <Status>string</Status> </Member> </Members> </GetAllMembersOfMailingListResult> </GetAllMembersOfMailingListResponse> Examples C#

40 // Authenticity Verification: please provide an Comm100 site account with administrative permission CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; MembersOutput tmpo = tmp marketingapi.getallmembersofmailinglist(mailinglistid as int); 2.13 AddAContactToMailingList You can add a contact to a specific mailing list Syntax Public Error AddAContactToMailingList(int mailinglistid, int contactid) Input int mailinglistid, int contactid Output Error int ErrorCode string ErrorMessage Parameters MailingListId: The unique Id of a mailing list. ContactId: The unique Id of a contact. ErrorCode: Error Code ; No error is detected when it's 0. ErrorMessage: Detailed error information

41 Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1 Host: localhost SOAPAction: " <soap:header> <CredentialSoapHeader xmlns=" <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader> </soap:header> <AddAContactToMailingList xmlns=" <mailinglistid>int</mailinglistid> <contactid>int</contactid> </AddAContactToMailingList> HTTP/ OK <AddAContactToMailingListResponse xmlns=" <AddAContactToMailingListResult> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </AddAContactToMailingListResult> </AddAContactToMailingListResponse> Examples C#

42 // Authenticity Verification: please provide an Comm100 site account with administrative permission CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; Error tmpe = tmp marketingapi.addacontacttomailinglist (mailinglistid as int, contactid as int); 2.14 AddMultipleContactsToMailingList You can add multiple contacts to a specific mailing list Syntax Public Error AddMultipleContactsToMailingList(int mailinglistid, int[] contactids) Input int mailinglistid, int[] contactids Output Error int ErrorCode string ErrorMessage Parameters MailingListId: The unique Id of a mailing list. ContactIds: The Id numbers of certain contacts. ErrorCode: Error Code ; No error is detected when it's 0. ErrorMessage: Detailed error information

43 Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1 Host: localhost SOAPAction: " <soap:header> <CredentialSoapHeader xmlns=" <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader> </soap:header> <AddMultipleContactsToMailingList xmlns=" <mailinglistid>int</mailinglistid> <contactids> <int>int</int> <int>int</int> </contactids> </AddMultipleContactsToMailingList> HTTP/ OK <AddMultipleContactsToMailingListResponse xmlns=" <AddMultipleContactsToMailingListResult> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </AddMultipleContactsToMailingListResult> </AddMultipleContactsToMailingListResponse>

44 Examples C# // Authenticity Verification: please provide an Comm100 site account with administrative permission CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; Error tmpe = tmp marketingapi.addmultiplecontactstomailinglist(mailinglistid as int, contactids as int array); 2.15 DeleteAContactFromMailingList You can remove a contact from a mailing list, but he/she still belongs to your contacts list Syntax Public Error DeleteAContactFromMailingList(int mailinglistid, int contactid) Input int mailinglistid, int contactid Output Error int ErrorCode string ErrorMessage Parameters MailingListId: The unique Id of a mailing list. ContactId: The unique Id of a contact.

45 ErrorCode: Error Code ; No error is detected when it's 0. ErrorMessage: Detailed error information Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1 Host: localhost SOAPAction: " <soap:header> <CredentialSoapHeader xmlns=" <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader> </soap:header> <DeleteAContactFromMailingList xmlns=" <mailinglistid>int</mailinglistid> <contactid>int</contactid> </DeleteAContactFromMailingList> HTTP/ OK <DeleteAContactFromMailingListResponse xmlns=" <DeleteAContactFromMailingListResult> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </DeleteAContactFromMailingListResult> </DeleteAContactFromMailingListResponse>

46 Examples C# // Authenticity Verification: please provide an Comm100 site account with administrative permission CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; Error tmpe = tmp marketingapi.deleteacontactfrommailinglist (mailinglistid as int, contactid as int); 2.16 DeleteMultipleContactsFromMailingList You can remove multiple contact from a mailing list, but the members still belong to your contacts list Syntax Public Error DeleteMultipleContactsFromMailingList(int mailinglistid, int[] contactids) Input int mailinglistid, int[] contactids Output Error int ErrorCode string ErrorMessage Parameters MailingListId: The unique Id of a mailing list. ContactIds: The Id numbers of certain contacts.

47 ErrorCode: Error Code ; No error is detected when it's 0. ErrorMessage: Detailed error information Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1 Host: localhost SOAPAction: " <soap:header> <CredentialSoapHeader xmlns=" <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader> </soap:header> <DeleteMultipleContactsFromMailingList xmlns=" <mailinglistid>int</mailinglistid> <contactids> <int>int</int> <int>int</int> </contactids> </DeleteMultipleContactsFromMailingList> HTTP/ OK <DeleteMultipleContactsFromMailingListResponse xmlns=" <DeleteMultipleContactsFromMailingListResult> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </DeleteMultipleContactsFromMailingListResult> </DeleteMultipleContactsFromMailingListResponse>

48 Examples C# // Authenticity Verification: please provide an Comm100 site account with administrative permission CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; Error tmpe = tmp marketingapi.deletemultiplecontactsfrommailinglist(mailinglistid as int, contactids as int array); 2.17 GetMemberByMailingListIdAndContactId You can obtain a member's detailed information by mailing list and the Contact Id Syntax Public MemberOutput GetMemberByMailingListIdAndContactId(int mailinglistid, int userorcontactid) Input int mailinglistid, int userorcontactid Output MemberOutput Error Error Member Member

49 Parameters Member: A subscribed contact/user belongs to a certain mailing list. Member int MailingListId int UserOrContactId string Address string FirstName string LastName int Age EnumGender Gender EnumGender Male Female It's a Secret string Occupation string Organization string Title string Phone string Mobile string Fax string HomePage string Interests string Address1 string Address2 string City string StateOrProvince string Country string ZipOrPostalCode string JoinTime string Source string Status MailingListId: The unique Id of a mailing list. UserorContactId: The unique Id of a user or a contact. Address: The address of a subscribed member. FirstName: The first name of a subscribed member. LastName: The last name of a subscribed member. Age: The age of a subscribed member.

50 Gender: Contact's gender. (EnumGender is an enumerated type provided for your direct use.) Occupation: The occupation of a subscribed member. Organization: The organization which a subscribed member works for. Title: The title of a subscribed member. Phone: The phone number of a subscribed member. Mobile: The mobile number of a subscribed member. Fax: The fax number subscribed member. HomePage: Member's company home page of Interests: Member's Interests. Address1: Member 's Address Address2: Member's Address City: The city in which a subscribed member locates. StateOrProvince: The state or province in which a subscribed member locates. Country: The country in which a subscribed member locates. ZipOrPostalCode: The zip/postal code of a subscribed member 's location. JoinTime: The time when a subscribed member is added in your Comm100 account. Source: From where a subscribed member is added into your Comm100 account. Status: The status of a member in a specific mailing list. Error: A struct consisting of error code and error message Error int ErrorCode //error code (No error is detected when it's 0.) string ErrorMessage //error message (detailed error information) Sample SOAP 1.1 Request & Response POST /NewsletterAPI/ marketingapi.asmx HTTP/1.1 Host: localhost SOAPAction: " <soap:header> <CredentialSoapHeader xmlns="

51 <SiteId>int</SiteId> < >string</ > <Password>string</Password> </CredentialSoapHeader> </soap:header> <GetMemberByMailingListIdAndContactId xmlns=" <mailinglistid>int</mailinglistid> <userorcontactid>int</userorcontactid> </GetMemberByMailingListIdAndContactId> HTTP/ OK <GetMemberByMailingListIdAndContactIdResponse xmlns=" <GetMemberByMailingListIdAndContactIdResult> <Error> <ErrorCode>int</ErrorCode> <ErrorMessage>string</ErrorMessage> </Error> <Member> <MailingListId>int</MailingListId> <UserOrContactId>int</UserOrContactId> < Address>string</ Address> <FirstName>string</FirstName> <LastName>string</LastName> <Age>int</Age> <Gender>Male or Female or ItsaSecret</Gender> <Occupation>string</Occupation> <Organization>string</Organization> <Title>string</Title> <Phone>string</Phone> <Mobile>string</Mobile> <Fax>string</Fax> <HomePage>string</HomePage> <Interests>string</Interests> <Address1>string</Address1> <Address2>string</Address2> <City>string</City> <StateOrProvince>string</StateOrProvince> <Country>string</Country> <ZipOrPostalCode>string</ZipOrPostalCode> <JoinTime>string</JoinTime> <Source>string</Source> <Status>string</Status> </Member>

52 </GetMemberByMailingListIdAndContactIdResult> </GetMemberByMailingListIdAndContactIdResponse> Examples C# // Authenticity Verification: please provide an Comm100 site account with administrative permission CredentialSoapHeader soapheader = new CredentialSoapHeader(); header.siteid = SiteId as int; header. = Operator as string; header.password = Password as string; MarketingAPI tmp marketingapi = new MarketingAPI(); tmp marketingapi.credentialsoapheadervalue = soapheader; MemberOutput tmpo = tmp marketingapi.getmemberbymailinglistidandcontactid (mailinglistid as int, userorcontactid as int); 2.18 GetMemberByMailingListIdAnd Address You can obtain multiple members' detailed information by mailing list and the Contact Id Syntax Public MembersOutput GetMembersByMailingListIdAnd Address(int mailinglistid, string address) Input int mailinglistid, string address Output MemberOutput Error Error Member Member