Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AccountsController

label

DISCOVERY

description

The accounts controller of the app. Handles requests about accounts that are available in the database.

This controller defines the following routes:

URI HTTP method Class method Description
/accounts GET find Responds with a pageable PaginatedResultDTO that contains AccountDTO objects.


since

v0.1.0

Hierarchy

  • AccountsController

Index

Constructors

Methods

Constructors

constructor

Methods

find

  • Handler of the /accounts endpoint. Returns all account that match the request query. If the query is null or not specified returns all documents.

    The result of this endpoint can be paginated using query parameters: pageSize, pageNumber. Also, it can be sorted with query parameters: sort, order.

    async
    access

    public

    method

    GET

    Parameters

    Returns Promise<PaginatedResultDTO<AccountDTO>>

Generated using TypeDoc