Skip to main content

​
Introduction

The MasterLabel API is built with ASP.NET Core MVC and provides REST endpoints for retrieving report data from Oracle Support Dashboard and saving label data to a SQL database.

​
Base URL

All API endpoints follow the ASP.NET Core MVC pattern: 
/Home/{action}
Where {action} corresponds to the controller action method name.

​
Request/Response Format

All API endpoints:
  • Accept JSON request bodies
  • Return JSON responses
  • Use HTTP POST method
  • Content-Type: application/json

​
Authentication

Currently, the API does not require authentication. Endpoints are publicly accessible within the network.

​
API Endpoints

Get Report Data

Retrieve equipment report data by serial number from Oracle Support Dashboard

Save Label Data

Save label information to the SQL database

​
UI Routes

The application also provides web interface routes:
RouteMethodDescription
/ or /Home/IndexGETMain application page with search and data entry form
/Home/PrivacyGETPrivacy policy page
/Home/ErrorGETError display page

​
Integration

The API integrates with:
  • Oracle Support Dashboard: External system at https://azuappsrvuat01v.mcquay.com/SupportDashboard/
  • SQL Server Database: Stores label data in the LabelData table

​
Error Handling

All endpoints return JSON responses with error information when operations fail: 
{
  "error": "Error message describing what went wrong"
}
Or for save operations: 
{
  "success": false,
  "message": "Detailed error message"
}

​
Next Steps

Get Report Data

Learn how to retrieve report data

Save Label Data

Learn how to save label data

Build docs developers (and LLMs) love

Get started for freeTalk to us