Dashboard APIs

Overview ¶

The Dashboard API provides a comprehensive suite of modules designed to facilitate the management and monitoring of various aspects of the system. These modules include functionalities for order summaries, pricing requests, profile management, and outbound shipments, among others. Each module is crafted to ensure efficient and effective operations through the Dashboard API.

Bearer Token

A bearer token is a type of access token that is used for authorization in APIs. It is a cryptic string that is generated by the server in response to a login request. The client must send this token in the Authorization header when making requests to protected resources.

The “Bearer” keyword is a signal to the server that the token is a type of bearer token. Here’s an example of how to use it:

Authorization: Bearer <Your-Bearer-Token>

Replace with your actual bearer token.

For example:

Authorization: Bearer 5262d64b892e8d4341000001

Error Messages

400 Bad Request: This error is returned when the server could not understand the request due to invalid syntax. Check your request body and parameters.
401 Unauthorized: This error is returned when the request lacks valid authentication credentials for the target resource. Make sure your API key is correct.
403 Forbidden: This error is returned when the server understood the request, but it refuses to authorize it. This status is often returned if you’re missing permissions to access the resource.
404 Not Found: This error is returned when the server can’t find the requested resource. Check your endpoint and parameters.
500 Internal Server Error: This error is returned when the server encounters an unexpected condition that prevented it from fulfilling the request.

Dashboard Filter APIs ¶

filter_acc_assign ¶

filter_acc_assign
GET`/api/dashboard/filter/acc_assign/`

Overview

This endpoint is designed to retrieve a list of account assignments for the filter options in the Environmental Services Company (ESC) dashboard. It allows users to access detailed information about the account assignments, including the ID, first name, and last name of the user. The endpoint supports the retrieval of account assignments, enabling users to filter and search for specific account assignments effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring easy access to necessary tools and information for compliance management, reporting, and operational oversight.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of account assignments.
id	integer	The ID of the account assignment.
first_name	string	The first name of the user.
last_name	string	The last name of the user.
totalElements	integer	The total number of account assignments.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/filter/acc_assign/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 1839,
      "first_name": "Jane",
      "last_name": "Doe"
    }
  ],
  "totalElements": 28
}

filter_sales_contact ¶

filter_sales_contact
GET`/api/dashboard/filter/sales_contact/`

Overview

This endpoint is designed to retrieve a list of sales contacts for the filter options in the Environmental Services Company (ESC) dashboard. It allows users to access detailed information about the sales contacts, including the name of the sales contact. The endpoint supports the retrieval of sales contacts, enabling users to filter and search for specific sales contacts effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring easy access to necessary tools and information for compliance management, reporting, and operational oversight.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of sales contacts.
Name	string	The name of the sales contact.
totalElements	integer	The total number of sales contacts.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/filter/sales_contact/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "Name": "Jane Doe"
    },
    {
      "Name": "John Doe"
    },
    {
      "Name": "Ken Doe"
    },
    {
      "Name": "Tori Doe"
    }
  ],
  "totalElements": 4
}

filter_order_creator ¶

filter_order_creator
GET`/api/dashboard/filter/order_creator/`

Overview

This endpoint is designed to retrieve a list of order creators for the filter options in the Environmental Services Company (ESC) dashboard. It allows users to access detailed information about the order creators, including the name of the order creator. The endpoint supports the retrieval of order creators, enabling users to filter and search for specific order creators effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring easy access to necessary tools and information for compliance management, reporting, and operational oversight.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
user_id	integer	The ID of the user.
full_name	string	The full name of the user.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/filter/order_creator/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "user_id": 1862,
      "full_name": "Jane Doe"
    }
  ],
  "totalElements": 40
}

Dashboard ESC & Grid Widgets APIs ¶

list_esc_grid ¶

list_esc_grid
GET`/api/dashboard/list_esc_grid`

Overview

