Introduction to the Api Documentation

This section is home to the api documentation which is automatically created from the data model. The main purpose of the api documentation is to give a more detailed and technical description of the data including any source information and any other attributes assigned to the individual data points.

Layout:

Each page will begin by stating which class it is describing with a description of the class just below that.

Next will be the Inheritance section which will describe any parent classes of the current class and the path from the main system object to the current class if there is one. If there are any data points which are inherited from these parent classes in the current class these will then be listed and linked in the Inherited Members section.

It then states the Namespace, Assembly and the Syntax of the class before starting the Constructors section. This section is anchored in the right hand navigation area.

The next section, which is also anchored in the right hand navigation bar, is Properties. It is here that the contents of the class will be listed. This includes classes and data points. Along with listing the name of the data it also gives details such as any sources for the data, whether it is in the UI or not, and any other attributes that have been assigned to the data. It also states the type of the data and the description of the data point.

To navigate the api documents you can use the left hand navigation bar.

This is split into the main folders within the documentation.

  • IAI.DT.DataModel.Attributes - This section contains all the different attributes that can be assigned to data. These are to help organisation and to aid in the understanding of the data.
  • IAI.DT.DataModel.Enumerations - This section is for the enumeration constants which are used together with the attributes to aid in the documentation. Most notably it contains all the data sources that are currently used in the data model.
  • IAI.DT.DataModel.InvestigatingDataPoints - This section is for data points that we have identified as wanting in the model but have not found a source for yet.
  • IAI.DT.DataModel.Legacy - This section contains all the data and information used in our previous data model that is no longer in use but still contains valuable information.
  • IAI.DT.DataModel.Production - This section contains all the details on the data currently used in the live data model.
  • IAI.DT.DataModel.PendingDataPoints - In this section are the data points that are currently under investigation as to their feasibility in being added to the data model. This icludes the reason for the data point being added to the data model, the sources for the data and any other information that is related to the investigation.
  • IAI.DT.DataModel.UnavailableDataPoints - This section includes any data points that have undergone investigation and been found to either not have a viable source or to not be useful and needed within the data model.