Lookup for filters

Endpoint Parameters

• Request parameters

  Name	Type	Origin	Description
  AccountGroupKey	AccountGroupKey	Query-String	Account group to get the events for.
  AccountKey	AccountKey	Query-String	Account to get the events for.
  ClientKey	ClientKey	Query-String	Client to get the events for.
  FieldGroups	LookupFieldGroups	Query-String	Specify lookup fields required in response. If FieldGroups are not specified in request then response will only contain data from FieldGroups with relevant data.
  IncludeSubAccounts	Boolean	Query-String	Indicate whether to include events from sub-clients.

• Response Parameters

  View Response Codes

  Name	Type	Description
  __count	Number	The total count of items in the feed.
  __next	String	The link for the next page of items in the feed.
  Data	Lookup []	The collection of entities for this feed.
  MaxRows	Number	The maximum number of rows that can be returned (if applicable).

  HTTP Code	Description
  200	OK	Lookup data retrieved successfully.
  400	Bad Request	Error Code Description InvalidRequest Default error code returned when it cannot be determined which part of the request is malformed.
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  429	Too Many Requests	The request was rejected due to rate limit being exceeded.
  503	Service Unavailable	Service Unavailable.

  Close

• Request Example

  Request URL

  GET /ca/v2/events/lookupdata?AccountGroupKey=BxS0VWLta8lJ3SBpjGBQjw==&AccountKey=2y0tX0m9ZH7MH8HK38qM9g==&ClientKey=7m4I|vtYLUnEGg77o9uQhw==&FieldGroups=All&IncludeSubAccounts=False

• Response Example

  Response body

  {
    "Data": [
      {
        "FieldGroup": "EventTypes",
        "Values": [
          {
            "Code": "DVCA",
            "Name": "Cash Dividend"
          }
        ]
      },
      {
        "FieldGroup": "AssetTypes",
        "Values": [
          {
            "Code": "Stock",
            "Name": "Stock"
          }
        ]
      }
    ]
  }