This endpoint is designed to retrieve a comprehensive view of the Environmental Services Company (ESC) dashboard within the system. It allows users to access detailed information about the dashboard’s main and side grid widgets, including but not limited to e-signing functionalities, order summaries, profile management, outbound shipments tracking, supplies ordering, inventory management, and communication tools. The endpoint supports the retrieval of widget-specific data, enabling users to customize and interact with the ESC dashboard effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring easy access to necessary tools and information for compliance management, reporting, and operational oversight.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
main_grid	array	The main grid widgets.
side_grid	array	The side grid widgets.
esc_esign_widget	string	The e-sign widget.
esc_order_summary_widget	string	The order summary widget.
esc_profiles_widget	string	The profiles widget.
esc_outbound_shipments_widget	string	The outbound shipments widget.
esc_supplies_widget	string	The supplies widget.
esc_inventory_widget	string	The inventory widget.
esc_communication_widget	string	The communication widget.
esc_inventory_notifications_widget	string	The inventory notifications widget.
esc_profile_notification_widget	string	The profile notification widget.
esc_order_notifications_widget	string	The order notifications widget.
serialized_data	string	The serialized data.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/list_esc_grid

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "main_grid": [],
  "side_grid": [
    "esc_esign_widget",
    "esc_order_summary_widget",
    "esc_profiles_widget",
    "esc_outbound_shipments_widget",
    "esc_supplies_widget",
    "esc_inventory_widget",
    "esc_communication_widget",
    "esc_inventory_notifications_widget",
    "esc_profile_notification_widget",
    "esc_order_notifications_widget"
  ],
  "serialized_data": "[]"
}

notification_price_requests ¶

notification_price_requests
GET`/api/dashboard/esc/notification/price_requests/{?page,pageSize}`

Overview

This endpoint is designed to retrieve a list of price requests that require user attention. It allows users to access detailed information about the price requests, including the pricing request number and status. The endpoint supports the retrieval of price requests that are pending, in progress, or completed, enabling users to track the progress of their pricing requests effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring timely responses to pricing requests and effective communication with waste management service providers.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of price requests.
id	integer	The ID of the price request.
PricingRequest_id	integer	The ID of the pricing request.
PricingRequestNumber	string	The number of the pricing request.
Status	string	The status of the pricing request.
totalElements	integer	The total number of price requests.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/esc/notification/price_requests/?page=&pageSize=

URI Parameters

HideShow

page: number (optional)
The page number.
pageSize: number (optional)
The number of items per page.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 8186,
      "PricingRequest_id": 11992,
      "PricingRequestNumber": "4935-01",
      "Status": "Completed"
    }
  ],
  "totalElements": 13
}

notification_inventory ¶

notification_inventory
GET`/api/dashboard/esc/notification/inventory/{?page,pageSize}`

Overview

This endpoint is designed to retrieve a list of inventory notifications that require user attention. It allows users to access detailed information about the inventory notifications, including the waste material pickup content ID, manifest number, line number, and notification type. The endpoint supports the retrieval of inventory notifications for waste material pickups, enabling users to track the status of their inventory notifications effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring timely responses to inventory notifications and effective communication with waste management service providers.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of inventory notifications.
id	integer	The ID of the inventory notification.
WasteMaterialPickup_Content_id	integer	The ID of the waste material pickup content.
Mainfest_Number	string	The manifest number.
Line_Number	string	The line number.
Type	string	The type of notification.
totalElements	integer	The total number of inventory notifications.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/esc/notification/inventory/?page=&pageSize=

URI Parameters

HideShow

page: number (optional)
The page number.
pageSize: number (optional)
The number of items per page.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 197451,
      "WasteMaterialPickup_Content_id": 1238811,
      "Mainfest_Number": "11111",
      "Line_Number": "1",
      "Type": "7days"
    }
  ],
  "totalElements": 13
}

notification_orders ¶

notification_orders
GET`/api/dashboard/esc/notification/orders/{?page,pageSize}`

Overview

This endpoint is designed to retrieve a list of orders that require user attention. It allows users to access detailed information about the orders, including the source order ID, suborder order number, order type, and customer ID. The endpoint supports the retrieval of orders that are pending, in progress, or completed, enabling users to track the progress of their orders effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring timely responses to orders and effective communication with waste management service providers.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of orders.
id	integer	The ID of the order.
ESC_SourceOrder_id	integer	The ID of the source order.
suborder_order_number	string	The suborder order number.
Type	integer	The type of order.
Customer_id	integer	The ID of the customer.
totalElements	integer	The total number of orders.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/esc/notification/orders/?page=&pageSize=

URI Parameters

HideShow

page: number (optional)
The page number.
pageSize: number (optional)
The number of items per page.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    "success": true,
    "content": [
        {
            "id": 2779568,
            "ESC_SourceOrder_id": 569661,
            "suborder_order_number": "608930-04",
            "Type": 8,
            "Customer_id": 68511
        },
            ],
    "totalElements": 13
}

notification_user_messages ¶

notification_user_messages
GET`/api/dashboard/esc/notification/user_messages/`

Overview

