GetFacilitiesList

Get Facilities List

Produced By: Tenant Service [service], Admin Backend-for-Frontend [service]
Consumed By: Tenant Service [service]

Overview

A RESTful query made to the Tenant service to retrieve a list of all facilities configured in the system.

flowchart LR
nGetFacilitiesList_48F17BCD["Query: Get Facilities List"]
  nTenantService_29AF3ECE["Service: TenantService"] -->|provides| nGetFacilitiesList_48F17BCD
  nAdminBFF_7A9CD338["Service: AdminBFF"] -->|provides| nGetFacilitiesList_48F17BCD
  nTenantService_29AF3ECE["Service: TenantService"] -->|requests| nGetFacilitiesList_48F17BCD
  subgraph nTenant_223E8F95_domain["Domain: Tenant"]
    nGetFacilitiesList_48F17BCD
    nTenantService_29AF3ECE
  end

REST API Details

  • Method: GET
  • Path: /api/Facility

Parameters

Name Type Description
pageNumber integer The page number to retrieve.
pageSize integer The number of records per page.

Response

Returns a paged list of facility configurations.

Relationships

flowchart LR
nGetFacilitiesList_48F17BCD["Query: Get Facilities List"]
  nTenantService_29AF3ECE["Service: TenantService"] -->|provides| nGetFacilitiesList_48F17BCD
  nAdminBFF_7A9CD338["Service: AdminBFF"] -->|provides| nGetFacilitiesList_48F17BCD
  nTenantService_29AF3ECE["Service: TenantService"] -->|requests| nGetFacilitiesList_48F17BCD
  subgraph nTenant_223E8F95_domain["Domain: Tenant"]
    nGetFacilitiesList_48F17BCD
    nTenantService_29AF3ECE
  end