Back to top

Waste Tracking APIs

Overview

The Waste Tracking API is a RESTful web service that allows you to interact with the Waste Tracking platform programmatically. You can use the API to access and manage data related to waste tracking, including contacts, facilities, shipments, and more. The API provides endpoints for retrieving, creating, updating, and deleting data, as well as for performing various other operations. This documentation provides detailed information about the API endpoints, request and response formats, and authentication requirements.

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.

Waste Tracking

ten_day_waste_tracking

ten_day_waste_tracking
GET/api/waste_tracking/ten_day_waste_tracking/

Overview:

The ten_day_waste_tracking endpoint, accessible at /api/waste_tracking/ten_day_waste_tracking, is a GET request that is used to retrieve the ten-day waste tracking information.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the waste tracking information.
id number The unique identifier for the waste tracking information.
broker_name string The name of the broker.
suborder_number string The sub-order number.
network_order string The network order.
is_network boolean Indicates whether the order is a network order.
enterprise_or_network string The enterprise or network.
mainfest_number string The manifest number.
line_number string The line number.
gen_name string The generator name.
line_status_name string The line status name.
network_requested_date string The network requested date.
network_logistics_type string The network logistics type.
profile_name string The profile name.
cont_type string The container type.
cont_size string The container size.
cont_cnt number The container count.
total_weight string The total weight.
days_in_inventory number The number of days in inventory.
ten_day_start_date string The ten-day start date.
waste_class string The waste class.
tsdf_name string The TSDF name.
movements_displaying_txt string The movements displaying text.
detail_displaying_txt string The detail displaying text.
wmpc_id number The WMP ID.
approval_number string The approval number.
line_color string The line color.
totalElements number The total number of elements.

Example URI

GET [Waste Tracking APIs](https://test-api.wastelinq.com)./api/waste_tracking/ten_day_waste_tracking/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1,
      "broker_name": "Company ABC",
      "suborder_number": "495555",
      "network_order": null,
      "is_network": false,
      "enterprise_or_network": "Enterprise",
      "mainfest_number": "22222",
      "line_number": "1",
      "gen_name": "Company ABC",
      "line_status_name": "Reconciled",
      "network_requested_date": "05/10/2023",
      "network_logistics_type": null,
      "profile_name": "OILY RAGS, Pads, Organic Debris",
      "cont_type": "DM",
      "cont_size": "55",
      "cont_cnt": 1,
      "total_weight": "502.7",
      "days_in_inventory": 461,
      "ten_day_start_date": "05/10/2023",
      "waste_class": "USED OIL",
      "tsdf_name": "Company ABC",
      "movements_displaying_txt": "Movements",
      "detail_displaying_txt": "Detail",
      "wmpc_id": 1020067,
      "approval_number": "",
      "line_color": "red"
    }
  ],
  "totalElements": 1333
}

filter_waste_receipt_summary_report

filter_waste_receipt_summary_report
GET/api/reporting/filter/filter_waste_receipt_summary_report

Overview:

The filter_waste_receipt_summary_report endpoint, accessible at /api/reporting/filter/filter_waste_receipt_summary_report, is a GET request that is used to retrieve the waste receipt summary report filters.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
facilities array An array containing the facilities.
id number The unique identifier for the facility.
Name string The name of the facility.
warehouses array An array containing the warehouses.
id number The unique identifier for the warehouse.
Name string The name of the warehouse.
tsdfs array An array containing the TSDFs.
tsdfs_id number The unique identifier for the TSDF.
Name string The name of the TSDF.
lineStatus array An array containing the line statuses.
id number The unique identifier for the line status.
Name string The name of the line status.

Example URI

GET [Waste Tracking APIs](https://test-api.wastelinq.com)./api/reporting/filter/filter_waste_receipt_summary_report
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "facilities": [
    {
      "id": 345,
      "Name": "Company ABCA"
    }
  ],
  "warehouses": [
    {
      "id": 45,
      "Name": "Company ABCB"
    }
  ],
  "tsdfs": [
    {
      "tsdfs_id": 12194,
      "Name": "Company ABCC"
    }
  ],
  "lineStatus": [
    {
      "id": 1014,
      "Name": "Pending WLQ Transfer"
    }
  ]
}