This endpoint is designed to retrieve a list of user messages that require user attention. It allows users to access detailed information about the user messages, including the message type, sender, item type, created date, and message content. The endpoint supports the retrieval of user messages for profile management, enabling users to track the status of their messages effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring timely responses to messages and effective communication with waste management service providers.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of user messages.
type	string	The type of message.
sender	string	The sender of the message.
item_type	string	The type of item.
created_date	string	The date the message was created.
message	string	The message content.
item_detail_info	object	The detailed information about the item.
Customer_id	integer	The ID of the customer.
customer_profile_id	integer	The ID of the customer profile.
reply_for_id	integer	The ID of the reply for the message.
item_number	integer	The item number.
item_delete_info	integer	The item delete information.
totalElements	integer	The total number of user messages.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/esc/notification/user_messages/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "type": "profile",
      "sender": "Jane Doe",
      "item_type": "Profile No.",
      "created_date": "07-22-2024 09:58 PM",
      "message": "Jane Doe hi ",
      "item_detail_info": {
        "Customer_id": 41024,
        "customer_profile_id": 306317,
        "reply_for_id": 123441
      },
      "item_number": 207780,
      "item_delete_info": 197389
    }
  ],
  "totalElements": 1
}

notification_profile ¶

notification_profile
GET`/api/dashboard/esc/notification/profile/{?page,pageSize,filter}`

Overview

This endpoint is designed to retrieve a list of profiles that require user attention. It allows users to access detailed information about the profiles, including the profile number, customer ID, and disposal facility name. The endpoint supports the retrieval of profiles that are pending, in progress, or completed, enabling users to track the progress of their profiles effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring timely responses to profile requests and effective communication with waste management service providers.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of profiles.
id	integer	The ID of the profile.
Type	integer	The type of profile.
Customer_id	integer	The ID of the customer.
Profile_Number	integer	The profile number.
DisposalFacility_Name	string	The name of the disposal facility.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/esc/notification/profile/?page=&pageSize=&filter=

URI Parameters

HideShow

page: number (optional)
The page number.
pageSize: number (optional)
The number of items per page.
filter: string (optional)
The filter criteria.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 139774,
      "Type": 22,
      "CustomerProfile_id": 306344,
      "Customer_id": 81168,
      "Profile_Number": 207807,
      "DisposalFacility_Name": "Company A"
    }
  ],
  "totalElements": 1
}

inventory ¶

inventory
GET`/api/dashboard/esc/inventory/{?page,pageSize,filter,sort}`

Overview

This endpoint is designed to retrieve a list of inventory items for waste material pickups. It allows users to access detailed information about the inventory items, including the manifest number, line number, generator, and days in inventory. The endpoint supports the retrieval of inventory items for waste material pickups, enabling users to track the status of their inventory effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring timely responses to inventory notifications and effective communication with waste management service providers.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of profiles.
id	integer	The ID of the profile.
Type	integer	The type of profile.
Customer_id	integer	The ID of the customer.
Profile_Number	integer	The profile number.
DisposalFacility_Name	string	The name of the disposal facility.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/esc/inventory/?page=&pageSize=&filter=&sort=

URI Parameters

HideShow

page: number (optional)
The page number.
pageSize: number (optional)
The number of items per page.
filter: string (optional)
The filter criteria.
sort: string (optional)
The sort criteria.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 1309926,
      "Order_Number": 612057,
      "Mainfest_Number": "22222",
      "Line_Number": "1",
      "generator": "Company A",
      "days_in_inventory": 11
    }
  ],
  "totalElements": 1
}

outbound_shipments ¶

outbound_shipments
GET`/api/dashboard/esc/outbound_shipments/{?page,pageSize,filter,sort}`

Overview

This endpoint is designed to retrieve a list of outbound shipments for waste material pickups. It allows users to access detailed information about the outbound shipments, including the shipment number, shipment date, destination, and shipped status. The endpoint supports the retrieval of outbound shipments for waste material pickups, enabling users to track the status of their shipments effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring timely responses to shipment notifications and effective communication with waste management service providers.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of outbound shipments.
id	integer	The ID of the outbound shipment.
Shipment_Number	integer	The number of the shipment.
Shipment_Date	string	The date of the shipment.
destination	string	The destination of the shipment.
Shipped	string	The shipped status of the shipment.
totalElements	integer	The total number of outbound shipments.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/esc/outbound_shipments/?page=&pageSize=&filter=&sort=

URI Parameters

HideShow

page: number (optional)
The page number.
pageSize: number (optional)
The number of items per page.
filter: string (optional)
The filter criteria.
sort: string (optional)
The sort criteria.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 117396,
      "Shipment_Number": 102890,
      "Shipment_Date": "05/21/2024",
      "destination": "Destination ABC",
      "Shipped": "Yes"
    }
  ],
  "totalElements": 1
}

