Back to top

Setup Tools APIs (Part 1)

Overview

Welcome to the Setup Tools API section of the Wastelinq API suite. This collection of APIs is specifically designed to manage and interact with setup tools within the Wastelinq system.

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

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

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.

Broker Config Info

This API group provides endpoints to retrieve and update detailed configuration information for a broker.

brokerconfiginfo1

brokerconfiginfo1
GET/api/lookup/brokerconfiginfo1/

Overview:

This API endpoint, /api/lookup/brokerconfiginfo1/, is a GET request that retrieves detailed configuration information for a broker. The information includes company details, contact information, invoice settings, e-Manifest options, system settings, and order settings. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field, a content field with an array of broker configuration objects, and a totalElements field indicating the total number of broker configuration objects returned.

Request Body and Response Description:

Name Data Type Description
id number The unique identifier for the company.
companyFullName string The full name of the company.
companyShortName string The short name of the company.
companyWebsite string The website URL of the company.
siteID number test
address1 string The first line of the company’s address.
address2 string The second line of the company’s address.
city string The city where the company is located.
state string The state where the company is located.
zip string The zip code of the company’s location.
phone string The company’s phone number.
emergencyPhone string The company’s emergency phone number.
emergencyContact string The emergency contact information for the company.
companySlogan string The company’s slogan.
customInvoiceNote string A custom note for the company’s invoice.
status number test
logo string The URL of the company’s logo.
createddate string The date when the company was created.
modifiedDate string The date when the company was last modified.
isAllCaps boolean Whether the company’s name is in all caps.
progress string Not used in this context.
EmanifestOption string The e-Manifest option for the company.
apiId number test
apiKey number test
logoInvoicePosition string The position of the logo in the invoice.
includeWastelinqEsignature boolean Whether to include the Wastelinq e-signature.
escContactId number The ID of the ESC contact.
is3decimals boolean Whether to use three decimal places.
excludeHandlingCode boolean Whether to exclude the handling code.
excludeSaveProforma boolean Whether to exclude the save proforma.
overrideSystemLock boolean Whether to override the system lock.
smallScanner boolean Whether to use a small scanner.
enableErAuthorization boolean Whether to enable ER authorization.
corporateAddress1 string The first line of the corporate address.
corporateAddress2 string The second line of the corporate address.
corporateCity string The city where the corporate office is located.
corporateState string The state where the corporate office is located.
corporateZip string The zip code of the corporate office.
excludeContainerTypeSize boolean Whether to exclude the container type size.
email string The email address of the company.
allowScheduleWithPriceValue boolean Whether to allow scheduling with price value.
creditCardPayment boolean Whether to accept credit card payments.
orderRequestedDateDaysInAdvance number The number of days in advance to request an order date.
orderConfirmEmailDefaultLanguage string The default language for order confirmation emails.
expiringProfileConfigurableSetting number The configurable setting for expiring profiles.
defaultUnitMeasure string The default unit of measure.
certificationLanguage string The certification language.
startingDay string The starting day.
hideWeekendFromCalendar boolean Whether to hide weekends from the calendar.
orderSelection1 number The first order selection.
orderSelection2 number The second order selection.
orderSelection3 number The third order selection.
orderSelection4 number The fourth order selection.
orderSelection5 number The fifth order selection.
orderStatusCancelled number The status of cancelled orders.
orderStatusOrderPending number The status of pending orders.
orderStatusOrderScheduled number The status of scheduled orders.
orderStatusServiceCompleted number The status of completed services.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/brokerconfiginfo1/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 18,
      "companyFullName": "Company A",
      "companyShortName": "A",
      "companyWebsite": "http://www.companya.com/",
      "siteID": null,
      "address1": "132, My Street, Kingston, New York 12401.",
      "address2": "132, My Street, Kingston, New York 12401.",
      "city": "New York",
      "state": "NY",
      "zip": "12401",
      "phone": "111-111-1111",
      "emergencyPhone": "111-111-1111",
      "emergencyContact": "#11111 - ON CALL SUPERVISOR",
      "companySlogan": "Company A",
      "customInvoiceNote": "test",
      "status": null,
      "logo": "logo.pnj",
      "createddate": "05-07-2020",
      "modifiedDate": "04-29-2024",
      "isAllCaps": false,
      "progress": "",
      "EmanifestOption": "ImageOnly e-Manifest",
      "apiId": null,
      "apiKey": null,
      "logoInvoicePosition": "2",
      "includeWastelinqEsignature": true,
      "escContactId": 974,
      "is3decimals": true,
      "excludeHandlingCode": false,
      "excludeSaveProforma": true,
      "overrideSystemLock": true,
      "smallScanner": false,
      "enableErAuthorization": false,
      "corporateAddress1": "132, My Street, Kingston, New York 12401.",
      "corporateAddress2": "132, My Street, Kingston, New York 12401.",
      "corporateCity": "New York",
      "corporateState": "NY",
      "corporateZip": "12401",
      "excludeContainerTypeSize": true,
      "email": "janedoe@noemail.com",
      "allowScheduleWithPriceValue": true,
      "creditCardPayment": false,
      "orderRequestedDateDaysInAdvance": 9,
      "orderConfirmEmailDefaultLanguage": "test",
      "expiringProfileConfigurableSetting": 41,
      "defaultUnitMeasure": "G",
      "certificationLanguage": "I hereby certify that to the best of my knowledge and belief, the information contained herein is a true, complete and accurate description of the material being offered for recycling or disposal and that all known or suspected hazards have been disclosed. All Analytical Results/Material Safety Data Sheets submitted are truthful and complete and are representative of the waste. Notification will be provided immediately if there is a change in the composition of, or process generating this material, prior to offering the material for shipmtent or management.\r\nIf I am an agent acting on behalf of the generator, I also certify that I have permission to sign any and all material profile paperwork on the generator’s behalf and that I can produce such certification in writing upon request.",
      "startingDay": "2",
      "hideWeekendFromCalendar": false,
      "orderSelection1": 10,
      "orderSelection2": 2,
      "orderSelection3": 8,
      "orderSelection4": 4,
      "orderSelection5": 5,
      "orderStatusCancelled": 1,
      "orderStatusOrderPending": 1,
      "orderStatusOrderScheduled": 1,
      "orderStatusServiceCompleted": 1
    }
  ],
  "totalElements": 1
}

brokerconfiginfo1_save

brokerconfiginfo1_save
POST/api/lookup/brokerconfiginfo1_save/

Overview:

The brokerconfiginfo1_save endpoint, accessible at /api/lookup/brokerconfiginfo1_save/, is a POST request that is used to update the broker configuration information. The request requires an Authorization header with a valid token and a body containing the broker’s details. The response will indicate whether the operation was successful, the unique identifier of the updated broker, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
id number The unique identifier for the company.
companyFullName string The full name of the company.
companyShortName string The short name of the company.
companyWebsite string The website of the company.
siteID null Not used in this context.
address1 string The first line of the company’s address.
address2 string The second line of the company’s address.
city string The city where the company is located.
state string The state where the company is located.
zip string The zip code of the company’s location.
phone string The phone number of the company.
emergencyPhone string The emergency phone number of the company.
emergencyContact string The emergency contact of the company.
companySlogan string The slogan of the company.
customInvoiceNote string A custom note to be included in the company’s invoices.
status null Not used in this context.
logo string The filename of the company’s logo.
createddate string The date the company was created.
modifiedDate string The date the company’s information was last modified.
isAllCaps boolean Indicates whether the company’s name should be displayed in all caps.
progress string Not used in this context.
EmanifestOption string The option chosen for e-Manifest.
apiId null Not used in this context.
apiKey null Not used in this context.
logoInvoicePosition string The position of the logo on the invoice.
includeWastelinqEsignature boolean Indicates whether to include a Wastelinq e-signature.
escContactId number The unique identifier for the ESC contact.
is3decimals boolean Indicates whether to use three decimal places.
excludeHandlingCode boolean Indicates whether to exclude the handling code.
excludeSaveProforma boolean Indicates whether to exclude the save proforma option.
overrideSystemLock boolean Indicates whether to override the system lock.
smallScanner boolean Indicates whether to use a small scanner.
enableErAuthorization boolean Indicates whether to enable ER authorization.
corporateAddress1 string The first line of the corporate address.
corporateAddress2 string The second line of the corporate address.
corporateCity string The city where the corporate office is located.
corporateState string The state where the corporate office is located.
corporateZip string The zip code of the corporate office’s location.
excludeContainerTypeSize boolean Indicates whether to exclude the container type size.
email string The email address of the company.
allowScheduleWithPriceValue boolean Indicates whether to allow scheduling with price value.
creditCardPayment boolean Indicates whether to accept credit card payments.
orderRequestedDateDaysInAdvance number The number of days in advance an order is requested.
orderConfirmEmailDefaultLanguage string The default language for order confirmation emails.
expiringProfileConfigurableSetting number The configurable setting for expiring profiles.
defaultUnitMeasure string The default unit of measure.
certificationLanguage string The language for certifications.
startingDay string The starting day of the week.
hideWeekendFromCalendar boolean Indicates whether to hide the weekend from the calendar.
orderSelection1 number The first order selection.
orderSelection2 number The second order selection.
orderSelection3 number The third order selection.
orderSelection4 number The fourth order selection.
orderSelection5 number The fifth order selection.
orderStatusCancelled number The status code for cancelled orders.
orderStatusOrderPending number The status code for pending orders.
orderStatusOrderScheduled number The status code for scheduled orders.
orderStatusServiceCompleted number The status code for completed services.
success boolean Indicates whether the operation was successful.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/brokerconfiginfo1_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 18,
  "companyFullName": "Company A",
  "companyShortName": "Company A",
  "companyWebsite": "http://www.companya.com/",
  "siteID": null,
  "address1": "132, My Street, Kingston, New York 12401.",
  "address2": "132, My Street, Kingston, New York 12401.",
  "city": "New York",
  "state": "NY",
  "zip": "12401",
  "phone": "222-222-2222",
  "emergencyPhone": "222-222-2222",
  "emergencyContact": "#2222 - ON CALL SUPERVISOR",
  "companySlogan": "Company A",
  "customInvoiceNote": "test 1",
  "status": null,
  "logo": "download_1.jpg",
  "createddate": "05-07-2020",
  "modifiedDate": "05-02-2024",
  "isAllCaps": false,
  "progress": "",
  "EmanifestOption": "ImageOnly e-Manifest",
  "apiId": null,
  "apiKey": null,
  "logoInvoicePosition": "2",
  "includeWastelinqEsignature": true,
  "escContactId": 385,
  "is3decimals": true,
  "excludeHandlingCode": false,
  "excludeSaveProforma": true,
  "overrideSystemLock": true,
  "smallScanner": false,
  "enableErAuthorization": false,
  "corporateAddress1": "132, My Street, Kingston, New York 12401.",
  "corporateAddress2": "132, My Street, Kingston, New York 12401.",
  "corporateCity": "New York",
  "corporateState": "NY",
  "corporateZip": "12401",
  "excludeContainerTypeSize": true,
  "email": "janedoe@noemail.com",
  "allowScheduleWithPriceValue": true,
  "creditCardPayment": false,
  "orderRequestedDateDaysInAdvance": 9,
  "orderConfirmEmailDefaultLanguage": "test",
  "expiringProfileConfigurableSetting": 41,
  "defaultUnitMeasure": "G",
  "certificationLanguage": "test",
  "startingDay": "2",
  "hideWeekendFromCalendar": false,
  "orderSelection1": 10,
  "orderSelection2": 2,
  "orderSelection3": 8,
  "orderSelection4": 4,
  "orderSelection5": 5,
  "orderStatusCancelled": 1,
  "orderStatusOrderPending": 1,
  "orderStatusOrderScheduled": 1,
  "orderStatusServiceCompleted": 1
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": 18,
  "message": "Data updated successfully"
}

Environmental Service Company Set-Up API

This API group provides endpoints to manage the setup information for an Environmental Service Company (ESC).

escsetup_save

escsetup_save
POST/api/lookup/escsetup_save

Overview:

The escsetup_save endpoint is a POST request used to save or update the setup information for a company. The request requires an Authorization header with a valid token and a body containing the setup details such as contact ID, email, corporate address, logo details, company slogan, emergency contact details, and company identifiers. The response will indicate whether the operation was successful and will return a message along with the unique identifier of the updated setup.

Request Body and Response Description:

Name Data Type Description
escContactId number The ID of the ESC contact.
email string The email address of the company.
corporateZip string The zip code of the corporate office.
corporateState string The state where the corporate office is located.
corporateCity string The city where the corporate office is located.
corporateAddress2 string The second line of the corporate address.
corporateAddress1 string The first line of the corporate address.
logoInvoicePosition number The position of the logo in the invoice.
logo string The URL of the company’s logo.
customInvoiceNote string A custom note for the company’s invoice.
companySlogan string The company’s slogan.
emergencyContact string The emergency contact information for the company.
emergencyPhone string The company’s emergency phone number.
phone string The company’s phone number.
zip string The zip code of the company’s location.
state string The state where the company is located.
city string The city where the company is located.
address2 string The second line of the company’s address.
address1 string The first line of the company’s address.
siteID string The site ID of the company.
companyWebsite string The website URL of the company.
companyShortName string The short name of the company.
companyFullName string The full name of the company.
id number The unique identifier for the company.
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/escsetup_save
Request
HideShow
Headers
Content-Type: multipart/form-data
Authorization: {TOKEN}
Body
{
escContactId: 385
email: janedoe@noemail.com
corporateZip: 12401
corporateState: NY
corporateCity: New York
corporateAddress2: 132, My Street, Kingston, New York 12401.
corporateAddress1: 132, My Street, Kingston, New York 12401.
logoInvoicePosition: 2
logo: download_1.jpg
customInvoiceNote: test 1
companySlogan: Company A
emergencyContact: #2222 - ON CALL SUPERVISOR
emergencyPhone: 222-222-2222
phone: 222-222-2222
zip: 12401
state: NY
city: New York
address2: 132, My Street, Kingston, New York 12401.
address1: 32, My Street, Kingston, New York 12401.
siteID: 
companyWebsite: http://www.companya.com/
companyShortName: A
companyFullName: Company A
id: 18
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": "18",
  "message": "ESC Setup updated successfully"
}