mmpsInventoryAvailableProcessingInit

mmpsInventoryAvailableProcessingInit
GET/api/wastetracking/mmps/mmpsInventoryAvailableProcessingInit/

Overview:

The mmpsInventoryAvailableProcessingInit endpoint, accessible at /api/wastetracking/mmps/mmpsInventoryAvailableProcessingInit, is a GET request that is used to retrieve the available processing information for the MMPs.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the available processing information for the MMPs.
mmp_list array An array containing the MMPs.
mmp_id number The unique identifier for the MMP.
name string The name of the MMP.
tsdf_list array An array containing the TSDFs.
tsdf_id number The unique identifier for the TSDF.
name string The name of the TSDF.
storageLocationList array An array containing the storage locations.
id number The unique identifier for the storage location.
name string The name of the storage location.

Example URI

GET [Waste Tracking APIs](https://test-api.wastelinq.com)./api/wastetracking/mmps/mmpsInventoryAvailableProcessingInit/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "mmp_list": [
      {
        "mmp_id": 186,
        "name": "UWP Aerosols"
      }
    ],
    "tsdf_list": [
      {
        "tsdf_id": 12194,
        "name": "Company ABC"
      }
    ],
    "storageLocationList": [
      {
        "id": 181,
        "name": "test"
      }
    ]
  }
}

getDataWeightGrade

getDataWeightGrade
POST/api/wastetracking/mmps/mmpsInventoryAvailableProcessing/getDataWeightGrade

Overview:

The getDataWeightGrade endpoint is a POST request that retrieves the available processing information for the MMPs. This endpoint specifically focuses on retrieving the data related to weight and grade for the MMPs.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the available processing information for the MMPs.
details array An array containing the details of the MMPs.
order_number number The order number of the MMP.
tsdf_association string The TSDF association of the MMP.
generator string The generator of the MMP.
inventory_start_date string The inventory start date of the MMP.
manifest_number string The manifest number of the MMP.
order_waste_product_code string The order waste product code of the MMP.
re_class_wpc string The RE class WPC of the MMP.
re_class_id string The RE class ID of the MMP.
profile_name string The profile name of the MMP.
profile_id number The profile ID of the MMP.
mmp_assignment string The MMP assignment of the MMP.
mmp_assignment_id string The MMP assignment ID of the MMP.
container_type string The container type of the MMP.
container_size string The container size of the MMP.
container_id_number string The container ID number of the MMP.
storage_location string The storage location of the MMP.
actual_weight string The actual weight of the MMP.
grade string The grade of the MMP.
current_volume number The current volume of the MMP.
current_weight number The current weight of the MMP.
wasteMaterialPickup_content_id number The waste material pickup content ID of the MMP.
id string The unique identifier for the detail of the MMP.
totalElements number The total number of elements in the response.
page number The page number of the response.
pageSize number The page size of the response.
tsdf string The TSDF of the MMP.
mmp string The MMP.
storage string The storage of the MMP.

Example URI

POST [Waste Tracking APIs](https://test-api.wastelinq.com)./api/wastetracking/mmps/mmpsInventoryAvailableProcessing/getDataWeightGrade
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "page": 0,
  "pageSize": 1,
  "tsdf": "",
  "mmp": "",
  "storage": ""
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "details": [
      {
        "order_number": 550485,
        "tsdf_association": "",
        "generator": "",
        "inventory_start_date": "2023-12-13",
        "manifest_number": "22222",
        "order_waste_product_code": "7202",
        "re_class_wpc": "",
        "re_class_id": "",
        "profile_name": "Spent Electropolish Solution",
        "profile_id": 187801,
        "mmp_assignment": "",
        "mmp_assignment_id": "",
        "container_type": "TP",
        "container_size": "330",
        "container_id_number": "22222-1-12",
        "storage_location": "",
        "actual_weight": "",
        "grade": "",
        "current_volume": 275,
        "current_weight": 0,
        "wasteMaterialPickup_content_id": 1150536,
        "id": "2622141"
      }
    ],
    "totalElements": 287
  }
}

MMPBulkBatchesInit