profiles ¶

profiles
GET`/api/dashboard/esc/profiles/{?page,pageSize,filter,sort}`

Overview

This endpoint is designed to retrieve a list of profiles for waste material pickups. It allows users to access detailed information about the profiles, including the profile number, profile name, approval status, disposal facility, and account assignment. The endpoint supports the retrieval of profiles for waste material pickups, enabling users to track the status of their profiles effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring timely responses to profile notifications and effective communication with waste management service providers.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of profiles.
id	integer	The ID of the profile.
CustomerProfile_id	integer	The ID of the customer profile.
network_or_enterprise	string	The network or enterprise type.
date_submitted	string	The date the profile was submitted.
generator	string	The generator of the profile.
profile_number	integer	The profile number.
profile_name	string	The name of the profile.
approval_status	string	The approval status of the profile.
disposal_facility	string	The disposal facility of the profile.
facility_name	string	The name of the facility.
account_assignment	string	The account assignment of the profile.
is_er_authorization	boolean	The ER authorization status of the profile.
customer_id	integer	The ID of the customer.
totalElements	integer	The total number of profiles.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/esc/profiles/?page=&pageSize=&filter=&sort=

URI Parameters

HideShow

page: number (optional)
The page number.
pageSize: number (optional)
The number of items per page.
filter: string (optional)
The filter criteria.
sort: string (optional)
The sort criteria.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 1,
      "CustomerProfile_id": 115495,
      "network_or_enterprise": "Enterprise",
      "date_submitted": "05/09/2020",
      "generator": "Company A",
      "profile_number": 5591,
      "profile_name": "4ft Lamps",
      "approval_status": "Approved",
      "disposal_facility": "Company A",
      "facility_name": "Facility A",
      "account_assignment": "Jane Doe",
      "is_er_authorization": false,
      "customer_id": 39890
    }
  ],
  "totalElements": 1
}

update_serialized_data ¶

update_serialized_data
POST`/api/dashboard/grid_widget/update_serialized_data/`

Overview

This endpoint is designed to update the serialized data for the Environmental Services Company (ESC) dashboard grid widgets. It allows users to customize the layout and configuration of the ESC dashboard by updating the serialized data for the main and side grid widgets. The endpoint supports the serialization of widget-specific data, enabling users to rearrange and configure the ESC dashboard widgets effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring easy access to necessary tools and information for compliance management, reporting, and operational oversight.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
serializedData	string	The serialized data.

Example URI

POST https://test-api.wastelinq.com./api/dashboard/grid_widget/update_serialized_data/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "serializedData": "[{\"widget_id\":\"esc_price_requests_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":0,\"y\":0}},{\"widget_id\":\"esc_order_summary_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":5,\"y\":0}},{\"widget_id\":\"esc_outbound_shipments_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":0,\"y\":3}},{\"widget_id\":\"esc_profiles_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":5,\"y\":3}},{\"widget_id\":\"esc_inventory_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":0,\"y\":6}},{\"widget_id\":\"esc_supplies_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":5,\"y\":6}},{\"widget_id\":\"esc_pricerequest_notifications_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":0,\"y\":9}},{\"widget_id\":\"esc_communication_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":5,\"y\":9}},{\"widget_id\":\"esc_order_notifications_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":0,\"y\":12}},{\"widget_id\":\"esc_profile_notification_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":5,\"y\":12}},{\"widget_id\":\"esc_esign_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":0,\"y\":15}},{\"widget_id\":\"esc_inventory_notifications_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":5,\"y\":15}}]"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true
}

get_serialized_data ¶

get_serialized_data
GET`/api/dashboard/grid_widget/get_serialized_data/`

Overview

This endpoint is designed to retrieve the serialized data for the Environmental Services Company (ESC) dashboard grid widgets. It allows users to access the serialized data for the main and side grid widgets, enabling them to customize and interact with the ESC dashboard effectively. The endpoint supports the retrieval of widget-specific data, enabling users to rearrange and configure the ESC dashboard widgets effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring easy access to necessary tools and information for compliance management, reporting, and operational oversight.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
serializedData	string	The serialized data.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/grid_widget/get_serialized_data/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "serializedData": "[{\"widget_id\":\"esc_price_requests_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":0,\"y\":0}},{\"widget_id\":\"esc_order_summary_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":5,\"y\":0}},{\"widget_id\":\"esc_outbound_shipments_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":0,\"y\":3}},{\"widget_id\":\"esc_profiles_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":5,\"y\":3}},{\"widget_id\":\"esc_inventory_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":0,\"y\":6}},{\"widget_id\":\"esc_supplies_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":5,\"y\":6}},{\"widget_id\":\"esc_pricerequest_notifications_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":0,\"y\":9}},{\"widget_id\":\"esc_communication_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":5,\"y\":9}},{\"widget_id\":\"esc_order_notifications_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":0,\"y\":12}},{\"widget_id\":\"esc_profile_notification_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":5,\"y\":12}},{\"widget_id\":\"esc_esign_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":0,\"y\":15}},{\"widget_id\":\"esc_inventory_notifications_widget\",\"opt\":{\"h\":3,\"w\":5,\"x\":5,\"y\":15}}]"
}

