Back to top

Portal APIs (Part 2)

Overview

The Portal API is a set of RESTful web services that are used to interact with the WasteLinq Portal. The API provides endpoints for managing waste streams, waste profiles, waste management units, and supporting documentation. The API is secured using a bearer token, which is generated by the server in response to a login request.

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.

Portal Waste Characterization APIs

portal_waste_stream_name_description_add

portal_waste_stream_name_description_add
POST/api/portalweb/portal_waste_stream_name_description_add

Overview:

The portal_waste_stream_name_description_add endpoint, accessible at /api/portalweb/portal_waste_stream_name_description_add, is a POST request that is used to add a waste stream name and description.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the ID of the waste stream.
id number The ID of the waste stream.
Name string The name of the waste stream.
Description string The description of the waste stream.
ProcessGenerating string The process generating the waste stream.
DateGeneration string The date the waste stream was generated.
WasteProfile number The waste profile ID.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_waste_stream_name_description_add
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "Name": "test API",
  "id": 0,
  "Description": "test API",
  "ProcessGenerating": "test API",
  "DateGeneration": "2024-06-25",
  "WasteProfile": 0
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169
  }
}

portal_waste_stream_name_description

portal_waste_stream_name_description
GET/api/portalweb/portal_waste_stream_name_description{?fromProfile,id}

Overview:

The portal_waste_stream_name_description endpoint, accessible at /api/portalweb/portal_waste_stream_name_description, is a GET request that is used to get the waste stream name and description.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the waste stream name and description.
NameDescription object An object containing the waste stream name and description.
Name string The name of the waste stream.
id number The ID of the waste stream.
Description string The description of the waste stream.
ProcessGenerating string The process generating the waste stream.
DateGeneration string The date the waste stream was generated.
editable boolean Indicates whether the waste stream is editable.
WasteProfileList array An array of waste profiles associated with the waste stream.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_waste_stream_name_description?fromProfile=&id=
URI Parameters
HideShow
fromProfile
number (required) 

The waste profile ID.

id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "NameDescription": {
      "Name": "test API",
      "id": 169,
      "Description": "test API",
      "ProcessGenerating": "test API",
      "DateGeneration": "2024-06-25",
      "editable": true,
      "WasteProfileList": []
    }
  }
}

portal_filter_waste_management_unit

portal_filter_waste_management_unit
GET/api/portalweb/portal_filter_waste_management_unit

Overview:

The portal_filter_waste_management_unit endpoint, accessible at /api/portalweb/portal_filter_waste_management_unit, is a GET request that is used to filter waste management units.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of waste management units.
id number The ID of the waste management unit.
name string The name of the waste management unit.
totalElements number The total number of waste management units.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_filter_waste_management_unit
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 14,
      "name": "CONTAINER STORAGE AREA"
    },
    {
      "id": 15,
      "name": "Tank 8 replacement. 10,000 gallon carbon steel tank."
    }
  ],
  "totalElements": 2
}

portal_waste_stream_origin_storage

portal_waste_stream_origin_storage
GET/api/portalweb/portal_waste_stream_origin_storage{?id}

Overview:

The portal_waste_stream_origin_storage endpoint, accessible at /api/portalweb/portal_waste_stream_origin_storage, is a GET request that is used to get the origin storage of the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the origin storage of the waste stream.
OriginStorage object An object containing the origin storage of the waste stream.
Name string The name of the origin storage.
id number The ID of the origin storage.
OriginCode string The origin code of the origin storage.
EPAFormCode string The EPA form code of the origin storage.
EpaSourceCode string The EPA source code of the origin storage.
editable boolean Indicates whether the origin storage is editable.
wastemanaunitchecked array An array of waste management units associated with the origin storage.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_waste_stream_origin_storage?id=
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "OriginStorage": {
      "Name": "test API",
      "id": 169,
      "OriginCode": null,
      "EPAFormCode": null,
      "EpaSourceCode": null,
      "editable": true
    },
    "wastemanaunitchecked": []
  }
}

portal_waste_stream_origin_storage_update

portal_waste_stream_origin_storage_update
POST/api/portalweb/portal_waste_stream_origin_storage_update

Overview:

The portal_waste_stream_origin_storage_update endpoint, accessible at /api/portalweb/portal_waste_stream_origin_storage_update, is a POST request that is used to update the origin storage of the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the ID of the origin storage.
id number The ID of the origin storage.
Name string The name of the origin storage.
EPAFormCode string The EPA form code of the origin storage.
OriginCode string The origin code of the origin storage.
EpaSourceCode string The EPA source code of the origin storage.
wastemanaunitchecked array An array of waste management units associated with the origin storage.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_waste_stream_origin_storage_update
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "Name": "test API",
  "id": 169,
  "EPAFormCode": "W001 - LAB PACKS FROM any SOURCE NOT CONTAINING ACUTE HAZARDOUS WASTE",
  "OriginCode": "1 - Was generated on-site from a product or service activity.",
  "EpaSourceCode": "G01 - DIP, FLUSH, OR SPRAY RINSING",
  "wastemanaunitchecked": []
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169
  }
}

portal_waste_stream_supporting_documentation

portal_waste_stream_supporting_documentation
GET/api/portalweb/portal_waste_stream_supporting_documentation{?id}

Overview:

The portal_waste_stream_supporting_documentation endpoint, accessible at /api/portalweb/portal_waste_stream_supporting_documentation, is a GET request that is used to get the supporting documentation of the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the supporting documentation of the waste stream.
SupportingDocumentation object An object containing the supporting documentation of the waste stream.
Name string The name of the supporting documentation.
id number The ID of the supporting documentation.
WasteDeterminationBasedOnWasteAnalysis boolean Indicates whether the waste determination is based on waste analysis.
WasteDeterminationBasedOnGeneratorKnowledge boolean Indicates whether the waste determination is based on generator knowledge.
WasteDeterminationBasedOnSDS boolean Indicates whether the waste determination is based on SDS.
EvaluationDate string The evaluation date of the supporting documentation.
editable boolean Indicates whether the supporting documentation is editable.
WasteStreamFileList array An array of waste stream files associated with the supporting documentation.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_waste_stream_supporting_documentation?id=
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "SupportingDocumentation": {
      "Name": "test API",
      "id": 169,
      "WasteDeterminationBasedOnWasteAnalysis": false,
      "WasteDeterminationBasedOnGeneratorKnowledge": false,
      "WasteDeterminationBasedOnSDS": false,
      "EvaluationDate": null,
      "editable": true,
      "WasteStreamFileList": []
    }
  }
}

portal_waste_stream_supporting_documentation_update

portal_waste_stream_supporting_documentation_update
POST/api/portalweb/portal_waste_stream_supporting_documentation_update

Overview:

The portal_waste_stream_supporting_documentation_update endpoint, accessible at /api/portalweb/portal_waste_stream_supporting_documentation_update, is a POST request that is used to update the supporting documentation of the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the ID of the supporting documentation.
id number The ID of the supporting documentation.
Name string The name of the supporting documentation.
EvaluationDate string The evaluation date of the supporting documentation.
WasteDeterminationBasedOnGeneratorKnowledge boolean Indicates whether the waste determination is based on generator knowledge.
WasteDeterminationBasedOnWasteAnalysis boolean Indicates whether the waste determination is based on waste analysis.
WasteDeterminationBasedOnSDS boolean Indicates whether the waste determination is based on SDS.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_waste_stream_supporting_documentation_update
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "Name": "test API",
  "id": 169,
  "EvaluationDate": null,
  "WasteDeterminationBasedOnGeneratorKnowledge": true,
  "WasteDeterminationBasedOnWasteAnalysis": false,
  "WasteDeterminationBasedOnSDS": false
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169
  }
}

solid_waste_definition

solid_waste_definition
GET/api/portalweb/wastestreams/{id}/solid_waste_definition

Overview:

The solid_waste_definition endpoint, accessible at /api/portalweb/wastestreams/{id}/solid_waste_definition, is a GET request that is used to get the solid waste definition of the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the solid waste definition.
id number The waste stream ID.
editable boolean Indicates whether the solid waste definition is editable.
WCSolidWaste string The solid waste code.
WCSolidWasteComment string The solid waste comment.
WCUsedOil string The used oil code.
WCUsedOilCadmium2PPM string The used oil cadmium 2 PPM code.
WCUsedOilChromium5PPM string The used oil chromium 5 PPM code.
WCUsedOilArsenic5PPM string The used oil arsenic 5 PPM code.
WCUsedOilLead100PPM string The used oil lead 100 PPM code.
WCUsedOilFlashpoint100F string The used oil flashpoint 100 F code.
WCUsedOilHalogen4000PPM string The used oil halogen 4000 PPM code.
WCHazardousWaste string The hazardous waste code.
WCTexas string The Texas code.
WCTexasYes string The Texas yes code.
WCUsedOilTotalHalogene string The used oil total halogene code.
WCUsedOilChlorinatedConstituent string The used oil chlorinated constituent code.
WCUsedOilRebutPresumption string The used oil rebut presumption code.
WCUniversalWaste string The universal waste code.
UniversalWaste string The universal waste.
federal_universal_waste_type string The federal universal waste type.
StateUniversalWaste string The state universal waste code.
UniversalWasteType string The universal waste type.
RecycleReuse string The recycle reuse code.
ProductCoProduct string The product co-product code.
MedicalWaste string The medical waste code.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/wastestreams/id/solid_waste_definition
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169,
    "editable": true,
    "WCSolidWaste": null,
    "WCSolidWasteComment": null,
    "WCUsedOil": null,
    "WCUsedOilCadmium2PPM": null,
    "WCUsedOilChromium5PPM": null,
    "WCUsedOilArsenic5PPM": null,
    "WCUsedOilLead100PPM": null,
    "WCUsedOilFlashpoint100F": null,
    "WCUsedOilHalogen4000PPM": null,
    "WCHazardousWaste": null,
    "WCTexas": null,
    "WCTexasYes": null,
    "WCUsedOilTotalHalogene": null,
    "WCUsedOilChlorinatedConstituent": null,
    "WCUsedOilRebutPresumption": null,
    "WCUniversalWaste": null,
    "UniversalWaste": null,
    "federal_universal_waste_type": null,
    "StateUniversalWaste": null,
    "UniversalWasteType": null,
    "RecycleReuse": null,
    "ProductCoProduct": null,
    "MedicalWaste": null
  }
}

solid_waste_definition_update

solid_waste_definition_update
POST/api/portalweb/wastestreams/{id}/solid_waste_definition/update

Overview:

The solid_waste_definition_update endpoint, accessible at /api/portalweb/wastestreams/{id}/solid_waste_definition/update, is a POST request that is used to update the solid waste definition of the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the solid waste definition.
id number The waste stream ID.
editable boolean Indicates whether the solid waste definition is editable.
WCSolidWaste string The solid waste code.
WCSolidWasteComment string The solid waste comment.
WCUsedOil string The used oil code.
WCUsedOilCadmium2PPM string The used oil cadmium 2 PPM code.
WCUsedOilChromium5PPM string The used oil chromium 5 PPM code.
WCUsedOilArsenic5PPM string The used oil arsenic 5 PPM code.
WCUsedOilLead100PPM string The used oil lead 100 PPM code.
WCUsedOilFlashpoint100F string The used oil flashpoint 100 F code.
WCUsedOilHalogen4000PPM string The used oil halogen 4000 PPM code.
WCHazardousWaste string The hazardous waste code.
WCTexas string The Texas code.
WCTexasYes string The Texas yes code.
WCUsedOilTotalHalogene string The used oil total halogene code.
WCUsedOilChlorinatedConstituent string The used oil chlorinated constituent code.
WCUsedOilRebutPresumption string The used oil rebut presumption code.
WCUniversalWaste string The universal waste code.
UniversalWaste string The universal waste.
federal_universal_waste_type string The federal universal waste type.
StateUniversalWaste string The state universal waste code.
UniversalWasteType string The universal waste type.
RecycleReuse string The recycle reuse code.
ProductCoProduct string The product co-product code.
MedicalWaste string The medical waste code.
WCUsWCUsedOilCadmium2PPMedOil string The used oil cadmium 2 PPM code.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/wastestreams/id/solid_waste_definition/update
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 169,
  "editable": true,
  "WCSolidWaste": "no",
  "WCSolidWasteComment": "",
  "WCUsedOil": "yes",
  "WCUsedOilCadmium2PPM": "yes",
  "WCUsedOilChromium5PPM": "yes",
  "WCUsedOilArsenic5PPM": "yes",
  "WCUsedOilLead100PPM": "yes",
  "WCUsedOilFlashpoint100F": "yes",
  "WCUsedOilHalogen4000PPM": "yes",
  "WCHazardousWaste": "",
  "WCTexas": "",
  "WCTexasYes": "",
  "WCUsedOilTotalHalogene": "yes",
  "WCUsedOilChlorinatedConstituent": "yes",
  "WCUsedOilRebutPresumption": "yes",
  "WCUniversalWaste": "",
  "UniversalWaste": "yes",
  "federal_universal_waste_type": "1",
  "StateUniversalWaste": "yes",
  "UniversalWasteType": "1",
  "RecycleReuse": "no",
  "ProductCoProduct": "yes",
  "MedicalWaste": "yes",
  "WCUsWCUsedOilCadmium2PPMedOil": ""
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169,
    "editable": true,
    "WCSolidWaste": "no",
    "WCSolidWasteComment": "",
    "WCUsedOil": "yes",
    "WCUsedOilCadmium2PPM": "yes",
    "WCUsedOilChromium5PPM": "yes",
    "WCUsedOilArsenic5PPM": "yes",
    "WCUsedOilLead100PPM": "yes",
    "WCUsedOilFlashpoint100F": "yes",
    "WCUsedOilHalogen4000PPM": "yes",
    "WCHazardousWaste": null,
    "WCTexas": null,
    "WCTexasYes": null,
    "WCUsedOilTotalHalogene": "yes",
    "WCUsedOilChlorinatedConstituent": "yes",
    "WCUsedOilRebutPresumption": "yes",
    "WCUniversalWaste": null,
    "UniversalWaste": "yes",
    "federal_universal_waste_type": "1",
    "StateUniversalWaste": "yes",
    "UniversalWasteType": "1",
    "RecycleReuse": "no",
    "ProductCoProduct": "yes",
    "MedicalWaste": "yes"
  }
}

solid_waste_exclusion

solid_waste_exclusion
GET/api/portalweb/wastestreams/{id}/solid_waste_exclusion

Overview:

The solid_waste_exclusion endpoint, accessible at /api/portalweb/wastestreams/{id}/solid_waste_exclusion, is a GET request that is used to get the solid waste exclusion of the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the solid waste exclusion.
id number The waste stream ID.
WCHazardous string The hazardous waste code.
WCHazardousComment string The hazardous waste comment.
editable boolean Indicates whether the solid waste exclusion is editable.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/wastestreams/id/solid_waste_exclusion
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169,
    "WCHazardous": null,
    "WCHazardousComment": null,
    "editable": true
  }
}

solid_waste_exclusion_update

solid_waste_exclusion_update
POST/api/portalweb/wastestreams/{id}/solid_waste_exclusion/update

Overview:

The solid_waste_exclusion_update endpoint, accessible at /api/portalweb/wastestreams/{id}/solid_waste_exclusion/update, is a POST request that is used to update the solid waste exclusion of the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the solid waste exclusion.
id number The waste stream ID.
WCHazardous string The hazardous waste code.
WCHazardousComment string The hazardous waste comment.
editable boolean Indicates whether the solid waste exclusion is editable.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/wastestreams/id/solid_waste_exclusion/update
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 169,
  "WCHazardous": "yes",
  "WCHazardousComment": "§261.4(a)(1) - Domestic Sewage and Mixtures of Domestic Sewage",
  "editable": true
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169,
    "WCHazardous": "yes",
    "WCHazardousComment": "§261.4(a)(1) - Domestic Sewage and Mixtures of Domestic Sewage",
    "editable": true
  }
}

epa_codes_listed

epa_codes_listed
GET/api/portalweb/wastestreams/{id}/epa_codes_listed

Overview:

The epa_codes_listed endpoint, accessible at /api/portalweb/wastestreams/{id}/epa_codes_listed, is a GET request that is used to get the EPA codes listed for the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the EPA codes listed.
id number The waste stream ID.
WCHazardousF string The hazardous waste code.
WCHazardousFYes array An array of hazardous waste codes.
WCHazardousK string The hazardous waste code.
WCHazardousKYes array An array of hazardous waste codes.
WCHazardousP string The hazardous waste code.
WCHazardousPYes array An array of hazardous waste codes.
WCHazardousU string The hazardous waste code.
WCHazardousUYes array An array of hazardous waste codes.
WCHazardousWaste string The hazardous waste code.
WCSolidWaste string The solid waste code.
editable boolean Indicates whether the EPA codes listed are editable.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/wastestreams/id/epa_codes_listed
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169,
    "WCHazardousF": "no",
    "WCHazardousFYes": [],
    "WCHazardousK": "no",
    "WCHazardousKYes": [],
    "WCHazardousP": "no",
    "WCHazardousPYes": [],
    "WCHazardousU": "no",
    "WCHazardousUYes": [],
    "WCHazardousWaste": null,
    "WCSolidWaste": "no",
    "editable": true
  }
}

epa_codes_listed_update

epa_codes_listed_update
POST/api/portalweb/wastestreams/{id}/epa_codes_listed/update

Overview:

The epa_codes_listed_update endpoint, accessible at /api/portalweb/wastestreams/{id}/epa_codes_listed/update, is a POST request that is used to update the EPA codes listed for the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the EPA codes listed.
id number The waste stream ID.
WCHazardousF string The hazardous waste code.
WCHazardousFYes array An array of hazardous waste codes.
WCHazardousK string The hazardous waste code.
WCHazardousKYes array An array of hazardous waste codes.
WCHazardousP string The hazardous waste code.
WCHazardousPYes array An array of hazardous waste codes.
WCHazardousU string The hazardous waste code.
WCHazardousUYes array An array of hazardous waste codes.
WCHazardousWaste string The hazardous waste code.
WCSolidWaste string The solid waste code.
editable boolean Indicates whether the EPA codes listed are editable.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/wastestreams/id/epa_codes_listed/update
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 169,
  "WCHazardousF": "no",
  "WCHazardousFYes": [],
  "WCHazardousK": "no",
  "WCHazardousKYes": [],
  "WCHazardousP": "no",
  "WCHazardousPYes": [],
  "WCHazardousU": "no",
  "WCHazardousUYes": [],
  "WCHazardousWaste": "",
  "WCSolidWaste": "no",
  "editable": true
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169,
    "WCHazardousF": "no",
    "WCHazardousFYes": [],
    "WCHazardousK": "no",
    "WCHazardousKYes": [],
    "WCHazardousP": "no",
    "WCHazardousPYes": [],
    "WCHazardousU": "no",
    "WCHazardousUYes": [],
    "editable": true
  }
}

epa_codes_uhc

epa_codes_uhc
GET/api/portalweb/wastestreams/{id}/epa_codes_uhc

Overview:

The epa_codes_uhc endpoint, accessible at /api/portalweb/wastestreams/{id}/epa_codes_uhc, is a GET request that is used to get the EPA codes UHC for the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the EPA codes UHC.
id number The waste stream ID.
WCHazardousIgnitable string The hazardous ignitable code.
WCHazardousCorrosive string The hazardous corrosive code.
WCHazardousReactive string The hazardous reactive code.
WCHazardousToxic string The hazardous toxic code.
WCHazardousToxicYes array An array of hazardous toxic codes.
WCHazardousUHC string The hazardous UHC code.
WCHazardousUHCYes array An array of hazardous UHC codes.
WCHazardousWaste string The hazardous waste code.
WCSolidWaste string The solid waste code.
editable boolean Indicates whether the EPA codes UHC are editable.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/wastestreams/id/epa_codes_uhc
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169,
    "WCHazardousIgnitable": "no",
    "WCHazardousCorrosive": "no",
    "WCHazardousReactive": "no",
    "WCHazardousToxic": "no",
    "WCHazardousToxicYes": [],
    "WCHazardousUHC": null,
    "WCHazardousUHCYes": [],
    "WCHazardousWaste": null,
    "WCSolidWaste": "no",
    "editable": true
  }
}

epa_codes_uhc_update

epa_codes_uhc_update
POST/api/portalweb/wastestreams/{id}/epa_codes_uhc/update

Overview:

The epa_codes_uhc_update endpoint, accessible at /api/portalweb/wastestreams/{id}/epa_codes_uhc/update, is a POST request that is used to update the EPA codes UHC for the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the EPA codes UHC.
id number The waste stream ID.
WCHazardousIgnitable string The hazardous ignitable code.
WCHazardousCorrosive string The hazardous corrosive code.
WCHazardousReactive string The hazardous reactive code.
WCHazardousToxic string The hazardous toxic code.
WCHazardousToxicYes array An array of hazardous toxic codes.
WCHazardousUHC string The hazardous UHC code.
WCHazardousUHCYes array An array of hazardous UHC codes.
WCHazardousWaste string The hazardous waste code.
WCSolidWaste string The solid waste code.
editable boolean Indicates whether the EPA codes UHC are editable.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/wastestreams/id/epa_codes_uhc/update
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 169,
  "WCHazardousIgnitable": "yes",
  "WCHazardousCorrosive": "no",
  "WCHazardousReactive": "no",
  "WCHazardousToxic": "no",
  "WCHazardousToxicYes": [],
  "WCHazardousUHC": "no",
  "WCHazardousUHCYes": [],
  "WCHazardousWaste": "",
  "WCSolidWaste": "no",
  "editable": true
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169,
    "WCHazardousIgnitable": "yes",
    "WCHazardousCorrosive": "no",
    "WCHazardousReactive": "no",
    "WCHazardousToxic": "no",
    "WCHazardousToxicYes": [],
    "WCHazardousUHC": "no",
    "WCHazardousUHCYes": [],
    "WCHazardousWaste": null,
    "WCSolidWaste": "no",
    "editable": true
  }
}

rcra_empty_container

rcra_empty_container
GET/api/portalweb/wastestreams/{id}/rcra_empty_container

Overview:

The rcra_empty_container endpoint, accessible at /api/portalweb/wastestreams/{id}/rcra_empty_container, is a GET request that is used to get the RCRA empty container for the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the RCRA empty container.
id number The waste stream ID.
WCHazardousP string The hazardous P code.
WCECMaterial string The EC material code.
WCECAcuteHazardousWaste string The acute hazardous waste code.
WCECPumpingAndAspirating string The pumping and aspirating code.
WCECLessThanEqual119Gallons string The less than equal 119 gallons code.
WCECMoreThan3ByWeight string The more than 3 by weight code.
WCECNoMoreThan03ByWeight string The no more than 0.3 by weight code.
editable boolean Indicates whether the RCRA empty container is editable.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/wastestreams/id/rcra_empty_container
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169,
    "WCHazardousP": "no",
    "WCECMaterial": null,
    "WCECAcuteHazardousWaste": null,
    "WCECPumpingAndAspirating": null,
    "WCECLessThanEqual119Gallons": null,
    "WCECMoreThan3ByWeight": null,
    "WCECNoMoreThan03ByWeight": null,
    "editable": true
  }
}

rcra_empty_container_update

rcra_empty_container_update
POST/api/portalweb/wastestreams/{id}/rcra_empty_container/update

Overview:

The rcra_empty_container_update endpoint, accessible at /api/portalweb/wastestreams/{id}/rcra_empty_container/update, is a POST request that is used to update the RCRA empty container for the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the RCRA empty container.
id number The waste stream ID.
WCHazardousP string The hazardous P code.
WCECMaterial string The EC material code.
WCECAcuteHazardousWaste string The acute hazardous waste code.
WCECPumpingAndAspirating string The pumping and aspirating code.
WCECLessThanEqual119Gallons string The less than equal 119 gallons code.
WCECMoreThan3ByWeight string The more than 3 by weight code.
WCECNoMoreThan03ByWeight string The no more than 0.3 by weight code.
editable boolean Indicates whether the RCRA empty container is editable.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/wastestreams/id/rcra_empty_container/update
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 169,
  "WCHazardousP": "no",
  "WCECMaterial": "yes",
  "WCECAcuteHazardousWaste": "",
  "WCECPumpingAndAspirating": "yes",
  "WCECLessThanEqual119Gallons": "yes",
  "WCECMoreThan3ByWeight": "yes",
  "WCECNoMoreThan03ByWeight": "",
  "editable": true
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169,
    "WCHazardousP": "no",
    "WCECMaterial": "yes",
    "WCECAcuteHazardousWaste": "",
    "WCECPumpingAndAspirating": "yes",
    "WCECLessThanEqual119Gallons": "yes",
    "WCECMoreThan3ByWeight": "yes",
    "WCECNoMoreThan03ByWeight": "",
    "editable": true
  }
}

tsca_expired_unused_chemicals

tsca_expired_unused_chemicals
GET/api/portalweb/wastestreams/{id}/tsca_expired_unused_chemicals

Overview:

The tsca_expired_unused_chemicals endpoint, accessible at /api/portalweb/wastestreams/{id}/tsca_expired_unused_chemicals, is a GET request that is used to get the TSCA expired unused chemicals for the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the TSCA expired unused chemicals.
id number The waste stream ID.
WCPCBContaminated string The PCB contaminated code.
WCDiscardedOrExpiredChemical string The discarded or expired chemical code.
WCDiscardedOrExpiredChecmicalUnused string The discarded or expired chemical unused code.
WCCERCLARegulatedWaste string The CERCLA regulated waste code.
WCBenzeneNESHAPWaste string The benzene NESHAP waste code.
WCHalogenatedOrganicCompound string The halogenated organic compound code.
editable boolean Indicates whether the TSCA expired unused chemicals are editable.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/wastestreams/id/tsca_expired_unused_chemicals
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169,
    "WCPCBContaminated": null,
    "WCDiscardedOrExpiredChemical": null,
    "WCDiscardedOrExpiredChecmicalUnused": null,
    "WCCERCLARegulatedWaste": null,
    "WCBenzeneNESHAPWaste": null,
    "WCHalogenatedOrganicCompound": null,
    "editable": true
  }
}

tsca_expired_unused_chemicals_update

tsca_expired_unused_chemicals_update
POST/api/portalweb/wastestreams/{id}/tsca_expired_unused_chemicals/update

Overview:

The tsca_expired_unused_chemicals_update endpoint, accessible at /api/portalweb/wastestreams/{id}/tsca_expired_unused_chemicals/update, is a POST request that is used to update the TSCA expired unused chemicals for the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the TSCA expired unused chemicals.
id number The waste stream ID.
WCPCBContaminated string The PCB contaminated code.
WCDiscardedOrExpiredChemical string The discarded or expired chemical code.
WCDiscardedOrExpiredChecmicalUnused string The discarded or expired chemical unused code.
WCCERCLARegulatedWaste string The CERCLA regulated waste code.
WCBenzeneNESHAPWaste string The benzene NESHAP waste code.
WCHalogenatedOrganicCompound string The halogenated organic compound code.
editable boolean Indicates whether the TSCA expired unused chemicals are editable.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/wastestreams/id/tsca_expired_unused_chemicals/update
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 169,
  "WCPCBContaminated": "yes",
  "WCDiscardedOrExpiredChemical": "no",
  "WCDiscardedOrExpiredChecmicalUnused": "",
  "WCCERCLARegulatedWaste": "yes",
  "WCBenzeneNESHAPWaste": "yes",
  "WCHalogenatedOrganicCompound": "yes",
  "editable": true
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169,
    "WCPCBContaminated": "yes",
    "WCDiscardedOrExpiredChemical": "no",
    "WCDiscardedOrExpiredChecmicalUnused": null,
    "WCCERCLARegulatedWaste": "yes",
    "WCBenzeneNESHAPWaste": "yes",
    "WCHalogenatedOrganicCompound": "yes",
    "editable": true
  }
}

physical_characteristics

physical_characteristics
GET/api/portalweb/wastestreams/{id}/physical_characteristics

Overview:

The physical_characteristics endpoint, accessible at /api/portalweb/wastestreams/{id}/physical_characteristics, is a GET request that is used to get the physical characteristics for the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the physical characteristics.
id number The waste stream ID.
PCAppearance string The appearance code.
PCPhysicalStateStrongMildNone string The physical state strong mild none code.
PCPhysicalStateStrongMildNoneText string The physical state strong mild none text.
PCpH string The pH code.
PCFlashPoint string The flash point code.
PCFlashPointActual string The flash point actual code.
PCSpecificGravity string The specific gravity code.
PCPPhysicalStatePowder2 boolean The physical state powder 2 code.
PCPPhysicalStatePowderPercent string The physical state powder percent code.
PCPPhysicalStateAshPercent string The physical state ash percent code.
PCPPhysicalStateAsh2 boolean The physical state ash 2 code.
PCPPhysicalStateGas2 boolean The physical state gas 2 code.
PCPPhysicalStateSludgePercent string The physical state sludge percent code.
PCPPhysicalStateSludge2 boolean The physical state sludge 2 code.
PCPPhysicalStateLiquidPercent string The physical state liquid percent code.
PCPPhysicalStateLiquid2 boolean The physical state liquid 2 code.
PCPPhysicalStateSolidPercent string The physical state solid percent code.
PCPhysicalStateSolid2 boolean The physical state solid 2 code.
PCPPhysicalStateGasPercent string The physical state gas percent code.
editable boolean Indicates whether the physical characteristics are editable.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/wastestreams/id/physical_characteristics
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169,
    "PCAppearance": null,
    "PCPhysicalStateStrongMildNone": null,
    "PCPhysicalStateStrongMildNoneText": null,
    "PCpH": null,
    "PCFlashPoint": null,
    "PCFlashPointActual": null,
    "PCSpecificGravity": null,
    "PCPPhysicalStatePowder2": false,
    "PCPPhysicalStatePowderPercent": null,
    "PCPPhysicalStateAshPercent": null,
    "PCPPhysicalStateAsh2": false,
    "PCPPhysicalStateGas2": false,
    "PCPPhysicalStateSludgePercent": null,
    "PCPPhysicalStateSludge2": false,
    "PCPPhysicalStateLiquidPercent": null,
    "PCPPhysicalStateLiquid2": false,
    "PCPPhysicalStateSolidPercent": null,
    "PCPhysicalStateSolid2": false,
    "PCPPhysicalStateGasPercent": null,
    "editable": true
  }
}

physical_characteristics_update

physical_characteristics_update
POST/api/portalweb/wastestreams/{id}/physical_characteristics/update

Overview:

The physical_characteristics_update endpoint, accessible at /api/portalweb/wastestreams/{id}/physical_characteristics/update, is a POST request that is used to update the physical characteristics for the waste stream.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the physical characteristics.
id number The waste stream ID.
PCAppearance string The appearance code.
PCPhysicalStateStrongMildNone string The physical state strong mild none code.
PCPhysicalStateStrongMildNoneText string The physical state strong mild none text.
PCpH string The pH code.
PCFlashPoint string The flash point code.
PCFlashPointActual string The flash point actual code.
PCSpecificGravity string The specific gravity code.
PCPPhysicalStatePowder2 boolean The physical state powder 2 code.
PCPPhysicalStatePowderPercent string The physical state powder percent code.
PCPPhysicalStateAshPercent string The physical state ash percent code.
PCPPhysicalStateAsh2 boolean The physical state ash 2 code.
PCPPhysicalStateGas2 boolean The physical state gas 2 code.
PCPPhysicalStateSludgePercent string The physical state sludge percent code.
PCPPhysicalStateSludge2 boolean The physical state sludge 2 code.
PCPPhysicalStateLiquidPercent string The physical state liquid percent code.
PCPPhysicalStateLiquid2 boolean The physical state liquid 2 code.
PCPPhysicalStateSolidPercent string The physical state solid percent code.
PCPhysicalStateSolid2 boolean The physical state solid 2 code.
PCPPhysicalStateGasPercent string The physical state gas percent code.
editable boolean Indicates whether the physical characteristics are editable.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/wastestreams/id/physical_characteristics/update
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 169,
  "PCAppearance": "red",
  "PCPhysicalStateStrongMildNone": "Mild",
  "PCPhysicalStateStrongMildNoneText": "red",
  "PCpH": "> 2 to ≤ 5",
  "PCFlashPoint": "≥ 73°F to < 100°F",
  "PCFlashPointActual": "",
  "PCSpecificGravity": "1",
  "PCPPhysicalStatePowder2": false,
  "PCPPhysicalStatePowderPercent": "",
  "PCPPhysicalStateAshPercent": "",
  "PCPPhysicalStateAsh2": false,
  "PCPPhysicalStateGas2": false,
  "PCPPhysicalStateSludgePercent": "",
  "PCPPhysicalStateSludge2": false,
  "PCPPhysicalStateLiquidPercent": "50",
  "PCPPhysicalStateLiquid2": true,
  "PCPPhysicalStateSolidPercent": "50",
  "PCPhysicalStateSolid2": true,
  "PCPPhysicalStateGasPercent": "",
  "editable": true
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169,
    "PCAppearance": "red",
    "PCPhysicalStateStrongMildNone": "Mild",
    "PCPhysicalStateStrongMildNoneText": "red",
    "PCpH": "> 2 to ≤ 5",
    "PCFlashPoint": "≥ 73°F to < 100°F",
    "PCFlashPointActual": "",
    "PCSpecificGravity": "1",
    "PCPPhysicalStatePowder2": false,
    "PCPPhysicalStatePowderPercent": "",
    "PCPPhysicalStateAshPercent": "",
    "PCPPhysicalStateAsh2": false,
    "PCPPhysicalStateGas2": false,
    "PCPPhysicalStateSludgePercent": "",
    "PCPPhysicalStateSludge2": false,
    "PCPPhysicalStateLiquidPercent": "50",
    "PCPPhysicalStateLiquid2": true,
    "PCPPhysicalStateSolidPercent": "50",
    "PCPhysicalStateSolid2": true,
    "PCPPhysicalStateGasPercent": "",
    "editable": true
  }
}

portal_waste_state_waste_codes

portal_waste_state_waste_codes
GET/api/portalweb/portal_waste_state_waste_codes{?id}

Overview:

The portal_waste_state_waste_codes endpoint, accessible at /api/portalweb/portal_waste_state_waste_codes{?id}, is a GET request that is used to get the waste state waste codes.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the waste state waste codes.
StateWasteCodes object An object containing the waste state waste codes.
Name string The name of the waste state waste code.
id number The waste state waste code ID.
WasteCode string The waste code of the waste state waste code.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_waste_state_waste_codes?id=
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "StateWasteCodes": {
      "Name": "test API",
      "id": 169,
      "WasteCode": null
    }
  }
}

portal_waste_state_waste_codes_update

portal_waste_state_waste_codes_update
POST/api/portalweb/portal_waste_state_waste_codes_update

Overview:

The portal_waste_state_waste_codes_update endpoint, accessible at /api/portalweb/portal_waste_state_waste_codes_update, is a POST request that is used to update the waste state waste codes.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the waste state waste codes.
id number The waste state waste code ID.
Name string The name of the waste state waste code.
WasteCode string The waste code of the waste state waste code.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_waste_state_waste_codes_update
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "Name": "test API",
  "id": 169,
  "WasteCode": "test1234"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 169
  }
}

portal_waste_stream_detail

portal_waste_stream_detail
GET/api/portalweb/portal_waste_stream_detail{?id}

Overview:

The portal_waste_stream_detail endpoint, accessible at /api/portalweb/portal_waste_stream_detail{?id}, is a GET request that is used to get the waste stream details.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the waste stream details.
wastestreamsummary object An object containing the waste stream summary.
Name string The name of the waste stream.
Section1Status boolean The status of section 1.
Section2Status boolean The status of section 2.
Section3Status boolean The status of section 3.
Section4Status boolean The status of section 4.
Section5Status boolean The status of section 5.
Section6Status boolean The status of section 6.
Section7Status boolean The status of section 7.
Section8Status boolean The status of section 8.
Section9Status boolean The status of section 9.
Section10Status boolean The status of section 10.
Section14Status boolean The status of section 14.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_waste_stream_detail?id=
URI Parameters
HideShow
id
number (required) 

The waste stream ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "wastestreamsummary": {
      "Name": "test API",
      "Section1Status": true,
      "Section2Status": true,
      "Section3Status": true,
      "Section4Status": true,
      "Section5Status": true,
      "Section6Status": true,
      "Section7Status": true,
      "Section8Status": true,
      "Section9Status": true,
      "Section10Status": true,
      "Section14Status": true
    }
  }
}

Portal Inventory Management APIs

portal_filter_inventory_waste_profile

portal_filter_inventory_waste_profile
GET/api/portalweb/portal_filter_inventory_waste_profile{?inventorytype}

Overview:

The portal_filter_inventory_waste_profile endpoint, accessible at /api/portalweb/portal_filter_inventory_waste_profile{?inventorytype}, is a GET request that is used to filter the waste profile inventory.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the waste profile inventory.
WasteProfile array An array of waste profiles.
id number The waste profile ID.
Name string The name of the waste profile.
totalElements number The total number of waste profiles.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_filter_inventory_waste_profile?inventorytype=
URI Parameters
HideShow
inventorytype
string (required) 

The inventory type.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "WasteProfile": [
      {
        "id": 584,
        "Name": "Company A Approved"
      }
    ]
  },
  "totalElements": 53
}

portal_waste_profile_change

portal_waste_profile_change
GET/api/portalweb/portal_waste_profile_change{?inventorytype,id}

Overview:

The portal_waste_profile_change endpoint, accessible at /api/portalweb/portal_waste_profile_change{?inventorytype,id}, is a GET request that is used to get the waste profile change.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the waste profile change.
ContainerType array An array of container types.
WasteManagementUnitList array An array of waste management units.
totalElements number The total number of waste profiles.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_waste_profile_change?inventorytype=&id=
URI Parameters
HideShow
inventorytype
string (required) 

The inventory type.

id
number (required) 

The waste profile ID.

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

portal_edit_Packaged

portal_edit_Packaged
POST/api/portalweb/portal_edit_Packaged

Overview:

The portal_edit_Packaged endpoint, accessible at /api/portalweb/portal_edit_Packaged, is a POST request that is used to edit the packaged waste profile inventory.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
id number The waste profile ID.
WasteProfile_id number The waste profile ID.
WasteManagementUnits_id string The waste management unit ID.
ContainerCount string The container count.
ContainerType string The container type.
ContainerSize string The container size.
ContainerVolumeType string The container volume type.
Status string The status.
Volume string The volume.
VolumeType string The volume type.
Note string The note.
Date string The date.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_edit_Packaged
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "WasteProfile_id": 11440,
  "WasteManagementUnits_id": "42",
  "ContainerCount": "1",
  "ContainerType": "",
  "ContainerSize": "",
  "ContainerVolumeType": "",
  "Status": "",
  "Volume": "1",
  "VolumeType": "",
  "Note": "1",
  "Date": "2024-06-25"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true
}

Portal Shipment Requests APIs

portal_waste_profile_detail

portal_waste_profile_detail
GET/api/portalweb/portal_waste_profile_detail{?id}

Overview:

The portal_waste_profile_detail endpoint, accessible at /api/portalweb/portal_waste_profile_detail{?id}, is a GET request that is used to get the waste profile details.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the waste profile details.
wasteprofilesummary object An object containing the waste profile summary.
Name string The name of the waste profile.
Section1Status boolean The status of section 1.
Section2Status boolean The status of section 2.
Section3Status boolean The status of section 3.
Section4Status boolean The status of section 4.
Section5Status boolean The status of section 5.
Section6Status boolean The status of section 6.
Section7Status boolean The status of section 7.
Section8Status boolean The status of section 8.
Section9Status boolean The status of section 9.
WithoutWasteStream boolean Indicates whether the waste stream is without a waste stream.
WasteStreamName string The name of the waste stream.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_waste_profile_detail?id=
URI Parameters
HideShow
id
number (required) 

The shipment ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "wasteprofilesummary": {
      "Name": "Boiler Wash Water -  Bulk",
      "Section1Status": true,
      "Section2Status": true,
      "Section3Status": true,
      "Section4Status": true,
      "Section5Status": true,
      "Section6Status": true,
      "Section7Status": true,
      "Section8Status": false,
      "Section9Status": false,
      "WithoutWasteStream": false,
      "WasteStreamName": "BOILER FLUSH"
    }
  }
}

portal_shipment_details

portal_shipment_details
GET/api/portalweb/portal_shipment_details{?id}

Overview:

The portal_shipment_details endpoint, accessible at /api/portalweb/portal_shipment_details{?id}, is a GET request that is used to get the shipment details.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the shipment details.
ShipmentForm object An object containing the shipment form.
ShipmentID number The shipment ID.
PickupDate string The pickup date.
id number The ID.
PickupTime string The pickup time.
PONumber string The PO number.
NumOfContainers number The number of containers.
TotalWeight number The total weight.
Status string The status.
CustomerName string The customer name.
CustomerCity string The customer city.
CustomerState string The customer state.
Note string The note.
WasteProfileList array An array of waste profiles.
ProductServiceList array An array of product services.
editable boolean Indicates whether the shipment details are editable.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_shipment_details?id=
URI Parameters
HideShow
id
number (required) 

The shipment ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "ShipmentForm": {
      "ShipmentID": 10010,
      "PickupDate": "",
      "id": 0,
      "PickupTime": "",
      "PONumber": "",
      "NumOfContainers": 0,
      "TotalWeight": 0,
      "Status": "New Request",
      "CustomerName": "Company A",
      "CustomerCity": "New York",
      "CustomerState": "NY",
      "Note": "",
      "WasteProfileList": [],
      "ProductServiceList": [],
      "editable": true
    }
  }
}

portal_shipment_add

portal_shipment_add
POST/api/portalweb/portal_shipment_add

Overview:

The portal_shipment_add endpoint, accessible at /api/portalweb/portal_shipment_add, is a POST request that is used to add the shipment.

Request Body and Response Description:

Name Data Type Description
susccess boolean Indicates whether the operation was successful.
id number The waste profile ID.
ShipmentID number The shipment ID.
PickupDate string The pickup date.
PickupTime string The pickup time.
PONumber string The PO number.
Note string The note.
NumOfContainers number The number of containers.
TotalWeight number The total weight.
Status string The status.
CustomerName string The customer name.
CustomerCity string The customer city.
CustomerState string The customer state.
WasteProfileList array An array of waste profiles.
ProductServiceList array An array of product services.
fromInventory boolean Indicates whether the shipment is from inventory.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_shipment_add
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 0,
  "ShipmentID": 10010,
  "PickupDate": "2024-08-27",
  "PickupTime": "1",
  "PONumber": "1123",
  "Note": "123",
  "NumOfContainers": 0,
  "TotalWeight": 0,
  "Status": "New Request",
  "CustomerName": "Company A",
  "CustomerCity": "New York",
  "CustomerState": "NY",
  "WasteProfileList": [],
  "ProductServiceList": [],
  "fromInventory": false
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true
}

Portal Training APIs

portal_search_training_employee

portal_search_training_employee
GET/api/portalweb/portal_search_training_employee{?search}

Overview:

The portal_search_training_employee endpoint, accessible at /api/portalweb/portal_search_training_employee{?search}, is a GET request that is used to search the training employee.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
list_personnels array An array of personnels.
id number The personnel ID.
FirstName string The first name of the personnel.
LastName string The last name of the personnel.
Phone string The phone number of the personnel.
Email string The email of the personnel.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_search_training_employee?search=
URI Parameters
HideShow
search
string (required) 

The search string.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "list_personnels": [
    {
      "id": 41,
      "FirstName": "Jane",
      "LastName": "Doe",
      "Phone": "222-222-2222",
      "Email": "janedoe@wastelinq.com"
    }
  ]
}

portal_edit_training

portal_edit_training
POST/api/portalweb/portal_edit_training

Overview:

The portal_edit_training endpoint, accessible at /api/portalweb/portal_edit_training, is a POST request that is used to edit the training.

Request Body and Response Description:

Name Data Type Description
status string The status of the training.
renewalDate string The renewal date of the training.
lastTrainingDate string The last training date of the training.
trainingCurriculumn string The training curriculumn of the training.
employeeEmail string The email of the employee.
employeePhone string The phone number of the employee.
employeeName string The name of the employee.
employeeId number The employee ID.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_edit_training
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "status": "Active",
  "renewalDate": "08/28/2024",
  "lastTrainingDate": "08/28/2024",
  "trainingCurriculumn": "25",
  "employeeEmail": "janedoe@wastelinq.com",
  "employeePhone": "222-222-2222",
  "employeeName": "Jane Doe",
  "employeeId": 618
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true
}

Portal Documents APIs

documents

documents
GET/api/portalweb/documents/

Overview:

The documents endpoint, accessible at /api/portalweb/documents/, is a GET request that is used to get the documents.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the documents.
key number The key of the document.
title string The title of the document.
state object An object containing the state of the document.
opened string The opened state of the document.
disable string The disable state of the document.
children array An array of children documents.
key number The key of the document.
title string The title of the document.
state object An object containing the state of the document.
opened string The opened state of the document.
disable string The disable state of the document.
children array An array of children documents.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/documents/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "key": 0,
    "title": "Company A",
    "state": {
      "opened": "true",
      "disable": "true"
    },
    "children": [
      {
        "key": 16686,
        "title": "Waste Profiles",
        "state": {
          "opened": "true",
          "disable": "true"
        },
        "children": []
      }
    ]
  }
}

documents_files

documents_files
GET/api/portalweb/documents/{id}/files

Overview:

The documents_files endpoint, accessible at /api/portalweb/documents/{id}/files, is a GET request that is used to get the files for the document.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the files.
id number The file ID.
FileExt string The file extension.
FileName string The file name.
IsSystem boolean Indicates whether the file is a system file.
S3File string The S3 file.
VirtualPath string The virtual path.
Created_date string The created date.
FileType_id number The file type ID.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/documents/id/files
URI Parameters
HideShow
id
number (required) 

The document ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 2231552,
      "FileExt": "pdf",
      "FileName": "Company A - 68453.pdf",
      "IsSystem": false,
      "S3File": "api/documents/s3file/2958193",
      "VirtualPath": "generator_id/profiles/cus_profile/S3FileName",
      "Created_date": "2023-10-19T22:15:29.417Z",
      "FileType_id": 4
    },
    {
      "id": 1587868,
      "FileExt": "pdf",
      "FileName": "2106 Slop DM_VLS H-needs signature.pdf",
      "IsSystem": false,
      "S3File": "api/documents/s3file/1060846",
      "VirtualPath": "generator_id/profiles/cus_profile/S3FileName",
      "Created_date": "2022-10-29T21:24:11.611Z",
      "FileType_id": null
    }
  ]
}

documents_by_id

documents_by_id
GET/api/portalweb/documents/{id}/

Overview:

The documents_by_id endpoint, accessible at /api/portalweb/documents/{id}/, is a GET request that is used to get the document by ID.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the document.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/documents/id/
URI Parameters
HideShow
id
number (required) 

The document ID.

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

Portal Settings APIs

portal_generalfacilityininfo_upadte_PO

portal_generalfacilityininfo_upadte_PO
POST/api/portalweb/portal_generalfacilityininfo_upadte_PO

Overview:

The portal_generalfacilityininfo_upadte_PO endpoint, accessible at /api/portalweb/portal_generalfacilityininfo_upadte_PO, is a POST request that is used to update the PO for the general facility information.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the general facility information.
generalfacilityIninfo object An object containing the general facility information.
id number The ID.
EPAId string The EPA ID.
StateId string The state ID.
SiteName string The site name.
SiteLocationAddress1 string The site location address 1.
SiteLocationAddress2 string The site location address 2.
SiteLocationCity string The site location city.
SiteLocationCounty string The site location county.
SiteLocationState string The site location state.
SiteLocationCountry string The site location country.
SiteLocationZip string The site location zip.
SiteMailingAddress1 string The site mailing address 1.
SiteMailingAddress2 string The site mailing address 2.
SiteMailingCity string The site mailing city.
SiteMailingCounty string The site mailing county.
SiteMailingState string The site mailing state.
SiteMailingCountry string The site mailing country.
SiteMailingZip string The site mailing zip.
SiteMailingAttentionTo string The site mailing attention to.
SiteContactName string The site contact name.
SiteContactAddress string The site contact address.
SiteContactAddress2 string The site contact address 2.
SiteContactCity string The site contact city.
SiteContactCounty string The site contact county.
SiteContactState string The site contact state.
SiteContactCountry string The site contact country.
SiteContactZip string The site contact zip.
SiteContactEmail string The site contact email.
SiteContactPhone string The site contact phone.
FacilityType string The facility type.
HWA1YN string The HWA1YN.
HWA1abc string The HWA1abc.
ElectronicBilling boolean Indicates whether the electronic billing is enabled.
ElectronicBillingNote string The electronic billing note.
PORequired boolean Indicates whether the PO is required.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_generalfacilityininfo_upadte_PO
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 7,
  "PORequired": false
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true",
  "content": {
    "generalfacilityIninfo": {
      "id": 7,
      "EPAId": "22222",
      "StateId": "87014",
      "SiteName": "Company A",
      "SiteLocationAddress1": "132, My Street, Kingston, New York 12401.",
      "SiteLocationAddress2": "132, My Street, Kingston, New York 12401.",
      "SiteLocationCity": "Kingston",
      "SiteLocationCounty": "",
      "SiteLocationState": "NY",
      "SiteLocationCountry": "United States",
      "SiteLocationZip": "12401",
      "SiteMailingAddress1": "132, My Street, Kingston, New York 12401.",
      "SiteMailingAddress2": "132, My Street, Kingston, New York 12401.",
      "SiteMailingCity": "Kingston",
      "SiteMailingCounty": "",
      "SiteMailingState": "NY",
      "SiteMailingCountry": "United States",
      "SiteMailingZip": "12401",
      "SiteMailingAttentionTo": "",
      "SiteContactName": "Company A",
      "SiteContactAddress": "132, My Street, Kingston, New York 12401.",
      "SiteContactAddress2": "132, My Street, Kingston, New York 12401.",
      "SiteContactCity": "Kingston",
      "SiteContactCounty": "",
      "SiteContactState": "NY",
      "SiteContactCountry": "United States",
      "SiteContactZip": "12401",
      "SiteContactEmail": "janedoe@wastelinq.com",
      "SiteContactPhone": "",
      "FacilityType": "Industrial",
      "HWA1YN": "Y",
      "HWA1abc": "LQG",
      "ElectronicBilling": false,
      "ElectronicBillingNote": "",
      "PORequired": false
    }
  }
}

portal_add_configuration

portal_add_configuration
POST/api/portalweb/portal_add_configuration

Overview:

The portal_add_configuration endpoint, accessible at /api/portalweb/portal_add_configuration, is a POST request that is used to add the configuration.

Request Body and Response Description:

Name Data Type Description
id number The ID.
name string The name.
unitsequence string The unit sequence.
unittype string The unit type.
inventorytype string The inventory type.
unitregulatory string The unit regulatory.
totalcapacity string The total capacity.
status string The status.
volumetype string The volume type.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_add_configuration
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "name": "test",
  "unitsequence": "test",
  "unittype": "01 Surface Impoundment",
  "inventorytype": "Packaged",
  "unitregulatory": "Point of Generation",
  "totalcapacity": "1",
  "status": "Active",
  "volumetype": "Gals"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true"
}

portal_wastemanagementunit_details

portal_wastemanagementunit_details
GET/api/portalweb/portal_wastemanagementunit_details{?id}

Overview:

The portal_wastemanagementunit_details endpoint, accessible at /api/portalweb/portal_wastemanagementunit_details{?id}, is a GET request that is used to get the waste management unit details.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the waste management unit details.
WasteManagementUnitForm object An object containing the waste management unit form.
id number The waste management unit ID.
name string The name of the waste management unit.
unitsequence string The unit sequence of the waste management unit.
unittype string The unit type of the waste management unit.
inventorytype string The inventory type of the waste management unit.
unitregulatory string The unit regulatory of the waste management unit.
totalcapacity string The total capacity of the waste management unit.
volumetype string The volume type of the waste management unit.
status string The status of the waste management unit.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_wastemanagementunit_details?id=
URI Parameters
HideShow
id
number (required) 

The waste management unit ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "WasteManagementUnitForm": {
      "id": 44,
      "name": "test",
      "unitsequence": "test",
      "unittype": "01 Surface Impoundment",
      "inventorytype": "Packaged",
      "unitregulatory": "Point of Generation",
      "totalcapacity": "1",
      "volumetype": "Gals",
      "status": "Active"
    }
  }
}

portal_delete_configuration

portal_delete_configuration
DELETE/api/portalweb/portal_delete_configuration

Overview:

The portal_delete_configuration endpoint, accessible at /api/portalweb/portal_delete_configuration, is a DELETE request that is used to delete the configuration.

Request Body and Response Description:

Name Data Type Description
id number The ID.
success boolean Indicates whether the operation was successful.s

Example URI

DELETE [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_delete_configuration
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 44
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true"
}

manage_modules

manage_modules
GET/api/portalweb/settings/users/{id}/manage_modules/

Overview:

The manage_modules endpoint, accessible at /api/portalweb/settings/users/{id}/manage_modules/, is a GET request that is used to manage the modules.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the modules.
modules array An array of modules.
id number The module ID.
Name string The name of the module.
IsRead boolean Indicates whether the module is readable.
IsWrite boolean Indicates whether the module is writable.

Example URI

GET [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/settings/users/id/manage_modules/
URI Parameters
HideShow
id
number (required) 

The user ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "modules": [
      {
        "id": 9,
        "Name": "Inspection",
        "IsRead": true,
        "IsWrite": true
      },
      {
        "id": 10,
        "Name": "Training",
        "IsRead": true,
        "IsWrite": true
      }
    ]
  }
}

manage_modules_update

manage_modules_update
POST/api/portalweb/settings/users/{id}/manage_modules/update/

Overview:

The manage_modules_update endpoint, accessible at /api/portalweb/settings/users/{id}/manage_modules/update/, is a POST request that is used to update the modules.

Request Body and Response Description:

Name Data Type Description
modules array An array of modules.
id number The user ID.
Name string The name of the module.
IsRead boolean Indicates whether the module is readable.
IsWrite boolean Indicates whether the module is writable.
success boolean Indicates whether the operation was successful.
content string The content.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/settings/users/id/manage_modules/update/
URI Parameters
HideShow
id
number (required) 

The user ID.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "modules": [
    {
      "id": 9,
      "Name": "Inspection",
      "IsRead": true,
      "IsWrite": true
    },
    {
      "id": 10,
      "Name": "Training",
      "IsRead": true,
      "IsWrite": true
    }
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": "Ok"
}

portal_check_user_existed

portal_check_user_existed
POST/api/portalweb/portal_check_user_existed

Overview:

The portal_check_user_existed endpoint, accessible at /api/portalweb/portal_check_user_existed, is a POST request that is used to check if the user exists.

Request Body and Response Description:

Name Data Type Description
username string The username.
firstname string The first name.
lastname string The last name.
password string The password.
email string The email.
status string The status.
success boolean Indicates whether the operation was successful.

Example URI

POST [Portal APIs](https://test-api.wastelinq.com)./api/portalweb/portal_check_user_existed
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "username": "janedoe@wastelinq.com",
  "firstname": "Jane",
  "lastname": "Doe",
  "password": "*****",
  "email": "janedoe@wastelinq.com",
  "status": "Active"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true
}

Generated by aglio on 29 Aug 2024