GetFacilityConfig

Get Facility Configuration

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

Overview

A RESTful query made to the Tenant service to obtain the full configuration of a specific facility, including its reporting schedule and time zone.

flowchart LR
nGetFacilityConfig_32C58A79["Query: Get Facility Configuration"]
  nTenantService_F25B55["Service: TenantService"] -->|provides| nGetFacilityConfig_32C58A79
  nReportService_1ECFD801["Service: ReportService"] -->|provides| nGetFacilityConfig_32C58A79
  nAdminBFF_4D4F63E2["Service: AdminBFF"] -->|provides| nGetFacilityConfig_32C58A79
  nDataAcquisitionService_3BF82DDB["Service: DataAcquisitionService"] -->|provides| nGetFacilityConfig_32C58A79
  nTenantService_F25B55["Service: TenantService"] -->|requests| nGetFacilityConfig_32C58A79
  subgraph nDataAccess_2A523756_domain["Domain: Data Access"]
    nDataAcquisitionService_3BF82DDB
  end
  subgraph nReport_4D4FBBDA_domain["Domain: Report"]
    nReportService_1ECFD801
  end
  subgraph nTenant_379CD514_domain["Domain: Tenant"]
    nGetFacilityConfig_32C58A79
    nTenantService_F25B55
  end

REST API Details

  • Method: GET
  • Path: /api/Facility/{facilityId}

Request

Name Type Description
facilityId string The unique identifier of the facility.

Response

Returns a FacilityConfig object.

(SchemaViewer tag used improperly, or no schema specified)

Relationships

flowchart LR
nGetFacilityConfig_32C58A79["Query: Get Facility Configuration"]
  nTenantService_F25B55["Service: TenantService"] -->|provides| nGetFacilityConfig_32C58A79
  nReportService_1ECFD801["Service: ReportService"] -->|provides| nGetFacilityConfig_32C58A79
  nAdminBFF_4D4F63E2["Service: AdminBFF"] -->|provides| nGetFacilityConfig_32C58A79
  nDataAcquisitionService_3BF82DDB["Service: DataAcquisitionService"] -->|provides| nGetFacilityConfig_32C58A79
  nTenantService_F25B55["Service: TenantService"] -->|requests| nGetFacilityConfig_32C58A79
  subgraph nDataAccess_2A523756_domain["Domain: Data Access"]
    nDataAcquisitionService_3BF82DDB
  end
  subgraph nReport_4D4FBBDA_domain["Domain: Report"]
    nReportService_1ECFD801
  end
  subgraph nTenant_379CD514_domain["Domain: Tenant"]
    nGetFacilityConfig_32C58A79
    nTenantService_F25B55
  end