QBO3 API Documentation - quandis/qbo3-Documentation GitHub Wiki
Overview
This document contains technical documentation for integration with Quandis Data Objects (QBO). It contains transmission protocols, general usage, sample code and use cases to integrate with QBO.
Security
The primary security model utilized by QBO is BASIC Authentication using HTTPS. QBO uses RESTful API where each table in the QBO database has a matching URL endpoint that can be utilized. Example of URL endpoint:
- Contact records can be referenced via /Contact/Contact.ashx
- ContactMethod records can be referenced via Contact/ContactMethod.ashx
- Message records can be referenced via /Message/Message.ashx
- Attachment records can be referenced via /Attachment/Attachment.ashx
General pattern: /{Module}/{Table}.ashx
Endpoint
Each endpoint supports the following basic operations:
| Operation | Description |
|---|---|
| Home | |
| Dashboard | |
| Search | Search table for key values |
| Summary | Return table row and all data from all related tables |
| Select | Return table row data |
| Save | Insert or Update table data |
Modules
Contact
| Operation | Endpoint | Response Type |
|---|---|---|
| Home | /Contact/Contact.ashx/Home | |
| Dashboard | /Contact/Contact.ashx/Dashboard | Json |
| Search | /Contact/Contact.ashx/Search | Json, Xml, Csv |
| Summary | /Contact/Contact.ashx/Summary | Json, Xml |
| Select | /Contact/Contact.ashx/Select | Json, Xml |
| Save | /Contact/Contact.ashx/Save | Json, Xml |