Convio Open API Reference 2 | Convio Open API Reference | TOC Contents Overview of Convio Open APIs...........................................................................................7 Getting Started......................................................................................................................9 Configuring your Site for Convio Open APIs..........................................................................................9 User's Guide........................................................................................................................ 12 General API Information........................................................................................................................12 Servlets.......................................................................................................................................12 Common Parameters.................................................................................................................. 12 Using Redirect URLs................................................................................................................. 14 HTTP Status Codes.................................................................................................................... 15 XML Schema Definition............................................................................................................16 Error Codes................................................................................................................................ 16 Logging API Calls......................................................................................................................20 Client and Server APIs...........................................................................................................................20 Client versus Server APIs.......................................................................................................... 20 API Administrator Accounts for Server API Access................................................................. 21 IP White List Security................................................................................................................21 Server Authentication using Convio APIs................................................................................. 21 Cross-Domain Access............................................................................................................................ 22 Cross-domain Access................................................................................................................. 22 JavaScript/AJAX Programming.................................................................................................23 Adobe Flash Cross-domain Policy.............................................................................................24 Single Sign-On....................................................................................................................................... 25 Single Sign On (Convio as client)..............................................................................................25 Single Sign On (Convio as master)............................................................................................25 Authentication Tokens............................................................................................................... 26 API Reference......................................................................................................................28 Address Book API..................................................................................................................................28 addAddressBookContact............................................................................................................28 addAddressBookContacts.......................................................................................................... 29 addAddressBookGroup.............................................................................................................. 31 addContactsToGroup................................................................................................................. 32 addressBookImportOAuthCallback........................................................................................... 33 deleteAddressBookContacts.......................................................................................................34 deleteAddressBookGroups.........................................................................................................35 getAddressBookContacts........................................................................................................... 36 getAddressBookGroups............................................................................................................. 38 getAddressBookImportContacts................................................................................................ 39 getAddressBookImportJobStatus...............................................................................................41 importAddressBookContacts..................................................................................................... 42 parseCsvContacts....................................................................................................................... 44 removeContactFromGroup.........................................................................................................46 startOnlineAddressBookImport................................................................................................. 47 updateAddressBookContact....................................................................................................... 49 updateAddressBookGroup......................................................................................................... 50 Advocacy API........................................................................................................................................ 51 getAdvocacyAlert.......................................................................................................................52 getAdvocacyAlerts..................................................................................................................... 65 getAdvocacyInteractions............................................................................................................76 takeAction.................................................................................................................................. 88 Constituent API......................................................................................................................................99 Convio Open API Reference | TOC | 3 create.......................................................................................................................................... 99 createOrUpdate.........................................................................................................................103 getGroupMembers....................................................................................................................109 getInteraction............................................................................................................................111 getUser..................................................................................................................................... 113 getUserCenters......................................................................................................................... 115 getUserGroups..........................................................................................................................117 getUserInteractions...................................................................................................................119 getUserInterests........................................................................................................................124 getUserTransactions................................................................................................................. 126 isEmailValid.............................................................................................................................130 isUserInterested........................................................................................................................131 isUserNameAvailable...............................................................................................................133 listCenters.................................................................................................................................134 listInteractions.......................................................................................................................... 136 listInterests............................................................................................................................... 141 listUserFieldChoices................................................................................................................ 143 listUserFields............................................................................................................................144 logInteraction........................................................................................................................... 147 update......................................................................................................................................