companytransportation

companytransportation
GET/api/lookup/companytransportation/

Overview:

The companytransportation endpoint, accessible at /api/lookup/companytransportation/, is a GET request that retrieves a list of companies. Each company object includes details such as the company’s unique identifier, name, EPA ID, state ID, address, city, state, zip code, phone number, and a flag indicating whether the delete option is available for the company. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field, a content field with an array of company objects, and a totalElements field indicating the total number of company objects returned.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects, each representing a company.
id number The unique identifier for the company.
name string The name of the company.
epaId string The EPA ID of the company.
stateId string The state ID of the company.
address1 string The first line of the company’s address.
address2 string The second line of the company’s address.
city string The city where the company is located.
state string The state where the company is located.
zip string The zip code of the company’s location.
phone string The phone number of the company.
showDelete boolean Indicates whether the delete option is available for the company.
totalElements number The total number of company objects returned.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/companytransportation/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 128,
      "name": "test1",
      "epaId": "321321",
      "stateId": "321",
      "address1": "Houston",
      "address2": "",
      "city": "Houston",
      "state": "IN",
      "zip": "34445",
      "phone": "222-222-2222",
      "showDelete": true
    }
  ],
  "totalElements": 1
}

companytransportation_save

companytransportation_save
POST/api/lookup/companytransportation_save

Overview:

The companytransportation_save endpoint, accessible at /api/lookup/companytransportation_save, is a POST request that is used to save or update the transportation details for a company. The request requires an Authorization header with a valid token and a body containing the company’s details such as phone number, zip code, state, city, address, state ID, EPA ID, name, and unique identifier. The response will indicate whether the operation was successful, the type of operation performed (e.g., “UPDATE”), the unique identifier of the updated company transportation, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
phone string The phone number of the company.
zip string The zip code of the company’s location.
state string The state where the company is located.
city string The city where the company is located.
address2 string The second line of the company’s address.
address1 string The first line of the company’s address.
stateId string The state ID of the company.
epaId string The EPA ID of the company.
name string The name of the company.
id string The unique identifier for the company.
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/companytransportation_save
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "phone": "222-222-2222",
  "zip": "34445",
  "state": "TX",
  "city": "Houston",
  "address2": "Houston",
  "address1": "Houston",
  "stateId": "321",
  "epaId": "321321",
  "name": "test_test",
  "id": "128"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 128,
  "message": "Company Transportation updated successfully"
}

companytransportation_del

companytransportation_del
POST/api/lookup/companytransportation_del

Overview:

The companytransportation_del endpoint, accessible at /api/lookup/companytransportation_del, is a POST request that is used to delete a company’s transportation details. The request requires an Authorization header with a valid token and a body containing the unique identifier (id) of the company’s transportation details to be deleted. The response will indicate whether the operation was successful, the type of operation performed (in this case, “DELETE”), the unique identifier of the deleted company transportation, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the deleted company transportation.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/companytransportation_del
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "131"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "131",
  "message": "Company Transportation deleted successfully"
}

networkcontacts

networkcontacts
GET/api/lookup/networkcontacts/

Overview:

The networkcontacts endpoint, accessible at /api/lookup/networkcontacts/, is a GET request that retrieves a list of network ESC contacts. Each contact object includes details such as the unique identifier, network ESC ID, network ESC broker name, personnel ID and name, technical contact ID and name, sales contact ID and name, specialist ID and name, and a flag indicating whether the delete option is available for the network ESC. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field, a content field with an array of network ESC contact objects, and a totalElements field indicating the total number of network ESC contact objects returned.

Request Body and Response Description:

Name Data Type Description
id number The unique identifier for the network ESC.
networkESC_Id number The ID of the network ESC.
networkESC_Broker_Name string The name of the network ESC broker.
personnel_Id number The ID of the personnel.
personnel_Name string The name of the personnel.
technicalContact_Id number The ID of the technical contact.
technicalContact_Name string The name of the technical contact.
salesContact_Id number The ID of the sales contact.
salesContact_Name string The name of the sales contact.
specialist_Id number The ID of the specialist.
specialist_Name string The name of the specialist.
showDelete boolean Indicates whether the delete option is available for the network ESC.
totalElements number The total number of network ESC objects returned.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/networkcontacts/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 54,
      "networkESC_Id": 93,
      "networkESC_Broker_Name": "Company A",
      "personnel_Id": 1078,
      "personnel_Name": "janedoe",
      "technicalContact_Id": 833,
      "technicalContact_Name": "janedoe",
      "salesContact_Id": 779,
      "salesContact_Name": "janedoe",
      "specialist_Id": 370,
      "specialist_Name": "janedoe",
      "showDelete": true
    }
  ],
  "totalElements": 1
}

networkcontacts_save

networkcontacts_save
POST/api/lookup/networkcontacts_save

Overview:

The networkcontacts_save endpoint, accessible at /api/lookup/networkcontacts_save, is a POST request that is used to save or update the contact details for a network ESC. The request requires an Authorization header with a valid token and a body containing the network ESC contact’s details such as specialist ID, sales contact ID, technical contact ID, personnel ID, network ESC ID, and unique identifier. The response will indicate whether the operation was successful, the type of operation performed (e.g., “UPDATE”), the unique identifier of the updated network contact, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
id string The unique identifier for the network ESC contact.
networkESC_Id string The ID of the network ESC.
personnel_Id string The ID of the personnel.
technicalContact_Id string The ID of the technical contact.
salesContact_Id string The ID of the sales contact.
specialist_Id string The ID of the specialist.
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/networkcontacts_save
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "specialist_Id": "370",
  "salesContact_Id": "779",
  "technicalContact_Id": "833",
  "personnel_Id": "1078",
  "networkESC_Id": "93",
  "id": "54"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 54,
  "message": "Network Contact updated successfully"
}

networkcontacts_del

networkcontacts_del
POST/api/lookup/networkcontacts_del

Overview:

The networkcontacts_del endpoint, accessible at /api/lookup/networkcontacts_del, is a POST request that is used to delete a network ESC contact’s details. The request requires an Authorization header with a valid token and a body containing the unique identifier (id) of the network ESC contact to be deleted. The response will indicate whether the operation was successful, the type of operation performed (in this case, “DELETE”), the unique identifier of the deleted network contact, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the deleted network contact.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/networkcontacts_del
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "88"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "88",
  "message": "Network Contact deleted successfully"
}

Company Defaults

This API group provides endpoints to manage the default settings for a company.

generatorcustomfield

generatorcustomfield
GET/api/lookup/generatorcustomfield/

Overview:

The generatorcustomfield endpoint, accessible at /api/lookup/generatorcustomfield/, is a GET request that retrieves a list of custom fields for a generator. Each custom field object includes details such as the unique identifier, name, display order, and a flag indicating whether the delete option is available for the custom field. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field, a content field with an array of custom field objects, and a totalElements field indicating the total number of custom field objects returned.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects, each representing a setup tool.
id number The unique identifier for the setup tool.
name string The name of the setup tool.
displayOrder string The display order of the setup tool.
showDelete boolean Indicates whether the delete option is available for the setup tool.
totalElements number The total number of setup tool objects returned.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/generatorcustomfield/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 26,
      "name": "Customer Confirmed",
      "displayOrder": "3",
      "showDelete": true
    }
  ],
  "totalElements": 1
}

cdgencustomfield_save

cdgencustomfield_save
POST/api/lookup/cdgencustomfield_save

Overview:

The cdgencustomfield_save endpoint, accessible at /api/lookup/cdgencustomfield_save, is a POST request that is used to save or update the custom field details for a generator. The request requires an Authorization header with a valid token and a body containing the custom field’s details such as unique identifier, name, and display order. The response will indicate whether the operation was successful, the type of operation performed (e.g., “UPDATE”), the unique identifier of the updated custom field, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
id string The unique identifier for the setup tool.
name string The name of the setup tool.
displayOrder string The display order of the setup tool.
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/cdgencustomfield_save
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "displayOrder": "4",
  "name": "test",
  "id": "57"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 57,
  "message": "Generator Custom Field updated successfully"
}

cdgencustomfield_del

cdgencustomfield_del
POST/api/lookup/cdgencustomfield_del

Overview:

The cdgencustomfield_del endpoint, accessible at /api/lookup/cdgencustomfield_del, is a POST request that is used to delete a custom field from a generator. The request requires an Authorization header with a valid token and a body containing the unique identifier (id) of the custom field to be deleted. The response will indicate whether the operation was successful, the type of operation performed (in this case, “DELETE”), the unique identifier of the deleted custom field, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the deleted custom field.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/cdgencustomfield_del
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "57"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "57",
  "message": "Generator Custom Field deleted successfully"
}

ordercustomfield

ordercustomfield
GET/api/lookup/ordercustomfield/

Overview:

The ordercustomfield endpoint, accessible at /api/lookup/ordercustomfield/, is a GET request that retrieves the custom fields associated with an order. The request requires an Authorization header with a valid token. The response will indicate whether the operation was successful, an array containing the details of the custom fields (including their unique identifiers, names, and whether the delete option is available for each), and the total number of custom fields.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the details of the setup tool.
id number The unique identifier for the setup tool.
name string The name of the setup tool.
showDelete boolean Indicates whether the delete option is available for the setup tool.
totalElements number The total number of elements in the content array.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/ordercustomfield/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 14,
      "name": "Customer Confirmed",
      "showDelete": true
    }
  ],
  "totalElements": 1
}

cdordcustomfield_save

cdordcustomfield_save
POST/api/lookup/cdordcustomfield_save

Overview:

The cdordcustomfield_save endpoint, accessible at /api/lookup/cdordcustomfield_save, is a POST request that is used to update a custom field for an order. The request requires an Authorization header with a valid token and a body containing the name and unique identifier (id) of the custom field to be updated. The response will indicate whether the operation was successful, the type of operation performed (in this case, “UPDATE”), the unique identifier of the updated custom field, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
name string The name of the setup tool.
id string The unique identifier for the setup tool.
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/cdordcustomfield_save
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "name": "test",
  "id": "34"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 34,
  "message": "Order Custom Field updated successfully"
}

cdordcustomfield_del

cdordcustomfield_del
POST/api/lookup/cdordcustomfield_del

Overview:

The cdordcustomfield_del endpoint, accessible at /api/lookup/cdordcustomfield_del, is a POST request that is used to delete a custom field from an order. The request requires an Authorization header with a valid token and a body containing the unique identifier (id) of the custom field to be deleted. The response will indicate whether the operation was successful, the type of operation performed (in this case, “DELETE”), the unique identifier of the deleted custom field, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the deleted custom field.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/cdordcustomfield_del
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "30"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "30",
  "message": "Order Custom Field deleted successfully"
}

profilecustomfield

profilecustomfield
GET/api/lookup/profilecustomfield/

Overview:

The profilecustomfield endpoint, accessible at /api/lookup/profilecustomfield/, is a GET request that retrieves the custom fields associated with a profile. The request requires an Authorization header with a valid token. The response will indicate whether the operation was successful, an array containing the details of the custom fields (including their unique identifiers, names, and whether the delete option is available for each), and the total number of custom fields.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the request was successful.
content array An array of objects, each representing a data item.
id number The unique identifier for the data item.
name string The name of the data item.
showDelete boolean Indicates whether the delete option is available for the data item.
totalElements number The total number of data items.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/profilecustomfield/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 24,
      "name": "test",
      "showDelete": true
    }
  ],
  "totalElements": 1
}

cdprocustomfield_save

cdprocustomfield_save
POST/api/lookup/cdprocustomfield_save

Overview:

The cdprocustomfield_save endpoint, accessible at /api/lookup/cdprocustomfield_save, is a POST request that is used to update a custom field for a profile. The request requires an Authorization header with a valid token and a body containing the name and unique identifier id of the custom field to be updated. The response will indicate whether the operation was successful, the type of operation performed (in this case, “UPDATE”), the unique identifier of the updated custom field, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the request was successful.
process string The process that was performed, in this case “UPDATE”.
id number The unique identifier for the updated custom field.
message string A message indicating the result of the operation.
name string The name of the custom field to be updated.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/cdprocustomfield_save
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "name": "test-test",
  "id": "24"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 24,
  "message": "Profile Custom Field updated successfully"
}

cdprocustomfield_del

cdprocustomfield_del
POST/api/lookup/cdprocustomfield_del

Overview:

The cdprocustomfield_del endpoint is a part of the lookup API. It is used to delete a custom field associated with a profile. A POST request to this endpoint requires an Authorization header with a valid token and a body containing the id of the custom field to be deleted. The response will indicate whether the deletion was successful, the process that was performed (in this case, “DELETE”), the id of the deleted custom field, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the request was successful.
process string The process that was performed, in this case “DELETE”.
id string The unique identifier for the deleted custom field.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/cdprocustomfield_del
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "25"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "25",
  "message": "Profile Custom Field deleted successfully"
}

driverstatus

driverstatus
GET/api/lookup/driverstatus/

Overview:

The driverstatus endpoint, accessible at /api/lookup/driverstatus/, is a GET request that retrieves a list of driver statuses. Each driver status object includes details such as the unique identifier, name, a flag indicating whether the driver status has a restriction day, and a flag indicating whether the delete option is available for the driver status. The request requires an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the details of the driver statuses.
id number The unique identifier for the driver status.
name string The name of the driver status.
restrictDay boolean Indicates whether the driver status has a restriction day.
showDelete boolean Indicates whether the delete option is available for the driver status.
totalElements number The total number of driver statuses returned.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/driverstatus/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 14,
      "name": "TFS",
      "restrictDay": true,
      "showDelete": true
    }
  ],
  "totalElements": 1
}

cddriverstatus_save

cddriverstatus_save
POST/api/lookup/cddriverstatus_save

Overview:

The cddriverstatus_save endpoint, accessible at /api/lookup/cddriverstatus_save, is a POST request that is used to save or update the driver status. The request requires an Authorization header with a valid token and a body containing the driver status’s details such as restrictDay, name, and id. The response will indicate whether the operation was successful, the type of operation performed (e.g., “UPDATE”), the unique identifier of the updated driver status, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the driver status.
message string A message indicating the result of the operation.
restrictDay boolean Indicates whether the driver status has a restriction day.
name string The name of the driver status.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/cddriverstatus_save
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "restrictDay": true,
  "name": "TFS",
  "id": "14"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 14,
  "message": "Driver Status updated successfully"
}

