V1 Create Cursor

Create a cursor to paginate large data sets.

Usage Notes

  • The cursor expires after 5 minutes of inactivity. However, with continuous use, you can keep the cursor alive up to a maximum of 12 hours.
  • A maximum of 10 cursors are allowed. Creation of the 11th cursor will result in the removal of the oldest cursor that is marked for expiration.
  • The limit query parameter may be overridden by the server. The server will calculate the optimal limit depending upon the requested number of loans and fields.
  • The cursorType is randomAccess which allows you to randomly assign a start position to start the pagination to retrieve data for the specified cursor.
  • When specifying a cursorType, the request can only include a filter attribute.
  • The x-total-count is a response header attribute that indicates the total number of loans matching your filter criteria.
  • The x-cursor is a response header attribute that represents the name of the cursor.
  • This API requires Encompass 17.3 or greater.
Query Params
string

cursorType is randomAccess. Required only for pagination.

integer
Defaults to 0

Zero-based starting index. The default is zero.

integer

The maximum number of items to return in a page. Refer to the Usage Notes in this endpoint page.

Body Params

The following attributes make up the V1LoanPipelineViewContract object.

loanGuids
array of strings

List of loan IDs. Required if the "filter" attribute is not specified.

loanGuids
filter
array of objects

Criteria to filter loans as described by the V1QueryCriterionContract.

filter
fields
array of strings

List of fields to return.

fields
sortOrder
array of objects

List of fields with more details like sort order as described by the V1LoanPipelineSortContract.

sortOrder
Headers
string
required

Bearer token

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language
URL
LoadingLoading…
Response
Choose an example:
application/json