Jump to: GET Response Notes | API Call Builder
Find Offer Files which are available to the requesting user. Relies upon Request Interface to determine which Offer Files the requester is allowed to access.
= Required Parameter
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NetworkId | Url | Network ID | ||||||||||||||||||||||||||||||||||||||||
NetworkToken | String | Network token | ||||||||||||||||||||||||||||||||||||||||
Target | String | This calls action target | ||||||||||||||||||||||||||||||||||||||||
Method | String | This calls action method | ||||||||||||||||||||||||||||||||||||||||
filters | Filter | Array of field values to filter results byShow Filterable Fields The following fields from the model can be filtered on.
| ||||||||||||||||||||||||||||||||||||||||
sort | Sort | Array of fields and directions to sort results byShow Sortable Fields The following fields from the model can be sorted in either ascending (ASC) or descending (DESC) order.
| ||||||||||||||||||||||||||||||||||||||||
limit | Integer | Objects per page to return; defaults to returning all found | ||||||||||||||||||||||||||||||||||||||||
page | Integer | Result page to return, based on limit value; defaults to 1 | ||||||||||||||||||||||||||||||||||||||||
fields | Array | List of fields to return; defaults to all fieldsShow Supported Values Any of the following values from the OfferFile model are supported.
| ||||||||||||||||||||||||||||||||||||||||
contain | Contain | List of related objects to return with each resultShow Supported Values Any of the following supported values can be passed.
|
GET Response Notes
List of Offer File model objects.
Return response will be in the following format: array.
API Call Builder
Javascript is required to use the API Call Builder.