cddriverstatus_del

cddriverstatus_del
POST/api/lookup/cddriverstatus_del

Overview:

The cddriverstatus_del endpoint, accessible at /api/lookup/cddriverstatus_del, is a POST request that is used to delete a driver status. The request requires an Authorization header with a valid token and a body containing the unique identifier (id) of the driver status to be deleted. The response will indicate whether the operation was successful, the type of operation performed (in this case, “DELETE”), the unique identifier of the deleted driver status, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id string The unique identifier for the driver status.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/cddriverstatus_del
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "47"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "47",
  "message": "Driver Status deleted successfully"
}

accountmapping

accountmapping
GET/api/lookup/accountmapping/

Overview:

The accountmapping endpoint, accessible at /api/lookup/accountmapping/, is a GET request that retrieves a list of account mappings. Each account mapping object includes details such as the unique identifier, location, and email. The request requires an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the details of the account mappings.
id number The unique identifier for the account mapping.
location string The location associated with the account mapping.
email string The email associated with the account mapping.
totalElements number The total number of account mappings returned.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/accountmapping/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 70,
      "location": "Company A",
      "email": "test@test.com"
    }
  ],
  "totalElements": 1
}

cdaccountmapping_save

cdaccountmapping_save
POST/api/lookup/cdaccountmapping_save

Overview:

The cdaccountmapping_save endpoint, accessible at /api/lookup/cdaccountmapping_save, is a POST request that is used to save or update the account mapping.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the account mapping.
message string A message indicating the result of the operation.
email string The email associated with the account mapping.
id string The unique identifier for the account mapping.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/cdaccountmapping_save
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "email": "test@test.com",
  "id": "69"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 182,
  "message": "Calendar Integration updated successfully"
}

outboundshipment

outboundshipment
GET/api/lookup/outboundshipment/

Overview:

The outboundshipment endpoint, accessible at /api/lookup/outboundshipment/, is a GET request that retrieves a list of outbound shipments.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the details of the outbound shipments.
totalElements number The total number of outbound shipments returned.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/outboundshipment/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [],
  "totalElements": 0
}

cdoutboundshipment_save

cdoutboundshipment_save
POST/api/lookup/cdoutboundshipment_save/

Overview:

The cdoutboundshipment_save endpoint, accessible at /api/lookup/cdoutboundshipment_save/, is a POST request that is used to save or update the outbound shipment.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the outbound shipment.
message string A message indicating the result of the operation.
id string The unique identifier for the outbound shipment.
name string The name of the outbound shipment.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/cdoutboundshipment_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "name": "test"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 5,
  "message": "Outbound Shipment created successfully"
}

cdoutboundshipment_del

cdoutboundshipment_del
POST/api/lookup/cdoutboundshipment_del/

Overview:

The cdoutboundshipment_del endpoint, accessible at /api/lookup/cdoutboundshipment_del/, is a POST request that is used to delete an outbound shipment.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the outbound shipment.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/cdoutboundshipment_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "5"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "5",
  "message": "Outbound Shipment deleted successfully"
}

Company Personnel

This API group provides endpoints to manage company personnel.

companypersonnel

companypersonnel
GET/api/lookup/companypersonnel/

Overview:

The companypersonnel endpoint, accessible at /api/lookup/companypersonnel/, is a GET request that retrieves a list of company personnel. Each personnel object includes details such as the unique identifier, name, initials, phone number, email address, a flag indicating whether the personnel is a system user, status, and a flag indicating whether the delete option is available for the personnel. The request requires an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the details of the company personnel.
id number The unique identifier for the personnel.
name string The name of the personnel.
initial string The initials of the personnel.
phone string The phone number of the personnel.
email string The email address of the personnel.
isSystemUser boolean Indicates whether the personnel is a system user.
status string The status of the personnel.
showDelete boolean Indicates whether the delete option is available for the personnel.
totalElements number The total number of personnel returned.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/companypersonnel/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 408,
      "name": "janedoe",
      "initial": "jd",
      "phone": "222-222-2222",
      "email": "janedoe@test.com",
      "isSystemUser": true,
      "status": "",
      "showDelete": true
    }
  ],
  "totalElements": 53
}

companypersonnel_save

companypersonnel_save
POST/api/lookup/companypersonnel_save/

Overview:

The companypersonnel_save endpoint, accessible at /api/lookup/companypersonnel_save/, is a POST request that is used to save or update the company personnel. The request requires an Authorization header with a valid token and a body containing the personnel’s details such as status, email, phone, name, initial, and id. The response will indicate whether the operation was successful, the type of operation performed (e.g., “UPDATE”), the unique identifier of the updated personnel, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the company personnel.
message string A message indicating the result of the operation.
status string The status of the company personnel.
email string The email address of the company personnel.
phone string The phone number of the company personnel.
name string The name of the company personnel.
initial string The initials of the company personnel.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/companypersonnel_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "status": "Active",
  "email": "janedoe@test.com",
  "phone": "222-222-2222",
  "name": "janedoe",
  "initial": "jd",
  "id": "408"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 408,
  "message": "Company Personnel updated successfully"
}

companypersonnel_del

companypersonnel_del
POST/api/lookup/companypersonnel_del

Overview:

The companypersonnel_del endpoint, accessible at /api/lookup/companypersonnel_del, is a POST request that is used to delete a company personnel. The request requires an Authorization header with a valid token and a body containing the unique identifier (id) of the personnel to be deleted. The response will indicate whether the operation was successful, the type of operation performed (in this case, “DELETE”), the unique identifier of the deleted personnel, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id string The unique identifier for the company personnel.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/companypersonnel_del
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "1162"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "1162",
  "message": "Company Personnel deleted successfully"
}

accountassignments

accountassignments
GET/api/lookup/accountassignments/

Overview:

The accountassignments endpoint, accessible at /api/lookup/accountassignments/, is a GET request that retrieves a list of account assignments. Each account assignment object includes details such as the unique identifier, role, display order, and a flag indicating whether the delete option is available for the assignment. The request requires an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the details of the account assignments.
id number The unique identifier for the account assignment.
role string The role associated with the account assignment.
displayOrder string The display order of the account assignment.
showDelete boolean Indicates whether the delete option is available for the account assignment.
totalElements number The total number of account assignments returned.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/accountassignments/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 90,
      "role": "Sales Rep",
      "displayOrder": "1",
      "showDelete": false
    }
  ],
  "totalElements": 1
}

accountassignments_save

accountassignments_save
POST/api/lookup/accountassignments_save/

Overview:

The accountassignments_save endpoint, accessible at /api/lookup/accountassignments_save/, is a POST request that is used to save or update an account assignment. The request requires an Authorization header with a valid token and a body containing the assignment’s details such as displayOrder, role, and id. The response will indicate whether the operation was successful, the type of operation performed (e.g., “UPDATE”), the unique identifier of the updated assignment, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the account assignment.
message string A message indicating the result of the operation.
displayOrder string The display order of the account assignment.
role string The role associated with the account assignment.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/accountassignments_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "displayOrder": "1",
  "role": "Sales Rep",
  "id": "90"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 90,
  "message": "Account Assignment updated successfully"
}

accountassignments_del

accountassignments_del
POST/api/lookup/accountassignments_del/

Overview:

The accountassignments_del endpoint, accessible at /api/lookup/accountassignments_del, is a POST request that is used to delete an account assignment. The request requires an Authorization header with a valid token and a body containing the unique identifier (id) of the assignment to be deleted. The response will indicate whether the operation was successful, the type of operation performed (in this case, “DELETE”), the unique identifier of the deleted assignment, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id string The unique identifier for the account assignment.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/accountassignments_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "242"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "242",
  "message": "Account Assignment deleted successfully"
}

trainingcurriculum

trainingcurriculum
GET/api/lookup/trainingcurriculum/

Overview:

The trainingcurriculum endpoint, accessible at /api/lookup/trainingcurriculum/, is a GET request that retrieves a list of training curriculums. Each curriculum object includes details such as the unique identifier, name, and a flag indicating whether the delete option is available for the curriculum. The request requires an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array containing the details of the training curriculum.
id number The unique identifier for the training curriculum.
name string The name of the training curriculum.
showDelete boolean Indicates whether the delete option is available for the training curriculum.
totalElements number The total number of training curriculums.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/trainingcurriculum/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 57,
      "name": "test",
      "showDelete": true
    }
  ],
  "totalElements": 1
}

trainingcurriculum_save

trainingcurriculum_save
POST/api/lookup/trainingcurriculum_save/

Overview:

The trainingcurriculum_save endpoint, accessible at /api/lookup/trainingcurriculum_save/, is a POST request that is used to save or update a training curriculum. The request requires an Authorization header with a valid token and a body containing the curriculum’s details such as name and id. The response will indicate whether the operation was successful, the type of operation performed (e.g., “UPDATE”), the unique identifier of the updated curriculum, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the training curriculum.
message string A message indicating the result of the operation.
name string The name of the training curriculum.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/trainingcurriculum_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "name": "test",
  "id": "58"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 57,
  "message": "Training Curriculum updated successfully"
}

trainingcurriculum_del

trainingcurriculum_del
POST/api/lookup/trainingcurriculum_del/

Overview:

The trainingcurriculum_del endpoint, accessible at /api/lookup/trainingcurriculum_del, is a POST request that is used to delete a training curriculum. The request requires an Authorization header with a valid token and a body containing the unique identifier (id) of the curriculum to be deleted. The response will indicate whether the operation was successful, the type of operation performed (in this case, “DELETE”), the unique identifier of the deleted curriculum, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id string The unique identifier for the training curriculum.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/trainingcurriculum_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "58"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "58",
  "message": "Training Curriculum deleted successfully"
}

Certification Approval and Required Fields Set-Up

This API group provides endpoints to manage certification approval and required fields set-up.

certificationrequired

certificationrequired
GET/api/lookup/certificationrequired/

Overview:

The GET /api/lookup/certificationrequired/ endpoint is used to fetch the certification requirements. Each requirement is represented by a boolean value indicating whether it is required or not. The requirements cover a wide range of aspects such as profile description, process generating the waste, chemical physical composition, PCP color, and many more. The response includes an array of objects, each representing a certification requirement. The id field is a unique identifier for each requirement.

Request Body and Response Description:

Name Data Type Description
id number The unique identifier for the certification requirement.
profile_description_Required boolean Indicates whether profile description is required.
processGeneratingTheWaste_Required boolean Indicates whether process generating the waste is required.
chemicalPhysicalComposion_Required boolean Indicates whether chemical physical composition is required.
pCPColor_Required boolean Indicates whether PCP color is required.
pCPOdor_Required boolean Indicates whether PCP odor is required.
pCpH_Required boolean Indicates whether PCP pH is required.
pCFlashPoint_Required boolean Indicates whether PCP flash point is required.
pCFlashPoint_Method_Required boolean Indicates whether PCP flash point method is required.
pCPBTUValue_Required boolean Indicates whether PCP BTU value is required.
pCPBoilingPointValue_Required boolean Indicates whether PCP boiling point value is required.
pCPTotalOrganicCarbonValue_Required boolean Indicates whether PCP total organic carbon value is required.
pCPViscosity_Required boolean Indicates whether PCP viscosity is required.
pCPDensity_Required boolean Indicates whether PCP density is required.
pCPPhysicalStateLiquid2_Required boolean Indicates whether PCP physical state liquid 2 is required.
pCNumberOfPhases_Layer_Required boolean Indicates whether PCP number of phases layer is required.
pCPOtherProperties_Required boolean Indicates whether PCP other properties is required.
regulatoryRestrictedUnderLDR_Required boolean Indicates whether regulatory restricted under LDR is required.
regulatoryUHCs_Required boolean Indicates whether regulatory UHCs is required.
regulatory500PPMVOC_Required boolean Indicates whether regulatory 500 PPM VOC is required.
regulatoryAlternativeStandardsofSoil_Required boolean Indicates whether regulatory alternative standards of soil is required.
regulatoryLDRSubcategory_Required boolean Indicates whether regulatory LDR subcategory is required.
hazardousWaste_Required boolean Indicates whether hazardous waste is required.
rCRAExempt_Required boolean Indicates whether RCRA exempt is required.
wCHazardous_Required boolean Indicates whether WC hazardous is required.
universalWaste_Required boolean Indicates whether universal waste is required.
stateUniversalWaste_Required boolean Indicates whether state universal waste is required.
usedOil_Required boolean Indicates whether used oil is required.
recycle_or_reuse_Required boolean Indicates whether recycle or reuse is required.
product_or_coproduct_Required boolean Indicates whether product or coproduct is required.
tSCARegulatedPCBWaste_Required boolean Indicates whether TSCA regulated PCB waste is required.
cERCLARegulatedWaste_Required boolean Indicates whether CERCLA regulated waste is required.
benzeneNESHAPWaste_Required boolean Indicates whether benzene NESHAP waste is required.
halogenatedOrganicCompound_Required boolean Indicates whether halogenated organic compound is required.
medicalWaste_Required boolean Indicates whether medical waste is required.
wasteDetermination_Required boolean Indicates whether waste determination is required.
isNoSampleTaken_Required boolean Indicates whether no sample taken is required.
shipping_volume_frequency_Required boolean Indicates whether shipping volume frequency is required.
transportation_requirements_Required boolean Indicates whether transportation requirements is required.
dto_information_Required boolean Indicates whether DTO information is required.
land_ban_Required boolean Indicates whether land ban is required.
processing_detail_Required boolean Indicates whether processing detail is required.
tsdf_Required boolean Indicates whether TSDF is required.
certification_upload_Required boolean Indicates whether certification upload is required.
weight_Required boolean Indicates whether weight is required.
count_Required boolean Indicates whether count is required.
grade_Required boolean Indicates whether grade is required.
oneTimeNumberNeeded boolean Indicates whether one time number is needed.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/certificationrequired/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1,
      "profile_description_Required": false,
      "processGeneratingTheWaste_Required": false,
      "chemicalPhysicalComposion_Required": false,
      "pCPColor_Required": false,
      "pCPOdor_Required": false,
      "pCpH_Required": true,
      "pCFlashPoint_Required": true,
      "pCFlashPoint_Method_Required": false,
      "pCPBTUValue_Required": false,
      "pCPBoilingPointValue_Required": false,
      "pCPTotalOrganicCarbonValue_Required": false,
      "pCPViscosity_Required": false,
      "pCPDensity_Required": true,
      "pCPPhysicalStateLiquid2_Required": true,
      "pCNumberOfPhases_Layer_Required": false,
      "pCPOtherProperties_Required": false,
      "regulatoryRestrictedUnderLDR_Required": true,
      "regulatoryUHCs_Required": true,
      "regulatory500PPMVOC_Required": true,
      "regulatoryAlternativeStandardsofSoil_Required": true,
      "regulatoryLDRSubcategory_Required": true,
      "hazardousWaste_Required": true,
      "rCRAExempt_Required": false,
      "wCHazardous_Required": false,
      "universalWaste_Required": false,
      "stateUniversalWaste_Required": false,
      "usedOil_Required": false,
      "recycle_or_reuse_Required": false,
      "product_or_coproduct_Required": false,
      "tSCARegulatedPCBWaste_Required": false,
      "cERCLARegulatedWaste_Required": false,
      "benzeneNESHAPWaste_Required": false,
      "halogenatedOrganicCompound_Required": false,
      "medicalWaste_Required": false,
      "wasteDetermination_Required": false,
      "isNoSampleTaken_Required": true,
      "shipping_volume_frequency_Required": true,
      "transportation_requirements_Required": true,
      "dto_information_Required": true,
      "land_ban_Required": false,
      "processing_detail_Required": true,
      "tsdf_Required": true,
      "certification_upload_Required": false,
      "weight_Required": false,
      "count_Required": false,
      "grade_Required": false,
      "oneTimeNumberNeeded": false
    }
  ],
  "totalElements": 1
}

