Admin
| API | Description |
|---|---|
| DELETE request/admin/brand/{id} |
Deletes any particular Brand Details |
| GET request/admin/brand/{id} |
Displays any particular Brand Details |
| GET request/admin/brand/all |
Displays all the Brand Details |
| POST request/admin/brand |
Cretes a new Brand User with Channel List |
| PUT request/admin/brand/{id} |
Updates any particular Brand Details |
Customer
Dashboard
| API | Description |
|---|---|
| GET request/dashboard |
Provides Dashboard info |
| GET request/dashboard/bespokequote/{bespokequoteid}/meters |
Updates MugCommission for the BespokeQuote and its all supplier quotes |
| GET request/dashboard/bespokequote/{bespokequoteid}/tender/content |
To send Bespoke tender request Email Content |
| GET request/dashboard/supplier/contract/template |
Lists all the supplier's contract pad and TC urls available |
| GET request/dashboard/supplier/pendingbespokequote |
To display all the Pending Bespoke Quote request sent to Supplier list |
| GET request/dashboard/supplier/tariff |
No documentation available. |
| GET request/notification |
Displays the Users Notifications Details |
| POST request/dashboard/bespokequote/{bespokequoteid}/tender/supplier/sent |
To send Bespoke tender request Email notification to the list of suppliers |
| POST request/notification |
Adds the User Notification Details |
| PUT request/dashboard/bespokequote/{bespokequoteid}/commission |
Updates MugCommission for the BespokeQuote and its all supplier quotes |
| PUT request/notification/{id} |
Updates the Supplier User Notification Read Details |
Lookup
| API | Description |
|---|---|
| GET request/bands/electricity |
Provides Electricity Bands for logged in Product |
| GET request/bands/gas |
Provides Gas Bands for logged in Product |
| GET request/channels |
Provides Channels list for logged in user product |
| GET request/commissionTerm |
Provides Commission Term for logged in Product |
| GET request/contractlength |
No documentation available. |
| GET request/contracts/failedreason |
Provides Contract Failed Reasons |
| GET request/contracts/quotetypes |
Provides Quote types |
| GET request/contracts/status |
Provides Contract update status |
| GET request/contractTerm |
No documentation available. |
| GET request/contracttype |
Display all contract types |
| GET request/creditrate |
No documentation available. |
| GET request/dnoldz/fuel/{fuelid} |
DNOLDZ by FuelId |
| GET request/paymentmethod/filter |
Display all payment methods |
| GET request/profile/electricity |
Provides Electricity Bands for logged in Product |
| GET request/profile/gas |
Provides Gas Bands for logged in Product |
| GET request/suppliers |
No documentation available. |
Pricing
Report
| API | Description |
|---|---|
| GET request/report/commission?date={date} |
Get Commission report for given n number of days |
| GET request/report/SalesForcastingReport |
Provides a Sales Forecasting Report |
| GET request/report/summary/{brokdercode}?from={from}&to={to} |
Provides a Summary For All Brokers |
| GET request/report/summary/agent/{agentId}/details?from={from}&to={to} |
Provides a Summary For All Brokers |
| GET request/report/summary/agent/{agentId}?from={from}&to={to} |
Provides a Summary For All Brokers |
| GET request/report/summaryDetails/{agentId}?from={from}&to={to} |
Provides a Dashboard |
| GET request/report/summaryForAll?from={from}&to={to} |
Provides a Summary For All Brokers |
Supplier
| API | Description |
|---|---|
| GET request/supplier/contact |
Provides Supplier contact details |
| GET request/supplier/energyoptions |
No documentation available. |
| GET request/supplier/info |
Get supplier Informations about Details,Acceptance,ConsumptionCriteria and Commission criteria |
| GET request/supplier/paymenttermscondition |
Provides payment terms and condition information |
| GET request/supplier/product/brand/config |
Displays the Product Brand Supplier configuration(for each brand supplier filter List) |
| GET request/supplier/productconfig |
Displays the Product configuration for Logged in Supplier |
| GET request/supplier/productconfig/all |
Displays the Product configuration for all supplier |
| GET request/supplier/targetmarket/bespoke | |
| GET request/supplier/targetmarket/matrix | |
| POST request/supplier/contact |
Add supplier contact details |
| POST request/supplier/energyoptions |
No documentation available. |
| POST request/supplier/logo/upload |
Uploads The Supplier Details Logo |
| POST request/supplier/paymenttermscondition/document |
Upload new document |
| POST request/supplier/productconfig |
Creates the Product configuration for Logged in Supplier |
| POST request/supplier/targetmarket/bespoke | |
| POST request/supplier/targetmarket/bespoke/hh | |
| POST request/supplier/targetmarket/matrix | |
| PUT request/supplier/{SupplierId}/brand/config |
To update the supplier Filter configs(Include or Exclude) for a particular Supplier |
| PUT request/supplier/{SupplierId}/info |
No documentation available. |
| PUT request/supplier/{SupplierId}/productconfig |
Updates the Product configuration details for the Logged in Supplier |
| PUT request/supplier/brand/{BrandId}/config |
To update the supplier Filter configs(Include or Exclude) for a particular Brand |
User
| API | Description |
|---|---|
| DELETE request/user/{id} |
Delete a specific user |
| GET request/user |
No documentation available. |
| GET request/user/{id} |
Display a particular User Information |
| GET request/user/{id}/notification/config |
User notifications get |
| GET request/user/currentuser |
Displays the current User Information. |
| GET request/user/departments |
No documentation available. |
| GET request/user/forgetpassword?email={email}&scope={scope} | |
| GET request/user/roles |
No documentation available. |
| POST request/user |
Add a new user |
| POST request/user/currentuser/password |
Asks to Change Password when first Login |
| PUT request/user/{id} |
Update a specific user |
| PUT request/user/{id}/notification/config |
Update User Notifications |