MMPBulkBatchesInit
GET/api/wastetracking/mmps/MMPBulkBatchesInit/

Overview:

The MMPBulkBatchesInit endpoint is a GET request that retrieves the available processing information for the MMPs in the MMPBulkBatches API.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the available processing information for the MMPs.
processcodedefinitions array An array containing the process code definitions.
id number The unique identifier for the process code definition.
tsdf_process_id string The TSDF process ID.
tsdf_process_definition string The TSDF process definition.
facility array An array containing the facilities.
facility_id number The unique identifier for the facility.
facility_name string The name of the facility.

Example URI

GET [Waste Tracking APIs](https://test-api.wastelinq.com)./api/wastetracking/mmps/MMPBulkBatchesInit/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "processcodedefinitions": [
      {
        "id": 177,
        "tsdf_process_id": "UWP 500",
        "tsdf_process_definition": "UWPRM Reroute"
      }
    ],
    "facility": [
      {
        "facility_id": 70,
        "facility_name": "Company ABC"
      }
    ]
  }
}

get_assigned_weight_grade_list_process_batch

get_assigned_weight_grade_list_process_batch
GET/api/wastetracking/mmps/MMPBulkBatches/get_assigned_weight_grade_list_process_batch{?batch}

Overview:

The get_assigned_weight_grade_list_process_batch endpoint is a GET request that retrieves the assigned weight and grade list for a specific batch in the MMPBulkBatches API.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the assigned weight and grade information for the MMPs.
details array An array containing the details.

Example URI

GET [Waste Tracking APIs](https://test-api.wastelinq.com)./api/wastetracking/mmps/MMPBulkBatches/get_assigned_weight_grade_list_process_batch?batch=
URI Parameters
HideShow
batch
string (required) 

The batch.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "details": []
  }
}

MMPBulkBatches

MMPBulkBatches
POST/api/wastetracking/mmps/MMPBulkBatches

Overview:

The MMPBulkBatches endpoint is a POST request that retrieves the available processing information for the MMPs related to bulk batches.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the available processing information for the MMPs.
details array An array containing the details.
id number The unique identifier for the detail.
facility string The facility.
bulk_location string The bulk location.
batch_version number The batch version.
mmp string The MMP.
containers string The containers.
is_completed boolean Indicates whether the batch is completed.
created_date string The created date.
date_completed string The date completed.
process_code_definition_id number The process code definition ID.
storage_location_id string The storage location ID.
display_closed_batches boolean Indicates whether the closed batches are displayed.
totalElements number The total number of elements.

Example URI

POST [Waste Tracking APIs](https://test-api.wastelinq.com)./api/wastetracking/mmps/MMPBulkBatches
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "page": 0,
  "pageSize": 15,
  "facility_id": "",
  "mmp_id": "",
  "display_closed_batches": false
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "details": [
      {
        "id": 153,
        "facility": "",
        "bulk_location": "",
        "batch_version": 1,
        "mmp": "UWP 502",
        "containers": null,
        "is_completed": false,
        "created_date": "04-12-2023",
        "date_completed": "",
        "process_code_definition_id": 182,
        "storage_location_id": null
      }
    ],
    "display_closed_batches": false,
    "totalElements": 11
  }
}

MMPDecantOrConsolidationProcessTrackingInit

MMPDecantOrConsolidationProcessTrackingInit
GET/api/wastetracking/mmps/MMPDecantOrConsolidationProcessTrackingInit/

Overview:

The MMPDecantOrConsolidationProcessTrackingInit endpoint is a GET request that retrieves the available processing information for the MMPs related to decant or consolidation processes.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the available processing information for the MMPs.
details array An array containing the details.

Example URI

GET [Waste Tracking APIs](https://test-api.wastelinq.com)./api/wastetracking/mmps/MMPDecantOrConsolidationProcessTrackingInit/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "details": []
  }
}

MMPRerouteProcessTrackingInit

MMPRerouteProcessTrackingInit
GET/api/wastetracking/mmps/MMPRerouteProcessTrackingInit/

Overview:

The MMPRerouteProcessTrackingInit endpoint is a GET request that retrieves the available processing information for the MMPs related to rerouting.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the available processing information for the MMPs.
cusList_reroute array An array containing the custom list for rerouting.
mmpList_reroute array An array containing the MMP list for rerouting.
manifestList_reroute array An array containing the manifest list for rerouting.
cusList_consolidation array An array containing the custom list for consolidation.
mmpList_consolidation array An array containing the MMP list for consolidation.
manifestList_consolidation an array An array containing the manifest list for consolidation.

Example URI

GET [Waste Tracking APIs](https://test-api.wastelinq.com)./api/wastetracking/mmps/MMPRerouteProcessTrackingInit/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "cusList_reroute": [],
    "mmpList_reroute": [],
    "manifestList_reroute": [],
    "cusList_consolidation": [],
    "mmpList_consolidation": [],
    "manifestList_consolidation": []
  }
}

manifest_process_tracking_reroute

manifest_process_tracking_reroute
GET/api/wastetracking/mmps/manifest_process_tracking_reroute/

Overview:

The manifest_process_tracking_reroute endpoint is a GET request that retrieves the manifest process tracking information for rerouting in the MMPs API.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the manifest process tracking information for rerouting.
display_title string The display title.
details array An array containing the details.

Example URI

GET [Waste Tracking APIs](https://test-api.wastelinq.com)./api/wastetracking/mmps/manifest_process_tracking_reroute/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "display_title": "",
    "details": []
  }
}

filter_facility

filter_facility
GET/api/reporting/filter/facility

Overview:

The filter_facility endpoint is a GET request that retrieves the facility filters for the Total Inventory report.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the facilities.
id number The unique identifier for the facility.
Name string The name of the facility.

Example URI

GET [Waste Tracking APIs](https://test-api.wastelinq.com)./api/reporting/filter/facility
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 71,
      "Name": "Company ABC"
    },
    {
      "id": 70,
      "Name": "Company ABCA"
    },
    {
      "id": 345,
      "Name": "Company ABCB"
    }
  ],
  "totalElements": 3
}

total_inventory

total_inventory
GET/api/waste_tracking/total_inventory/

Overview:

The total_inventory endpoint is a GET request that retrieves the total inventory information for the Total Inventory report.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the total inventory information.
id number The unique identifier for the total inventory information.
wmpc_id number The WMP ID.
broker_name string The name of the broker.
suborder_number string The sub-order number.
network_order string The network order.
is_network boolean Indicates whether the order is a network order.
enterprise_or_network string The enterprise or network.
line_number string The line number.
gen_name string The generator name.
line_status_name string The line status name.
network_requested_date string The network requested date.
network_logistics_type string The network logistics type.
profile_name string The profile name.
cont_type string The container type.
cont_size string The container size.
cont_cnt number The container count.
total_weight string The total weight.
days_in_inventory number The number of days in inventory.
ten_day_start_date string The ten-day start date.
waste_class string The waste class.
tsdf_name string The TSDF name.
movements_displaying_txt string The movements displaying text.
detail_displaying_txt string The detail displaying text.
line_color string The line color.
totalElements number The total number of elements.

Example URI

GET [Waste Tracking APIs](https://test-api.wastelinq.com)./api/waste_tracking/total_inventory/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 2,
      "wmpc_id": 1093381,
      "broker_name": "Company ABC",
      "suborder_number": "522089",
      "network_order": null,
      "is_network": false,
      "enterprise_or_network": "Enterprise",
      "line_number": "2",
      "gen_name": "Company ABC",
      "line_status_name": "Fully Scheduled Outbound",
      "network_requested_date": "09/22/2023",
      "network_logistics_type": null,
      "profile_name": "Sulfuric Acid Product",
      "cont_type": "DF",
      "cont_size": "5",
      "cont_cnt": 6,
      "total_weight": "270.0",
      "days_in_inventory": 327,
      "ten_day_start_date": "09/22/2023",
      "waste_class": "Recycle",
      "tsdf_name": "Interstate Oil",
      "movements_displaying_txt": "Movements",
      "detail_displaying_txt": "Detail",
      "line_color": "normal"
    }
  ],
  "totalElements": 1493
}

Generated by aglio on 19 Aug 2024