Home → 360 → Aristotle 360 API → Getting Started with the Aristotle 360 API
93.2. Getting Started with the Aristotle 360 API
Introduction
The Aristotle 360 API enables you to configure your website, 3rd Party application, and other external resources to communicate with your Aristotle 360 dataset. The Aristotle 360 API (version 2.0) is comprised of 11 core web-services associated with the core 360 entity types, each with various operations available for your usage. You may access each web-service URL interactively through a web-browser for additional documentation on each of the operations which include expected XML formats, sample responses, and namespace specifications.
Getting Started
In order to start working with the Aristotle 360 API, your Aristotle 360 dataset must first be enabled for API usage. Please contact Aristotle Support for more information on how you can get your dataset enabled the API. Once fully enabled, you will first need to grant API access to a system user in your dataset.
Aristotle 360 API User Configuration
From within your Aristotle 360 interface, you enable API access to a system user by browsing to SETTINGS and selecting "User Permissions". From there, you will see your user access groups. Select the user access group of your choosing to open the Access Area configuration screen. Of the various access areas, you should see an access area labeled "360 API". Enable each of the options for that access area (View, Edit, Add, Delete) to fully enable API access for the users in this permission group.
API Web-service Calls
Now that a user is enabled for API access, you can begin to make calls to each of the API web-services detailed in the "Entity Web-services" section of this document. With each web-service call, you must provide the username and password associated with this account.
Entity Web-services
Below are listings of the web-services available for each of the core entity types in Aristotle 360.
Individuals
- getDetail
- getFECTransaction
- getIndividualDetailByGroup
- getList
- getVoterList
- listVoter
- searchKeyword
- setDetail
Organizations
- getCompanyByList
- getDetail
- getFECTransaction
- getList
- searchKeyword
- setDetail
Committees
- getDetail
- getFECTransaction
- getList
- getPoliticalCommitteeByList
- listFilingCommittee
- searchKeyword
- setDetail
Legislators/Candidates
- getDetail
- getLegislativeCommitteeByLegislator
- getLegislativeOffice
- getLegislativeOfficeStaffByLegislator
- getLegislatorDisbursement
- getLegislatorGroup
- getLegislatorNote
- getLegislatorReceipt
- getList
- getPoliticalCommittee
- searchKeyword
- setDetail
Financial Transactions (Receipts/Disbursements)
- getDisbursementDetail
- getList
- getNoteDetail
- getReceiptDetail
- setDisbursementDetail
- setReceiptDetail
Events
- getDetail
- getEventListByCriteria
- getList
This page was: Helpful |
Not Helpful