MES Stateless API

GetAvailableReasons(String,String,String) Method

Save PDF

GetAvailableReasons(String,String,String) Method

Save PDF

Last UpdatedNov 06, 2025
3 minute read

The GetAvailableReasons() method retrieves the set of possible final reason codes for the specified entity. This overload of the method uses a site name and entity name to specify the entity.

If the optional raw reason code parameter is included, then the final list is filtered to include those final reasons that can override the given raw reason.

Syntax

'Declaration
 
Public Overloads Shared Function GetAvailableReasons( _
   ByVal entName As String, _
   ByVal siteName As String, _
   ByVal rawReasCd As String _
) As DataSet

'Usage
 
Dim entName As String
Dim siteName As String
Dim rawReasCd As String
Dim value As DataSet
 
value = UtilExec.GetAvailableReasons(entName, siteName, rawReasCd)

public static DataSet GetAvailableReasons( 
   string entName,
   string siteName,
   string rawReasCd
)

Parameters

entName: Required. Holds the name of the entity whose final reason codes are being retrieved.
siteName: Optional filter parameter. Holds the site name for the entity.
rawReasCd: Optional filter parameter. Holds a raw reason code by which to filter the final reason codes that are being retrieved.

Return Value

If the entity is configured to have a set of possible final reasons for a given raw reason code, then those reasons that are linked to the supplied raw reason are returned in a DataSet. If there are no reasons for the supplied raw reason code, then all utilization reasons are returned in the DataSet. If no rows are found for the specified parameters, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Name	Description
reas_grp_id	An integer that is the utilization reason group from the Util_Reas_Grp table linked to the reas_cd is returned.
reas_grp_desc	The description of the utilization reason group from Util_Reas_Grp table linked to the reas_grp_id for this reason is returned.
reas_cd	The utilization reason code, from the Util_Reas table.
reas_desc	The description of this utilization reason, from the Util_Reas table.
l0_reas_grp_id	An integer which contains ID of the top-level reason group. There can be up to 10 levels of reason groups above the reason. This will always contain a value and will be the same as the reas_grp_id in the case where there is only one reason group above the reason.
l0_reas_grp_desc	The description of the top-level reason group.
l1_reas_grp_id	An integer which contains the ID of the second-level reason group. This will be null if there is only one reason group above the reason.
l1_reas_grp_desc	The description of the second-level reason group.
l2_reas_grp_id	An integer which contains the ID of the third-level reason group. This will be null if there is only two levels of reason groups above the reason.
l2_reas_grp_desc	The description of the third-level reason group.
l3_reas_grp_id	An integer which contains the ID of the fourth-level reason group. This will be null if there is only three levels of reason groups above the reason.
l3_reas_grp_desc	The description of the fourth-level reason group.
l4_reas_grp_id	An integer which contains the ID of the fifth-level reason group. This will be null if there is only four levels of reason groups above the reason.
l4_reas_grp_desc	The description of the fifth -level reason group.
l5_reas_grp_id	An integer which contains the ID of the sixth-level reason group. This will be null if there is only five levels of reason groups above the reason.
l5_reas_grp_desc	The description of the sixth -level reason group.
l6_reas_grp_id	An integer which contains the ID of the seventh-level reason group. This will be null if there is only six levels of reason groups above the reason.
l6_reas_grp_desc	The description of the seventh -level reason group.
l7_reas_grp_id	An integer which contains the ID of the eighth-level reason group. This will be null if there is only seven levels of reason groups above the reason.
l7_reas_grp_desc	The description of the eighth -level reason group.
l8_reas_grp_id	An integer which contains the ID of the ninth-level reason group. This will be null if there is only eight levels of reason groups above the reason.
l8_reas_grp_desc	The description of the ninth -level reason group.
l9_reas_grp_id	An integer which contains the ID of the tenth-level reason group. This will be null if there is only nine levels of reason groups above the reason.
l9_reas_grp_desc	The description of the tenth -level reason group.

MES Stateless API