profile_acknowledge_all ¶

profile_acknowledge_all
GET`/api/dashboard/esc/notification/profile/acknowledge_all/?{filters}`

Overview

This endpoint is designed to acknowledge all profile notifications that require user attention. It allows users to acknowledge all profile notifications, ensuring that they are marked as read and no longer require user attention. The endpoint supports the acknowledgment of profile notifications, enabling users to manage their environmental compliance tasks efficiently and effectively. This functionality is crucial for users seeking to streamline their compliance management processes, ensuring that all profile notifications are addressed promptly and accurately.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/esc/notification/profile/acknowledge_all/?filters

URI Parameters

HideShow

filters: string (optional)
The filter criteria.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true
}

orders_acknowledge_all ¶

orders_acknowledge_all
PUT`/api/dashboard/esc/notification/orders/acknowledge_all/`

Overview

This endpoint is designed to acknowledge all order notifications that require user attention. It allows users to acknowledge all order notifications, ensuring that they are marked as read and no longer require user attention. The endpoint supports the acknowledgment of order notifications, enabling users to manage their environmental compliance tasks efficiently and effectively. This functionality is crucial for users seeking to streamline their compliance management processes, ensuring that all order notifications are addressed promptly and accurately.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.

Example URI

PUT https://test-api.wastelinq.com./api/dashboard/esc/notification/orders/acknowledge_all/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true
}

Dashboard Esignature APIs ¶

esignature_request ¶

esignature_request
GET`/api/dashboard/esignature_request/?{page,pageSize,selectedField,filter}`

Overview

This endpoint is designed to retrieve a list of e-signature requests that require user attention. It allows users to access detailed information about the e-signature requests, including the generator, profile, disposal facility, approval status, primary TSDF status, and signature status. The endpoint supports the retrieval of e-signature requests that are pending, in progress, or completed, enabling users to track the progress of their e-signature requests effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring timely responses to e-signature requests and effective communication with waste management service providers.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of e-signature requests.
id	integer	The ID of the e-signature request.
GeneratorID	integer	The ID of the generator.
CustProfileID	integer	The ID of the customer profile.
ModifiedDate	string	The modified date of the e-signature request.
Generator	string	The generator of the e-signature request.
ProfileID	integer	The ID of the profile.
ProfileName	string	The name of the profile.
DisposalFacility	string	The disposal facility of the e-signature request.
ApprovalStatus	string	The approval status of the e-signature request.
IsPrimaryTSDF	string	The primary TSDF status of the e-signature request.
SignatureStatus	string	The signature status of the e-signature request.
totalElements	integer	The total number of e-signature requests.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/esignature_request/?page&pageSize&selectedField&filter

URI Parameters

HideShow

page: number (optional)
The page number.
pageSize: number (optional)
The number of items per page.
selectedField: string (optional)
The selected field.
filter: string (optional)
The filter criteria.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 993,
      "GeneratorID": 41647,
      "CustProfileID": 179527,
      "ModifiedDate": "07/18/2024",
      "Generator": "Jane Doe",
      "ProfileID": 81444,
      "ProfileName": "Lab Waste (lab debris & empty containers)",
      "DisposalFacility": "Company A",
      "ApprovalStatus": "Cancelled",
      "IsPrimaryTSDF": "No",
      "SignatureStatus": "Completed"
    }
  ],
  "totalElements": 4
}

view_sign_documents ¶

view_sign_documents
GET`/api/dashboard/view_sign_documents/{?id}`

Overview

This endpoint is designed to retrieve the e-signature document for a specific e-signature request. It allows users to access the e-signature document, enabling them to view and interact with the document effectively. The endpoint supports the retrieval of the e-signature document, enabling users to review and sign the document as needed. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring timely responses to e-signature requests and effective communication with waste management service providers.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	object	The content of the e-signature request.
url	string	The URL of the e-signature document.
url_generator	string	The URL generator for the e-signature document.
flag	boolean	The flag status of the e-signature document.
esigned_delete	boolean	The e-signed delete status of the document.
document	array	The list of documents.
url	string	The URL of the document.
gen_loa	array	The list of LOAs.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/view_sign_documents/?id=

