MES Stateless API

GetAll Method (ShiftPattern)

Save PDF

GetAll Method (ShiftPattern)

Save PDF

Last UpdatedNov 06, 2025
2 minute read

The GetAll() method retrieves one or more shift pattern records from the Shift_Pattern table, as specified by the filter parameters. Passing no filter parameters will retrieve all shift pattern records from the table.

Syntax

'Declaration
 
Public Shared Function GetAll( _
   ByVal patternId As Nullable(Of Integer), _
   ByVal patternName As String, _
   ByVal startEffLocal As Nullable(Of Date), _
   ByVal endEffLocal As Nullable(Of Date), _
   ByVal recurring As Nullable(Of Boolean), _
   ByVal additive As Nullable(Of Boolean), _
   ByVal enabled As Nullable(Of Boolean), _
   ByVal lastEditAt As Nullable(Of Date) _
) As DataSet

'Usage
 
Dim patternId As Nullable(Of Integer)
Dim patternName As String
Dim startEffLocal As Nullable(Of Date)
Dim endEffLocal As Nullable(Of Date)
Dim recurring As Nullable(Of Boolean)
Dim additive As Nullable(Of Boolean)
Dim enabled As Nullable(Of Boolean)
Dim lastEditAt As Nullable(Of Date)
Dim value As DataSet
 
value = ShiftPattern.GetAll(patternId, patternName, startEffLocal, endEffLocal, recurring, additive, enabled, lastEditAt)

public static DataSet GetAll( 
   Nullable<int> patternId,
   string patternName,
   Nullable<DateTime> startEffLocal,
   Nullable<DateTime> endEffLocal,
   Nullable<bool> recurring,
   Nullable<bool> additive,
   Nullable<bool> enabled,
   Nullable<DateTime> lastEditAt
)

Parameters

patternId: Optional filter parameter. Holds a shift pattern ID.
patternName: Optional filter parameter. Holds a shift pattern name.
startEffLocal: Optional filter parameter. Holds an effective local start time of a shift pattern.
endEffLocal: Optional filter parameter. Holds effective local end time of a shift pattern.
recurring: Optional filter parameter. Holds a flag that specifies whether the shifts in the shift pattern are recurring.
additive: Optional filter parameter. Holds a flag that specifies whether the shifts in the shift pattern are additive.
enabled: Optional filter parameter. Holds a flag that specifies whether the shift pattern is enabled.
lastEditAt: Optional filter parameter. Holds the datetime when a shift pattern record was added or last changed.

Return Value

Returns a DataSet that contains records for all the shift patterns that satisfy the specified filters. The returned records include columns from the Shift_Pattern table. If no matching shift patterns are found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Name	Description
pattern_id	An integer that is the shift pattern ID.
pattern_name	A string that is the shift pattern name.
start_eff_local	A datetime that is the effective start time for the shift pattern.
end_eff_local	A datetime that is the effective end time for the shift pattern.
recurring	A Boolean flag that indicates whether the shifts in the shift pattern are recurring.
additive	A Boolean flag that indicates whether the shifts in the shift pattern are additive.
enabled	A Boolean flag that indicates whether the shift pattern is enabled.
comments	A string that contains comments about the shift pattern.
last_edit_comment	A string that contains comments about why the record was added or changed.
last_edit_by	A string that is the ID of the user who added or last updated this record.
last_edit_at	A datetime that indicates when the record was added or last updated.

MES Stateless API