certificationrequired_save

certificationrequired_save
POST/api/lookup/certificationrequired_save/

Overview:

The POST /api/lookup/certificationrequired_save/ endpoint is used to save the certification requirements. The request body should include a JSON object with various fields representing different certification requirements, each represented by a boolean value indicating whether it is required or not. The id field in the request body is a unique identifier for the certification requirement. The response includes a success status, the type of operation performed, the id of the updated certification requirement, and a message indicating the result of the operation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
process string The type of operation performed
id number The unique identifier for the certification requirement
message string A message indicating the result of the operation

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/certificationrequired_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "oneTimeNumberNeeded": false,
  "grade_Required": false,
  "count_Required": false,
  "weight_Required": false,
  "certification_upload_Required": false,
  "tsdf_Required": true,
  "processing_detail_Required": true,
  "land_ban_Required": false,
  "dto_information_Required": true,
  "transportation_requirements_Required": true,
  "shipping_volume_frequency_Required": true,
  "isNoSampleTaken_Required": true,
  "wasteDetermination_Required": false,
  "medicalWaste_Required": false,
  "halogenatedOrganicCompound_Required": false,
  "benzeneNESHAPWaste_Required": false,
  "cERCLARegulatedWaste_Required": false,
  "tSCARegulatedPCBWaste_Required": false,
  "product_or_coproduct_Required": false,
  "recycle_or_reuse_Required": false,
  "usedOil_Required": false,
  "stateUniversalWaste_Required": false,
  "universalWaste_Required": false,
  "wCHazardous_Required": false,
  "rCRAExempt_Required": false,
  "hazardousWaste_Required": true,
  "regulatoryLDRSubcategory_Required": true,
  "regulatoryAlternativeStandardsofSoil_Required": true,
  "regulatory500PPMVOC_Required": true,
  "regulatoryUHCs_Required": true,
  "regulatoryRestrictedUnderLDR_Required": true,
  "pCPOtherProperties_Required": false,
  "pCNumberOfPhases_Layer_Required": false,
  "pCPPhysicalStateLiquid2_Required": true,
  "pCPDensity_Required": true,
  "pCPViscosity_Required": false,
  "pCPTotalOrganicCarbonValue_Required": false,
  "pCPBoilingPointValue_Required": false,
  "pCPBTUValue_Required": false,
  "pCFlashPoint_Method_Required": false,
  "pCFlashPoint_Required": true,
  "pCpH_Required": true,
  "pCPOdor_Required": false,
  "pCPColor_Required": false,
  "chemicalPhysicalComposion_Required": false,
  "processGeneratingTheWaste_Required": false,
  "profile_description_Required": false,
  "id": "1"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 1,
  "message": "Certification Approval Required updated successfully"
}

certificationdecertify

certificationdecertify
GET/api/lookup/certificationdecertify/

Overview:

The GET /api/lookup/certificationdecertify/ endpoint is used to fetch the certification decertifications. Each decertification is represented by a boolean value indicating whether it is decertified or not. The response includes an array of objects, each representing a certification decertification. The id field is a unique identifier for each decertification.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
content array An array of objects, each representing a certification decertification
id number The unique identifier for each decertification
profile_name_Decertify boolean Indicates whether the profile name is decertified
profile_status_Decertify boolean Indicates whether the profile status is decertified
profile_description_Decertify boolean Indicates whether the profile description is decertified
processGeneratingTheWaste_Decertify boolean Indicates whether the process generating the waste is decertified
chemicalPhysicalComposion_Decertify boolean Indicates whether the chemical physical composition is decertified
pCPColor_Decertify boolean Indicates whether the color is decertified
pCPOdor_Decertify boolean Indicates whether the odor is decertified
pCpH_Decertify boolean Indicates whether the pH is decertified
pCFlashPoint_Decertify boolean Indicates whether the flash point is decertified
pCFlashPoint_Method_Decertify boolean Indicates whether the flash point method is decertified
pCPBTUValue_Decertify boolean Indicates whether the BTU value is decertified
pCPBoilingPointValue_Decertify boolean Indicates whether the boiling point value is decertified
pCPTotalOrganicCarbonValue_Decertify boolean Indicates whether the total organic carbon value is decertified
pCPViscosity_Decertify boolean Indicates whether the viscosity is decertified
pCPDensity_Decertify boolean Indicates whether the density is decertified
pCPPhysicalStateLiquid2_Decertify boolean Indicates whether the physical state liquid2 is decertified
pCNumberOfPhases_Layer_Decertify boolean Indicates whether the number of phases layer is decertified
pCPOtherProperties_Decertify boolean Indicates whether the other properties are decertified
regulatoryRestrictedUnderLDR_Decertify boolean Indicates whether it is restricted under LDR
regulatoryUHCs_Decertify boolean Indicates whether UHCs are decertified
regulatory500PPMVOC_Decertify boolean Indicates whether 500 PPM VOC is decertified
regulatoryAlternativeStandardsofSoil_Decertify boolean Indicates whether alternative standards of soil are decertified
regulatoryLDRSubcategory_Decertify boolean Indicates whether LDR subcategory is decertified
hazardousWaste_Decertify boolean Indicates whether it is hazardous waste
rCRAExempt_Decertify boolean Indicates whether it is RCRA exempt
wCHazardous_Decertify boolean Indicates whether it is WC hazardous
epa_waste_code_Decertify boolean Indicates whether EPA waste code is decertified
state_waste_code_Decertify boolean Indicates whether state waste code is decertified
universalWaste_Decertify boolean Indicates whether it is universal waste
stateUniversalWaste_Decertify boolean Indicates whether it is state universal waste
usedOil_Decertify boolean Indicates whether it is used oil
tSCARegulatedPCBWaste_Decertify boolean Indicates whether it is TSCA regulated PCB waste
cERCLARegulatedWaste_Decertify boolean Indicates whether it is CERCLA regulated waste
benzeneNESHAPWaste_Decertify boolean Indicates whether it is benzene NESHAP waste
halogenatedOrganicCompound_Decertify boolean Indicates whether it is halogenated organic compound
ePASourceCode_Decertify boolean Indicates whether EPA source code is decertified
originCode_Decertify boolean Indicates whether origin code is decertified
ePAFormCode_Decertify boolean Indicates whether EPA form code is decertified
wasteDetermination_Decertify boolean Indicates whether waste determination is decertified
shipping_volume_frequency_Decertify boolean Indicates whether shipping volume frequency is decertified
transportation_requirements_Decertify boolean Indicates whether transportation requirements are decertified
dto_information_Decertify boolean Indicates whether DTO information is decertified
land_ban_Decertify boolean Indicates whether land ban is decertified
processing_detail_Decertify boolean Indicates whether processing detail is decertified
tsdf_Decertify boolean Indicates whether tsdf is decertified
totalElements number The total number of certification decertifications

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/certificationdecertify/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1,
      "profile_name_Decertify": false,
      "profile_status_Decertify": false,
      "profile_description_Decertify": false,
      "processGeneratingTheWaste_Decertify": false,
      "chemicalPhysicalComposion_Decertify": true,
      "pCPColor_Decertify": false,
      "pCPOdor_Decertify": false,
      "pCpH_Decertify": true,
      "pCFlashPoint_Decertify": true,
      "pCFlashPoint_Method_Decertify": false,
      "pCPBTUValue_Decertify": false,
      "pCPBoilingPointValue_Decertify": false,
      "pCPTotalOrganicCarbonValue_Decertify": false,
      "pCPViscosity_Decertify": false,
      "pCPDensity_Decertify": false,
      "pCPPhysicalStateLiquid2_Decertify": true,
      "pCNumberOfPhases_Layer_Decertify": false,
      "pCPOtherProperties_Decertify": false,
      "regulatoryRestrictedUnderLDR_Decertify": true,
      "regulatoryUHCs_Decertify": true,
      "regulatory500PPMVOC_Decertify": false,
      "regulatoryAlternativeStandardsofSoil_Decertify": false,
      "regulatoryLDRSubcategory_Decertify": true,
      "hazardousWaste_Decertify": true,
      "rCRAExempt_Decertify": false,
      "wCHazardous_Decertify": false,
      "epa_waste_code_Decertify": true,
      "state_waste_code_Decertify": false,
      "universalWaste_Decertify": false,
      "stateUniversalWaste_Decertify": false,
      "usedOil_Decertify": false,
      "tSCARegulatedPCBWaste_Decertify": false,
      "cERCLARegulatedWaste_Decertify": false,
      "benzeneNESHAPWaste_Decertify": false,
      "halogenatedOrganicCompound_Decertify": false,
      "ePASourceCode_Decertify": false,
      "originCode_Decertify": false,
      "ePAFormCode_Decertify": false,
      "wasteDetermination_Decertify": false,
      "shipping_volume_frequency_Decertify": false,
      "transportation_requirements_Decertify": false,
      "dto_information_Decertify": false,
      "land_ban_Decertify": false,
      "processing_detail_Decertify": false,
      "tsdf_Decertify": false
    }
  ],
  "totalElements": 1
}

certificationdecertify_save

certificationdecertify_save
POST/api/lookup/certificationdecertify_save/

Overview:

This API endpoint allows you to save the certification decertify. It accepts a JSON object containing various certification decertify properties and returns a response indicating the success of the operation, the type of operation performed, the unique identifier of the certification decertify, and a message describing the result of the operation. The request must include an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
process string The type of operation performed
id number The unique identifier for the certification decertify
message string A message indicating the result of the operation

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/certificationdecertify_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "tsdf_Decertify": false,
  "processing_detail_Decertify": false,
  "land_ban_Decertify": false,
  "dto_information_Decertify": false,
  "transportation_requirements_Decertify": false,
  "shipping_volume_frequency_Decertify": false,
  "wasteDetermination_Decertify": false,
  "ePAFormCode_Decertify": false,
  "originCode_Decertify": false,
  "ePASourceCode_Decertify": false,
  "halogenatedOrganicCompound_Decertify": false,
  "benzeneNESHAPWaste_Decertify": false,
  "cERCLARegulatedWaste_Decertify": false,
  "tSCARegulatedPCBWaste_Decertify": false,
  "usedOil_Decertify": false,
  "stateUniversalWaste_Decertify": false,
  "universalWaste_Decertify": false,
  "state_waste_code_Decertify": false,
  "epa_waste_code_Decertify": true,
  "wCHazardous_Decertify": false,
  "rCRAExempt_Decertify": false,
  "hazardousWaste_Decertify": true,
  "regulatoryLDRSubcategory_Decertify": true,
  "regulatoryAlternativeStandardsofSoil_Decertify": false,
  "regulatory500PPMVOC_Decertify": false,
  "regulatoryUHCs_Decertify": true,
  "regulatoryRestrictedUnderLDR_Decertify": true,
  "pCPOtherProperties_Decertify": false,
  "pCNumberOfPhases_Layer_Decertify": false,
  "pCPPhysicalStateLiquid2_Decertify": true,
  "pCPDensity_Decertify": false,
  "pCPViscosity_Decertify": false,
  "pCPTotalOrganicCarbonValue_Decertify": false,
  "pCPBoilingPointValue_Decertify": false,
  "pCPBTUValue_Decertify": false,
  "pCFlashPoint_Method_Decertify": false,
  "pCFlashPoint_Decertify": true,
  "pCpH_Decertify": true,
  "pCPOdor_Decertify": false,
  "pCPColor_Decertify": false,
  "chemicalPhysicalComposion_Decertify": true,
  "processGeneratingTheWaste_Decertify": false,
  "profile_description_Decertify": false,
  "profile_status_Decertify": false,
  "profile_name_Decertify": false,
  "id": "1"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 1,
  "message": "Certification Approval Decertify updated successfully"
}

Container Set-Up

This API group provides endpoints to manage container types and sizes.

containertype

containertype
GET/api/lookup/containertype/

Overview:

This endpoint retrieves a list of container types. It returns a JSON object containing a success status, an array of container types, and the total number of container types. Each container type in the array includes the unique identifier, code, description, a boolean indicating if it’s bulk only, and a boolean indicating if the delete option is available for the container type. The request must include an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
content array An array of container types
id number The unique identifier for the container type
code string The code of the container type
description string The description of the container type
bulkOnly boolean Indicates whether the container type is bulk only
showDelete boolean Indicates whether the delete option is available for the container type
totalElements number The total number of container types

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/containertype/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1,
      "code": "BA",
      "description": "Burlap, cloth, paper or plastic bags",
      "bulkOnly": false,
      "showDelete": false
    }
  ],
  "totalElements": 1
}

