Back to top

Lookup APIs

Overview

The Lookup API is a crucial component of our platform, designed to provide users with quick and efficient access to a wide range of lookup data. This API is essential for applications requiring detailed information on various entities, such as locations, items, categories, and more, facilitating seamless integration and interaction within our ecosystem.

Key Features:

  • Comprehensive Data Access: Retrieve detailed information across a broad spectrum of data categories.

  • Dynamic Search Capabilities: Utilize advanced search options to filter and find specific data points.

  • Real-time Updates: Access the most current data thanks to real-time updates to the lookup database.

  • Easy Integration: Designed with simplicity in mind, ensuring easy integration with existing systems and applications.

This documentation is structured to guide you through each endpoint, detailing request and response formats, parameters, and examples to get you started quickly. Whether you’re looking to integrate our Lookup API into your application or seeking to enhance your platform’s capabilities, you’ll find all the necessary information here.

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.

LookUp APIs

The Lookup API provides endpoints to retrieve information about generator sizes, facility names, segments, and categories for waste management and environmental compliance.

generatorsizes

generatorsizes
GET/api/lookup/generatorsizes/

Overview:

This endpoint retrieves a list of generator sizes. It is designed to provide clients with information about different categories of generators based on their waste production scale. The response includes a unique identifier and a description for each generator size category. This service is essential for clients looking to categorize their waste generation capabilities accurately and comply with environmental regulations.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
id number The unique identifier for each generator size category.
Code string A short code representing the generator size category.
Value string A descriptive name of the generator size category.

Example URI

GET https://test-api.wastelinq.com./api/lookup/generatorsizes/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 124,
    "Code": "VSQG ",
    "Value": "Very Small Quantity Generator"
  }
]

generatorsizesbycustid

generatorsizesbycustid
GET/api/lookup/generatorsizesbycustid/customer_id/

Overview:

This endpoint retrieves a list of generator sizes based on the customer ID. It is designed to provide clients with information about different categories of generators based on their waste production scale for a specific customer. The response includes a unique identifier and a description for each generator size category. This service is essential for clients looking to categorize their waste generation capabilities accurately and comply with environmental regulations.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
customer_id number The unique identifier for the customer.
id number The unique identifier for each generator size category.
Code string A short code representing the generator size category.
Value string A descriptive name of the generator size category.

Example URI

GET https://test-api.wastelinq.com./api/lookup/generatorsizesbycustid/customer_id/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 122,
    "Code": "LQG",
    "Value": "Large Quantity Generator"
  },
  {
    "id": 121,
    "Code": "N/A",
    "Value": "Not Applicable"
  },
  {
    "id": 123,
    "Code": "SQG ",
    "Value": "Small Quantity Generator"
  },
  {
    "id": 124,
    "Code": "VSQG ",
    "Value": "Very Small Quantity Generator"
  }
]

facilitynames

facilitynames
GET/api/lookup/esc/facilitynames

Overview:

The facilitynames endpoint provides a list of facility names accessible within the system. It requires an authorization token to access. This endpoint is particularly useful for retrieving the unique identifiers and names of all facilities registered in the system. Clients can use this information to reference specific facilities in subsequent API calls or for displaying a list of facilities in user interfaces.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
id number The unique identifier for each facility name.
Name string The name of the facility.

Example URI

GET https://test-api.wastelinq.com./api/lookup/esc/facilitynames
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 71,
    "Name": "Company A"
  },
  {
    "id": 70,
    "Name": "Company B"
  }
]

facilitynamesbycustid

facilitynamesbycustid
GET/api/lookup/esc/esc/facilitynamesbycustid/customer_id/

Overview:

The facilitynamesbycustid endpoint provides a list of facility names based on the customer ID. It requires an authorization token to access. This endpoint is particularly useful for retrieving the unique identifiers and names of all facilities registered in the system for a specific customer. Clients can use this information to reference specific facilities in subsequent API calls or for displaying a list of facilities in user interfaces.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
customer_id number The unique identifier for the customer.
id number The unique identifier for each facility name.
Name string The name of the facility.

