ApiParser C#

C# class for using our company's API as part of the subscription.

---

Installation

Install the NuGet package from the package manager console:

Install-Package ApiParser -Version 1.2.21

---

How to use

1. Create instance from ApiParser.NET.dll

ApiParserparser=newApiParser("API_USERNAME","API_TOKEN","json");

2. Call method from ApiParser

intcampaignid=278;floathours=1;objectresponse=parser.ScheduleSendSMS(campaignid,hours);

---

Changelog:

Differences between v1.2.20 and v1.2.21

Method definition changed:

• ScheduleSendSMS

Previous:

publicstringScheduleSendSMS(intcampaignid=0,int[]lists=null,floathours=0)

Now:

publicstringScheduleSendSMS(intcampaignid=0,floathours=0)

• Removed: lists.

Removed method:

• SendSMS

publicstringSendSMS(intcampaignid=0,stringsubject="",stringtext="",intsubscriberid=0,intlistid=0,stringmobile="",stringmobilePrefix="")

Differences between v1.2.18 and v1.2.20

New method:

• RemoveOTMDocument

publicstringRemoveOTMDocument(intsubscriberid=0,intfieldid=0,stringpath="",intindex=0)

Differences between v1.2.17 and v1.2.18

New methods:

• CreateSubAccount

publicstringCreateSubAccount(stringaccountName="",stringaccountPassword="",stringownerEmail="",string[]allowedDomains=null)

• InheritListsToSubAccount

publicstringInheritListsToSubAccount(stringaccountName="",int[]inheritLists=null)

• InheritSegmentsToSubAccount

publicstringInheritSegmentsToSubAccount(stringaccountName="",int[]inheritSegments=null)

• InheritNewsletterToSubAccount

publicstringInheritNewsletterToSubAccount(stringaccountName="",intnewsletterid=0,stringrecipientsType="",int[]recipientsid=null)

Differences between v1.2.16 and v1.2.17

Method definition changed:

• UpdateOTMDocument

Previous:

publicstringUpdateOTMDocument(intsubscriberid=0,intfieldid=0,Dictionary<string,object>values=null,stringpath="");

Now:

publicstringUpdateOTMDocument(intsubscriberid=0,intlistid=0,stringemailaddress="",stringmobileNumber="",stringmobilePrefix="",intfieldid=0,Dictionary<string,object>values=null,stringpath="");

• Added: listid, emailaddress, mobileNumber and mobilePrefix.

Differences between v1.2.15 and v1.2.16

Method definition changed:

• GetSubscriberDetails

Previous:listid was required.

Now:listid is not required if subscriberid is specified.

Differences between v1.2.14.2 and v1.2.15

New methods:

• UpdateOTMDocument

publicstringUpdateOTMDocument(intsubscriberid=0,intfieldid=0,Dictionary<string,object>values=null,stringpath="")

• RemoveOTMDocument

publicstringRemoveOTMDocument(intsubscriberid=0,intfieldid=0,stringpath="",intindex=0)

Method definition changed:

• SendNewsletter

Previous:

publicstringSendNewsletter(intnewsletterid=0,intsubscriberid=0,stringemail="",stringsenderEmail="",stringsenderName="",stringreplyEmail="",stringcallbackUrl="",boolreloadFeed=false)

Now:

publicstringSendNewsletter(intnewsletterid=0,intsubscriberid=0,stringemail="",stringsenderEmail="",stringsenderName="",stringreplyEmail="",stringcallbackUrl="",boolreloadFeed=false,boolnotifyOwner=false)

• Added: notifyOwner

• ScheduleSendNewsletter

Previous:

publicstringScheduleSendNewsletter(intcampaignid=0,floathours=0,boolsaveSnapshots=true,boolreloadFeed=true)

Now:

publicstringScheduleSendNewsletter(intcampaignid=0,floathours=0,boolsaveSnapshots=true,boolreloadFeed=true,boolnotifyOwner=false)

• Added: notifyOwner

• ScheduleSendNewsletterToLists

Previous:

publicstringScheduleSendNewsletterToLists(intcampaignid=0,floattimeToSend=0,int[]listids=null,boolsaveSnapshots=true,boolreloadFeed=true)

Now:

publicstringScheduleSendNewsletterToLists(intcampaignid=0,floattimeToSend=0,int[]listids=null,boolsaveSnapshots=true,boolreloadFeed=true,boolnotifyOwner=false)

• Added: notifyOwner

• ScheduleSendNewsletterToSegments

Previous:

publicstringScheduleSendNewsletterToSegments(intcampaignid=0,floattimeToSend=0,int[]segmentids=null,boolsaveSnapshots=true,boolreloadFeed=true)

Now:

publicstringScheduleSendNewsletterToSegments(intcampaignid=0,floattimeToSend=0,int[]segmentids=null,boolsaveSnapshots=true,boolreloadFeed=true,boolnotifyOwner=false)

• Added: notifyOwner

Differences between v1.2.14.1 and v1.2.14.2

Method result changed:

• GetStatids