URI Parameters

HideShow

id: number (required)
The ID of the e-signature request.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {
    "url": "",
    "url_generator": "/printing/document/view_esign_pdf/3304",
    "flag": false,
    "esigned_delete": true,
    "document": [
      {
        "url": "file.pdf"
      }
    ],
    "gen_loa": []
  }
}

Dashboard Supply Requests APIs ¶

supply_requests ¶

supply_requests
GET`/api/dashboard/supply_requests/{?page,pageSize,filter,sort}`

Overview

This endpoint is designed to retrieve a list of supply requests that require user attention. It allows users to access detailed information about the supply requests, including the order number, date submitted, receive order by date, broker name, product item, general description, quantity, shipping destination, status, expected delivery date, and tracking number. The endpoint supports the retrieval of supply requests that are pending, in progress, or completed, enabling users to track the progress of their supply requests effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring timely responses to supply requests and effective communication with waste management service providers.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of supply requests.
id	integer	The ID of the supply request.
OrderNumber	string	The number of the order.
DateSubmitted	string	The date the order was submitted.
ReceiveOrderBy	string	The date the order should be received by.
Broker_Name	string	The name of the broker.
ProductItem	string	The product item.
GeneralDescription	string	The general description of the product.
Quantity	integer	The quantity of the product.
shipTo	string	The shipping destination.
Status	string	The status of the order.
ExpectedDeliveryDate	string	The expected delivery date.
TrackingNo	string	The tracking number.
suborder_order_number	string	The suborder order number.
FullName	string	The full name of the user.
days_in_cycle	integer	The number of days in the cycle.
assign_to_id	integer	The ID of the assignee.
ProductsAncOrderRequest_id	integer	The ID of the product.
Broker_id	integer	The ID of the broker.
totalElements	integer	The total number of supply requests.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/supply_requests/?page=&pageSize=&filter=&sort=

URI Parameters

HideShow

page: number (optional)
The page number.
pageSize: number (optional)
The number of items per page.
filter: string (optional)
The filter criteria.
sort: string (optional)
The sort criteria.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 2080,
      "OrderNumber": "939-S_1",
      "DateSubmitted": "07/15/2024",
      "ReceiveOrderBy": "07/16/2024",
      "Broker_Name": "Company A",
      "ProductItem": "23001",
      "GeneralDescription": "05 Gallon, Poly Pail, Open Top with Screw Top Lid (Black)",
      "Quantity": 50,
      "shipTo": "Texas",
      "Status": "Confirmed",
      "ExpectedDeliveryDate": "",
      "TrackingNo": null,
      "suborder_order_number": "",
      "FullName": "Jane Doe",
      "days_in_cycle": 8,
      "assign_to_id": 737,
      "ProductsAncOrderRequest_id": 972,
      "Broker_id": 32
    }
  ],
  "totalElements": 22
}

order_detail_assign ¶

order_detail_assign
POST`/api/dashboard/supply_requests/order_detail/assign/`

Overview

This endpoint is designed to assign a supply request to a specific user. It allows users to assign a supply request to a user, ensuring that the request is managed and processed effectively. The endpoint supports the assignment of supply requests, enabling users to streamline their compliance management processes and ensure that all supply requests are addressed promptly and accurately. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring that all supply requests are assigned and processed in a timely manner.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
message	string	The message.
user_id	integer	The ID of the user.
order_id	integer	The ID of the order.

Example URI

POST https://test-api.wastelinq.com./api/dashboard/supply_requests/order_detail/assign/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "userId": 353,
  "orderId": 2021
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "message": "Successfully"
}

order_detail_set_waste_order ¶

order_detail_set_waste_order
POST`/api/dashboard/supply_requests/order_detail/set_waste_order/`

Overview

This endpoint is designed to set a supply request as a waste order. It allows users to set a supply request as a waste order, ensuring that the request is managed and processed effectively. The endpoint supports the setting of supply requests as waste orders, enabling users to streamline their compliance management processes and ensure that all supply requests are addressed promptly and accurately. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring that all supply requests are processed in a timely manner.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
message	string	The message.
supplyOrderId	integer	The ID of the supply order.
custOrderId	integer	The ID of the customer order.

Example URI

POST https://test-api.wastelinq.com./api/dashboard/supply_requests/order_detail/set_waste_order/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "supplyOrderId": 2021,
  "custOrderId": 377459
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "message": "Successfully"
}

Dashboard Profile Approvals APIs ¶

