XML API Documentation
Contents
1. NH 12345 US null 205 555 1212 null null 205 987 6543 orianthi bigstar com null null N null null API User amp login xxx amp pass yyy Returns This command returns the donor ID value of the new updated donor lt result gt lt record gt lt field name id value 147 gt lt record gt lt result gt Notes e 147 is the donor_id of the created donor s Do not have any spaces in the first part of your command https Awww donorperfect net prod xmlrequest asp action dp_savedonor amp para ms otherwise the API will return an error indicating that the parameter donor_id was not supplied e The null values act as placeholders and must be included in your command e Character values and date values must be enclosed in single quotes e g 11 01 2010 e The user id value is just there for transaction reference purposes and is not validated against the list of DPO users Version 4 1 September 11 2014 Page 18 DonorPerfect Online XML API User Manual dp_ gifts This procedure returns a predefined set of fields associated with all gifts given by the specified donor Parameters Parameter Type Notes donor_id numeric Sample Call https www donorperfect net prod xmlrequest asp action dp _ gifts amp params 147 amp login xxx amp pass yyy Returns lt result gt lt record gt lt field name gift date2 id gift date2 value 10 272. Or NULL membership_level NVarchar 30 Or NULL Version 4 1 September 11 2014 Page 22 DonorPerfect Online XML API User Manual Parameter Type Notes membership_enr_d datetime Or NULL ate membership_exp_d datetime Or NULL ate O numeric Or NULL address_id numeric Or NULL gift_narrative NVarchar 3000 Or NULL ty_letter_no NVarchar 30 Or NULL vault_id NVarchar 55 Or NULL receipt_delivery_g NVarchar 30 E for email B for both email and letter L for letter N for do not acknowledge or NULL contact_id numeric Or NULL Sample Call https www donorperfect net prod xmlrequest asp action dp _ savepledge amp params 0 10 15 2012 600 00 30 00 M Y 4540 N BQ10 N TS 0 00 12 29 2013 API User REG NULL NULL NULL NULL NULL NULL Gift narrative amp login xxx amp pass yyy Returns lt result gt lt record gt lt field name lt record gt lt result gt Notes 147 10 12 2012 TTY id e 10230 is the gift_id of the created gift Version 4 1 September 11 2014 value 10230 123321 E NULL gt Page 23 DonorPerfect Online XML API User Manual dp_saveotherinfo This procedure saves fields to the dpotherinfo table It will create a new or updated Other Info record for the specified donor_id Parameters Parameter Type Notes other_id nu
3. 2010 gt lt field name amount id amount value 14 98 gt lt field name total id total value 0 gt lt field name sub_ solicit code id sub solicit code value TS gt lt field name campaign id campaign value gt lt field name balance id balance value 0 gt lt field name gl id gl value NO Rcpt BOOKS TAPES gt lt field name solicit code id solicit code value BQ10 gt lt field name reference id reference value gt lt field name record type id record type value G gt lt field name gift id id gift id value 10230 gt lt field name donor id id donor id value 147 gt lt field name anongift id anongift value gt lt field name gift aid date id gift aid date value gt lt record gt lt result gt Notes s If you need different or additional fields returned from the system use a Dynamic Query SELECT command Version 4 1 September 11 2014 Page 19 DonorPerfect Online XML API User Manual dp_savegift This procedure is used to save changes to an existing gift or to save a new gift into the DPO system Parameters Parameter Type Notes gift_id numeric a 0 in this field to create a new gift or the gift ID of an existing gift donor_id numeric record_type NVarchar 30 G for Gift P for Pledge gift_date datetime amount money gl_code NVarchar 3
4. 4 Predefined Procedures cuiiicocinsadiiada cd ida de cd a da 15 AA FEA anaE AAT EEA ANAE aA EVAAA AET EAAA 15 EEEE EEE E EA mn A T 15 o O RAN 15 PROTONS toco 15 Notes PE aia 16 OP ER Te eect tn en RaT 17 Paramete Si eect ie leeds nt ne A en ai a a ade LE 17 Sample Galleries cx REZ edad 18 ST TTT 18 A HH HHH 18 Version 4 1 September 11 2014 Page 3 DonorPerfect Online XML API User Manual Co THIS aa A oe ee oY 19 Parameters is tacos tk te See A RR np a Anne ral 19 Sample Calla auth aie Ge tite ave nies De ANR Re AP Case RU Ana die bik oad 19 STs tates Sennett e Mak de e A Re cr di dus 19 NOLES Feito ns he hte ee lor ata hale e aa de Ll do blo alae qu se An 19 dp SAV l cae a ae a E esac sa ha aha OEE EA 20 Parameters ssc A A Ts hei Re ee T NE 20 Sa S detec tty E act se aver a LRH ERT 21 RAILO AEEA ER Bee rente AE ae 2k ate Alek eB ot tot ME NR tn ea ot oe ie ek 21 INOTOS 5 EE e ex A de Non ad ed att eto sa HR oie eh 21 TREUT e s Te 22 Parameters mnra a ESC aa den 9 wave eee avec VEN eu 22 Sample Gal a raoc ea ae panne E 23 ST s 15888 ee ene en ete es da uae he ie D whine eae iowa aah wd alee 23 A ca aul ahd ee ea a anaes eee ye eae 23 dp_saveotherinfo ss sssnnnneeennnnnnenennnnnnnnnnnennnnnnnnenennnns 24 Parameters KE dr Da nil tm fl are M et a oe AL co e a nm lb foe fa 24 Sample Galli vidi nes ant atin ht at deena ate ee thee 24 Returns abi ad oa e LZ AD ot Tee Ali ate de Lt ada loth tia an te de Be al 24 Notes so
5. Breakdown A sample HTTPS request is analyzed below This particular one returns all the gifts that are in the DPO system for a donor with id 1269525 https www donorperfect net prod xmlrequest asp action dp _ gifts amp params 1269525 amp login xxx amp pass yyy Each XML API call has a number of key components 1 https www donorperfect net prod xmlrequest asp a constant location of the page that accepts the parameters and returns the requested XML information 2 action dp_gifts action function that one would like to perform 3 params 1269525 parameters listing This particular example only has one 4 5 parameter but in most cases there will be more than one for other functions especially that deal with saving information into DPO The parameters must be listed in order and separated by a comma Some parameters are numeric some are date time and some are text login xxx where xxx is the username login provided to you by your account manager for communication with DPO via XML API pass yyy where yyy is the password provided to you by your account manager for communication with DPO via XML API NOTE See following section on API Connection Credentials for information on the alternative API Key connection method Version 4 1 September 11 2014 Page 8 DonorPerfect Online XML API User Manual API Connection Credentials There are two methods for supplying connection credenti
6. statement instead to achieve the desired result set Version 4 1 September 11 2014 Page 16 DonorPerfect Online XML API User Manual dp_savedonor Saving a New Existing Donor used to save changes to the existing donor constituent or save the new donor constituent into the DPO system Parameters Parameter Type Notes donor_id numeric Enter 0 zero to create a new donor constituent record or an existing donor_id first_name NVarchar 100 last_name NVarchar 150 middle_name NVarchar 100 suffix NVarchar 100 title NVarchar 100 salutation NVarchar 100 prof title NVarchar 100 opt_line NVarchar 100 address NVarchar 100 address2 NVarchar 100 city NVarchar 75 state NVarchar 50 zip NVarchar 50 country NVarchar 50 address_type NVarchar 30 home_phone NVarchar 75 business_phone NVarchar 75 fax_phone NVarchar 75 mobile_phone NVarchar 75 email NVarchar 100 org_rec NVarchar 1 Adonor_type NVarchar 30 Version 4 1 September 11 2014 Page 17 DonorPerfect Online XML API User Manual nomail NVarchar 1 nomail_reason NVarchar 30 narrative text user_id NVarchar 20 Sample Call https www donorperfect net prod xmlrequest asp action dp _ savedonor params 0 Orianthi Panagaris null null null null null null 4240 Main St null North Woodstock
7. the overall DPO CRM solution Version Control This document has been updated to Version 4 0 to correspond to DonorPerfect Online Version 2014 03 e This update corrects error in dp_savecontact example to show use of null in this field 1 ConstantContact is a registered trademark of ConstantContact Inc Version 4 1 September 11 2014 Page 6 DonorPerfect Online XML API User Manual 2 API Overview What is the DPO API The DPO API is a set of calls and parameters that one can use to interface external applications with DPO The API uses XML to return data back to the client and these XML data streams can be easily parsed using many popular XML parsers Simply put the DPO API is a way for programmers and webmasters to make their existing websites or any other applications synchronize with DPO on a variety of levels Common API Uses The DPO API includes the most commonly requested functions such as e Saving Donor Constituent Information includes demographic Name Address Email Phone Numbers etc e Saving a Donor Constituent s extended information User Defined Fields Unlimited ability to save to any field in the DPO system at the donor constituent level including ones that are created by the client e Retrieving a Donor Constituent s record from the database retrieves all demographic information and User Defined Fields e Searching for a Donor Constituent and returning the Donor_ID e S
8. 0 solicit_code NVarchar 30 sub_solicit co NVarchar 30 de gift_type NVarchar 30 split_gift NVarchar 1 pledge_payme NVarchar 1 nt reference NVarchar 25 memory_honor NVarchar 30 gfname NVarchar 50 Oglname NVarchar 75 fmv money batch_no numeric gift_narrative NVarchar 3000 ty_letter_no NVarchar 30 glink numeric plink numeric nocalc NVarchar 1 Version 4 1 September 11 2014 Page 20 DonorPerfect Online XML API User Manual Parameter Type Notes receipt NVarchar 1 old_amount money user_id NVarchar 20 campaign NVarchar 30 NULL membership_ty NVarchar 30 pe NULL membership_le NVarchar 30 vel NULL membership_e datetime NULL nr_date membership_e datetime NULL xp_date membership_li numeric NULL nk_ID address_id numeric NULL Sample Call https www donorperfect net prod xmlrequest asp action dp _ savegift params 0 147 G 10 27 2010 14 98 4540 N BQ10 TS VISAIC N N null null null nul1 0 0 In memory of my friend null null null N N null API User amp login xxx amp pass yyy Returns lt result gt lt record gt lt field name id value 10230 gt lt record gt lt result gt Notes e 10230 is the gift_id of the created gift Version 4 1 September 11 2014 Page 21 DonorPerfect Online XML API User Manual dp_savepledge This procedure
9. 10 14 2010 1 11 30 PM gt lt field name ModifiedDate id ModifiedDate value 10 14 2010 1 11 29 PM gt lt field name CustomerVaultID id CustomerVaultID value 1234567890 gt lt field name import id id import_id value gt lt field name created by id created by value Diane Warner gt lt field name modified by id modified by value gt lt field name selected currency id selected currency value USD gt lt record gt Version 4 1 September 11 2014 Page 33 DonorPerfect Online XML API User Manual 5 Support and Implementation Services How to contact DPO API Support Mark Warren XML API Consultant Email mwarren softerware com Fastest path for resolution Phone 1 855 896 5100 e Normal Working Hours Monday Friday 8 30 a m to 5 00 p m EST e Acknowledgement response time for support calls is not guaranteed and is independent of any other support guidelines Calls are answered in the order they are received and it s reasonable to expect a response within one business day For emergencies send an additional email to support donorperfect com Your purchase of the API XML service allows you access to our support staff and we can offer the following type of services at no additional charge e Assistance with API Call syntax e Recommendations or suggestions to accomplish your task e Error message explanations e Restoring API service due to our own outages Provi
10. 5 The actual key values are much longer than the partial key shown here https www donorperfect net prod xmlrequest asp apikey 95LT 7Cc VoBJnHqILHvljN2ZYbdBR5U amp action dp_ gifts amp params 1269525 Version 4 1 September 11 2014 Page 9 DonorPerfect Online XML API User Manual XML Response Format Each XML API call has a number of key components If you were to copy and paste the complete HTTP request found above into the Address area in a browser and press Enter Assuming the login and password was correct you would see the actual XML data being returned from DPO This will only work if all the items in the call 1 through 5 are valid and current Note that the returned values are quoted within the attributes value parameter lt result gt lt record gt lt field name gift_date2 id gift_date2 value 09 30 2005 gt lt field name amount id amount value 5000 gt lt field name total id total value 0 gt lt field name sub_solicit_code id sub_solicit_code value gt lt field name campaign id campaign value KAD905 gt lt field name balance id balance value 0 gt lt field name gl id gl value gt lt field name solicit_code id solicit_ code value 0223AF gt lt field name reference id reference value 56724 gt lt field name record_type id record_type value G gt lt field name gift_id id gift_id value 384441 gt lt fiel
11. DonorPerfect Online XML API User Manual SofterWare Inc Version 4 0 September 11 2014 Copyright SofterWare Inc 2014 All rights reserved Version 4 0 September 11 2014 Copyright SofterWare Inc 2014 All rights reserved DonorPerfect Online XML API User Manual Table of Contents 1 Executive SUMMA sessions nn nee nn nn es ein 6 Intended AUdIenCe essence nettes aeea Za aR eed NRT va aa dats D Version Control TTT 6 2 API OVervieW cccccocooncnnanancconononanananancncrononanananan raro nnnnan anna rr nenennan anna rr rr rra nan nnmnnn nnna 7 What is the DPO API sss sss ss ess sees nenen 7 Common APIUSEOS ui a 7 How do l usethe DRO API ui ai on nn de 7 API Example Call BreakKdOWN is iinssrrrssnerrnsnenennnennenssnnneensneeeeennnes 8 API Connection Credentials c ccccceccsssessssseeeneeeeeeeceseecacenssneneneeeeeusceceecansnsaneseneees 9 Username Password amp login e eee eee eeeee eee eenn 9 API Key apik ys 2 0 3ic bcc ceetadeaeh e alacena 9 XML Response Format ceceeeee cece eeeeeeee eee nn 10 API Administration and Limitations sse ss seene eenn eenn 11 LOG QING RER TT 11 FRRESIICHONS cet ted thi Aleit to Ae tele ta li 11 No BlockIMg 1 a a nee ie ARE 11 3 Dynamic Queries 2 id 12 SELECT Statements ida acon a e aera e Erea m ar e reo ae Eare aae r ardaoa hanaan 12 EN e EENE a E E E E E Sue 12 DPO Table Iet A EA A R E ee eae 14
12. ETT 24 dp SAVE UE lc ren ss nn ra a dees ne done tee Pa Eaa Paaa aaaea nn sde due 25 ParameterS sis ne rente Nr Ma tr tanto Re le Pre Lu die nl en tre 25 Sample Calk see a a Un a rl 25 REUS AE Se Bee te duet ce el te al e e ee eho ne reine 25 IGG RS PR E 25 dp SAVED Moi abri 26 A eect avec tac en ue ta dee dean Pa ee a A aa Re ent 26 Sample Cal as A ein eee 26 A L E S AENA RNT A A E O A ERA 26 V Tan 26 dp_delflags_xmI ss sssssnesrrnnnnnnenennnnnnnnnenennnnnnnneenennnns 28 ParamMelers ss ss ann E Nam den AT ne Ans ts 28 Sample Calla coat eat rie an A RAR Te A ata en EE A ee ee AN are a 28 STs tet o et ah Aol tec Rd Bk de Ce te TT 28 NOLS lt L ax tien A tte lod ce al bolts as ante de Lita do bla acta fu RZ 28 le BEEN ly AAA ac aca ed 29 A tase te A Reinke E edt oat ee le Pre NN Rea ae nl ts 29 sample Calle AL A ndo 29 REINOS SEE LA LE e e a e A L e ee 30 Notes screech a e ode dd do o H ci are 30 dp_PaymentMethod_Insert ssnnnnnnnnnnns 31 Parameters Pi Sn a an nd et eda avd es an se 31 Sample Callipso aiii da aR a ns an eee ete 31 Version 4 1 September 11 2014 Page 4 DonorPerfect Online XML API User Manual STZ TTT 32 INQUCS SR ne tt 32 5 Support and Implementation Services es 34 Version 4 1 September 11 2014 Page 5 DonorPerfect Online XML API User Manual 1 Executive Summary The DonorPerfect Online Application Programming Interface DPO API makes it possible for you to
13. NameOnAccount id NameOnAccount value Arthur Roundtable gt lt field name CreatedDate id CreatedDate value 10 15 2010 12 01 48 PM gt lt field name ModifiedDate id ModifiedDate value 10 15 2010 12 01 46 PM gt lt field name CustomerVaultID id CustomerVaultID value 1742923032 gt lt field name import_id id import_id value gt lt field name created by id created by value gt lt field name modified by id modified by value gt lt field name selected currency id selected_currency value CAD gt lt record gt Version 4 1 September 11 2014 Page 32 DonorPerfect Online XML API User Manual Sample Credit Card Item lt record gt lt field name DpPaymentMethodID id DpPaymentMethodID value 392 gt lt field name donor id id donor id value 21245 gt lt field name IsDefault id IsDefault value True gt lt field name AccountType id AccountType value MasterCard gt lt field name dpPaymentMethodTypeID id dpPaymentMethodTypeID value creditcard gt lt field name CardNumberLastFour id CardNumberLastFour value 1xxxxxxxxxxx2345 gt lt field name CardExpirationDate id CardExpirationDate value 0614 gt lt field name BankAccountNumberLastFour id BankAccountNumberLastFour value gt lt field name NameOnAccount id NameOnAccount value gt lt field name CreatedDate id CreatedDate value
14. The required values will be listed in the Code column of the resulting display mailing_ code NVarchar CODE value for Mailing Code field 30 by_whom NVarchar CODE value for the By Whom Contact Screen field in DPO 30 Description value of selected code shows in the Assigned To field of the contact record contact_date Datetime Contact Entry Date field in DPO due_date Datetime Due Date field in DPO due_time NVarchar Time field in DPO completed_date Datetime Completed Date field in DPO comment NVarchar Contact Notes field in DPO 3000 document_path NVarchar Type a URL File Path field in DPO 200 user_id NVarchar Created by value not shown in DPO user interface 20 Sample Call https www donorperfect net prod xmlrequest asp action dp _ savecontact params 0 135 TE BWO2 ELF 09 13 2012 Your comment on this contact item http api markwarren ca APIUser amp login xxx amp pass yyy Version 4 1 September 11 2014 09 18 2012 12 24 00 PM 09 28 2012 Page 29 DonorPerfect Online XML API User Manual Returns lt result gt lt record gt lt field name id value 123 gt lt record gt lt result gt Notes e 123 is the contact_id associated with the created value e In this example the contact_date is 09 13 2012 Typically the current date The due_date is 09 18 2012 and the completed_date is 09 28 2012 but you would typically leave this field b
15. able List This is a list of tables in DPO you can run Dynamic Queries On Table Name DP DPUDF DPUSERMULTIVALUES DPGIFT DPGIFTUDF DPADDRESS DPLINK DPOTHERINFO DPOTHERINFOUDF DPPAYMENTMETHOD Version 4 1 September 11 2014 Comments Contains donor information User Defined Fields associated with the DP table Checkbox field values Contains gift information User Defined Fields associated with the DPGIFT table Allows storages of additional addresses for donors in DPO Address tab Associated with values seen in the DPO Link tab Associated with values seen in the DPO Other Info tab User Defined fields added to the DPO Other Info tab Contains payment information associated with EFT Transactions for systems where this feature has been enabled Two examples of the data returned from this table are shown in the section on the dp_paymentMethodInsert command Page 14 DonorPerfect Online XML API User Manual 4 Predefined Procedures dp_donorsearch Searching for a Donor used to search for the donor based on a number of search criteria similar to the search functionality offered in DPO Use for wildcards Parameters Parameter Type Notes donor_id numeric last_name NVarchar 100 first_name NVarchar 50 opt_line NVarchar 100 address NVarchar 100 city NVarchar 50 state NVarchar 20 zip NVarchar 50 country NVarchar 50 filter_id nume
16. als to DonorPerfect Online DPO Either connection method will work but the new API Key method has the benefit of enhanced security through the use of long over 100 characters and very strong key values 1 Using a username and corresponding password value from a user created within the DPO user interface Settings gt User Security 2 Using an API Key value provided by DonorPerfect Username Password amp login This is the traditional method for supplying connection credentials A sample HTTPS request is analyzed below This particular one returns all the gifts that are in the DPO system for a donor with id 1269525 https www donorperfect net prod xmlrequest asp action dp _ gifts amp params 1269525 amp login xxx amp pass yyy Note that the login credentials can be supplied either at the beginning i e after https www donorperfect net prod xmlrequest asp or the end of the command This second example shows the amp login credentials at the beginning of the command specific part of the string https www donorperfect net prod xmlrequest asp login xxx4 pass yyy amp action dp gifts amp params 1269525 API Key amp apikey This connection method has the benefit of providing enhanced security through the use of very strong passwords of over one hundred characters in length A sample HTTPS request is analyzed below This particular one returns all the gifts that are in the DPO system for a donor with id 126952
17. archar 3 Sample Call https www donorperfect net prod xmlrequest asp action dp _ paymentmethod_insert amp params 0 147 1 Visa creditcard 4x XXXXXXXX1234 0412 null Oriana null null null null null USD Version 4 1 September 11 2014 amp login xxx amp pass yyy Page 31 DonorPerfect Online XML API User Manual Returns lt result gt lt record gt lt field name DpPaymentMethodID id DpPaymentMethodID value 2 gt lt record gt lt result gt Notes e This table would normally only be populated from an ecommerce API where the DPO system has EFT Transactions enabled Here are two samples of XML data retrieved from a Dynamic SELECT Query on the DpPaymentMethod table from a system with EFT Transactions enabled Sample Check Item lt record gt lt field name DpPaymentMethodID id DpPaymentMethodID value 402 gt lt field name donor id id donor_id value 123456 gt lt field name IsDefault id IsDefault value True gt lt field name AccountType id AccountType value Bank Account gt lt field name dpPaymentMethodTypeID id dpPaymentMethodTypeID value check gt lt field name CardNumberLastFour id CardNumberLastFour value gt lt field name CardExpirationDate id CardExpirationDate value gt lt field name BankAccountNumberLastFour id BankAccountNumberLastFour value 7xxxx6543 gt lt field name
18. aving a Gift saves all aspects of a gift or pledge transaction including Date Start Date Amount Gift Type General Ledger Solicitation Thank You Letter Type Memo Comments etc e Saving a Gifts extended information User Defined Fields unlimited ability to save any field at the Gift Pledge level e Listing Gifts for a selected Donor Constituent retrieves Gift or Pledge Transactions for the selected Donor The list of these functions is constantly expanding as clients request more commonly used functions exposed to the API It is also possible to have a custom call designed for your organization and it has to be arranged through your Account Manager How do I use the DPO API The DPO API can be accessed via HTTPS Hyper Text Transfer Protocol Secure requests made to a specific page located on the secure DPO web server Anyone who has familiarity with XML and has possibly used an outside credit card processor which requires an HTTPS request should be comfortable with using the DPO API XML is a structured data set that is sent from our DPO system to your application website etc that is then translated to a meaningful form whether for the web user to view or to be stored by your application database file email etc Some calls are used exclusively to save information in DPO such as gift pledge or event information Version 4 1 September 11 2014 Page 7 DonorPerfect Online XML API User Manual API Example Call
19. d name donor_id id donor_id value 1269525 gt lt record gt lt record gt lt field name gift_date2 id gift_date2 value 09 28 2005 gt lt field name amount id amount value 5000 gt lt field name total id total value 0 gt lt field name sub_solicit_code id sub_solicit_code value gt lt field name campaign id campaign value KA0905 gt lt field name balance id balance value 0 gt lt field name gl id gl value gt lt field name solicit_code id solicit_code value 0223AF gt lt field name reference id reference value 56724 gt lt field name record_type id record_type value G gt lt field name gift_id id gift_id value 384382 gt lt field name donor_id id donor_id value 1269525 gt lt record gt lt result gt Version 4 1 September 11 2014 Page 10 DonorPerfect Online XML API User Manual API Administration and Limitations Logging DonorPerfect Online logs all API requests for record keeping and administration purposes These logs are kept to help troubleshoot common problems as well as to identify fraudulent or suspicious activity Restrictions In addition the calls are limited to return a maximum amount of data so that overall application performance will not be affected Since some calls allow multiple transactions to be returned these calls are limited to 5000 transactions per call The limit is set as a default t
20. dp_saveotherinfo flag varchar 20 Use the code value associated with the flag For example the AL flag in this example had a description value of Alumni user_id varchar 20 Sample Call https www donorperfect net prod xmlrequest asp action dp _ saveflag xml amp params 135 AL xmluser amp login xxx amp pass yyy Returns lt result gt lt record gt lt field name id value 135 gt lt record gt lt result gt Notes e 135 is the donor id associated with the updated value e This example assumes that a user defined field called ALT PHONE already exists in your system e If the flag was already set the system returns an error like this Microsoft ODBC SQL Server Driver SQL Server Violation of PRIMARY KEY constraint PK_dpflags Cannot insert duplicate key in object e To view the flags set for a specified donor use this command format Version 4 1 September 11 2014 Page 26 DonorPerfect Online XML API User Manual https www donorperfect net prod xmlrequest asp action select from dpflags where donor id 135 amp login xxx amp pass yyy Version 4 1 September 11 2014 Page 27 DonorPerfect Online XML API User Manual dp_delflags xml This procedure removes deletes all flags for the specified donor Flags are shown on the main donor screen in DPO Parameters Parameter Type Notes donor_id numeric Specify the donor_id of
21. hough can be changed on an individual client basis depending on need and scheduling concerns Finally there is no limit to the number of consecutive calls to the server SmartAction triggers are not activated by any API actions e g donor gift additions or updates No Blocking The API is designed such that the API user is exempted from the DPO restriction on maximum number of concurrent users so API calls are never blocked regardless of the number of concurrent users connected to the DPO system Version 4 1 September 11 2014 Page 11 DonorPerfect Online XML API User Manual 3 Dynamic Queries SELECT Statements This query format is based on the ANSI SQL implementation of Structured Query Language SQL SQL is the universal language used to communicate with databases The dynamic query feature of the DPO API allows users to build API calls using SQL syntax Example DPO contains a table called DP which contains donor information including people s first and last names and their donor ID numbers The column names are DONOR ID FIRST NAME and LAST NAME The values are capitalized for clarity but the query does not expect capitalization An SQL query to retrieve DONOR_ID FIRST_NAME and LAST_NAME from the DP table for people with the last name Bacon would look like this Select donor id first name last name from dp where last_name bacon This SQL gets placed into an XML API call and looks like this htt
22. integrate DonorPerfect Online with your existing web environment You can for example access donor and gift information on secure login protected portions of your intranet The API proves secure connections to the DPO database allowing read and write access in real time Common uses of the API allow developers to create content rich applications for web sites to display donor and gift information For example a religious organization may choose to display a list of church contact records from the DonorPerfect Online database on their website Then when the contact records are updated in the DonorPerfect Online database the website will automatically display the updated records Extending the same scenario the API could also be configured to allow users to update the contact records from their website Another example of the use of the API is the updating of DPO contact information by the ConstantContact application When ConstantContact sends out an email the DPO donor contact record is updated with the email title status and date information This particular API interaction is set up automatically when you purchase the ConstantContact add on feature in DPO For more information please contact your Account Manager at 800 220 8111 Intended Audience This document is written for customers who currently have an existing DonorPerfect Online license or for those developers that wish to integrate their third party applications with
23. is used to create or save changes to a pledge It is not used for pledge payments In DPO there is a parent pledge which this command is used to create that shows up in the DPO pledges tab Then when pledge payments are made they are created as gifts record_type G using the dp_savegift procedure with a gift_type of G like a regular gift but add in a plink value with the gift_id of the parent pledge Parameters Parameter Type Notes gift_id numeric Enter 0 in this field to create a new pledge or the gift ID of an existing pledge donor_id numeric Enter the donor_id of the person for whom the pledge is being created updated gift_date datetime start_date datetime total money Enter either the total amount to be pledged the sum of all the expected payment amounts or enter 0 zero if the pledge amount is to be collected ad infinitum bill money Enter the individual monthly quarterly annual billing amount frequency NVarchar 30 Enter one of M monthly Q quarterly S semi annually A annually reminder NVarchar 1 Sets the pledge reminder flag gl_code NVarchar 30 solicit_code NVarchar 30 initial_payment NVarchar 1 Set to Y for intial payment otherwise N sub_solicit_code NVarchar 30 vwriteoff_amount money writeoff_date datetime user_id NNVarchar 20 campaign NVarchar 30 Or NULL membership_type NVarchar 30
24. lank by entering null in this field to allow the DPO User to whom the activity was assigned to mark the item as completed when they performed the required activity e g https www donorperfect net prod xmlrequest asp action dp_sav econtact params 0 135 TE BWO2 ELF 09 13 2012 09 18 2012 12 24 00 PM null Your comment on this contact item http api markwarren ca API User amp login xxx amp pass yyy Version 4 1 September 11 2014 Page 30 DonorPerfect Online XML API User Manual dp_PaymentMethod_Insert This procedure allows insertion of DPO Payment Method values This table is used on systems with the EFT Transactions feature enabled This procedure will save a single parameter for a specified User Defined Field UDF Parameters Parameter Type Notes CustomerVaultiD NVarchar 55 Enter 0 to create a new Customer Vault ID record donor_id int lsDefault bit Bit Enter 1 if this is will be the default EFT payment method AccountType NVarchar 256 e g Visa dpPaymentMethodTypelD NVarchar 20 e g creditcard CardNumberLastFour NVarchar 16 e g 4xxxxxxxxxxx1111 CardExpirationDate NVarchar 10 e g 0810 BankAccountNumberLastFour NVarchar 50 NameOnAccount NVarchar 256 CreatedDate datetime ModifiedDate datetime import_id int created_by NVarchar 20 modified_by NVarchar 20 selected_currency NV
25. meric Enter 0 to create a new record or the other_id record number of an existing dpotherinfo record donor_id numeric Enter the donor_id for whom the record is to be created updated other_date Date_time Format as date mVdVY time comments NVarchar 500 user_id NVarchar 20 Sample Call https www donorperfect net prod xmlrequest asp action dp _ saveotherinfo params 0 147 11 18 2010 my comment API User amp login xxx amp pass yyy Returns lt result gt lt record gt lt field name id value 160 gt lt record gt lt result gt Notes s 160 is the other_id associated with the updated value e This other_id value can now be used as a matching_id value to save additional fields associated with the dpotherinfoudf table associated with this entry Version 4 1 September 11 2014 Page 24 DonorPerfect Online XML API User Manual dp_save_udf_xml This procedure saves a Donor s extended information User Defined Fields used to save changes to the user defined fields that are custom for each client and are not part of the standard DPO system This procedure will save a single parameter for a specified User Defined Field UDF Parameters Parameter Type Notes matching_id numeric Specify either a donor_id value if updating a donor record a gift_id value if updating a gift record or an other_id value if updating a dpotherinfo table val
26. ps www donorperfect net prod xmlrequest asp action Select donor id first name last name from dp where last_name bacon amp login xxx amp pass yyy If there is a donor in your system named Kevin Bacon and the above command was submitted through a web browser with the appropriate username and password the raw unprocessed XML result will look like this lt result gt lt record gt lt field name donor_id id donor_id value 68 gt lt field name first_ name id first_name value Kevin gt lt field name last_name id last_name value Bacon gt lt record gt lt result gt 2 ANSI is the American National Standards Institute MSSQL uses ANSI SQL Version 4 1 September 11 2014 Page 12 DonorPerfect Online XML API User Manual To retrieve all fields from the DP table you would use the asterisk wildcard instead of field names NOTE This can be a good way to identify all the field names in a table BUT make sure you limit the result set by specifying a particular donor_id or gift_id as appropriate Otherwise your system will be burdened with a query retrieving thousands of data values The query to retrieve all DP table field data for Kevin donor_id 68 would look like this https www donorperfect net prod xmlrequest asp action Select from dp where donor id 68 amp login xxx amp pass yyy Version 4 1 September 11 2014 Page 13 DonorPerfect Online XML API User Manual DPO T
27. ric user_id NVarchar 20 Sample Call https www donorperfect net prod xmlrequest asp action dp _ donorsearch amp params null Pa Ori null null null null null null null null amp login xxx amp pass yyy Returns lt result gt lt record gt lt field name donor id id donor id value 147 gt lt field name first name id first name value Orianthi gt lt field name last name id last name value Panagaris gt lt field name title id title value gt lt field name suffix id suffix value gt lt field name address id address value 4240 Main St gt lt field name opt line id opt line value gt Version 4 1 September 11 2014 Page 15 DonorPerfect Online XML API User Manual lt field name city id city value North Woodstock gt lt field name state id state value NH gt lt field name zip id zip value 12345 gt lt field name gifts id gifts value 0 gt lt field name gift total id gift total value 0 gt lt field name address2 id address2 value gt lt field name donor name id donor name value Orianthi Panagaris gt lt field name city state zip id city state zip value North Woodstock NH 12345 gt lt record gt lt result gt Notes e f you require different fields to be returned if you need the city state zip or donor_name fields to appear as separate fields then use a Dynamic Query SELECT
28. sion of the DPO API by SofterWare includes e The DPO API toolkit commands e The DPO API documentation e API support as described above API Support does not include assistance or consulting services on applications developed by the client organization or an authorized third party integrator These remain the sole responsibility of the client organization As a result additional chargeable services not covered above include e Creating Reviewing or Testing API calls on behalf of the client e Debugging API Code created by the client or the client s authorized third party e Creating or editing website code to utilize the DPO API e Creating or editing any API documentation Depending on the availability of SofterWare development staff and on the evaluation of any such proposed contract project offers SofterWare may provide these types of Version 4 1 September 11 2014 Page 34 DonorPerfect Online XML API User Manual services to a client by prior agreement with the client Any such services would be based on a rate of 100 hour Please contact your Account Manager for any additional questions regarding our support for the DPO API Version 4 1 September 11 2014 Page 35
29. the donor for whom the flags all of them are to be deleted user_id varchar 20 Sample Call https www donorperfect net prod xmlrequest asp action dp _ delflags_xml params 135 xmluser login xxx amp pass yyy Returns lt result gt lt record gt lt field name id value 135 gt lt record gt lt result gt Notes 135 is the donor_id associated with the deleted flags It is not currently possible to delete individual flags for a specified donor This command deletes all flags set for the specified donor_id To view the flags set for a specified donor use this command format https www donorperfect net prod xmlrequest asp action select from dpflags where donor id 135 amp login xxx amp pass yyy Version 4 1 September 11 2014 Page 28 DonorPerfect Online XML API User Manual dp_savecontact This procedure saves fields to the DPCONTACT table It will create a new or updated Contact record for the specified donor_id Parameters Parameter Type Notes contact_id numeric Enter 0 to create a new record or the other_id record number of an existing dpcontact record donor_id Numeric Enter the Donor ID of the donor for whom the contact record is to be created or retrieved activity_code NVarchar CODE value for the Activity Code field See DPO Settings gt Code 30 Maintenance gt Activity Code Contact Screen
30. ue see dp_saveotherinfo field_name NVarchar 20 data_type NVarchar 1 C Character D Date N Numeric char_value NVarchar 2000 Null if not a Character field date_value datetime Null if not a Date field number_value numeric 18 4 Null if not a Number field user_id NVarchar 20 Sample Call https www donorperfect net prod xmlrequest asp action dp _ save udf xml params 16013 ALT PHONE C 555 1212 null null API User Returns lt result gt lt record gt lt field name lt record gt lt result gt Notes id amp login xxx amp pass yyy value 16013 gt e 16013 is the donor_id associated with the updated value e This example assumes that a user defined field called ALT PHONE already exists in your system Version 4 1 September 11 2014 Page 25 DonorPerfect Online XML API User Manual dp_saveflag_xml This procedure allows you to set flags as shown in the top section of the Main tab The Flags field is on the Main tab in the DPO user interface Flags must have been previously created in Settings gt Code Maintenance and the value you set corresponds to the Code value not the description value Parameters Parameter Type Notes donor_id numeric Specify either a donor_id value if updating a donor record a gift_id value if updating a gift record or an other_id value if updating a dpotherinfo table value see
Download Pdf Manuals
Related Search