containersize

containersize
GET/api/lookup/containersize/

Overview:

This endpoint retrieves a list of container sizes. It returns a JSON object containing a success status, an array of container sizes, and the total number of container sizes. Each container size in the array includes the unique identifier, container type identifier, container type, size, unit, weight, a boolean indicating if it’s active, and a boolean indicating if the delete option is available for the container size. The request must include an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
content array An array of container sizes
id number The unique identifier for the container size
containerTypeId number The unique identifier for the container type
containerType string The type of the container
size string The size of the container
unit string The unit of the size
weight number The weight of the container
isActive boolean Indicates whether the container size is active
showDelete boolean Indicates whether the delete option is available for the container size
totalElements number The total number of container sizes

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/containersize/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 49,
      "containerTypeId": 3,
      "containerType": "CM",
      "size": "3",
      "unit": "Y",
      "weight": 0,
      "isActive": true,
      "showDelete": false
    }
  ],
  "totalElements": 1
}

Profile Approval Levels

This API group provides endpoints to manage profile approval levels.

pal_roles

pal_roles
GET/api/lookup/pal_roles/

Overview:

This endpoint retrieves a list of PAL roles. It returns a JSON object containing a success status, an array of PAL roles, and the total number of PAL roles. Each PAL role in the array includes the unique identifier, name, an array of associated user IDs, an array of associated usernames, and a boolean indicating if the delete option is available for the PAL role. The request must include an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
content array An array of PAL roles
id number The unique identifier for the PAL role
name string The name of the PAL role
user_id array An array of user IDs associated with the PAL role
user_name array An array of usernames associated with the PAL role
showDelete boolean Indicates whether the delete option is available for the PAL role
totalElements number The total number of PAL roles

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/pal_roles/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 33,
      "name": "Sales",
      "user_id": [
        408
      ],
      "user_name": [
        "cliles"
      ],
      "showDelete": true
    }
  ],
  "totalElements": 1
}

pal_roles_save

pal_roles_save
POST/api/lookup/pal_roles_save/

Overview:

This endpoint allows you to save a PAL role. It accepts a JSON object containing the unique identifier, name, and an array of user IDs for the PAL role. It returns a response indicating the success of the operation, the type of operation performed, the unique identifier of the PAL role, and a message describing the result of the operation. The request must include an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
process string The type of operation performed
id number The unique identifier for the PAL role
message string A message describing the result of the operation

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/pal_roles_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "user_id": [
    408,
    925,
    406,
    1190,
    1208
  ],
  "name": "Sales",
  "id": "33"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 33,
  "message": "Role updated successfully"
}

pal_roles_del

pal_roles_del
POST/api/lookup/pal_roles_del/

Overview:

This endpoint allows you to delete a PAL role. It accepts a JSON object containing the unique identifier for the PAL role. It returns a response indicating the success of the operation, the type of operation performed, the unique identifier of the deleted PAL role, and a message describing the result of the operation. The request must include an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
process string The type of operation performed
id number The unique identifier for the PAL role
message string A message describing the result of the operation

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/pal_roles_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "147"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "147",
  "message": "Role deleted successfully"
}

profileapprovedlevels

profileapprovedlevels
GET/api/lookup/profileapprovedlevels/

Overview:

This endpoint retrieves a list of profile approved levels. It returns a JSON object containing a success status, an array of profile approved levels, and the total number of profile approved levels. Each profile approved level in the array includes the unique identifier, name, user role and user associated with the permission and approved level, username associated with the permission and approved level, and a boolean indicating if the profile approved level is editable. The request must include an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
content array An array of profile approved levels
id number The unique identifier for the profile approved level
name string The name of the profile approved level
userRole_Permission string The user role associated with the permission
user_Permission string The user associated with the permission
userName_Permission string The username associated with the permission
userRole_AL string The user role associated with the approved level
user_AL string The user associated with the approved level
userName_AL string The username associated with the approved level
editable boolean Indicates whether the profile approved level is editable
totalElements number The total number of profile approved levels

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/profileapprovedlevels/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 165,
      "name": "Approved",
      "userRole_Permission": "Admin",
      "user_Permission": "",
      "userName_Permission": "",
      "userRole_AL": "Admin",
      "user_AL": "",
      "userName_AL": "",
      "editable": false
    }
  ],
  "totalElements": 9
}

profileapprovedlevels_save

profileapprovedlevels_save
POST/api/lookup/profileapprovedlevels_save/

Overview:

This endpoint allows you to save a profile approved level. It accepts a JSON object containing the unique identifier, name, user role and user associated with the permission and approved level, and username associated with the permission and approved level. It returns a response indicating the success of the operation, the type of operation performed, the unique identifier of the profile approved level, and a message describing the result of the operation. The request must include an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
process string The type of operation performed
id number The unique identifier for the profile approved level
message string A message describing the result of the operation

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/profileapprovedlevels_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "userName_AL": "",
  "user_AL": "NaN",
  "userRole_AL": "Admin",
  "userName_Permission": "",
  "user_Permission": "NaN",
  "userRole_Permission": "Admin",
  "name": "Approved",
  "id": "165"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 165,
  "message": "Profile Approval Level updated successfully"
}

profileapprovedlevels_del

profileapprovedlevels_del
POST/api/lookup/profileapprovedlevels_del/

Overview:

This endpoint allows you to delete a profile approved level. It accepts a JSON object containing the unique identifier for the profile approved level. It returns a response indicating the success of the operation, the type of operation performed, the unique identifier of the deleted profile approved level, and a message describing the result of the operation. The request must include an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
process string The type of operation performed
id number The unique identifier for the profile approved level
message string A message describing the result of the operation

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/profileapprovedlevels_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "1023"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "1023",
  "message": "Profile Approval Level deleted successfully"
}

disposalfacilityapprovalstatus

disposalfacilityapprovalstatus
GET/api/lookup/disposalfacilityapprovalstatus/

Overview:

This endpoint retrieves a list of disposal facility approval statuses. It returns a JSON object containing a success status, an array of disposal facility approval statuses, and the total number of disposal facility approval statuses. Each disposal facility approval status in the array includes the unique identifier, name, and booleans indicating if it’s editable, deletable, and active. The request must include an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
content array An array of disposal facility approval statuses
id number The unique identifier for the disposal facility approval status
name string The name of the disposal facility approval status
is_editable boolean Indicates whether the disposal facility approval status is editable
is_deleteable boolean Indicates whether the disposal facility approval status is deletable
is_active boolean Indicates whether the disposal facility approval status is active
totalElements number The total number of disposal facility approval statuses

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/disposalfacilityapprovalstatus/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 239,
      "name": "Active",
      "is_editable": false,
      "is_deleteable": false,
      "is_active": true
    }
  ],
  "totalElements": 1
}

disposalfacilityapprovalstatus_save

disposalfacilityapprovalstatus_save
POST/api/lookup/disposalfacilityapprovalstatus_save/

Overview:

The disposalfacilityapprovalstatus_save endpoint, accessible at /api/lookup/disposalfacilityapprovalstatus_save/, is a POST request that is used to save or update a disposal facility approval status.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
process string The type of operation performed
id number The unique identifier for the disposal facility approval status
message string A message describing the result of the operation
name string The name of the disposal facility approval status

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/disposalfacilityapprovalstatus_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "name": "test"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 627,
  "message": "Disposal Facility Approval Status created successfully"
}

disposalfacilityapprovalstatus_del

disposalfacilityapprovalstatus_del
POST/api/lookup/disposalfacilityapprovalstatus_del/

Overview:

The disposalfacilityapprovalstatus_del endpoint, accessible at /api/lookup/disposalfacilityapprovalstatus_del/, is a POST request that is used to delete a disposal facility approval status.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
process string The type of operation performed
id number The unique identifier for the disposal facility approval status
message string A message describing the result of the operation

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/disposalfacilityapprovalstatus_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "627"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "627",
  "message": "Disposal Facility Approval Status deleted successfully"
}

Facility

This API group provides endpoints to manage facility locations.

companyfacilitylocations

companyfacilitylocations
GET/api/lookup/companyfacilitylocations/

Overview:

This endpoint retrieves a list of company facility locations. It returns a JSON object containing a success status, an array of company facility locations, and the total number of company facility locations. Each company facility location in the array includes the unique identifier, name, EPA ID, state ID, region, address, city, state, zip code, phone number, sales tax rate, status, a boolean indicating if it’s a WASTELINQ facility, the less than truckload pickup day, and a boolean indicating if the delete option is available. The request must include an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
content array An array of company facility locations
id number The unique identifier for the facility location
name string The name of the facility location
ePA_ID string The EPA ID of the facility location
state_ID string The state ID of the facility location
region string The region of the facility location
address1 string The first line of the address of the facility location
address2 string The second line of the address of the facility location
city string The city of the facility location
state string The state of the facility location
zip string The zip code of the facility location
phone string The phone number of the facility location
sales_Tax_Rate number The sales tax rate of the facility location
status string The status of the facility location
is_wastelinq boolean Indicates whether the facility location is a WASTELINQ facility
ltl_pickup_day string The less than truckload pickup day of the facility location
showDelete boolean Indicates whether the delete option is available for the facility location
totalElements number The total number of company facility locations

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/companyfacilitylocations/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 345,
      "name": "Company A",
      "ePA_ID": "",
      "state_ID": "NY",
      "region": "New York",
      "address1": "132, My Street, Kingston, New York 12401.",
      "address2": "132, My Street, Kingston, New York 12401.",
      "city": "Kingston",
      "state": "NY",
      "zip": "12401",
      "phone": "222-222-2222",
      "sales_Tax_Rate": null,
      "status": "Active",
      "is_wastelinq": true,
      "ltl_pickup_day": null,
      "showDelete": false
    }
  ],
  "totalElements": 1
}

companyfacilitylocations_save

companyfacilitylocations_save
POST/api/lookup/companyfacilitylocations_save/

Overview:

This API endpoint, /api/lookup/companyfacilitylocations_save/, is a POST request that saves the company facility locations. The request requires an Authorization header with a valid token and a JSON body containing the details of the company facility locations. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field with the ID of the updated company facility location, and a message field with a success message.

Request Body and Response Description:

Name Data Type Description
status string The status of the company facility location.
phone string The phone number of the company facility location.
zip string The zip code of the company facility location.
state string The state of the company facility location.
city string The city of the company facility location.
address2 string The second line of the address of the company facility location.
address1 string The first line of the address of the company facility location.
state_ID string The state ID of the company facility location.
region string The region of the company facility location.
ePA_ID string The EPA ID of the company facility location.
name string The name of the company facility location.
id string The unique identifier for the company facility location.
personnel_list array The list of personnel associated with the company facility location.
success boolean Indicates whether the operation was successful.
process string The operation performed.
message string A success message.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/companyfacilitylocations_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "status": "Active",
  "phone": "123-123-1234",
  "zip": "10001",
  "state": "GA",
  "city": "test",
  "address2": "test",
  "address1": "test",
  "state_ID": "test",
  "region": "test",
  "ePA_ID": "test",
  "name": "test",
  "id": "411",
  "personnel_list": [
    {
      "id": 66,
      "personnel_id": 385,
      "initial": "jd",
      "name": "janedoe,
      "phone": "",
      "email": "janedoe@test.com",
      "status": "0"
    }
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 411,
  "message": "Company Facility Location updated successfully"
}

companyfacilitylocations_del

companyfacilitylocations_del
POST/api/lookup/companyfacilitylocations_del/

Overview:

This API endpoint, /api/lookup/companyfacilitylocations_del/, is a POST request that deletes a company facility location. The request requires an Authorization header with a valid token and a JSON body containing the id of the company facility location to be deleted. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field with the ID of the deleted company facility location, and a message field with a success message.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The operation performed.
id number The ID of the deleted company facility location.
message string A success message.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/companyfacilitylocations_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "411"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "411",
  "message": "Company Facility Location deleted successfully"
}

facilityname_personnel_list

facilityname_personnel_list
GET/api/lookup/facilityname_personnel_list/{id}

Overview:

This endpoint retrieves a list of facility personnel. It returns a JSON object containing a success status, an array of facility personnel, and the total number of facility personnel. Each facility personnel in the array includes the unique identifier, personnel ID, initials, name, phone number, email address, and status. The request must include an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
content array An array of facility personnel
id number The unique identifier for the personnel
personnel_id number The personnel ID
initial string The initials of the personnel
name string The name of the personnel
phone string The phone number of the personnel
email string The email address of the personnel
status string The status of the personnel
totalElements number The total number of facility personnel

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/facilityname_personnel_list/id
URI Parameters
HideShow
id
number (required) 

The unique identifier for the facility.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 63,
      "personnel_id": 385,
      "initial": "jd",
      "name": "janedoe",
      "phone": "",
      "email": "janedoe@test.com",
      "status": "0"
    }
  ],
  "totalElements": 1
}

facilitywarehouse

facilitywarehouse
GET/api/lookup/facilitywarehouse/

Overview:

This endpoint retrieves a list of facility warehouses. It returns a JSON object containing a success status, an array of facility warehouses, and the total number of facility warehouses. Each facility warehouse in the array includes the unique identifier, name, type, status, the ID and name of the associated facility, booleans indicating if it’s a waste or product warehouse, and a boolean indicating if the delete option is available. The request must include an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
content array An array of facility warehouses
id number The unique identifier for the warehouse
name string The name of the warehouse
type string The type of the warehouse
status string The status of the warehouse
facilityName_Id number The ID of the facility associated with the warehouse
facilityName_Name string The name of the facility associated with the warehouse
isWasteWarehouse boolean Indicates whether the warehouse is a waste warehouse
isProductWarehouse boolean Indicates whether the warehouse is a product warehouse
showDelete boolean Indicates whether the delete option is available for the warehouse
totalElements number The total number of facility warehouses

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/facilitywarehouse/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 45,
      "name": "Company A",
      "type": "10 Day",
      "status": "Active",
      "facilityName_Id": 71,
      "facilityName_Name": "Company A",
      "isWasteWarehouse": true,
      "isProductWarehouse": false,
      "showDelete": true
    }
  ],
  "totalElements": 1
}

