PerceptiveMCAPIDo cumentation
5December2010 Page:1of22 ©2010PerceptiveLogic
WrapperOverview
Goal
ImproveeaseofuseandfunctionalityforASP.NETusersoftheMailChimpAPIbyprovidingaclasslibrary
wrapperandTestingUI.
Approach
• Use.NETclassestowrapfunctionalityoftheAPI,passinputparameters,andoutputresults.
• ProvideforbothXml‐RpcandSerial(GET/POST)accesstoAPIinformationviastronglytypeclassesfor
inputthatformatandcreatetheappropriateAPIcallsforyou.Multipleclasssignaturesprovided.
• Provide
aconsistentoutputtype,using.Netgenerictypesinplaceofarraysandstructs;e.g.,
List<string>insteadofstring[],Dictionary<string,string>forassociativearrays,etc.
• Providechoiceofunformattedoutputtypes;XML,JSON,andPHP.
• ProvidecustomdefaultvaluesthatcanoverrideMailChimpapidefaults;e.g.,limit=200vs.
1000.
• Providevalidation(selectable,on/off)forparametercompletenessandtypechecking.
• ReturnwrappervalidationmessagesandreturnedAPIerrorsmessagesasgenericlistsforeaseof
checkingandreporting.
• Results,otherthansimpleinteger,stringorBooleanvalues,aredefinedascustomclassesmakingthem
easiertouse,
especiallyindataboundcontrols.
Specifications&Requirements
• MailChimpAPIfunctionalitythroughthev1.2.7announcementdated16‐Jul‐2010.
• .NET3.5required
• CookComputingxml‐rpc.netv2.5.0libraryisused&included