Example URI

GET https://test-api.wastelinq.com./api/lookup/esc/esc/facilitynamesbycustid/customer_id/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 71,
    "Name": "Company A"
  },
  {
    "id": 70,
    "Name": "Company B"
  }
]

segments

segments
GET/api/lookup/segments

Overview:

This endpoint retrieves a list of segments. It is designed to provide clients with information about different industries and sectors. The response includes a unique identifier, a short code, and a descriptive name for each segment. This service is essential for clients looking to categorize their data accurately and analyze it based on industry or sector.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
id number The unique identifier for the segment.
Code string A short code representing the segment.
Value string A descriptive name of the segment, detailing the industry it represents.

Example URI

GET https://test-api.wastelinq.com./api/lookup/segments
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 692,
    "Code": "AGR",
    "Value": "Agriculture, and all food/begerage related industries"
  }
]

segmentsbycustid

segmentsbycustid
GET/api/lookup/segmentsbycustid/customer_id/

Overview:

This endpoint retrieves a list of segments based on the customer ID. It is designed to provide clients with information about different industries and sectors for a specific customer. The response includes a unique identifier, a short code, and a descriptive name for each segment. This service is essential for clients looking to categorize their data accurately and analyze it based on industry or sector for a specific customer.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
customer_id number The unique identifier for the customer.
id number The unique identifier for the segment.
Code string A short code representing the segment.
Value string A descriptive name of the segment, detailing the industry it represents.

Example URI

GET https://test-api.wastelinq.com./api/lookup/segmentsbycustid/customer_id/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 692,
    "Code": "AGR",
    "Value": "Agriculture, and all food/begerage related industries"
  },
  {
    "id": 693,
    "Code": "CHM",
    "Value": "Chemical industry"
  }
]

categories

categories
GET/api/lookup/categories

Overview:

This endpoint retrieves a list of categories. It is designed to provide clients with information about different categories of waste generators. The response includes a unique identifier, a short code, and a descriptive name for each category. This service is essential for clients looking to categorize their waste generation capabilities accurately and comply with environmental regulations.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
id number The unique identifier for the category.
Code string A short code representing the category.
Value string A descriptive name of the category.

Example URI

GET https://test-api.wastelinq.com./api/lookup/categories
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 191,
    "Code": "BRK",
    "Value": "Generator – Brokered"
  },
  {
    "id": 192,
    "Code": "BRP",
    "Value": "Project – Brokered"
  },
  {
    "id": 189,
    "Code": "GEN",
    "Value": "Generator – Direct"
  }
]

categoriesbycustid

categoriesbycustid
GET/api/lookup/categoriesbycustid/customer_id/

Overview:

This endpoint retrieves a list of categories. It is designed to provide clients with information about different categories of waste generators. The response includes a unique identifier, a short code, and a descriptive name for each category. This service is essential for clients looking to categorize their waste generation capabilities accurately and comply with environmental regulations.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
customer_id number The unique identifier for the customer.
id number The unique identifier for the category.
Code string A short code representing the category.
Value string A descriptive name of the category.

Example URI

GET https://test-api.wastelinq.com./api/lookup/categoriesbycustid/customer_id/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 191,
    "Code": "BRK",
    "Value": "Generator – Brokered"
  },
  {
    "id": 192,
    "Code": "BRP",
    "Value": "Project – Brokered"
  }
]

sizecodes

sizecodes
GET/api/lookup/sizecodes

Overview:

This endpoint retrieves a list of size codes. It is designed to provide clients with information about different size categories. The response includes a unique identifier, a short code, and a descriptive name for each size code. This service is essential for clients looking to categorize their data accurately and analyze it based on size categories.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
id number The unique identifier for the size code.
Code string A short code representing the size code.
Value string A descriptive name of the size code.

