SearchResponse Data Type

Pagination and sorting criteria plus total record count.

Abstract Type
Subtypes
RecurringChargeTemplateResponseDto, RatedTransactionListResponseDto, CustomEntityTemplatesResponseDto, ContractListResponsDto, GetDiscountPlansResponseDto, TradingCountriesResponseDto, FileFormatListResponseDto, InvoicingPlanItemsResponseDto, GetListCommercialOrderDtoResponse, ReportExtractsResponseDto, CounterTemplatesResponseDto, TaxMappingListResponseDto, PaymentHistoriesDto, TaxClassListResponseDto, GetListBundleTemplateResponseDto, CustomersResponseDto, GetOccTemplatesResponseDto, CustomTableDataResponseDto, CpqQuotesListResponseDto, OfferTemplateCategoriesResponseDto, GetCountriesIsoResponse, PricePlanMatrixesResponseDto, UserHierarchyLevelsDto, PaymentScheduleInstancesDto, GetTaxesResponse, GetListPricePlanMatrixVersionResponseDto, SubscriptionsListResponseDto, ProductChargeTemplatesResponseDto, InvoiceSubCategoryResponseDto, DunningDocumentsListResponseDto, GetListProductVersionsResponseDto, AccountOperationsResponseDto, PaymentScheduleTemplatesDto, DiscountPlanItemsResponseDto, GetListOrderTypeResponseDto, GetInvoiceTypesResponse, GetListProductsResponseDto, GetListServiceTemplateResponseDto, BillingAccountsResponseDto, AccessesResponseDto, OneShotChargeTemplateResponseDto, GetListAccountingArticlePricesResponseDto, InvoicingPlansResponseDto, MediaListResponsDto, GetListProductTemplateResponseDto, PaymentMethodTokensDto, SellerResponseDto, InvoiceCategoryResponseDto, GetListCpqOfferResponseDto, JobInstanceListResponseDto, MeveoInstancesResponseDto, AccountingCodeListResponseDto, TradingLanguagesResponseDto, GetLanguagesIsoResponse, UserAccountsResponseDto, CustomEntityInstancesResponseDto, UsageChargeTemplateResponseDto, TaxCategoryListResponseDto, CreditCategoriesResponseDto, InvoicesDto, PaymentScheduleInstanceItemsDto, CustomerAccountsResponseDto, JobExecutionResultsResponseDto, TriggeredEdrsResponseDto, GetListCommercialRulesResponseDto, GenericSearchResponse, GetListServiceResponseDto, TradingCurrenciesResponseDto, GetListOfferTemplateResponseDto, ContactsResponseDto, GetCurrenciesIsoResponse, ListCalendarResponse, DDRequestBuilderResponseDto, GetListQuoteProductOfferingPriceResponse, UsersDto, ChartsResponseDto, GetListUnitOfMeasureResponseDto, TitlesResponseDto, ReportExtractExecutionResultsResponseDto, EmailTemplatesResponseDto, QueryResponse, BillingCyclesResponseDto, FindWalletOperationsResponseDto, MeveoModuleDtosResponse, ProvidersDto, PaymentGatewayResponseDto, RolesDto, CustomerPaymentsResponse
Implemented Interfaces
Serializable
Properties
name data type description
actionStatus ActionStatus Gets the action status.
paging PagingAndFiltering Gets the paging.

Example

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
{
  "actionStatus" : {
    "status" : "FAIL",
    "errorCode" : { },
    "message" : "...",
    "entityId" : 12345,
    "entityCode" : "...",
    "nrAffected" : 12345,
    "json" : "..."
  },
  "paging" : {
    "fullTextFilter" : "...",
    "filters" : {
      "property1" : { },
      "property2" : { }
    },
    "fields" : "...",
    "offset" : 12345,
    "limit" : 12345,
    "sortBy" : "...",
    "sortOrder" : "ASCENDING",
    "multiSortOrder" : "...",
    "totalNumberOfRecords" : 12345,
    "loadReferenceDepth" : 12345
  }
}