# API Reference The Portfolio+ API is REST -oriented. Our API uses OAuth2 for authentication, and returns responses in JSON using standard HTTP response codes. Requests to the Portfolio+ API are performed using the cURL command line tool. # Path Parameters When utilizing endpoints that contain string Path Parameters, please ensure that any special characters that are used are correctly defined according to standard markdown. # Input Sanitization The Portfolio+ API does not perform any input sanitization. It is the responsibility of the API consumer to properly sanitize any information before use, if required. # Pagination Portfolio+ utilizes cursor-based pagination via the `page_start_id` and `size` parameters. Both parameters take an existing object ID value and return objects in reverse chronological order. Portfolio+ utilizes offset-based pagination via the `page_offset` and `size` parameters. The `page_method` parameter determines what pagination method to be utilized on the backend. The `page_start_id` parameter fetches data at the specified `rowid`. The size parameter sets the maximum number of data rows to return in the response to the request. If the size parameter is not entered, paging will not be applied. The `page_offset` parameter fetches data at the specified `row`. The size parameter sets the maximum number of data rows to return in the response to the request. If the size parameter is not entered, paging will not be applied. ## Parameters - ### page_method
*optional, string* - To determine whether rowid-based pagination or offset-based pagination will be utilized. If page_method is not entered, rowid-based pagination will be utilized. - ### page_start_id
*optional, string* - The row ID at which to start fetching data. - To retrieve the next page of records or data, populate `page_start_id` with the `next_start_id` from the previous page response. - To start from the first available record of the result, leave the `page_start_id` parameter empty. If `page_start_id` is included, and size is not, a system default number of records will be returned. - Valid entries can be integers for index based data sources, or hexadecimal values for OpenEdge database based data sources. - ### page_offset
*optional, integer* - The zero-based index value of the first record to return from a collection. A value of zero specifies the index of the first record in the collection. Values greater than zero specify a record index in the collection equal to page_offset + 1. - ### size
*optional, integer* - Maximum page size, starting from the row specified by the `page_start_id` parameter. Corresponds to the maximum number of data rows to return in the response to this request. - If `size` is included but not `row`, records will be returned starting at the first row that satisfies any API parameters provided. If the size parameter is not entered, paging will not be applied. ## Error Cases - ### page_method - Must be either `Rowid` or `Offset` if it is entered. - ### page_start_id - Must be a valid OpenEdge `rowid`, if applicable. - If index based, must be greater than or equal to 1 (Collections are indexed from 1). - Must correspond to a real database record, fetched by the called API. - ### page_offset - Must be greater than or equal to 0. - ### size - Must be an integer greater than 0. ## List Response Format - ### page_info
*object* The response will only include `page_info` if the endpoint supports pagination. - #### size Indicates the size of the page that has been returned. - #### next_url Relative link to an API call that can be used to retrieve the next page of data. - #### next_page_start_id ID indicating the start of the next page. Value is embedded in `next_url`, but can also be parsed as a standalone. - #### next_page_offset The number of records to skip in the next page. This value must be included in the page_offset query parameter in the next request and is included in the next_url property as a convenience. This value is not included in the last page returned. - ### data
*array/object* The response's data element containing the data that currently makes up the entire response body. Results are only paged when contents are an array. # Important Information ## Enums and case-sensitive Values Clients can configure their tables to meet their own best practices; examples and case-sensitive values can differ. ## Field Formatting Standardization All Amount and Balance field values are formatted as decimals. ## A note on data availability Some data in the following specification is only available for use through OBP and may not be available for some Portfolio+ installation instances. ## Deprecated Features - A deprecated endpoint appears dimmed and remains functional until it is removed. - A deprecated parameter is labelled as "deprecated" and remains functional until it is removed. - A deprecated request or response field appears dimmed and is struck through in the schema; is removed from the example; and remains functional until it is removed.