Example URI

GET https://test-api.wastelinq.com./api/lookup/sizecodes
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 177,
    "Code": "A",
    "Value": ">=$250K"
  },
  {
    "id": 178,
    "Code": "B",
    "Value": ">=$100K and <$250K"
  }
]

sizecodesbycustid

sizecodesbycustid
GET/api/lookup/sizecodesbycustid/customer_id/

Overview:

This endpoint retrieves a list of size codes based on the customer ID. It is designed to provide clients with information about different size categories for a specific customer. The response includes a unique identifier, a short code, and a descriptive name for each size code. This service is essential for clients looking to categorize their data accurately and analyze it based on size categories for a specific customer.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
customer_id number The unique identifier for the customer.
id number The unique identifier for the size code.
Code string A short code representing the size code.
Value string A descriptive name of the size code.

Example URI

GET https://test-api.wastelinq.com./api/lookup/sizecodesbycustid/customer_id/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 177,
    "Code": "A",
    "Value": ">=$250K"
  },
  {
    "id": 178,
    "Code": "B",
    "Value": ">=$100K and <$250K"
  }
]

personnels

personnels
GET/api/lookup/personnels

Overview:

This endpoint retrieves a list of personnel. It is designed to provide clients with information about different personnel associated with an organization. The response includes a unique identifier, the name of the personnel, and the status of the personnel. This service is essential for clients looking to manage their personnel effectively and assign tasks to specific individuals.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
id number The unique identifier for the personnel.
Name string The name of the personnel.
Status string The status of the personnel, such as active or inactive.

Example URI

GET https://test-api.wastelinq.com./api/lookup/personnels
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 385,
    "Name": "John Doe",
    "Status": "Active"
  },
  {
    "id": 671,
    "Name": "Jane Doe",
    "Status": "Active"
  }
]

personnel_roles

personnel_roles
GET/api/lookup/personnel_roles

Overview:

This endpoint retrieves a list of personnel roles. It is designed to provide clients with information about different roles within an organization. The response includes a unique identifier and the name of each role. This service is essential for clients looking to categorize personnel based on their roles and responsibilities.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
id number The unique identifier for the role.
Role string The name of the role.

Example URI

GET https://test-api.wastelinq.com./api/lookup/personnel_roles
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 90,
    "Role": "Sales Rep"
  },
  {
    "id": 91,
    "Role": "Customer Service"
  }
]

generator_custom_fields

generator_custom_fields
GET/api/lookup/generator_custom_fields

Overview:

This endpoint retrieves a list of custom fields for generators. It is designed to provide clients with information about the custom fields available for generators. The response includes a unique identifier, the name of the custom field, and the order in which it should be displayed. This service is essential for clients looking to customize their generator data and add additional fields for specific requirements.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
id number The unique identifier for the custom field.
Name string The name of the custom field.
Display_Order string The order in which the custom field should be displayed.

Example URI

GET https://test-api.wastelinq.com./api/lookup/generator_custom_fields
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 10,
    "Name": "Quickbooks #",
    "Display_Order": "1"
  },
  {
    "id": 26,
    "Name": "Customer Confirmed",
    "Display_Order": "2"
  }
]

order_custom_fields

order_custom_fields
GET/api/lookup/order_custom_fields

Overview:

This endpoint retrieves a list of custom fields for orders. It is designed to provide clients with information about the custom fields available for orders. The response includes a unique identifier, the name of the custom field, and the order in which it should be displayed. This service is essential for clients looking to customize their order data and add additional fields for specific requirements.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
id number The unique identifier for the custom field.
Name string The name of the custom field.

Example URI

GET https://test-api.wastelinq.com./api/lookup/order_custom_fields
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 14,
    "Name": "Customer Confirmed"
  }
]

network_esc_contact

network_esc_contact
GET/api/lookup/network_esc_contact

