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_3026B4B5["Query: Get Facility Configuration"]
  nTenantService_29AF3ECE["Service: TenantService"] -->|provides| nGetFacilityConfig_3026B4B5
  nReportService_7E534222["Service: ReportService"] -->|provides| nGetFacilityConfig_3026B4B5
  nAdminBFF_7A9CD338["Service: AdminBFF"] -->|provides| nGetFacilityConfig_3026B4B5
  nDataAcquisitionService_6CAFA860["Service: DataAcquisitionService"] -->|provides| nGetFacilityConfig_3026B4B5
  nTenantService_29AF3ECE["Service: TenantService"] -->|requests| nGetFacilityConfig_3026B4B5
  subgraph nDataAccess_43BF0C8B_domain["Domain: Data Access"]
    nDataAcquisitionService_6CAFA860
  end
  subgraph nReport_523BC237_domain["Domain: Report"]
    nReportService_7E534222
  end
  subgraph nTenant_223E8F95_domain["Domain: Tenant"]
    nGetFacilityConfig_3026B4B5
    nTenantService_29AF3ECE
  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_3026B4B5["Query: Get Facility Configuration"]
  nTenantService_29AF3ECE["Service: TenantService"] -->|provides| nGetFacilityConfig_3026B4B5
  nReportService_7E534222["Service: ReportService"] -->|provides| nGetFacilityConfig_3026B4B5
  nAdminBFF_7A9CD338["Service: AdminBFF"] -->|provides| nGetFacilityConfig_3026B4B5
  nDataAcquisitionService_6CAFA860["Service: DataAcquisitionService"] -->|provides| nGetFacilityConfig_3026B4B5
  nTenantService_29AF3ECE["Service: TenantService"] -->|requests| nGetFacilityConfig_3026B4B5
  subgraph nDataAccess_43BF0C8B_domain["Domain: Data Access"]
    nDataAcquisitionService_6CAFA860
  end
  subgraph nReport_523BC237_domain["Domain: Report"]
    nReportService_7E534222
  end
  subgraph nTenant_223E8F95_domain["Domain: Tenant"]
    nGetFacilityConfig_3026B4B5
    nTenantService_29AF3ECE
  end