Method Format and Syntax
- Last UpdatedNov 06, 2025
- 2 minute read
The MES Web API includes standard Put, Post, Get, and Delete methods to interact with the MES database.
- POST Generally used when the call inserts new records into the MES database.
- PUT Generally used when the call updates existing records in the MES database.
- GET Used to return information from the MES database.
- DELETE Used to remove records from the MES database.
General Format
The general format of the Web API is:
API?Filter=FilterValue&Filter2=Filter2Value
This document lists all the names and the corresponding filter parameters. The endpoint name is followed by the ? symbol to indicate the start of the filters. If no filters are needed, then do not include the ? symbol.
To include multiple filters, separate each with the & symbol.
Endpoint entries are case insensitive.
Syntax
Nearly all the GET Web API endpoints require filter parameters to identify what records to return from the database. Some Get methods have no filter or optional filter parameters. Gets can return a model, a value, a JSON object, or a JSON array. These are predefined formats as needed by the MES Web Portal.
The DELETE Web API endpoints require the key field in the database so that only a single record will be deleted at a time.
The POST Web API endpoints can include parameters in addition to the model. The new or updated database table record is returned in the response body as a model as well.
The PUT Web API endpoints can include parameters to identify the record to be updated in addition to a model.