Overview:

This endpoint retrieves a list of network ESC contacts. It is designed to provide clients with information about the contacts associated with network ESCs. The response includes the name, phone number, and email address of each contact. This service is essential for clients looking to communicate with network ESCs and manage their contact information efficiently.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
name string The name of the contact.
phone string The phone number of the contact.
email string The email address of the contact.

Example URI

GET https://test-api.wastelinq.com./api/lookup/network_esc_contact
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "N/A",
  "phone": "123-222-2222",
  "email": "test@test.com"
}

paymentterms

paymentterms
GET/api/lookup/paymentterms

Overview:

This endpoint retrieves a list of payment terms. It is designed to provide clients with information about different payment terms available in the system. The response includes a unique identifier and the name of each payment term. This service is essential for clients looking to categorize their payment terms accurately and manage their financial transactions effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
id number The unique identifier for the payment term.
Name string The name of the payment term.

Example URI

GET https://test-api.wastelinq.com./api/lookup/paymentterms
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 464,
    "Name": "1.5% 10, Net 30"
  },
  {
    "id": 466,
    "Name": "2% 10, Net 30"
  }
]

paymenttypes

paymenttypes
GET/api/lookup/paymenttypes

Overview:

This endpoint retrieves a list of payment types. It is designed to provide clients with information about different payment types available in the system. The response includes a unique identifier and the name of each payment type. This service is essential for clients looking to categorize their payment methods accurately and manage their financial transactions effectively.

Request Body and Response Description:

Name Data Type Description

Example URI

GET https://test-api.wastelinq.com./api/lookup/paymenttypes
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[]

action_types

action_types
GET/api/lookup/action_types

Overview:

This endpoint retrieves a list of action types. It is designed to provide clients with information about different types of actions that can be performed within the system. The response includes a unique identifier and the name of each action type. This service is essential for clients looking to categorize their actions accurately and manage their tasks effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
id number The unique identifier for the action type.
Name string The name of the action type.

Example URI

GET https://test-api.wastelinq.com./api/lookup/action_types
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 162,
    "Name": "Action Item - AR"
  },
  {
    "id": 163,
    "Name": "Action Item - General"
  }
]

get_contact_type

get_contact_type
GET/api/lookup/get_contact_type

Overview:

This endpoint retrieves a list of contact types. It is designed to provide clients with information about different types of contacts associated with brokers. The response includes a unique identifier, the name of the contact type, and the broker associated with the contact type. This service is essential for clients looking to categorize their contacts accurately and manage their communication effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
id number The unique identifier for the contact type.
Name string The name of the contact type.
Broker number The broker associated with the contact type.

Example URI

GET https://test-api.wastelinq.com./api/lookup/get_contact_type
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 158,
    "Name": "Customer Primary",
    "Broker": 31
  },
  {
    "id": 159,
    "Name": "Site Secondary",
    "Broker": 31
  }
]

Order Types

order_types
GET/api/lookup/{network}/order_types

Overview:

This endpoint retrieves a list of order types. It is designed to provide clients with information about different types of orders available in the system. The response includes a unique identifier and the name of each order type. This service is essential for clients looking to categorize their orders accurately and manage their transactions effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
success boolean The status of the request.
content array The list of order types.
id number The unique identifier for the order type.
Name string The name of the order type.

Example URI

GET https://test-api.wastelinq.com./api/lookup/network/order_types
URI Parameters
HideShow
network
string (required) Example: network

Use network for Network order types or esc for ESC-specific order types.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 153,
      "Name": "Bulk"
    },
    {
      "id": 154,
      "Name": "Packaged"
    },
    {
      "id": 155,
      "Name": "Project"
    },
    {
      "id": 156,
      "Name": "Transportation Only"
    }
  ]
}

order_sources

order_sources
GET/api/lookup/{network}/order_sources

Overview:

This endpoint retrieves a list of order sources. It is designed to provide clients with information about different sources of orders. The response includes a unique identifier and the name of each order source. This service is essential for clients looking to categorize their order sources accurately and manage their transactions effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
success boolean The status of the request.
content array The list of order sources.
id number The unique identifier for the order source.
Name string The name of the order source.

Example URI

GET https://test-api.wastelinq.com./api/lookup/network/order_sources
URI Parameters
HideShow
network
string (required) Example: network

Use network for Network order sources or esc for ESC-specific order sources.

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"
    },
    {
      "id": 79,
      "Name": "Customer Email"
    },
    {
      "id": 81,
      "Name": "ENet"
    },
    {
      "id": 82,
      "Name": "Other"
    },
    {
      "id": 80,
      "Name": "Sales Call"
    }
  ]
}

logistic_statuses

logistic_statuses
GET/api/lookup/{network}/logistic_statuses

Overview:

This endpoint retrieves a list of logistic statuses. It is designed to provide clients with information about different statuses associated with logistics operations. The response includes a unique identifier and the name of each logistic status. This service is essential for clients looking to categorize their logistics operations accurately and manage their shipments effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
success boolean The status of the request.
content array The list of logistic statuses.
id number The unique identifier for the logistic status.
Name string The name of the logistic status.
StatCode string The status code of the logistic status.

Example URI

GET https://test-api.wastelinq.com./api/lookup/network/logistic_statuses
URI Parameters
HideShow
network
string (required) Example: network

Use network for Network logistic statuses or esc for ESC-specific logistic statuses.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 124,
      "Name": "Cancelled",
      "StatCode": "4"
    },
    {
      "id": 552,
      "Name": "WLQ 10-day Delivery",
      "StatCode": "25"
    }
  ]
}

delay_reasons

delay_reasons
GET/api/lookup/{network}/delay_reasons

Overview:

This endpoint retrieves a list of delay reasons. It is designed to provide clients with information about different reasons for delays in ESC operations. The response includes a unique identifier and the name of each delay reason. This service is essential for clients looking to categorize delays accurately and manage their ESC operations effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
success boolean The status of the request.
content array The list of delay reasons.
id number The unique identifier for the delay reason.
Name string The name of the delay reason.

Example URI

GET https://test-api.wastelinq.com./api/lookup/network/delay_reasons
URI Parameters
HideShow
network
string (required) Example: network

Use network for Network delay reasons or esc for ESC-specific delay reasons.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 20,
      "Name": "Logistics"
    },
    {
      "id": 22,
      "Name": "None"
    },
    {
      "id": 21,
      "Name": "Other"
    },
    {
      "id": 19,
      "Name": "Pricing"
    },
    {
      "id": 18,
      "Name": "Profiling"
    }
  ]
}

assign_users

assign_users
GET/api/lookup/network/assign_users

Overview:

This endpoint retrieves a list of users available for assignment. It is designed to provide clients with information about different users who can be assigned to tasks or projects. The response includes a unique identifier, the name of the user, and the role of the user. This service is essential for clients looking to assign tasks to specific users and manage their projects effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
success boolean The status of the request.
content array The ist of users available for assignment.
id number The unique identifier for the user.
full_name string The full name of the user.

Example URI

GET https://test-api.wastelinq.com./api/lookup/network/assign_users
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1807,
      "full_name": "Jane Doe - 1807"
    },
    {
      "id": 627,
      "full_name": "John Doe - 627"
    }
  ]
}

line_statuses

line_statuses
GET/api/lookup/line_statuses

Overview:

This endpoint retrieves a list of line statuses. It is designed to provide clients with information about different statuses associated with order lines. The response includes a unique identifier and the name of each line status. This service is essential for clients looking to categorize their order lines accurately and manage their transactions effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
success boolean The status of the request.
content array The list of line statuses.
id number The unique identifier for the line status.
Name string The name of the line status.
StatCode string The status code of the line status.

