MES Stateless API

GetAll Method (Site)

Save PDF

GetAll Method (Site)

Save PDF

Last UpdatedNov 06, 2025
3 minute read

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

Syntax

'Declaration
 
Public Shared Function GetAll( _
   ByVal entId As Nullable(Of Integer), _
   ByVal siteName As String, _
   ByVal corporation As String, _
   ByVal division As String, _
   ByVal subDivision As String, _
   ByVal regionId As String, _
   ByVal spare1 As String, _
   ByVal spare2 As String, _
   ByVal spare3 As String, _
   ByVal spare4 As String, _
   ByVal lastEditBy As String, _
   ByVal lastEditAt As Nullable(Of Date) _
) As DataSet

'Usage
 
Dim entId As Nullable(Of Integer)
Dim siteName As String
Dim corporation As String
Dim division As String
Dim subDivision As String
Dim regionId As String
Dim spare1 As String
Dim spare2 As String
Dim spare3 As String
Dim spare4 As String
Dim lastEditBy As String
Dim lastEditAt As Nullable(Of Date)
Dim value As DataSet
 
value = Site.GetAll(entId, siteName, corporation, division, subDivision, regionId, spare1, spare2, spare3, spare4, lastEditBy, lastEditAt)

public static DataSet GetAll( 
   Nullable<int> entId,
   string siteName,
   string corporation,
   string division,
   string subDivision,
   string regionId,
   string spare1,
   string spare2,
   string spare3,
   string spare4,
   string lastEditBy,
   Nullable<DateTime> lastEditAt
)

Parameters

entId: Optional filter parameter. An integer value to filter the dataset by entity id
siteName: Optional filter parameter. A string value to filter the dataset by site name
corporation: Optional filter parameter. A string value to filter the dataset by corporation
division: Optional filter parameter. A string value to filter the dataset by division
subDivision: Optional filter parameter. A string value to filter the dataset by sub division
regionId: Optional filter parameter. A string value to filter the dataset by region id
spare1: Optional filter parameter. A string value to filter the dataset by spare1 field
spare2: Optional filter parameter. A string value to filter the dataset by spare2 field
spare3: Optional filter parameter. A string value to filter the dataset by spare3 field
spare4: Optional filter parameter. A string value to filter the dataset by spare4 field
lastEditBy: Optional filter parameter. Holds the ID of the user who added or last updated a site record.
lastEditAt: Optional filter parameter. Holds the date/time when a site record was added or last updated.

Return Value

Returns a DataSet that contains a DataRow for each site record from the Site table that satisfies the specified filter criteria. If no matching records are found, an empty DataSet is returned. Any exceptions thrown by the middleware will need to be handled by the client calling this method.

The columns of the returned DataSet are described below.

Column Name	Description
ent_id	An integer that is the ID of the entity to which the site is assigned.
site_name	A string that is the site name.
corporation	This property is currently not used.
division	This property is currently not used.
sub_division	This property is currently not used.
region_id	A string that is the ID of the time zone region in which the site is located. Regions are maintained in the Tz_Offset table by the MES middleware service.
spare1	The contents of the user-defined spare1 field.
spare2	The contents of the user-defined spare2 field.
spare3	The contents of the user-defined spare3 field.
spare4	The contents of the user-defined spare4 field.
ent_name	A string that is the name of the entity to which the site is assigned.
description	A string that is the description of the entity to which the site is assigned.
last_edit_comment	A string that is the comments about why the record was added or updated.
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 is the date and time, in UTC, when the record was created or last updated.

MES Stateless API