Shared Schemes
  • 01 Aug 2023
  • 1 Minute to read
  • Contributors

    Shared Schemes


      Article summary

      SearchQueryDto

      DTO for query of search options.

      PropertyData TypeDescription
      qStringSearch string or URL encoded JSON.
      qTypeStringType of search. One of:
      • full [default]
      • partial
      qOperatorStringApplicable only if qType equals 'partial'. One of:
      • and
      • or [default]

      SortQueryDto

      DTO for query of sort options.

      PropertyData TypeDescription
      sortStringMap of fields and sort order. Example:
       ?sort=[field1]=asc&sort[field2]=desc

      PaginatedList

      Object for a paginated list.

      PropertyData TypeDescription
      page*NumberPage number.
      totalPage*NumberNumber of pages in list.
      itemsTotal*NumberNumber of items in list.

      PaginationQueryDto

      DTO for query about pagination options.

      PropertyData TypeDescription
      pageIntegerPage to start from. Minimum 1.
      limitIntegerNumber of records per page. Maximum 100.

      qOperator

      Search operation only applicable if qType equals ‘partial’. Found in SearchQueryDto.

      ValueDescription
      andBoolean operator for all values required.
      orBoolean operator for at least one value is required [default].

      qType

      Type of search. Found in SearchQueryDto.

      ValueDescription
      fullFull search [default]
      partialPartial search. Partial search query can include qOperator.

      Was this article helpful?