facilitywarehouse_save

facilitywarehouse_save
POST/api/lookup/facilitywarehouse_save/

Overview:

This API endpoint, /api/lookup/facilitywarehouse_save/, is a POST request that saves a facility warehouse. The request requires an Authorization header with a valid token and a JSON body containing the details of the facility warehouse. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field with the ID of the updated facility warehouse, and a message field with a success message.

Request Body and Response Description:

Name Data Type Description
status string The status of the facility warehouse.
facilityName_Id string The ID of the facility name.
type string The type of the facility warehouse.
name string The name of the facility warehouse.
success boolean Indicates whether the operation was successful.
process string The operation performed.
id number The ID of the updated facility warehouse.
message string A success message.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/facilitywarehouse_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "status": "Active",
  "facilityName_Id": "71",
  "type": "10 Day",
  "name": "test",
  "id": "114"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 114,
  "message": "Facility Warehouse updated successfully"
}

facilitywarehouse_del

facilitywarehouse_del
POST/api/lookup/facilitywarehouse_del/

Overview:

This API endpoint, /api/lookup/facilitywarehouse_del/, is a POST request that deletes a facility warehouse. The request requires an Authorization header with a valid token and a JSON body containing the id of the facility warehouse to be deleted. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field with the ID of the deleted facility warehouse, and a message field with a success message.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The operation performed.
id number The ID of the deleted facility warehouse.
message string A success message.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/facilitywarehouse_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "114"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "114",
  "message": "Warehouse deleted successfully"
}

storagelocation

storagelocation
GET/api/lookup/storagelocation/

Overview:

This endpoint retrieves a list of storage locations. It returns a JSON object containing a success status, an array of storage locations, and the total number of storage locations. Each storage location in the array includes the unique identifier, name, status, the ID and name of the associated warehouse, the ID and name of the facility associated with the warehouse, and a boolean indicating if the delete option is available. The request must include an Authorization header with a valid token.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful
content array An array of storage locations
id number The unique identifier for the storage location
name string The name of the storage location
status string The status of the storage location
warehouse_Id number The ID of the warehouse associated with the storage location
warehouse_Name string The name of the warehouse associated with the storage location
warehouse_facilityName_Id number The ID of the facility associated with the warehouse
warehouse_facilityName_Name string The name of the facility associated with the warehouse
showDelete boolean Indicates whether the delete option is available for the storage location
totalElements number The total number of storage locations

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/storagelocation/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 175,
      "name": "test",
      "status": "Active",
      "warehouse_Id": 45,
      "warehouse_Name": "Company A",
      "warehouse_facilityName_Id": 71,
      "warehouse_facilityName_Name": "Company A",
      "showDelete": true
    }
  ],
  "totalElements": 1
}

storagelocation_save

storagelocation_save
POST/api/lookup/storagelocation_save/

Overview:

This API endpoint, /api/lookup/storagelocation_save/, is a POST request that saves a storage location. The request requires an Authorization header with a valid token and a JSON body containing the details of the storage location. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field with the ID of the updated storage location, and a message field with a success message.

Request Body and Response Description:

Name Data Type Description
mmp_id string The ID of the MMP.
is_mmp_bulk boolean Indicates whether the MMP is bulk.
warehouse_Id string The ID of the warehouse.
status string The status of the storage location.
name string The name of the storage location.
success boolean Indicates whether the operation was successful.
process string The operation performed.
id number The ID of the updated storage location.
message string A success message.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/storagelocation_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "mmp_id": "177",
  "is_mmp_bulk": true,
  "warehouse_Id": "45",
  "status": "Active",
  "name": "test",
  "id": "175"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 175,
  "message": "Storage Location updated successfully"
}

storagelocation_del

storagelocation_del
POST/api/lookup/storagelocation_del/

Overview:

This API endpoint, /api/lookup/storagelocation_del/, is a POST request that deletes a storage location. The request requires an Authorization header with a valid token and a JSON body containing the id of the storage location to be deleted. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field with the ID of the deleted storage location, and a message field with a success message.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The operation performed.
id number The ID of the deleted storage location.
message string A success message.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/storagelocation_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "179"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "179",
  "message": "Storage Location deleted successfully"
}

Marketing

This API group provides endpoints to manage marketing data.

calllogactiontype

calllogactiontype
GET/api/lookup/calllogactiontype/

Overview:

This API endpoint, /api/lookup/calllogactiontype/, is a GET request that retrieves the list of call log action types. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of call log action types, and a totalElements field indicating the total number of call log action types.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of call log action types. Each object in the array contains an id, name, and showDelete field.
id number The unique identifier for the call log action type.
name string The name of the call log action type.
showDelete boolean Indicates whether the delete option is available for the call log action type.
totalElements number The total number of call log action types.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/calllogactiontype/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 161,
      "name": "Comments",
      "showDelete": false
    }
  ],
  "totalElements": 1
}

calllogactiontype_save

calllogactiontype_save
POST/api/lookup/calllogactiontype_save/

Overview:

This API endpoint, /api/lookup/calllogactiontype_save/, is a POST request that saves a call log action type. The request requires an Authorization header with a valid token and a body containing the name, id, and brokerId of the call log action type to be saved. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field indicating the id of the saved call log action type, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
name string The name of the call log action type to be saved.
id number The unique identifier for the call log action type.
brokerId number The unique identifier for the broker associated with the call log action type.
success boolean Indicates whether the operation was successful.
process string The operation performed. In this case, “UPDATE”.
id number The id of the saved call log action type.
message string A success message indicating the call log action type was saved successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/calllogactiontype_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "name": "Telemarketing",
  "id": 165,
  "brokerId": 31
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 165,
  "message": "Action Type updated successfully"
}

calllogactiontype_del

calllogactiontype_del
POST/api/lookup/calllogactiontype_del/

Overview:

This API endpoint, /api/lookup/calllogactiontype_del/, is a POST request that deletes a specific call log action type. The request requires an Authorization header with a valid token and a body containing the id of the call log action type to be deleted. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field indicating the id of the deleted call log action type, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The operation performed. In this case, “DELETE”.
id number The id of the deleted call log action type.
message string A success message indicating the call log action type was deleted successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/calllogactiontype_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "541"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "541",
  "message": "Action Type deleted successfully"
}

customercategory

customercategory
GET/api/lookup/customercategory/

Overview:

This API endpoint, /api/lookup/customercategory/, is a GET request that retrieves the list of customer categories. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of customer categories, and a totalElements field indicating the total number of customer categories.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of customer categories. Each object in the array contains an id, code, value, and showDelete field.
id number The unique identifier for the customer category.
code string The code of the customer category.
value string The value of the customer category.
showDelete boolean Indicates whether the delete option is available for the customer category.
totalElements number The total number of customer categories.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/customercategory/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 189,
      "code": "GEN",
      "value": "Generator - Direct",
      "showDelete": false
    }
  ],
  "totalElements": 1
}

customercategory_save

customercategory_save
POST/api/lookup/customercategory_save/

Overview:

This API endpoint, /api/lookup/customercategory_save/, is a POST request that saves a customer category. The request requires an Authorization header with a valid token and a body containing the code, value, id, and brokerId of the customer category to be saved. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field indicating the id of the saved customer category, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
code string The code of the customer category to be saved.
value string The value of the customer category to be saved.
id number The unique identifier for the customer category.
brokerId number The unique identifier for the broker associated with the customer category.
success boolean Indicates whether the operation was successful.
process string The operation performed. In this case, “UPDATE”.
id number The id of the saved customer category.
message string A success message indicating the customer category was saved successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/customercategory_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "code": "TRO",
  "value": "Transportation Only",
  "id": 193,
  "brokerId": 31
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 193,
  "message": "Category updated successfully"
}

customercategory_del

customercategory_del
POST/api/lookup/customercategory_del/

Overview:

This API endpoint, /api/lookup/customercategory_del/, is a POST request that deletes a specific customer category. The request requires an Authorization header with a valid token and a body containing the id of the customer category to be deleted. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field indicating the id of the deleted customer category, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The operation performed. In this case, “DELETE”.
id number The id of the deleted customer category.
message string A success message indicating the customer category was deleted successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/customercategory_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "675"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "675",
  "message": "Category deleted successfully"
}

customerbusinesssegment

customerbusinesssegment
GET/api/lookup/customerbusinesssegment/

Overview:

This API endpoint, /api/lookup/customerbusinesssegment/, is a GET request that retrieves the list of customer business segments. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of customer business segments, and a totalElements field indicating the total number of customer business segments.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of customer business segments. Each object in the array contains an id, code, value, and showDelete field.
id number The unique identifier for the customer business segment.
code string The code of the customer business segment.
value string The value of the customer business segment.
showDelete boolean Indicates whether the delete option is available for the customer business segment.
totalElements number The total number of customer business segments.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/customerbusinesssegment/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 692,
      "code": "AGR",
      "value": "Agriculture, and all food/begerage related industries",
      "showDelete": false
    }
  ],
  "totalElements": 1
}

customerbusinesssegment_save

customerbusinesssegment_save
POST/api/lookup/customerbusinesssegment_save/

Overview:

This API endpoint, /api/lookup/customerbusinesssegment_save/, is a POST request that saves a customer business segment. The request requires an Authorization header with a valid token and a body containing the code, value, id, and brokerId of the customer business segment to be saved. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field indicating the id of the saved customer business segment, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
code string The code of the customer business segment to be saved.
value string The value of the customer business segment to be saved.
id number The unique identifier for the customer business segment.
brokerId number The unique identifier for the broker associated with the customer business segment.
success boolean Indicates whether the operation was successful.
process string The operation performed. In this case, “UPDATE”.
id number The id of the saved customer business segment.
message string A success message indicating the customer business segment was saved successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/customerbusinesssegment_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "code": "test",
  "value": "test",
  "id": 2857,
  "brokerId": 31
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 2857,
  "message": "Segment updated successfully"
}

customerbusinesssegment_del

customerbusinesssegment_del
POST/api/lookup/customerbusinesssegment_del/

Overview:

This API endpoint, /api/lookup/customerbusinesssegment_del/, is a POST request that deletes a specific customer business segment. The request requires an Authorization header with a valid token and a body containing the id of the customer business segment to be deleted. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field indicating the id of the deleted customer business segment, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The operation performed. In this case, “DELETE”.
id number The id of the deleted customer business segment.
message string A success message indicating the customer business segment was deleted successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/customerbusinesssegment_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "2857"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "2857",
  "message": "Segment deleted successfully"
}

customersizecode

customersizecode
GET/api/lookup/customersizecode/

Overview:

This API endpoint, /api/lookup/customersizecode/, is a GET request that retrieves the list of customer size codes. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of customer size codes, and a totalElements field indicating the total number of customer size codes.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of customer size codes. Each object in the array contains an id, code, value, and showDelete field.
id number The unique identifier for the customer size code.
code string The code of the customer size code.
value string The value of the customer size code.
showDelete boolean Indicates whether the delete option is available for the customer size code.
totalElements number The total number of customer size codes.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/customersizecode/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 177,
      "code": "A",
      "value": ">=$250K",
      "showDelete": false
    }
  ],
  "totalElements": 5
}

customersizecode_save

customersizecode_save
POST/api/lookup/customersizecode_save/

Overview:

This API endpoint, /api/lookup/customersizecode_save/, is a POST request that saves a customer size code. The request requires an Authorization header with a valid token and a body containing the code, value, id, and brokerId of the customer size code to be saved. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field indicating the id of the saved customer size code, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
code string The code of the customer size code to be saved.
value string The value of the customer size code to be saved.
id number The unique identifier for the customer size code.
brokerId number The unique identifier for the broker associated with the customer size code.
success boolean Indicates whether the operation was successful.
process string The operation performed. In this case, “UPDATE”.
id number The id of the saved customer size code.
message string A success message indicating the customer size code was saved successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/customersizecode_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "code": "E",
  "value": "<$10K",
  "id": 181,
  "brokerId": 31
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 181,
  "message": "SizeCode updated successfully"
}

customersizecode_del

customersizecode_del
POST/api/lookup/customersizecode_del/

Overview:

This API endpoint, /api/lookup/customersizecode_del/, is a POST request that deletes a specific customer size code. The request requires an Authorization header with a valid token and a body containing the id of the customer size code to be deleted. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field indicating the id of the deleted customer size code, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The operation performed. In this case, “DELETE”.
id number The id of the deleted customer size code.
message string A success message indicating the customer size code was deleted successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/customersizecode_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "647"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "647",
  "message": "SizeCode deleted successfully"
}

contacttype

contacttype
GET/api/lookup/contacttype/

Overview:

This API endpoint, /api/lookup/contacttype/, is a GET request that retrieves the list of contact types. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of contact types, and a totalElements field indicating the total number of contact types.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of contact types. Each object in the array contains an id, name, and showDelete field.
id number The unique identifier for the contact type.
name string The name of the contact type.
showDelete boolean Indicates whether the delete option is available for the contact type.
totalElements number The total number of contact types.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/contacttype/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 158,
      "name": "Customer Primary",
      "showDelete": false
    }
  ],
  "totalElements": 1
}

contacttype_save

contacttype_save
POST/api/lookup/contacttype_save/

Overview:

This API endpoint, /api/lookup/contacttype_save/, is a POST request that saves a contact type. The request requires an Authorization header with a valid token and a body containing the name, id, and brokerId of the contact type to be saved. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field indicating the id of the saved contact type, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
name string The name of the contact type to be saved.
id number The unique identifier for the contact type.
brokerId number The unique identifier for the broker associated with the contact type.
success boolean Indicates whether the operation was successful.
process string The operation performed. In this case, “UPDATE”.
id number The id of the saved contact type.
message string A success message indicating the contact type was saved successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/contacttype_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "name": "Customer Secondary",
  "id": 268,
  "brokerId": 31
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 268,
  "message": "Contact Type updated successfully"
}

contacttype_del

contacttype_del
POST/api/lookup/contacttype_del/

Overview:

This API endpoint, /api/lookup/contacttype_del/, is a POST request that deletes a specific contact type. The request requires an Authorization header with a valid token and a body containing the id of the contact type to be deleted. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field indicating the id of the deleted contact type, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The operation performed. In this case, “DELETE”.
id string The id of the deleted contact type.
message string A success message indicating the contact type was deleted successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/contacttype_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "570"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "570",
  "message": "Contact Type deleted successfully"
}

