Skip to content

[Milestone]: Finalize Data Preparations for Internal Entrata Packaged Data

No due date 0% complete

Included with the package are various Entrata-specific prepared data frames and lists that aid in validation and referential lookups, etc. throughout the Entrata logic of the Package.

Endpoints, Endpoint Methods, and Endpoint Method Parameters

The Primary purpose of these prepared datasets/lists is to validate user inputs and R function arguments against…

Included with the package are various Entrata-specific prepared data frames and lists that aid in validation and referential lookups, etc. throughout the Entrata logic of the Package.

Endpoints, Endpoint Methods, and Endpoint Method Parameters

The Primary purpose of these prepared datasets/lists is to validate user inputs and R function arguments against a conditional set of enumerated values (i.e. based on the selected endpoint, validate the endpoint method against available endpoint methods for that endpoint as well as validate the method's parameters.

  • entrata_endpoints: Vector of available endpoints

  • entrata_endpoint_methods: Named, nested list containing endpoints and their available methods

  • entrata_endpoint_method_parameters: Named, nested list containing endpoints, methods, and the method parameters metadata (type, required, multiple, description)

  • important_entrata_endpoint_methods: Filtered to only include "important" (used) endpoints

from these lists, the following tables are generated:

  • entrata_endpoint_method_parameters_tbl:
  • entata_endpoint_methods_tbl:

Reporting Data

/report endpoint specific metadata:

  • entrata_report_names:
  • entrata_report_info:
  • entrata_report_versions:
  • entrata_report_filter_parameters:
  • entrata_report_default_filter_parameters:

Property Data

/properties endpoint related data:

  • entrata_properties:
  • entrata_property_map_data:

Request/Response Body Data Structures

also derived are:

  • entrata_default_req_body
  • entrata_default_resp_body

Others

  • Various JSONSchema's for request body, response body, request method parameters, reports request method filter parameters, etc.

  • OpenAPI Specification YAML Schemas

  • Database Preparations and Setup

  • Shiny App Default Values for Picker Input Choices

Loading