CamAcct API

The FirstService Residential CamAcct API provides access to read and write functionality for the CamAcct data: Table data includes entities, buildings, units, residents, vendors, checks, invoices, receipts and more. The CamAcct API identifies users through a propietary authentication application. All responses are returned in JSON.

Overview

Read below for a detailed explanation on how to implement certain capabilities of the CamAcct API.

Pagination

For resources that return an undetermined amount of records, the ability to use paging has been implemented. Any resource with a {page} and {pageSize} parameter can implement paging.

  • The {pageSize} determines the amount of records to pull for a given page.
  • The {page} parameter determines which particular subset records to retrieve given the {pageSize}.
  • If {page} or {pageSize} is 0, all records will be returned.
[Not Yet Implemented]


Sorting

Any resource with a sort parameter can implement sorting. Each route allows specific sorting options wich are explained in details in the route's help.

  • The sort parameter take a list of comma separated fields, each with a possible unary negative to imply descending sort order.
  • Unary positive is the default sort direction used, which implies ascending order.
  • Each route that allows sorting defaults to some order which is specified in the route's help.
[Not Yet Implemented]


File Download

[Not Yet Implemented]


File Upload

[Not Yet Implemented]