Transactions

Search for Transactions

NOTE: This resource has been deprecated in favor of using OData with the /wolfconnect/transactions/v1 resource. See Retrieve a Collection of Transactions for more information.

This retrieves all of the transactions that meet the search criteria. The SearchRequest object's Criteria property should contain an instance of a TransactionSearchCriteria object.

You will only be able to filter search criteria on fields to which you have read access. For example, if you don't have read access to see the close date of a transaction and you set the close date range in the TransactionSearchCriteria object that range will be ignored.

The search could take longer to complete if the TransactionSearchCriteria.FullDetail flag is set to true as it has to completely populate the information in the Transaction object. If the flag is set to false, only a subset of the transaction data containing commonly used data is returned.

The SearchResult object's ResultSet property will contain a list of Transaction objects.

post/wolfconnect/transactions/v1/search

Request

  • Base URL: https://api.globalwolfweb.com
  • URL: https://api.globalwolfweb.com/wolfconnect/transactions/v1/search
  • Auth: API key in header Authorization

Request body

PageSizeinteger

The number of objects to return per page in the response. The maximum value for PageSize is currently 1000. If you pass 0 in for this parameter, the maximum PageSize value will be used. NOTE: The PageSize returned in the SearchResponse object is not guaranteed to be equal to this value even if it is less than or equal to the max page size. Please use the PageSize value in the SearchResponse object when processing the response. Paging is currently not implemented; therefore, the PageSize value has no bearing on the response.

Limitinteger

The maximum number of objects to return in the results. This value can go across pages. For instance, if you set PageSize to 10 and Limit to 25 and the search finds 50 records, the top 25 will be returned on 3 different pages.

Response

A SearchResult object.

Idstring

The Id of the search. This will be used when getting the next page of results for a previous search.

PageSizeinteger

The page size for the response. This can also be thought of as the number of objects that will be returned in the ResultSet collection if it requires a full page.

PageNumberinteger

The page number for the response.

TotalPagesinteger

The total number of pages in the search results.

TotalResultsinteger

The total number of results across all pages.

Changes

No recorded changes to this operation across all 1 revision of this API.