publicobjectGetStatids(intlistid=0,intsegmentid=0,intcampaignid=0,stringfrom="",stringto="",intlimit=100,intoffset=0)

Differences between v1.2.14 and v1.2.14.1

New method:

• GetSampleDataForOTM

publicobjectGetSampleDataForOTM(intfieldid=0)

Differences between v1.2.13 and v1.2.14

Method definition changed:

• ScheduleSendNewsletter

Previous:

publicstringScheduleSendNewsletter(intcampaignid=0,floathours=0,boolsaveSnapshots=true)

Now:

publicstringScheduleSendNewsletter(intcampaignid=0,floathours=0,boolsaveSnapshots=true,boolreloadFeed=true)

• Added: reloadFeed

• ScheduleSendNewsletterToLists

Previous:

publicfunctionScheduleSendNewsletterToLists(intcampaignid=0,floattimeToSend=0,int[]listids=null)

Now:

publicfunctionScheduleSendNewsletterToLists(intcampaignid=0,floattimeToSend=0,int[]listids=null,boolsaveSnapshots=true,boolreloadFeed=true)

• Added: saveSnapshots and reloadFeed

• ScheduleSendNewsletterToSegments

Previous:

publicfunctionScheduleSendNewsletterToSegments(intcampaignid=0,floattimeToSend=0,int[]segmentids=null)

Now:

publicfunctionScheduleSendNewsletterToSegments(intcampaignid=0,floattimeToSend=0,int[]segmentids=null,boolsaveSnapshots=true,boolreloadFeed=true)

• Added: saveSnapshots and reloadFeed

Differences between v1.2.12 and v1.2.13

New method:

• CreateSegment

publicstringCreateSegment(stringname="",Dictionary<string,object>rules=null,stringconnector="and")

Differences between v1.2.11 and v1.2.12

New method:

• AddCustomFieldsToList

publicstringAddCustomFieldsToList(intlistid=0,int[]customFields=null)

Differences between v1.2.10 and v1.2.11

Method definition changed:

• SendNewsletter

Previous:

publicstringSendNewsletter(intnewsletterid=0,intsubscriberid=0,stringemail="",stringsenderEmail="",stringsenderName="",stringreplyEmail="")

Now:

publicstringSendNewsletter(intnewsletterid=0,intsubscriberid=0,stringemail="",stringsenderEmail="",stringsenderName="",stringreplyEmail="",stringcallbackUrl="",boolreloadFeed=false)

• Added: callbackUrl and reloadFeed

Differences between v1.2.9 and v1.2.10

New methods:

• ScheduleSendNewsletterToLists

Definition:

publicstringScheduleSendNewsletterToLists(intcampaignid=0,floathours=0,int[]listids=null)

• ScheduleSendNewsletterToSegments

Definition:

publicstringScheduleSendNewsletterToSegments(intcampaignid=0,floathours=0,int[]segmentids=null)

Differences between v1.2.8 and v1.2.9

Method definition changed:

• ScheduleSendNewsletter

Previous:

publicstringScheduleSendNewsletter(intcampaignid=0,floathours=0)

Now:

publicstringScheduleSendNewsletter(intcampaignid=0,floathours=0,boolsaveSnapshots=true)

• Added: saveSnapshots

New methods:

• GetSentEmailCampaignEvents

Definition:

publicstringGetSentEmailCampaignEvents(stringfrom="",stringto="",intlimit=10,intoffset=0)

• GetSentEmailCampaignWithTriggerEvents

Definition:

publicstringGetSentEmailCampaignWithTriggerEvents(stringfrom="",stringto="",intlimit=10,intoffset=0)

• GetOpenCampaignEvents

Definition:

publicstringGetOpenCampaignEvents(stringfrom="",stringto="",intlimit=10,intoffset=0)

• GetOpenTriggersEvents

Definition:

publicstringGetOpenTriggersEvents(stringfrom="",stringto="",intlimit=10,intoffset=0)

• GetLinkClickCampaignEvents

Definition:

publicstringGetLinkClickCampaignEvents(stringfrom="",stringto="",intlimit=10,intoffset=0)

• GetLinkClickTriggersEvents

Definition:

publicstringGetLinkClickTriggersEvents(stringfrom="",stringto="",intlimit=10,intoffset=0)

• GetSentAutoresponderEvents

Definition:

publicstringGetSentAutoresponderEvents(stringfrom="",stringto="",intlimit=10,intoffset=0)

• GetOpenAutoresponderEvents

Definition:

publicstringGetOpenAutoresponderEvents(stringfrom="",stringto="",intlimit=10,intoffset=0)

• GetLinkClickAutoresponderEvents

Definition:

publicstringGetLinkClickAutoresponderEvents(stringfrom="",stringto="",intlimit=10,intoffset=0)

• GetSentSMSCampaignEvents

Definition:

publicstringGetSentSMSCampaignEvents(stringfrom="",stringto="",intlimit=10,intoffset=0)

---

Differences between v1.2.7 and v1.2.8

Update on memory objects:

---

Differences between v1.2.6 and v1.2.7

New method:

• GetTrackingEvents

Definition:

publicobjectGetTrackingEvents(intlistid=0,intsubscriberid=0,intlimit=100,intoffset=0)

---

Differences between v1.2.5 and v1.2.6

New methods:

• GetLeadScore

Definition:

publicobjectGetLeadScore(intsubscriberid=0)

• SetLeadScore

Definition:

publicobjectSetLeadScore(intsubscriberid=0,int?leadScore=null,stringtype="add")

---

Differences between v1.2.4 and v1.2.5

New method:

• LoadCustomField

Definition:

publicobjectLoadCustomField(intfieldid=0,boolreturn_options=false,boolmakeInstance=false)

Method condition changed:

• GetCustomFields

Previous:

public object GetCustomFields(int[] lists = null) 

Now:

public object GetCustomFields(int[] lists = null) 

• lists: is not required.

---

Differences between v1.2.3 and v1.2.4

New methods:

• GetNewsletterSummary

Definition:

publicobjectGetNewsletterSummary(intnewsletterid=0,intstatid=0,stringfrom="",stringto="")

• GetStatids

Definition:

publicobjectGetStatids(intlistid=0,intsegmentid=0,intcampaignid=0,stringfrom="",stringto="",intlimit=100,intoffset=0)

• GetSnapshots

Definition:

publicobjectGetSnapshots(intsubscriberid=0,inttriggerid=0,intautoresponderid=0)

---

Differences between v1.2.2 and v1.2.3

Method definition changed:

• ResubscribeContact

Previous:

public string ResubscribeContact(int listid = 0, string emailaddress = "", string mobileNumber = "", string mobilePrefix = "", bool add_to_autoresponders = false)

Now:

public string ResubscribeContact(int listid = 0, string emailaddress = "", string mobileNumber = "", string mobilePrefix = "", bool add_to_autoresponders = false, List<ContactFieldText> contactFields = null, List<Dictionary<string, object>> otmValues = null)

• Added: contactFields and otmValues.

---

Differences between v1.2.1 and v1.2.2

New methods:

• GetSegments

Definition:

publicobjectGetSegments(intlistid=0,boolcount_subscribers=false,intlimit=1000,intoffset=0)

• GetTriggers

Definition:

publicobjectGetTriggers(intlistid=0,intlimit=1000,intoffset=0)

---

Differences between v1.1.11 and v1.2.1

New methods:

• AddToOTMDocument

Definition:

publicstringAddToOTMDocument(intlistid=0,intsubscriberid=0,stringemailaddress="",stringmobile="",stringmobilePrefix="",intfieldid=0,Dictionary<string,object>values=null,stringpath="")

• GetSubscribersByCustomField

Definition:

publicobjectGetSubscribersByCustomField(intlistid=0,List<ContactFieldText>data=null,boolactiveonly=true,boolcountonly=false,intlimit=1000,intoffset=0)

---

Differences between v1.1.10 and v1.1.11

New methods:

• GetTriggerSummary

Definition:

publicobjectGetTriggerSummary(inttriggerid=0,stringfrom="",stringto="")

• GetAutoresponderSummary

Definition:

publicobjectGetAutoresponderSummary(intautoresponderid=0,stringfrom="",stringto="")

---

Differences between v1.1.9 and v1.1.10

New methods:

• GetSegmentSummary

Definition:

publicobjectGetSegmentSummary(intsegmentid=0,stringfrom="",stringto="")

• GetRulesForSegment

Definition:

publicobjectGetRulesForSegment(intsegmentid=0)

• EditNewsletter

Definition:

publicobjectEditNewsletter(intnewsletterid=0,stringname="",stringsubject="")

• SetTriggerStatus

Definition:

publicobjectSetTriggerStatus(inttriggerid=0,boolstatus=false)

• SetAutoresponderStatus

Definition:

publicobjectSetAutoresponderStatus(intautoresponderid=0,boolstatus=false)

---

Differences between v1.1.8 and v1.1.9

Method definition changed:

• GetNewsletters

Previous:

publicobjectGetNewsletters(boolcountOnly=false,boolgetLastSentDetails=false,boolcontent=true,stringafterCreateDate="",stringnewsletterNameLike="")

Now:

publicobjectGetNewsletters(boolcountOnly=false,boolgetLastSentDetails=false,boolcontent=true,stringafterCreateDate="",stringnewsletterNameLike="",intlimit=100,intoffset=0)

• Added: limit & offset.

New methods:

• SendSMS

Definition:

publicstringSendSMS(intcampaignid=0,stringsubject="",stringtext="",intsubscriberid=0,intlistid=0,stringmobile="",stringmobilePrefix="")

• GetSubscribersFromSegment

Definition:

publicobjectGetSubscribersFromSegment(intsegmentid=0,boolcountonly=false,boolactiveonly=true,intlimit=100,intoffset=0)

• ViewNewsletter

Definition:

publicobjectViewNewsletter(intnewsletterid=0)

• GetTriggersForSegment

Definition:

publicobjectGetTriggersForSegment(intsegmentid=0)