filter_disposal_facility ¶

filter_disposal_facility
GET`/api/dashboard/filter/disposal_facility/`

Overview

This endpoint is designed to retrieve a list of disposal facilities for filtering purposes. It allows users to access the list of disposal facilities, enabling them to filter and search for specific disposal facilities effectively. The endpoint supports the retrieval of disposal facilities, enabling users to manage their environmental compliance tasks efficiently and effectively. This functionality is crucial for users seeking to filter and search for disposal facilities based on their specific requirements and preferences.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of disposal facilities.
id	integer	The ID of the disposal facility.
Name	string	The name of the disposal facility.
totalElements	integer	The total number of disposal facilities.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/filter/disposal_facility/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 21315,
      "Name": "Company A"
    }
  ],
  "totalElements": 298
}

profile_approvals ¶

profile_approvals
GET`/api/dashboard/profile_approvals/{?page,pageSize,selectedFields,filter,sort}`

Overview

This endpoint is designed to retrieve a list of profile approvals that require user attention. It allows users to access detailed information about the profile approvals, including the profile ID, profile category, date submitted, bill-to name, customer name, profile number, profile name, high priority status, disposal facility name, approval number, primary status, recertification change status, approval status, days submitted, days since the last status change, assignee name, customer ID, assignee ID, ER authorization status, ID, template automatic approval status, ESC certification status, and hours since the profile was submitted. The endpoint supports the retrieval of profile approvals that are pending, in progress, or completed, enabling users to track the progress of their profile approvals effectively. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring timely responses to profile approvals and effective communication with waste management service providers.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of profile approvals.
profile_id	integer	The ID of the profile.
profile_category	string	The category of the profile.
date_submitted	string	The date the profile was submitted.
bill_to_name	string	The name of the bill-to customer.
customer_name	string	The name of the customer.
profile_number	integer	The profile number.
profile_name	string	The name of the profile.
high_priority	string	The high priority status of the profile.
disposalFacility_name	string	The name of the disposal facility.
approval_number	string	The approval number.
is_primary	string	The primary status of the profile.
re_cert_change_status	string	The recertification change status of the profile.
approval_status	string	The approval status of the profile.
days_submitted	string	The number of days since the profile was submitted.
days_last_status_change	string	The number of days since the last status change.
assign_to_name	string	The name of the assignee.
customer_id	integer	The ID of the customer.
assign_to_id	string	The ID of the assignee.
is_er_authorization	string	The ER authorization status of the profile.
id	integer	The ID of the profile.
template_automaticApproval	integer	The template automatic approval status of the profile.
esc_certified	boolean	The ESC certification status of the profile.
hours_submitted	integer	The number of hours since the profile was submitted.
totalElements	integer	The total number of profile approvals.

Example URI

GET https://test-api.wastelinq.com./api/dashboard/profile_approvals/?page=&pageSize=&selectedFields=&filter=&sort=

URI Parameters

HideShow

page: number (optional)
The page number.
pageSize: number (optional)
The number of items per page.
selectedFields: string (optional)
The selected fields.
filter: string (optional)
The filter criteria.
sort: string (optional)
The sort criteria.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    "success": true,
    "content": [
        {
            "profile_id": 268361,
            "profile_category": "New Profile from ESC",
            "date_submitted": "09/03/2023",
            "bill_to_name": "Company A",
            "customer_name": "Company A",
            "profile_number": 169859,
            "profile_name": "Expired Raw Material",
            "high_priority": "No",
            "disposalFacility_name": "Facility A",
            "approval_number": "22222",
            "is_primary": "Yes",
            "re_cert_change_status": "Non-Renewal",
            "aproval_status": "Approved",
            "days_submitted": "325",
            "days_last_status_change": "303",
            "assign_to_name": "",
            "customer_id": 73321,
            "assign_to_id": "",
            "is_er_authorization": "No",
            "id": 286218,
            "template_automaticApproval": 0,
            "esc_certified": true,
            "hours_submitted": 7811
        },
            ],
    "totalElements": 298
}

change_category ¶

change_category
POST`/api/dashboard/change_category/`

Overview

This endpoint is designed to change the category of a profile. It allows users to update the category of a profile, ensuring that the profile is managed and processed effectively. The endpoint supports the change of profile categories, enabling users to streamline their compliance management processes and ensure that all profiles are categorized accurately. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring that all profiles are categorized correctly based on their specific requirements and preferences.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
profileId	integer	The ID of the profile.
categoryValue	string	The category value.

Example URI

POST https://test-api.wastelinq.com./api/dashboard/change_category/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "profileId": 268362,
  "categoryValue": "Optimization"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true
}