ordersource

ordersource
GET/api/lookup/ordersource/

Overview:

This API endpoint, /api/lookup/ordersource/, is a GET request that retrieves the list of order sources. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of order sources, and a totalElements field indicating the total number of order sources.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of order sources. Each object in the array contains an id, name, and showDelete field.
id number The unique identifier for the order source.
name string The name of the order source.
showDelete boolean Indicates whether the delete option is available for the order source.
totalElements number The total number of order sources.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/ordersource/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 78,
      "name": "Customer Call",
      "showDelete": false
    }
  ],
  "totalElements": 1
}

ordersource_save

ordersource_save
POST/api/lookup/ordersource_save/

Overview:

This API endpoint, /api/lookup/ordersource_save/, is a POST request that saves an order source. The request requires an Authorization header with a valid token and a body containing the name, id, and brokerId of the order source to be saved. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field indicating the id of the saved order source, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
name string The name of the order source to be saved.
id number The unique identifier for the order source.
brokerId number The unique identifier for the broker associated with the order source.
success boolean Indicates whether the operation was successful.
process string The operation performed. In this case, “UPDATE”.
id number The id of the saved order source.
message string A success message indicating the order source was saved successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/ordersource_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "name": "ENet",
  "id": 81,
  "brokerId": 31
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 81,
  "message": "Order Source updated successfully"
}

ordersource_del

ordersource_del
POST/api/lookup/ordersource_del/

Overview:

This API endpoint, /api/lookup/ordersource_del/, is a POST request that deletes a specific order source. The request requires an Authorization header with a valid token and a body containing the id of the order source to be deleted. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field indicating the id of the deleted order source, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The operation performed. In this case, “DELETE”.
id string The id of the deleted order source.
message string A success message indicating the order source was deleted successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/ordersource_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "131"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "131",
  "message": "Order Source deleted successfully"
}

Generator Information

This API group provides endpoints to manage generator information.

epageneratorstatuscategory

epageneratorstatuscategory
GET/api/lookup/epageneratorstatuscategory/

Overview:

This API endpoint, /api/lookup/epageneratorstatuscategory/, is a GET request that retrieves the EPA generator status categories. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of EPA generator status categories, and a totalElements field indicating the total number of EPA generator status categories.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of EPA generator status categories. Each object in the array contains an id, code, and value field.
id number The unique identifier for the EPA generator status category.
code string The code of the EPA generator status category.
value string The value of the EPA generator status category.
totalElements number The total number of EPA generator status categories.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/epageneratorstatuscategory/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 121,
      "code": "N/A",
      "value": "Not Applicable"
    }
  ],
  "totalElements": 1
}

Drivers

This API group provides endpoints to manage driver information.

driver

driver
GET/api/lookup/driver/

Overview:

This API endpoint, /api/lookup/driver/, is a GET request that retrieves the driver details. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of driver details, and a totalElements field indicating the total number of drivers.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of driver details. Each object in the array contains the driver details.
id number The unique identifier for the driver.
driverId number The driver’s ID.
name string The name of the driver.
code string The code of the driver.
status string The status of the driver.
createdDate string The date the driver was created.
modifiedDate string The date the driver was last modified.
broker string The broker for the driver.
facilityName string The name of the facility.
transportationName string The name of the transportation.
transportationNameId number The ID of the transportation name.
transportationStateId string The state ID of the transportation.
transportationPhone string The phone number of the transportation.
transportationEpaId string The EPA ID of the transportation.
user string The user associated with the driver.
wastelinq boolean Indicates whether the driver is linked to Wastelinq.
email string The email of the driver.
username string The username of the driver.
special string Any special notes for the driver.
uId number The unique ID of the driver.
showDelete boolean Indicates whether the delete option is available for the driver.
totalElements number The total number of drivers.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/driver/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 536,
      "driverId": 1,
      "name": "janedoe",
      "code": "111",
      "status": "Inactive",
      "createdDate": "",
      "modifiedDate": "2024-05-07",
      "broker": "Company A",
      "facilityName": "",
      "transportationName": "Company B",
      "transportationNameId": 21,
      "transportationStateId": "91034",
      "transportationPhone": "222-222-2222",
      "transportationEpaId": "10000",
      "user": "",
      "wastelinq": false,
      "email": null,
      "username": "",
      "special": "",
      "uId": null,
      "showDelete": false
    }
  ],
  "totalElements": 1
}

driver_save

driver_save
POST/api/lookup/driver_save/

Overview:

This API endpoint, /api/lookup/driver_save/, is a POST request that saves the driver details. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field indicating the id of the saved driver, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
modifiedDate string The date the driver was last modified.
status string The status of the driver.
wastelinq boolean Indicates whether the driver is linked to Wastelinq.
email string The email of the driver.
uId number The unique ID of the driver.
special string Any special notes for the driver.
username string The username of the driver.
company string The company of the driver.
code string The code of the driver.
name string The name of the driver.
id number The unique identifier for the driver.
success boolean Indicates whether the operation was successful.
process string The operation performed. In this case, “UPDATE”.
id number The id of the saved driver.
message string A success message indicating the driver was updated successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/driver_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "modifiedDate": "05/07/2024",
  "status": "Inactive",
  "wastelinq": false,
  "email": null,
  "uId": null,
  "special": "ZG9zYW5nMTIzMzIx",
  "username": "janedoe@test.com",
  "company": "21",
  "code": "111",
  "name": "janedoe",
  "id": "536"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 536,
  "message": "Driver updated successfully"
}

driver_del

driver_del
POST/api/lookup/driver_del/

Overview:

This API endpoint, /api/lookup/driver_del/, is a POST request that deletes a driver. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field indicating the id of the deleted driver, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The operation performed. In this case, “DELETE”.
id number The id of the deleted driver.
message string A success message indicating the driver was deleted successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/driver_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "1190"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "1190",
  "message": "Driver deleted successfully"
}

3rd Party Transportation Companies

This API group provides endpoints to manage third party transportation companies.

thirdpartytransportationcompanies

thirdpartytransportationcompanies
GET/api/lookup/thirdpartytransportationcompanies/

Overview:

This API endpoint, /api/lookup/thirdpartytransportationcompanies/, is a GET request that retrieves the third party transportation companies. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of third party transportation companies, and a totalElements field indicating the total number of third party transportation companies.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of third party transportation companies. Each object in the array contains the company details.
totalElements number The total number of third party transportation companies.
id number The unique identifier for the company.
origination string The origination of the company.
tran_Com_Number number The company number.
name string The name of the company.
preferred boolean Indicates whether the company is preferred.
isWasteLinq boolean Indicates whether the company is linked to WasteLinq.
transportation_State_ID string The state ID of the transportation.
transportation_EPA_ID string The EPA ID of the transportation.
transportation_Phone string The phone number of the transportation.
address1 string The first line of the address.
address2 string The second line of the address.
city string The city of the address.
state string The state of the address.
zip string The zip code of the address.
status string The status of the company.
approval_Documents string The approval documents of the company.
showDelete boolean Indicates whether the delete option is available for the company.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/thirdpartytransportationcompanies/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 46008,
      "origination": "WASTELINQ",
      "tran_Com_Number": 38119,
      "name": "Company A",
      "preferred": false,
      "isWasteLinq": false,
      "transportation_State_ID": "85672",
      "transportation_EPA_ID": "10000",
      "transportation_Phone": "222-222-2222",
      "address1": null,
      "address2": null,
      "city": null,
      "state": null,
      "zip": null,
      "status": "Active",
      "approval_Documents": null,
      "showDelete": false
    }
  ],
  "totalElements": 1
}

thirdpartytransportationcompanies_save

thirdpartytransportationcompanies_save
POST/api/lookup/thirdpartytransportationcompanies_save/

Overview:

This API endpoint, /api/lookup/thirdpartytransportationcompanies_save/, is a POST request that saves the third party transportation company details. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field indicating the id of the saved company, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
brokerId number The broker ID of the company.
approval_Documents string The approval documents of the company.
status string The status of the company.
zip string The zip code of the company’s address.
state string The state of the company’s address.
city string The city of the company’s address.
address2 string The second line of the company’s address.
address1 string The first line of the company’s address.
transportation_Phone string The phone number of the transportation.
transportation_EPA_ID string The EPA ID of the transportation.
transportation_State_ID string The state ID of the transportation.
isWasteLinq boolean Indicates whether the company is linked to WasteLinq.
preferred boolean Indicates whether the company is preferred.
name string The name of the company.
id number The unique identifier for the company.
success boolean Indicates whether the operation was successful.
process string The operation performed. In this case, “UPDATE”.
id number The id of the saved company.
message string A success message indicating the company was updated successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/thirdpartytransportationcompanies_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "brokerId": 31,
  "approval_Documents": null,
  "status": "Active",
  "zip": "10001",
  "state": "CO",
  "city": "test",
  "address2": "test",
  "address1": "test",
  "transportation_Phone": "222-222-2222",
  "transportation_EPA_ID": "10000",
  "transportation_State_ID": "85672",
  "isWasteLinq": false,
  "preferred": false,
  "name": "Company A",
  "id": "46008"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 46008,
  "message": "3rd Party Transportation Company updated successfully"
}

thirdpartytransportationcompanies_del

thirdpartytransportationcompanies_del
POST/api/lookup/thirdpartytransportationcompanies_del/

Overview:

This API endpoint, /api/lookup/thirdpartytransportationcompanies_del/, is a POST request that deletes a third party transportation company. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the operation performed, an id field indicating the id of the deleted company, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The operation performed. In this case, “DELETE”.
id number The id of the deleted company.
message string A success message indicating the company was deleted successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/thirdpartytransportationcompanies_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "119516"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "119516",
  "message": "3rd Party Transportation Company deleted successfully"
}

thirdpartytransportationcompanies_upload_file

thirdpartytransportationcompanies_upload_file
POST/api/lookup/thirdpartytransportationcompanies_upload_file/

Overview:

This API endpoint, /api/lookup/thirdpartytransportationcompanies_upload_file/, is a POST request that uploads a file for a third party transportation company. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, an id field indicating the id of the uploaded file, and a message field containing a success message.

Request Body and Response Description:

files | file | The file to be uploaded. success | boolean | Indicates whether the operation was successful. id | number | The id of the uploaded file. message | string | A success message indicating the file was uploaded successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/thirdpartytransportationcompanies_upload_file/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
    ------WebKitFormBoundary1s99WJAWj6BpOpPa
    Content-Disposition: form-data; name="files"; filename="test.txt"
    Content-Type: text/plain
    ------WebKitFormBoundary1s99WJAWj6BpOpPa--
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "119516",
  "message": "Files uploaded successfully"
}

thirdpartytransportationcompanies_get_file

thirdpartytransportationcompanies_get_file
GET/api/lookup/thirdpartytransportationcompanies_get_file/

Overview:

This API endpoint, /api/lookup/thirdpartytransportationcompanies_get_file/, is a GET request that retrieves the file details for a third party transportation company. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of file details, and a totalElements field indicating the total number of files.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of file details. Each object in the array contains the file details.
totalElements number The total number of files.
id number The unique identifier for the file.
name string The name of the file.
url string The URL of the file.
IsPublic boolean Indicates whether the file is public.
FileExt string The file extension.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/thirdpartytransportationcompanies_get_file/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 2617285,
      "name": "06_11.txt",
      "url": "3rdTransportation/test.txt",
      "IsPublic": false,
      "FileExt": "txt"
    }
  ],
  "totalElements": 1
}

thirdpartytransportationcompanies_remove_file

thirdpartytransportationcompanies_remove_file
POST/api/lookup/thirdpartytransportationcompanies_remove_file/

Overview:

This API endpoint, /api/lookup/thirdpartytransportationcompanies_remove_file/, is a POST request that removes a file from a third party transportation company. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, an id field indicating the id of the removed file, and a message field containing a success message.

Request Body and Response Description:

success | boolean | Indicates whether the operation was successful. id | number | The id of the removed file. message | string | A success message indicating the file was removed successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/thirdpartytransportationcompanies_remove_file/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "2617285"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": 2617285,
  "message": "File delete successfully"
}

Fuel Surcharge

This API group provides endpoints to manage fuel surcharge information.

fuelsurchargeconfig

fuelsurchargeconfig
GET/api/lookup/fuelsurchargeconfig/

Overview:

This API endpoint, /api/lookup/fuelsurchargeconfig/, is a GET request that retrieves the fuel surcharge configuration. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of fuel surcharge configuration details, and a totalElements field indicating the total number of configurations.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of fuel surcharge configuration details. Each object in the array contains the configuration details.
id number The unique identifier for the configuration.
fuel_Surcharges_Threshold_Price string The threshold price for fuel surcharges.
fuel_Surcharges_Fleet_MPG string The fleet miles per gallon for fuel surcharges.
fuel_Surcharges_Adjustment_Factor string The adjustment factor for fuel surcharges.
totalElements number The total number of configurations.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/fuelsurchargeconfig/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 5,
      "fuel_Surcharges_Threshold_Price": "2.00",
      "fuel_Surcharges_Fleet_MPG": "5.4",
      "fuel_Surcharges_Adjustment_Factor": "0"
    }
  ],
  "totalElements": 1
}

fuelsurchargeconfig_save

fuelsurchargeconfig_save
POST/api/lookup/fuelsurchargeconfig_save/

Overview:

This API endpoint, /api/lookup/fuelsurchargeconfig_save/, is a POST request that saves the fuel surcharge configuration. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the type of operation performed, an id field indicating the id of the saved configuration, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token.
brokerId number The unique identifier for the broker.
fuel_Surcharges_Adjustment_Factor number The adjustment factor for fuel surcharges.
fuel_Surcharges_Fleet_MPG number The fleet miles per gallon for fuel surcharges.
fuel_Surcharges_Threshold_Price number The threshold price for fuel surcharges.
id string The unique identifier for the configuration.
success boolean Indicates whether the operation was successful.
process string The type of operation performed. This can be “UPDATE” or “CREATE”.
id number The id of the saved configuration.
message string A success message indicating the configuration was saved successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/fuelsurchargeconfig_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "brokerId": 31,
  "fuel_Surcharges_Adjustment_Factor": 0,
  "fuel_Surcharges_Fleet_MPG": 5.4,
  "fuel_Surcharges_Threshold_Price": 2,
  "id": "5"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 5,
  "message": "Fuel Surcharge Config updated successfully"
}

