API - Further Information

String Encoding, Paged data sets

String Encoding

String values received and sent via the API are not HTML encoded - HTML tags will be stored and provided in their raw format.

Developers may need to format and encode values received from the API to ensure they are appropriate to meet their use-case.

Paged Data Sets

The Contracts, Contract User Defined Fields, Counterparties, Contacts and Users result sets support paging.

When querying contracts, we recommend a maximum page size of 100-200 contracts.

The maximum page size of paged data sets (Contracts, Contract User Defined Fields, Counterparties, Contacts and Users) may be set by Contract Eagle to manage performance and this maximum may be less than the requested page size. Developers should check the response to see if there are further pages in these data sets.

Paged data sets will include properties

TotalCount - the total number of records matching the filter criteria.
HasNextPage - a boolean value indicating whether there is a next page
EndCursor - a string value uniquely identifying the last record in the current data set

To retrieve the next page of data, repeat the request, setting the StartAfterCursor property in the request to the EndCursor property of the last data set returned.

Examples using paged data sets are included in the example "Console Application - Documents Download" and "Web Application" - refer to the API Library and Example Apps page

Restricted Security Access

The API applies similar security restrictions to the Web Application. In some situations, this may result in missing or defaulted values in the information returned from the API.

For example: A user that has contract read/write access to the "Human Resources" business unit in the Web Application can view and maintain the contract values stored for any User Defined Field appearing on that contract, regardless of the business unit the User Defined Field is associated with. When querying the API, the User Defined Field details included with contract information only include the Id and Name of the User Defined Field (the data type in this instance is defaulted to "TEXT")