assignedto_profile ¶

assignedto_profile
POST`/api/dashboard/assignedto_profile/`

Overview

This endpoint is designed to assign a profile to a specific user. It allows users to assign a profile to a user, ensuring that the profile is managed and processed effectively. The endpoint supports the assignment of profiles, enabling users to streamline their compliance management processes and ensure that all profiles are assigned promptly and accurately. This functionality is crucial for users seeking to manage their environmental compliance tasks efficiently, ensuring that all profiles are assigned and processed in a timely manner.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
contactId	integer	The ID of the contact.
profileId	integer	The ID of the profile.
tsdfId	integer	The ID of the TSDF.

Example URI

POST https://test-api.wastelinq.com./api/dashboard/assignedto_profile/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "contactId": 252,
  "profileId": 268362,
  "tsdfId": 286219
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true
}

Menu ¶

Other APIs docs ¶

Overview ¶

Bearer Token ¶

Error Messages ¶

Dashboard Filter APIs ¶

filter_acc_assign ¶

filter_acc_assignGET/api/dashboard/filter/acc_assign/

Overview ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

filter_sales_contact ¶

filter_sales_contactGET/api/dashboard/filter/sales_contact/

Overview ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

filter_order_creator ¶

filter_order_creatorGET/api/dashboard/filter/order_creator/

Overview ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

Dashboard ESC & Grid Widgets APIs ¶

list_esc_grid ¶

list_esc_gridGET/api/dashboard/list_esc_grid

Overview ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

notification_price_requests ¶

notification_price_requestsGET/api/dashboard/esc/notification/price_requests/{?page,pageSize}

Overview ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

notification_inventory ¶

notification_inventoryGET/api/dashboard/esc/notification/inventory/{?page,pageSize}

Overview ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

notification_orders ¶

notification_ordersGET/api/dashboard/esc/notification/orders/{?page,pageSize}

Overview ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

notification_user_messages ¶

notification_user_messagesGET/api/dashboard/esc/notification/user_messages/

Overview ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

notification_profile ¶

notification_profileGET/api/dashboard/esc/notification/profile/{?page,pageSize,filter}

Overview ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

inventory ¶

Other APIs docs

Bearer Token

Error Messages

filter_acc_assign
GET`/api/dashboard/filter/acc_assign/`

Overview

Request Body and Response Description:

filter_sales_contact
GET`/api/dashboard/filter/sales_contact/`

Overview

Request Body and Response Description:

filter_order_creator
GET`/api/dashboard/filter/order_creator/`

Overview

Request Body and Response Description:

list_esc_grid
GET`/api/dashboard/list_esc_grid`

Overview

Request Body and Response Description:

notification_price_requests
GET`/api/dashboard/esc/notification/price_requests/{?page,pageSize}`

Overview

Request Body and Response Description:

notification_inventory
GET`/api/dashboard/esc/notification/inventory/{?page,pageSize}`

Overview

Request Body and Response Description:

notification_orders
GET`/api/dashboard/esc/notification/orders/{?page,pageSize}`

Overview

Request Body and Response Description:

notification_user_messages
GET`/api/dashboard/esc/notification/user_messages/`

Overview

Request Body and Response Description:

notification_profile
GET`/api/dashboard/esc/notification/profile/{?page,pageSize,filter}`

Overview

Request Body and Response Description:

inventory
GET`/api/dashboard/esc/inventory/{?page,pageSize,filter,sort}`

Overview

Request Body and Response Description:

outbound_shipments
GET`/api/dashboard/esc/outbound_shipments/{?page,pageSize,filter,sort}`

Overview

Request Body and Response Description:

profiles
GET`/api/dashboard/esc/profiles/{?page,pageSize,filter,sort}`

Overview

Request Body and Response Description:

update_serialized_data
POST`/api/dashboard/grid_widget/update_serialized_data/`

Overview

Request Body and Response Description:

get_serialized_data
GET`/api/dashboard/grid_widget/get_serialized_data/`

Overview

Request Body and Response Description:

profile_acknowledge_all
GET`/api/dashboard/esc/notification/profile/acknowledge_all/?{filters}`

Overview

Request Body and Response Description:

orders_acknowledge_all
PUT`/api/dashboard/esc/notification/orders/acknowledge_all/`

Overview

Request Body and Response Description:

esignature_request
GET`/api/dashboard/esignature_request/?{page,pageSize,selectedField,filter}`

Overview

Request Body and Response Description:

view_sign_documents
GET`/api/dashboard/view_sign_documents/{?id}`

Overview

Request Body and Response Description: