Back to top

Streamlinq Generators APIs

Overview

Welcome to the Streamlinq API section of the Wastelinq API suite. This collection of APIs is specifically designed to manage and interact with Streamlinq data within the Wastelinq system.

The Streamlinq API provides functionalities such as creating, updating, retrieving, and deleting Streamlinq data. It allows for efficient management of Streamlinq data, enabling seamless integration with other systems or services.

Each API endpoint in this section corresponds to a unique functionality related to Streamlinq. The response from each API call includes specific fields and data types, providing detailed information about the Streamlinq data.

For comprehensive documentation of each API, follow the respective link provided in the APIs section.

For more detailed information on the structure of requests and responses, please refer to the individual API sections.

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.

APIs

Aggregated Data

Aggregated Data
POST/api/streamlinq/generators/aggregated_data/

Overview:

Retrieve data from the database and calculate it to load into the MANIFESTS SHIPPED, TOTAL TONS, TOTAL CONTAINERS, and TOTAL SHIPPERS boxes.

Response Description:

Name Data Type Description
epa_total number The total estimated weight in tons of all products shipped
shipped_count number This is the total number of shipments that were made
container_count number This is the total number of containers that were used for shipments
mmc_count number The total count of individual minimum units shipped

Example URI

POST https://test-api.wastelinq.com/api/streamlinq/generators/aggregated_data/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "filterFields": {},
  "searchKey": ""
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "epa_total": " 112,316,288.68",
  "shipped_count": " 8,846,131",
  "container_count": " 69,367,493",
  "mmc_count": " 21,300,151"
}

Generators

Generators
POST/api/streamlinq/generators/

Overview:

Retrieve data from the database to load into the Generators table.

Response Description:

Name Data Type Description
totalElements number The total number of records in the full dataset
content array The array containing the individual record objects
epa_handler_id string A unique ID for the waste handler assigned by the EPA
generator_name string The name of the company/organization generating the waste
physical_address string The street address where the waste is generated
location_street_number string The street number of the physical address
location_street_1 string The street name of the physical address
location_city string The city of the physical address
location_state string The state of the physical address
location_zip string The zip code of the physical address
contact_name string Potential contact person at the waste generator
contact_phone_number string Phone number to contact the waste generator
contact_email string Email address for the waste generator contact
primary_naics_code string NAICS code for the generator’s primary industry
primary_naics_desc string Description of the NAICS code
registration_status string Registration status with the EPA
state_handler_id string ID provided by the state regulator
total_waste number Total waste generated annually in tons

Example URI

POST https://test-api.wastelinq.com/api/streamlinq/generators/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "pageInfo": {
    "page": 0,
    "pageSize": 10,
    "filters": "all=",
    "selectedFields": "epa_handler_id,generator_name,physical_address,location_city,location_state,contact_name,contact_phone_number,contact_email,primary_naics_code,primary_naics_desc,total_waste,",
    "sort": "epa_handler_id asc"
  },
  "filterFields": {
    "shippedYears": [
      "2023"
    ],
    "cities": [
      " New Yor"
    ],
    "naics": [
      "10000"
    ],
    "ids": [
      "10000"
    ],
    "states": [
      "NY"
    ],
    "wasteCodes": [
      "D001"
    ],
    "names": [
      "Company A"
    ],
    "statuses": [
      "LQG"
    ],
    "handlingCodes": [
      "H039"
    ]
  },
  "searchKey": "Company A"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalElements": 513011,
  "content": [
    {
      "epa_handler_id": "10000",
      "generator_name": "Company A",
      "physical_address": "132, My Street, Kingston, New York 12401.",
      "location_street_number": "132",
      "location_street_1": "132",
      "location_city": "Kingston",
      "location_state": "NY",
      "location_zip": "12401",
      "contact_name": "Jane Doe",
      "contact_phone_number": "100-100-1000",
      "contact_email": "janedoe@test.com",
      "primary_naics_code": "32411",
      "primary_naics_desc": "Company A",
      "registration_status": "",
      "state_handler_id": "",
      "total_waste": 1783.437022
    }
  ]
}

Generator City Filter Box

Generator City Filter Box
GET/api/streamlinq/generators/filters/?field=generator_city&page=1&search=

Overview:

Retrieve data from the database to load into the Generator City Filter Box.

Response Description:

Name Data Type Description
results array Array containing result objects
value string The value of each result
text string Display text for each result
pagination object Object with pagination metadata
more boolean Indicates if more pages exist

Example URI

GET https://test-api.wastelinq.com/api/streamlinq/generators/filters/?field=generator_city&page=1&search=
URI Parameters
HideShow
field
string (required) Example: generator_city

The city of the generator

page
number (required) Example: 1

The page number for pagination

search
string (optional) Example: ""

The search query

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "results": [
    {
      "value": "New York ",
      "text": "New York "
    }
  ],
  "pagination": {
    "more": true
  }
}

NAICS Filter Box

NAICS Filter Box
GET/api/streamlinq/generators/filters/?field=naics&page=1&search=

Overview:

Retrieve data from the database to load into the NAICS Filter Box.

Response Description:

Name Data Type Description
results array Array containing result objects
value string The value of each result
text string Display text for each result
pagination object Object with pagination metadata
more boolean Indicates if more pages exist

Example URI

GET https://test-api.wastelinq.com/api/streamlinq/generators/filters/?field=naics&page=1&search=
URI Parameters
HideShow
field
string (required) Example: naics

The NAICS code

page
number (required) Example: 1

The page number for pagination

search
string (optional) Example: ""

The search query

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "results": [
    {
      "value": "11",
      "text": "11 AGRICULTURE, FORESTRY, FISHING AND HUNTING"
    }
  ],
  "pagination": {
    "more": true
  }
}

Generator EPA ID Filter Box

Generator EPA ID Filter Box
GET/api/streamlinq/generators/filters/?field=epa_handler_id&page=1&search=

Overview:

Retrieve data from the database to load into the Generator EPA ID Filter Box.

Response Description:

Name Data Type Description
results array Array containing result objects
value string The value of each result
text string Display text for each result
pagination object Object with pagination metadata
more boolean Indicates if more pages exist

Example URI

GET https://test-api.wastelinq.com/api/streamlinq/generators/filters/?field=epa_handler_id&page=1&search=
URI Parameters
HideShow
field
string (required) Example: epa_handler_id

The EPA handler ID

page
number (required) Example: 1

The page number for pagination

search
string (optional) Example: ""

The search query

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "results": [
    {
      "value": "10000",
      "text": "10000"
    }
  ],
  "pagination": {
    "more": true
  }
}

Generator State Filter Box

Generator State Filter Box
GET/api/streamlinq/generators/filters/?field=generator_state&page=1&search=

Overview:

Retrieve data from the database to load into the Generator EPA ID Filter Box.

Response Description:

Name Data Type Description
results array Array containing result objects
value string The value of each result
text string Display text for each result
pagination object Object with pagination metadata
more boolean Indicates if more pages exist

Example URI

GET https://test-api.wastelinq.com/api/streamlinq/generators/filters/?field=generator_state&page=1&search=
URI Parameters
HideShow
field
string (required) Example: generator_state

The state of the generator

page
number (required) Example: 1

The page number for pagination

search
string (optional) Example: ""

The search query

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "results": [
    {
      "value": "AK",
      "text": "AK"
    }
  ],
  "pagination": {
    "more": true
  }
}

EPA Waste Code Filter Box

EPA Waste Code Filter Box
GET/api/streamlinq/generators/filters/?field=epa_waste_code&page=1&search=

Overview:

Retrieve data from the database to load into the EPA Waste Code Filter Box.

Response Description:

Name Data Type Description
results array Array containing result objects
value string The value of each result
text string Display text for each result
pagination object Object with pagination metadata
more boolean Indicates if more pages exist

Example URI

GET https://test-api.wastelinq.com/api/streamlinq/generators/filters/?field=epa_waste_code&page=1&search=
URI Parameters
HideShow
field
string (required) Example: epa_waste_code

The EPA waste code

page
number (required) Example: 1

The page number for pagination

search
string (optional) Example: ""

The search query

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "results": [
    {
      "value": "D001",
      "text": "D001"
    }
  ],
  "pagination": {
    "more": true
  }
}

Generator Name Filter Box

Generator Name Filter Box
GET/api/streamlinq/generators/filters/?field=generator_name&page=1&search=

Overview:

Retrieve data from the database to load into the Generator Name Filter Box.

Response Description:

Name Data Type Description
results array Array containing result objects
value string The value of each result
text string Display text for each result
pagination object Object with pagination metadata
more boolean Indicates if more pages exist

Example URI

GET https://test-api.wastelinq.com/api/streamlinq/generators/filters/?field=generator_name&page=1&search=
URI Parameters
HideShow
field
string (required) Example: generator_name

The name of the generator

page
number (required) Example: 1

The page number for pagination

search
string (optional) Example: ""

The search query

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "results": [
    {
      "value": "Company A",
      "text": "Company A"
    }
  ],
  "pagination": {
    "more": true
  }
}

Handling Code Filter Box

Handling Code Filter Box
GET/api/streamlinq/generators/filters/?field=mmc&page=1&search=

Overview:

Retrieve data from the database to load into the Handling Code Filter Box.

Response Description:

Name Data Type Description
results array Array containing result objects
value string The value of each result
text string Display text for each result
pagination object Object with pagination metadata
more boolean Indicates if more pages exist

Example URI

GET https://test-api.wastelinq.com/api/streamlinq/generators/filters/?field=mmc&page=1&search=
URI Parameters
HideShow
field
string (required) Example: mmc

The MMC field

page
number (required) Example: 1

The page number for pagination

search
string (optional) Example: ""

The search query

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "results": [
    {
      "value": "H010",
      "text": "H010"
    }
  ],
  "pagination": {
    "more": true
  }
}

Generator Details

Generator Details
GET/api/streamlinq/generators/details/?handler_id=10000

Overview:

Retrieve data from the database to load into the Generator Details pop-up.

Response Description:

Name Data Type Description
generator_data object Object containing generator data
epa_handler_id string The facility’s EPA identification number
generator_name string Name of the waste generator/facility
mail_street_number, mail_street_1, mail_street_2, mail_city, mail_zip, mail_state string Mailing address fields for the facility
physical_address string Physical location address of the facility
location_street_number, location_street_1, location_street_2, location_city, location_zip, location_state string Physical location address fields
contact_name string Contact person name
contact_email string Contact email address
contact_phone_number string Contact phone number
primary_naics_code string North American Industry Classification System code
primary_naics_desc string Description of primary NAICS code
total_generated_waste number Total amount of waste generated (tons)
total_container number Number of containers/shipments
total_mmc number Total management method codes used
total_shipped number Amount of waste shipped off-site (tons)
shipped_years string Year(s) waste was shipped
federal_generator_status_universe string The facility’s status according to federal regulations (e.g. Large Quantity Generator)
land_type string Type of land the facility is located on (e.g. industrial, residential)
short_term_generator_activity string Indicates if the facility engages in short-term or episodic hazardous waste generation
mixed_waste_generator string Indicates if the facility generates mixed (hazardous and radioactive) wastes
transporter_activity string Indicates if the facility transports hazardous waste
transfer_facility_activity string Indicates if the facility is a hazardous waste transfer facility
importer_activity string Indicates if the facility imports hazardous waste
federal_waste_codes string The hazardous waste codes that apply to the facility’s waste streams
management_method_code string The primary management method used for the facility’s hazardous waste
full_address string The complete physical address of the facility
location_latitude, location_longitude string GPS coordinates of the facility location
public_notes string Any public notes about the facility
managed_waste, shipped_waste, received_waste number Amounts of waste managed/shipped/received annually (tons)
registration_status string The facility’s registration status
is_industry string Indicates if the facility is classified as industrial
state_handler_id string The facility ID assigned by the state (if applicable)
federal_generator_status_universe_code string Code for the facility’s federal generator status
mailing_address string The facility’s mailing address
type_data object Object containing type data
short_term_generator_activity string Indicates if facility engages in short-term/episodic generation
mixed_waste_generator string Indicates if facility generates mixed (hazardous and radioactive) wastes
transporter_activity string Indicates if facility transports hazardous waste
transporter_facility_activity string Indicates if facility is a hazardous waste transporter facility
importer_activity string Indicates if facility imports hazardous waste
site_activities object Object containing site data
report_year string Year waste data applies to
generated_waste string Amount of waste generated (tons)
managed_waste number Amount of waste managed on-site (tons)
shipped_waste number Amount of waste shipped off-site (tons)
received_waste number Amount of waste received from other facilities (tons)
waste_code_data array Array containing waste code and description
D001 string Hazardous waste code and description
mmc_codes array Array containing mmc and description
management_method string Code for primary management method
management_method_description string Description of management method
naics_codes array Array of NAICS codes associated with the facility
naics_code string The NAICS code number
naics_desc string Description of the NAICS code
is_active string Indicates if the NAICS code is currently active for the facility (“Y” or “N”)
sic_codes array Array of SIC codes associated with the facility
sic_code number The SIC code number
sic_desc string Description of the SIC code
gen_map string Embedded map of the facility location
is_network boolean Indicates if facility is part of a network
is_streamlinq_enable boolean Indicates StreamlinQ feature status