Example URI

GET https://test-api.wastelinq.com./api/lookup/line_statuses
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 218,
      "Name": "Direct Bulk/Package Outbound",
      "StatCode": "5"
    },
    {
      "id": 216,
      "Name": "Fully Scheduled Outbound",
      "StatCode": "3"
    }
  ]
}

trucks

trucks
GET/api/lookup/trucks

Overview:

This endpoint retrieves a list of trucks. It is designed to provide clients with information about different trucks available for transportation. The response includes a unique identifier, the value of the truck, the equipment ID, and the vendor ID. This service is essential for clients looking to categorize their trucks accurately and manage their transportation operations effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
success boolean The status of the request.
content array The list of trucks.
id number The unique identifier for the truck.
Value string The value of the truck.
Equipment_ID string The equipment ID of the truck.
Vendor_id string The vendor ID of the truck.

Example URI

GET https://test-api.wastelinq.com./api/lookup/trucks
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 302,
      "Value": "115",
      "Equipment_ID": "R/O Truck",
      "Vendor_id": null
    },
    {
      "id": 307,
      "Value": "122",
      "Equipment_ID": "Mack 3",
      "Vendor_id": null
    }
  ]
}

trailers

trailers
GET/api/lookup/trailers

Overview:

This endpoint retrieves a list of trailers. It is designed to provide clients with information about different trailers available for transportation. The response includes a unique identifier, the value of the trailer, the equipment ID, and the vendor ID. This service is essential for clients looking to categorize their trailers accurately and manage their transportation operations effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
success boolean The status of the request.
content array The list of trailers.
id number The unique identifier for the trailer.
Value string The value of the trailer.
Equipment_ID string The equipment ID of the trailer.
Vendor_id string The vendor ID of the trailer.

Example URI

GET https://test-api.wastelinq.com./api/lookup/trailers
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 645,
      "Value": "201",
      "Equipment_ID": "1981 Trim 40'",
      "Vendor_id": null
    },
    {
      "id": 640,
      "Value": "204",
      "Equipment_ID": "DB-204",
      "Vendor_id": null
    }
  ]
}

vendors

vendors
GET/api/lookup/vendors

Overview:

This endpoint retrieves a list of vendors. It is designed to provide clients with information about different vendors available for services. The response includes a unique identifier, the name of the vendor, and the vendor type. This service is essential for clients looking to categorize their vendors accurately and manage their service providers effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
success boolean The status of the request.
content array The list of vendors.
id number The unique identifier for the vendor.
Name string The name of the vendor.

Example URI

GET https://test-api.wastelinq.com./api/lookup/vendors
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 7155,
      "Name": "1"
    },
    {
      "id": 3188,
      "Name": "Company A"
    }
  ]
}

drivers

drivers
GET/api/lookup/drivers

Overview:

This endpoint retrieves a list of drivers. It is designed to provide clients with information about different drivers available for transportation services. The response includes a unique identifier, the name of the driver, and the driver type. This service is essential for clients looking to categorize their drivers accurately and manage their transportation operations effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
success boolean The status of the request.
content array The list of drivers.
id number The unique identifier for the driver.
Name string The name of the driver.

Example URI

GET https://test-api.wastelinq.com./api/lookup/drivers
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 536,
      "Name": "John Doe"
    },
    {
      "id": 567,
      "Name": "Jane Doe"
    }
  ]
}

active_drivers

active_drivers
GET/api/lookup/active_drivers

Overview:

This endpoint retrieves a list of active drivers. It is designed to provide clients with information about different active drivers available for transportation services. The response includes a unique identifier, the name of the driver, and the driver type. This service is essential for clients looking to categorize their active drivers accurately and manage their transportation operations effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
success boolean The status of the request.
content array The list of active drivers.
id number The unique identifier for the driver.
Name string The name of the driver.

Example URI