fuelsurcharge

fuelsurcharge
GET/api/lookup/fuelsurcharge/

Overview:

This API endpoint, /api/lookup/fuelsurcharge/, is a GET request that retrieves the fuel surcharge details. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of fuel surcharge details, and a totalElements field indicating the total number of fuel surcharge entries.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of fuel surcharge details. Each object in the array contains the fuel surcharge details.
id number The unique identifier for the fuel surcharge entry.
entry_Date string The date of the fuel surcharge entry.
diesel_Rate string The diesel rate for the fuel surcharge entry.
fuel_surcharge_value string The fuel surcharge value for the entry.
showDelete boolean Indicates whether the delete option is available for the entry.
totalElements number The total number of fuel surcharge entries.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/fuelsurcharge/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 785,
      "entry_Date": "2024-04-29",
      "diesel_Rate": "3.657",
      "fuel_surcharge_value": "0.307",
      "showDelete": true
    }
  ],
  "totalElements": 1
}

fuelsurcharge_save

fuelsurcharge_save
POST/api/lookup/fuelsurcharge_save/

Overview:

This API endpoint, /api/lookup/fuelsurcharge_save/, is a POST request that saves the fuel surcharge details. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the type of operation performed, an id field indicating the id of the saved fuel surcharge entry, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token.
id number The unique identifier for the fuel surcharge entry.
entry_Date string The date of the fuel surcharge entry.
diesel_Rate string The diesel rate for the fuel surcharge entry.
fuel_surcharge_value string The fuel surcharge value for the entry.
brokerId number The unique identifier for the broker.
success boolean Indicates whether the operation was successful.
process string The type of operation performed. This can be “UPDATE” or “CREATE”.
id number The id of the saved fuel surcharge entry.
message string A success message indicating the fuel surcharge entry was saved successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/fuelsurcharge_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 788,
  "entry_Date": "2024-05-10",
  "diesel_Rate": "1.1",
  "fuel_surcharge_value": "-0.167",
  "brokerId": 31
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 788,
  "message": "Fuel Surcharge updated successfully"
}

Network Fuel Surcharge

This API group provides endpoints to manage network fuel surcharge information.

networkfuelsurchargeconfig

networkfuelsurchargeconfig
GET/api/lookup/networkfuelsurchargeconfig/

Overview:

This API endpoint, /api/lookup/networkfuelsurchargeconfig/, is a GET request that retrieves the network fuel surcharge configuration. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of network fuel surcharge configuration details, and a totalElements field indicating the total number of configurations.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of network fuel surcharge configuration details. Each object in the array contains the configuration details.
id number The unique identifier for the configuration.
fuel_Surcharges_Threshold_Price string The threshold price for network fuel surcharges.
fuel_Surcharges_Fleet_MPG string The fleet miles per gallon for network fuel surcharges.
fuel_Surcharges_Adjustment_Factor string The adjustment factor for network fuel surcharges.
totalElements number The total number of configurations.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/networkfuelsurchargeconfig/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [],
  "totalElements": 0
}

networkfuelsurcharge

networkfuelsurcharge
GET/api/lookup/networkfuelsurcharge/

Overview:

This API endpoint, /api/lookup/networkfuelsurcharge/, is a GET request that retrieves the network fuel surcharge details. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of network fuel surcharge details, and a totalElements field indicating the total number of network fuel surcharge entries.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of network fuel surcharge details. Each object in the array contains the network fuel surcharge details.
id number The unique identifier for the network fuel surcharge entry.
entry_Date string The date of the network fuel surcharge entry.
diesel_Rate string The diesel rate for the network fuel surcharge entry.
fuel_surcharge_value string The network fuel surcharge value for the entry.
showDelete boolean Indicates whether the delete option is available for the entry.
totalElements number The total number of network fuel surcharge entries.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/networkfuelsurcharge/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [],
  "totalElements": 0
}

Transportation Logistic Zone

This API group provides endpoints to manage transportation logistic zone information.

transportationlogisticzone

transportationlogisticzone
GET/api/lookup/transportationlogisticzone/

Overview:

This API endpoint, /api/lookup/transportationlogisticzone/, is a GET request that retrieves the transportation logistic zone details. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of transportation logistic zone details, and a totalElements field indicating the total number of transportation logistic zone entries.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of transportation logistic zone details. Each object in the array contains the transportation logistic zone details.
id number The unique identifier for the transportation logistic zone entry.
code string The code of the transportation logistic zone.
region string The region of the transportation logistic zone.
zip string The zip code of the transportation logistic zone.
state string The state of the transportation logistic zone.
county string The county of the transportation logistic zone.
showDelete boolean Indicates whether the delete option is available for the entry.
totalElements number The total number of transportation logistic zone entries.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/transportationlogisticzone/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 120324,
      "code": "WT3",
      "region": "TX, NM",
      "zip": "79938",
      "state": "TX, NM",
      "county": "El Paso ",
      "showDelete": true
    }
  ],
  "totalElements": 1
}

transportationlogisticzone_save

transportationlogisticzone_save
POST/api/lookup/transportationlogisticzone_save/

Overview:

This API endpoint, /api/lookup/transportationlogisticzone_save/, is a POST request that saves the transportation logistic zone details. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the type of operation performed, an id field indicating the id of the saved transportation logistic zone entry, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
code string The code of the transportation logistic zone.
region string The region of the transportation logistic zone.
zip string The zip code of the transportation logistic zone.
state string The state of the transportation logistic zone.
county string The county of the transportation logistic zone.
id number The unique identifier for the transportation logistic zone entry.
brokerId number The unique identifier for the broker.
success boolean Indicates whether the operation was successful.
process string The type of operation performed. This can be “UPDATE” or “CREATE”.
id number The id of the saved transportation logistic zone entry.
message string A success message indicating the transportation logistic zone entry was saved successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/transportationlogisticzone_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "code": "WT3",
  "region": "TX, NM",
  "zip": "79938",
  "state": "TX, NM",
  "county": "El Paso ",
  "id": 120324,
  "brokerId": 31
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 120324,
  "message": "Transportation Logistic Zone updated successfully"
}

transportationlogisticzone_del

transportationlogisticzone_del
POST/api/lookup/transportationlogisticzone_del/

Overview:

This API endpoint, /api/lookup/transportationlogisticzone_del/, is a POST request that deletes a transportation logistic zone entry. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the type of operation performed, an id field indicating the id of the deleted transportation logistic zone entry, and a message field containing a success message.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed. This will be “DELETE”.
id number The id of the deleted transportation logistic zone entry.
message string A success message indicating the transportation logistic zone entry was deleted successfully.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/transportationlogisticzone_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "157489"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "157489",
  "message": "Transportation Logistic Zone deleted successfully"
}

Logistic

This API group provides endpoints to manage logistic information.

transportationequipment

transportationequipment
GET/api/lookup/transportationequipment/

Overview:

This API endpoint, /api/lookup/transportationequipment/, is a GET request that retrieves the transportation equipment details. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of transportation equipment details, and a totalElements field indicating the total number of transportation equipment entries.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of transportation equipment details. Each object in the array contains the transportation equipment details.
id number The unique identifier for the transportation equipment entry.
itemId number The unique identifier for the item.
value string The value of the transportation equipment.
equipment_ID string The ID of the equipment.
vendor_ID string The ID of the vendor.
vendor_Name string The name of the vendor.
type string The type of the equipment.
outOfService boolean Indicates whether the equipment is out of service.
showDelete boolean Indicates whether the delete option is available for the entry.
totalElements number The total number of transportation equipment entries.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/transportationequipment/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1,
      "itemId": 640,
      "value": "Rental",
      "equipment_ID": "Rental Unit",
      "vendor_ID": "",
      "vendor_Name": "",
      "type": "Truck",
      "outOfService": false,
      "showDelete": false
    }
  ],
  "totalElements": 61
}

transportationequipment_save

transportationequipment_save
POST/api/lookup/transportationequipment_save/

Overview:

This API endpoint, /api/lookup/transportationequipment_save/, is a POST request that saves the transportation equipment details. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the type of operation performed (e.g., “UPDATE”), an id field indicating the unique identifier of the updated transportation equipment, and a message field providing a description of the operation result.

Request Body and Response Description:

Name Data Type Description
value string The value of the transportation equipment.
equipment_ID string The ID of the equipment.
vendor_ID string The ID of the vendor.
type string The type of the equipment.
outOfService boolean Indicates whether the equipment is out of service.
id number The unique identifier for the transportation equipment entry.
oldType string The previous type of the equipment.
newType string The new type of the equipment.
brokerId number The unique identifier for the broker.
success boolean Indicates whether the operation was successful.
process string The type of operation performed (e.g., “UPDATE”).
id number The unique identifier of the updated transportation equipment.
message string A description of the operation result.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/transportationequipment_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "value": "139",
  "equipment_ID": "2008 International Roll-off",
  "vendor_ID": "N/A",
  "type": "Truck",
  "outOfService": false,
  "id": 614,
  "oldType": "Truck",
  "newType": "Truck",
  "brokerId": 31
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 614,
  "message": "Transportation Equipment (Truck) updated successfully"
}

transportationequipment_del

transportationequipment_del
POST/api/lookup/transportationequipment_del/

Overview:

This API endpoint, /api/lookup/transportationequipment_del/, is a POST request that deletes a transportation equipment entry. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the type of operation performed (i.e., “DELETE”), an id field indicating the unique identifier of the deleted transportation equipment, and a message field providing a description of the operation result.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed (i.e., “DELETE”).
id number The unique identifier of the deleted transportation equipment.
message string A description of the operation result.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/transportationequipment_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "737"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "737",
  "message": "Transportation Equipment (Truck) deleted successfully"
}

transportationequipmentcode

transportationequipmentcode
GET/api/lookup/transportationequipmentcode/

Overview:

This API endpoint, /api/lookup/transportationequipmentcode/, is a GET request that retrieves the transportation equipment code details. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of transportation equipment code details, and a totalElements field indicating the total number of transportation equipment code entries.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of transportation equipment code details. Each object in the array contains the transportation equipment code details.
id number The unique identifier for the transportation equipment code entry.
equipment string The equipment code.
description string The description of the equipment code.
showDelete boolean Indicates whether the delete option is available for the entry.
totalElements number The total number of transportation equipment code entries.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/transportationequipmentcode/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 630,
      "equipment": "Bulk Solid Rolloff",
      "description": " ",
      "showDelete": true
    }
  ],
  "totalElements": 1
}

transportationequipmentcode_save

transportationequipmentcode_save
POST/api/lookup/transportationequipmentcode_save/

Overview:

This API endpoint, /api/lookup/transportationequipmentcode_save/, is a POST request that saves the transportation equipment code details. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the type of operation performed (e.g., “UPDATE”), an id field indicating the unique identifier of the updated transportation equipment code, and a message field providing a description of the operation result.

Request Body and Response Description:

Name Data Type Description
equipment string The name of the equipment.
description string The description of the equipment.
id number The unique identifier for the transportation equipment code entry.
brokerId number The unique identifier for the broker.
success boolean Indicates whether the operation was successful.
process string The type of operation performed (e.g., “UPDATE”).
id number The unique identifier of the updated transportation equipment code.
message string A description of the operation result.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/transportationequipmentcode_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "equipment": "Bulk Solid Rolloff",
  "description": "",
  "id": 630,
  "brokerId": 31
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": 630,
  "message": "Transportation Equipment Code updated successfully"
}

transportationequipmentcode_del

transportationequipmentcode_del
POST/api/lookup/transportationequipmentcode_del/

Overview:

This API endpoint, /api/lookup/transportationequipmentcode_del/, is a POST request that deletes a transportation equipment code entry. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a process field indicating the type of operation performed (i.e., “DELETE”), an id field indicating the unique identifier of the deleted transportation equipment code, and a message field providing a description of the operation result.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed (i.e., “DELETE”).
id number The unique identifier of the deleted transportation equipment code.
message string A description of the operation result.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/transportationequipmentcode_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "2449"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "2449",
  "message": "Transportation Equipment Code deleted successfully"
}

orderlogisticsstatus

orderlogisticsstatus
GET/api/lookup/orderlogisticsstatus/

Overview:

This API endpoint, /api/lookup/orderlogisticsstatus/, is a GET request that retrieves the order logistics status details. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of order logistics status details, and a totalElements field indicating the total number of order logistics status entries.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of order logistics status details. Each object in the array contains the order logistics status details.
id number The unique identifier for the order logistics status entry.
name string The name of the order logistics status.
statCode string The status code of the order logistics status.
totalElements number The total number of order logistics status entries.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/orderlogisticsstatus/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 137,
      "name": "Order Pending",
      "statCode": "1"
    }
  ],
  "totalElements": 1
}

orderlinestatus

orderlinestatus
GET/api/lookup/orderlinestatus/

Overview:

This API endpoint, /api/lookup/orderlinestatus/, is a GET request that retrieves the order line status details. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of order line status details, and a totalElements field indicating the total number of order line status entries.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of order line status details. Each object in the array contains the order line status details.
id number The unique identifier for the order line status entry.
name string The name of the order line status.
statCode string The status code of the order line status.
totalElements number The total number of order line status entries.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/orderlinestatus/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1014,
      "name": "Pending WLQ Transfer",
      "statCode": "15"
    }
  ],
  "totalElements": 1
}

vendorlist

vendorlist
GET/api/lookup/vendorlist/

Overview:

This API endpoint, /api/lookup/vendorlist/, is a GET request that retrieves the vendor list. The request requires an Authorization header with a valid token. The response is a JSON object containing a success field indicating whether the operation was successful, a content field containing an array of vendor details, and a totalElements field indicating the total number of vendors.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of vendor details. Each object in the array contains the vendor details.
id number The unique identifier for the vendor.
name string The name of the vendor.
totalElements number The total number of vendors.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/vendorlist/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 3188,
      "name": "Company A"
    }
  ],
  "totalElements": 1
}

Generated by aglio on 25 Jul 2024