Example URI

GET https://test-api.wastelinq.com/api/streamlinq/generators/details/?handler_id=10000
URI Parameters
HideShow
handler_id
string (required) Example: 10000

The handler ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "generator_data": {
    "epa_handler_id": "10000",
    "generator_name": "Company A",
    "mail_street_number": "132",
    "mail_street_1": "My Street",
    "mail_street_2": "My Street",
    "mail_city": "Kingston",
    "mail_zip": "12401",
    "mail_state": "NY",
    "physical_address": "132, My Street, Kingston, New York 12401.",
    "location_street_number": "132, My Street, Kingston, New York 12401.",
    "location_street_1": "132",
    "location_street_2": "132",
    "location_city": "Kingston",
    "location_zip": "12401",
    "location_state": "NY",
    "contact_name": "Jane Doe",
    "contact_email": "janedoe@gmail.com",
    "contact_phone_number": "100-100-1000",
    "primary_naics_code": "",
    "primary_naics_desc": "",
    "total_generated_waste": 0.2,
    "total_container": 2,
    "total_mmc": 2,
    "total_shipped": 1,
    "shipped_years": "2023",
    "federal_generator_status_universe": "N/A - Not Applicable",
    "land_type": "N/A",
    "short_term_generator_activity": "",
    "mixed_waste_generator": "",
    "transporter_activity": "",
    "transfer_facility_activity": "",
    "importer_activity": "",
    "federal_waste_codes": "D001",
    "management_method_code": "H141",
    "full_address": "Mr John Smith. 132, My Street, Kingston, New York 12401.",
    "location_lattitude": "N/A",
    "location_longitude": "N/A",
    "public_notes": "",
    "managed_waste": 0,
    "shipped_waste": 0,
    "recieved_waste": 0,
    "registration_status": "N/A",
    "is_industry": "No",
    "state_handler_id": "",
    "federal_generator_status_universe_code": "",
    "mailing_address": "Mr John Smith. 132, My Street, Kingston, New York 12401."
  },
  "type_data": {
    "short_term_generator_activity": "No",
    "mixed_waste_generator": "No",
    "transporter_activity": "No",
    "transporter_facility_activity": "No",
    "importer_activity": "No"
  },
  "site_activities": {
    "report_year": "2023",
    "generated_waste": "0.20",
    "managed_waste": 0,
    "shipped_waste": 0,
    "received_waste": 0
  },
  "waste_code_data": {
    "D001": "IGNITABLE WASTE"
  },
  "mmc_codes": [
    {
      "management_method": "H141",
      "management_method_description": "STORAGE, BULKING AND/OR TRANSFER OFF SITE"
    }
  ],
  "naics_codes": [
    {
      "naics_code": "11111",
      "naics_desc": "SOYBEAN FARMING",
      "is_active": "Y"
    }
  ],
  "sic_codes": [
    {
      "sic_code": 5311,
      "sic_desc": "Department Stores"
    }
  ],
  "gen_map": "example",
  "is_network": false,
  "is_streamlinq_enable": false
}

Generated by aglio on 08 May 2024