GET https://test-api.wastelinq.com./api/lookup/active_drivers
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 537,
      "Name": "John Doe"
    },
    {
      "id": 538,
      "Name": "Jane Doe"
    }
  ]
}

third_parties

third_parties
GET/api/lookup/third_parties

Overview:

This endpoint retrieves a list of third parties. It is designed to provide clients with information about different third-party service providers. The response includes a unique identifier, the name of the third party, and the third-party type. This service is essential for clients looking to categorize their third-party service providers accurately and manage their service contracts effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
success boolean The status of the request.
content array The list of third parties.
id number The unique identifier for the third party.
Name string The name of the third party.

Example URI

GET https://test-api.wastelinq.com./api/lookup/third_parties
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 46016,
      "Name": "Company A"
    },
    {
      "id": 46018,
      "Name": "Company B"
    }
  ]
}

active_third_parties

active_third_parties
GET/api/lookup/active_third_parties

Overview:

This endpoint retrieves a list of active third parties. It is designed to provide clients with information about different active third-party service providers. The response includes a unique identifier, the name of the third party, and the third-party type. This service is essential for clients looking to categorize their active third-party service providers accurately and manage their service contracts effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
success boolean The status of the request.
content array The list of active third parties.
id number The unique identifier for the third party.
Name string The name of the third party.

Example URI

GET https://test-api.wastelinq.com./api/lookup/active_third_parties
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 46016,
      "Name": "Company A"
    },
    {
      "id": 46018,
      "Name": "Company B"
    }
  ]
}

freightstatus

freightstatus
GET/api/lookup/freightstatus

Overview:

This endpoint retrieves a list of freight statuses. It is designed to provide clients with information about different statuses associated with freight operations. The response includes a unique identifier and the name of each freight status. This service is essential for clients looking to categorize their freight operations accurately and manage their shipments effectively.

Request Body and Response Description:

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

Example URI

GET https://test-api.wastelinq.com./api/lookup/freightstatus
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": []
}

tsdfinslotstatus

tsdfinslotstatus
GET/api/lookup/tsdfinslotstatus

Overview:

This endpoint retrieves a list of TSDF in-slot statuses. It is designed to provide clients with information about different statuses associated with TSDF in-slot operations. The response includes a unique identifier and the name of each TSDF in-slot status. This service is essential for clients looking to categorize their TSDF in-slot operations accurately and manage their waste disposal effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
success boolean The status of the request.
content array The list of TSDF in-slot statuses.

Example URI

GET https://test-api.wastelinq.com./api/lookup/tsdfinslotstatus
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": []
}

waste_class_uhc

waste_class_uhc
GET/api/lookup/waste_class_uhc

Overview:

This endpoint retrieves a list of waste classes for UHC. It is designed to provide clients with information about different waste classes associated with UHC operations. The response includes a unique identifier, the name of the waste class, and the waste code. This service is essential for clients looking to categorize their waste classes accurately and manage their waste disposal effectively.

Request Body and Response Description:

Name Data Type Description
Authorization string The authorization token required to access the endpoint.
success boolean The status of the request.
content array The list of waste classes for UHC.
id number The unique identifier for the waste class.
CommonName string The common name of the waste class.
CASNo string The CAS number of the waste class.
WastewaterStandard string The wastewater standard of the waste class.
NonWastewaterStandard string The non-wastewater standard of the waste class.

Example URI

GET https://test-api.wastelinq.com./api/lookup/waste_class_uhc
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1,
      "CommonName": "Organic Constituents",
      "CASNo": "",
      "WastewaterStandard": "",
      "NonWastewaterStandard": ""
    },
    {
      "id": 2,
      "CommonName": "Acenaphthylene",
      "CASNo": "208-96-8",
      "WastewaterStandard": "0.059",
      "NonWastewaterStandard": "3.4"
    }
  ]
}

Generated by aglio on 09 Jul 2024