Schedules APIs

Overview ¶

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

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

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

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

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

Bearer Token

A bearer token is a type of access token that is used for authorization in APIs. It is a cryptic string that is generated by the server in response to a login request. The client must send this token in the Authorization header when making requests to protected resources.

The “Bearer” keyword is a signal to the server that the token is a type of bearer token. Here’s an example of how to use it:

Authorization: Bearer <Your-Bearer-Token>

Replace with your actual bearer token.

For example:

Authorization: Bearer 5262d64b892e8d4341000001

Error Messages

400 Bad Request: This error is returned when the server could not understand the request due to invalid syntax. Check your request body and parameters.
401 Unauthorized: This error is returned when the request lacks valid authentication credentials for the target resource. Make sure your API key is correct.
403 Forbidden: This error is returned when the server understood the request, but it refuses to authorize it. This status is often returned if you’re missing permissions to access the resource.
404 Not Found: This error is returned when the server can’t find the requested resource. Check your endpoint and parameters.
500 Internal Server Error: This error is returned when the server encounters an unexpected condition that prevented it from fulfilling the request.

APIs ¶

Schedules ESC ¶

Schedules ESC
GET`/api/schedules_esc/{?page,pageSize,filter,sort}`

Overview:

The Schedules ESC endpoint retrieves schedule data from the ESC system. It returns a list of various entities such as drivers, trailers, events, driver statuses, transport companies, and others with specific details. The data can be filtered and sorted using the filter and sort query parameters respectively. An Authorization token is required for access. The API is primarily used for managing and retrieving schedule data.

Response Description:

Name	Data Type	Description
drivers	array	An array of driver objects
id	number	The unique identifier for the driver
Name	string	The name of the driver
Status	string	The status of the driver
Modified_date	string	The date and time when the driver’s information was last modified
getDateWithStatus	number	The flag identifies that date with status.
TransportationName_id	number	The identifier for the transportation name associated with the driver
trailers	array	An array of trailer objects
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	number	The identifier for the vendor associated with the trailer
Broker_id	number	The identifier for the broker associated with the trailer
OutOfService	boolean	Indicates whether the trailer is out of service
events	array	An array of event objects
startDay	string	The start day
driverStatus	array	An array of driver status objects
id	number	The unique identifier for the driver status
Name	string	The name of the driver status
Broker_id	number	The identifier for the broker associated with the driver status
RestrictDay	boolean	Indicates whether the day is restricted
CalendarDefaults_id	number	The unique identifier for the Calendar Defaults
transportCompanies	array	An array of transport company objects
transportCompanies2	array	An array of transport company objects
id	number	The unique identifier for the transport company
Tran_Com_Number	number	The transport company number
Name	string	The name of the transport company
Portal_Default	boolean	Indicates whether the transport company is the default for the portal
Transportation_State_ID	string	The state ID of the transport company
Transportation_EPA_ID	string	The EPA ID of the transport company
Transportation_Phone	string	The phone number of the transport company
Address1	string	The first line of the address of the transport company
Address2	string	The second line of the address of the transport company
City	string	The city of the transport company
State	string	The state of the transport company
Zip	string	The zip code of the transport company
Status	string	The status of the transport company
Approval_Documents	string	The approval documents of the transport company
Created_date	string	The date and time when the transport company was created
Modified_date	string	The date and time when the transport company’s information was last modified
User_id	number	The identifier for the user associated with the transport company
from_esc_id	number	The unique identifier for the From ESC
Broker_id	number	The identifier for the broker associated with the transport company
Sub_Field	number	The identifier for the Sub Field
Preferred	boolean	Indicates whether the transport company is preferred
IsWasteLinq	boolean	Indicates whether the transport company is WasteLinq
is_company_transportation	boolean	Indicates whether the company is a transportation company
IsNetwork	boolean	Indicates whether it is a network
suborderLock	boolean	Indicates whether the suborder is locked
flag_displayOnCal	boolean	Indicates whether to display on the calendar
transportationname	array	An array of transportation name objects
id	number	The unique identifier for the transportation name
Name	string	The name of the transportation
EPA_ID	string	The EPA ID of the transportation
State_ID	string	The state ID of the transportation
Address1	string	The first line of the address of the transportation
Address2	string	The second line of the address of the transportation
City	string	The city of the transportation
State	string	The state of the transportation
Zip	string	The zip code of the transportation
Phone	string	The phone number of the transportation
Broker_id	number	The identifier for the broker associated with the transportation
HideWeekendFromCalendar	boolean	Indicates whether to hide the weekend from the calendar
outbounds_escpickup	array	An array of outbound escpickup objects
outbounds_wlqtenday	array	An array of outbound wlqtenday objects
id	number	The unique identifier for the outbound wlqtenday
shipment_number	number	The shipment number of the outbound wlqtenday
esc	string	The esc of the outbound wlqtenday
pick_up_location	string	The pick up location of the outbound wlqtenday
deliver_location	string	The deliver location of the outbound wlqtenday
55_eqv	number	The 55 eqv of the outbound wlqtenday
is_wastelinq	boolean	Indicates whether the outbound wlqtenday is WasteLinq
city_state	string	The city and state of the outbound wlqtenday
hide	boolean	Indicates whether to hide the outbound wlqtenday
shipment_date	string	The shipment date of the outbound wlqtenday
facilities	array	An array of facility objects

Example URI

GET https://test-api.wastelinq.com/api/schedules_esc/?page=&pageSize=&filter=&sort=

URI Parameters

HideShow

page: number (optional)
The page number for pagination. Default is 0.
pageSize: number (optional)
The number of items per page for pagination. Default is 10.
filter: string (optional)
The filter conditions. Default is “esc=0,startDate=2024-04-05,endDate=2024-04-05”.
sort: string (optional)
The sorting order. Default is “esc asc”.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "drivers": [
    {
      "id": 536,
      "Name": "Jane Doe",
      "Status": "Active",
      "Modified_date": "2024-04-03T07:30:35.959322Z",
      "getDateWithStatus": null,
      "TransportationName_id": 21
    }
  ],
  "trailers": [
    {
      "id": 1714,
      "Value": "1",
      "Equipment_ID": "1",
      "Vendor_id": 3188,
      "Broker_id": 31,
      "OutOfService": false
    }
  ],
  "events": [],
  "startDay": "1",
  "driverStatus": [
    {
      "id": 12,
      "Name": "Vacation",
      "Broker_id": 31,
      "RestrictDay": true,
      "CalendarDefaults_id": null
    }
  ],
  "transportCompanies": [],
  "transportCompanies2": [
    {
      "id": 119477,
      "Tran_Com_Number": 69645,
      "Name": "2",
      "Portal_Default": false,
      "Transportation_State_ID": "2",
      "Transportation_EPA_ID": "2",
      "Transportation_Phone": "222-222-2222",
      "Address1": "132, My Street, Kingston, New York 12401.",
      "Address2": "132, My Street, Kingston, New York 12401.",
      "City": "New York",
      "State": "NY",
      "Zip": "12401",
      "Status": "Active",
      "Approval_Documents": "",
      "Created_date": "2024-04-04T06:36:33.995708Z",
      "Modified_date": "2024-04-04T06:37:04.865563Z",
      "User_id": 1941,
      "from_esc_id": null,
      "Broker_id": 31,
      "Sub_Field": null,
      "Preferred": false,
      "IsWasteLinq": true,
      "is_company_transportation": false
    }
  ],
  "IsNetwork": false,
  "suborderLock": true,
  "flag_displayOnCal": true,
  "transportationname": [
    {
      "id": 21,
      "Name": "Company A",
      "EPA_ID": "10000",
      "State_ID": "10000",
      "Address1": "132, My Street, Kingston, New York 12401.",
      "Address2": "132, My Street, Kingston, New York 12401.",
      "City": "New York",
      "State": "NY",
      "Zip": "12401",
      "Phone": "100-100-1000",
      "Broker_id": 31
    }
  ],
  "HideWeekendFromCalendar": false,
  "outbounds_escpickup": [],
  "outbounds_wlqtenday": [
    {
      "id": 107728,
      "shipment_number": 93227,
      "esc": "Company A",
      "pick_up_location": "Company A",
      "deliver_location": "Company B",
      "55_eqv": 61.199999999999996,
      "is_wastelinq": true,
      "city_state": "Kingston, New York",
      "hide": true,
      "shipment_date": "2024-02-29"
    }
  ],
  "facilities": []
}

Schedules Inbound ¶

Schedules Inbound
GET`/api/schedules_inbound/{?page,pageSize,selectedFields,filter,sort}`

Overview:

The Schedules Inbound API endpoint retrieves the details of scheduled pickups in the WasteLinq system. This endpoint requires an Authorization token and supports optional parameters for pagination, field selection, filtering, and sorting. The API returns a success status and an array containing the details of each scheduled pickup, including the requested date, order number, entity scheduling the pickup, pickup location, city and state of the pickup location, generator facility name, container type, equivalent 55-gallon drum count, and more. This API is primarily used for managing and retrieving information about scheduled pickups in the system.

Response Description:

Name	Data Type	Description
success	boolean	Indicates whether the request was successful.
content	array	An array containing the details of the scheduled pickup.
requested_date	string	The date the pickup was requested.
Order_Number	number	The order number for the pickup.
ESC	string	The name of the Environmental Service Company.
pickup_location	string	The location where the pickup is to be made.
city_state	string	The city and state of the pickup location.
generatorFacilityName	string	The name of the generator facility.
cont_type	string	The type of container for the pickup.
e55eq	number	The equivalent 55-gallon drum count.
id	number	The unique identifier for the pickup.
locked	string	The status of the pickup.
hide	boolean	Indicates whether the pickup is hidden.
dateless	boolean	Indicates whether the pickup has a scheduled date.
scheduled_date	string	The date the pickup is scheduled.
estimatedOnly	string	Indicates whether the pickup is estimated only.
suborderList	string	Indicates whether the pickup has a suborder list.
erAuth	boolean	Indicates whether the pickup has emergency response authorization.
notPrior	boolean	Indicates whether the pickup is not a priority.
address	string	The address of the pickup location.
facility_hours	string	The operating hours of the facility.
facility_access	string	The access information for the facility.
gen_facility_hours	string	The operating hours of the generator facility.
gen_transportation_note	string	Notes regarding transportation for the generator.
gen_equipment_requirements	string	Equipment requirements for the generator.
tsdfProtocol	string	The protocol for the treatment, storage, and disposal facility.
df	string	The disposal facility for the pickup.
count	number	The count of pickups.
wmp_id	number	The waste management plan id.
schedulingnote	string	Any notes regarding the scheduling of the pickup.
is_approved_on_hold_tsdf	string	Indicates whether the pickup is approved and on hold at the treatment, storage, and disposal facility.
trans_zone	string	The transportation zone for the pickup.
special_handling	string	Any special handling instructions for the pickup.
totalElements	number	The total number of elements in the response.

Example URI

GET https://test-api.wastelinq.com/api/schedules_inbound/?page=&pageSize=&selectedFields=&filter=&sort=

URI Parameters

HideShow

page: number (optional)
The page number for pagination. Default is 0.
pageSize: number (optional)
The number of items per page for pagination. Default is 10.
selectedFields: object (optional)
The fields to be included in the response. Default is “requested_date,Order_Number,ESC,pickup_location,city_state,df,generatorFacilityName,cont_type,e55eq,trans_zone”
filter: string (optional)
The filter conditions. Default is “esc=0,startDate=undefined,endDate=undefined,facility_id=999999999,searchstring=undefined,showdateless=true,esc_inbound=”.
sort: string (optional)
The sorting order. Default is “esc asc”.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "requested_date": "04-02-2024",
      "Order_Number": 586937,
      "ESC": "Company A",
      "pickup_location": "132, My Street, Kingston, New York 12401.",
      "city_state": "Kingston, New York",
      "generatorFacilityName": "Company A",
      "cont_type": "CF, DF",
      "e55eq": 5,
      "id": 547668,
      "locked": "locked",
      "hide": false,
      "dateless": false,
      "scheduled_date": null,
      "estimatedOnly": "estimatedOnly",
      "suborderList": "False",
      "erAuth": false,
      "notPrior": true,
      "address": "address",
      "facility_hours": "No info",
      "facility_access": "No info",
      "gen_facility_hours": "No info",
      "gen_transportation_note": "Profile 70666 - Need totes Drained and returned\r\nProfile 63130 - Need totes Drained and returned\r\nProfile 75385 - Need totes Drained and returned",
      "gen_equipment_requirements": "No info",
      "tsdfProtocol": "tsdfProtocol",
      "df": "Mr John Smith. 132, My Street, Kingston, New York 12401.",
      "count": 3,
      "wmp_id": 620458,
      "schedulingnote": null,
      "is_approved_on_hold_tsdf": "False",
      "trans_zone": "CT2",
      "special_handling": ""
    }
  ],
  "totalElements": 1
}

Schedules Weekdata ¶

Schedules Weekdata
GET`/api/schedules_weekdata/{?page,pageSize,selectedFields,filter,sort}`

Overview:

The Schedules Weekdata API endpoint retrieves the details of the week’s schedules in the WasteLinq system. This endpoint requires an Authorization token and supports optional parameters for pagination, field selection, filtering, and sorting. The API returns a success status and an array containing the details of each schedule for the week, including the type of schedule (event or inbound), date, day slot order, driver, emergency response authorization status, unique identifier, name, on hold status, orders, original order ID, restricted day, suborders, trailer, transportation company, truck, waste management plan id, generator, generator name, and paperwork status. This API is primarily used for managing and retrieving information about the week’s schedules in the system.

Response Description:

Name	Data Type	Description
weekData	array	An array containing the details of the week’s data.
type	string	The type of the schedule (event or inbound).
date	string	The date of the schedule.
dayslotOrder	number/string	The order of the day slot.
driver	number/string	The driver for the schedule.
erAuth	boolean/string	Indicates whether the schedule has emergency response authorization.
id	number	The unique identifier for the schedule.
name	string/number	The name or identifier of the schedule.
onHold	boolean/string	Indicates whether the schedule is on hold.
orders	array	An array containing the details of the orders.
originOrderID	string	The original order ID.
restrictDay	string	The restricted day for the schedule.
suborders	array	An array containing the details of the suborders.
trailer	string	The trailer for the schedule.
tran_com	string	The transportation company for the schedule.
tran_com_name	string	The name of the transportation company.
truck	string	The truck for the schedule.
wmp_id	number	The waste management plan id.
generator	number	The generator for the schedule.
generator_name	string	The name of the generator.
is_paper_work	boolean	Indicates whether there is paperwork for the schedule.

Example URI

GET https://test-api.wastelinq.com/api/schedules_weekdata/?page=&pageSize=&selectedFields=&filter=&sort=

URI Parameters

HideShow

page: number (optional)
The page number for pagination. Default is 0.
pageSize: number (optional)
The number of items per page for pagination. Default is 4.
selectedFields: object (optional)
The fields to be included in the response.
filter: string (optional)
The filter conditions. Default is “esc=0,startDate=2024-04-08,endDate=2024-04-08”.
sort: string (optional)
The sorting order. Default is “esc asc”.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "weekData": [
    {
      "type": "event",
      "date": "2024-04-16",
      "dayslotOrder": 1,
      "driver": 557,
      "erAuth": "",
      "id": 95880,
      "name": "DEFAULT",
      "onHold": "",
      "orders": [
        [
          "535977",
          575246,
          false,
          false,
          1022671,
          "Company A",
          false
        ]
      ],
      "originOrderID": "",
      "restrictDay": "",
      "suborders": [],
      "trailer": null,
      "tran_com": "None",
      "tran_com_name": null,
      "truck": null,
      "wmp_id": ""
    },
    {
      "type": "inbound",
      "date": "2024-04-16",
      "dayslotOrder": "",
      "driver": "UA",
      "erAuth": false,
      "id": 546855,
      "name": 586124,
      "onHold": false,
      "orders": [],
      "originOrderID": "",
      "restrictDay": "",
      "suborders": [],
      "trailer": "",
      "tran_com": "",
      "tran_com_name": "",
      "truck": "",
      "wmp_id": 619112,
      "generator": 1030407,
      "generator_name": "Company B",
      "is_paper_work": false
    }
  ]
}

Schedules Update ¶

Schedules Update
POST`/api/schedules_update/`

Overview:

The Schedules Update API endpoint allows for the updating of existing schedules in the WasteLinq system. This endpoint requires an Authorization token and a JSON body containing the details of the schedule to be updated. The details include the object type, object ID, date, truck ID, trailer ID, driver ID, transportation company ID, event ID, orders to be removed, suborders to be removed, and parent lock status. Upon successful update, the API returns a success status and a JSON object containing the updated details of the schedule. This API is primarily used for updating the details of existing schedules in the system.

Response Description:

Name	Data Type	Description
objectType	string	The type of the object, in this case, ‘existing’.
objectID	number	The unique identifier for the object.
Date	string	The date associated with the object.
Truck_id	number	The identifier for the truck, if any.
Trailer_id	number	The identifier for the trailer, if any.
Driver_id	number	The identifier for the driver.
Tran_Com_id	number	The identifier for the transportation company, if any.
Event_id	number	The identifier for the event.
removeOrder	array	An array containing the orders to be removed.
removeSuborder	array	An array containing the suborders to be removed.
parentLock	boolean	Indicates whether the parent object is locked.
type	string	The type of the schedule, in this case, ‘event’.
id	string	The unique identifier for the schedule.
name	string	The name of the schedule, in this case, ‘DEFAULT’.
driver	number	The identifier for the driver.
tran_com	number	The identifier for the transportation company, if any.
tran_com_name	string	The name of the transportation company, if any.
truck	string	The truck for the schedule, in this case, ‘None’.
trailer	string	The trailer for the schedule, in this case, ‘None’.
date	string	The date of the schedule.
dayslotOrder	number	The order of the day slot.
orders	array	An array containing the details of the orders.
suborders	array	An array containing the details of the suborders.
updated	string	Indicates whether the schedule has been updated, in this case, ‘true’.

Example URI

POST https://test-api.wastelinq.com/api/schedules_update/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "objectType": "existing",
  "objectID": 98564,
  "Date": "2024-04-09",
  "Truck_id": null,
  "Trailer_id": null,
  "Driver_id": 537,
  "Tran_Com_id": null,
  "Event_id": 98564,
  "removeOrder": [],
  "removeSuborder": [],
  "parentLock": false
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "type": "event",
  "id": "98564",
  "name": "DEFAULT",
  "driver": 537,
  "tran_com": null,
  "tran_com_name": null,
  "truck": "None",
  "trailer": "None",
  "date": "2024-04-09",
  "dayslotOrder": 2,
  "orders": [
    [
      "546135",
      585404,
      false,
      false,
      1006384,
      "Company A",
      false
    ]
  ],
  "suborders": [],
  "updated": "true"
}

Schedules Create Event ¶

Schedules Create Event
POST`/api/schedules_createevent/`

Overview:

The Schedules Create Event API endpoint allows for the creation of a new event in the WasteLinq system. This endpoint requires an Authorization token and a JSON object containing the details of the event to be created. Upon successful creation, the API returns a success status and a JSON object containing the details of the newly created event. This API is primarily used for creating new events in the system.

Response Description:

Name	Data Type	Description
type	string	The type of the event.
id	string	The unique identifier for the event.
name	string	The name of the event.
driver	string	The driver assigned to the event.
tran_com	string	The transport company assigned to the event.
tran_com_name	string	The name of the transport company.
truck	string	The truck assigned to the event.
trailer	string	The trailer assigned to the event.
date	string	The date of the event.
orders	array	An array containing the orders in the event.
suborders	array	An array containing the suborders in the event.
dayslotOrder	number	The order of the day slot.

Example URI

POST https://test-api.wastelinq.com/api/schedules_createevent/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "objectType": "order",
  "objectID": 547639,
  "Date": "2024-04-08",
  "Name": " test",
  "Truck_id": 388,
  "Trailer_id": 651,
  "Time": "12:00 AM",
  "Driver_id": 1171,
  "Tran_Com_id": null,
  "parentLock": false
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "type": "event",
  "id": "99238",
  "name": " test",
  "driver": "1171",
  "tran_com": "None",
  "tran_com_name": "",
  "truck": "388",
  "trailer": "651",
  "date": "2024-04-08",
  "orders": [
    [
      "547639",
      586908,
      false,
      false,
      1023544,
      "Company A",
      false
    ]
  ],
  "suborders": [],
  "dayslotOrder": 1
}

Schedules Edit Existing ¶

Schedules Edit Existing
GET`/api/schedules_editexisting/{id}/`

Overview:

The Schedules Edit Existing API endpoint allows for the retrieval of details for an existing schedule in the system. This endpoint requires an Authorization token and the unique identifier (id) of the schedule to be retrieved. The details include the schedule’s date, time, trailer, truck, driver, transportation company, name, orders, suborders, trucks, trailers, drivers, day slot order, maximum day slot numbers, transportation companies, total 55eq, event comments, network status, event id, and calendar files. Upon successful retrieval, the API returns a success status and a JSON object containing the details of the schedule. This API is primarily used for retrieving the details of existing schedules in the system.

Response Description:

Name	Data Type	Description
id	number	The unique identifier for the schedule.
myDate	string	The date of the schedule.
myTime	string	The time of the schedule.
myTrailer	number	The trailer for the schedule, if any.
myTruck	number	The truck for the schedule, if any.
myDriver	number	The identifier for the driver.
myTranCom	number	The identifier for the transportation company, if any.
name	string	The name of the schedule.
orders	array	An array containing the details of the orders.
suborders	array	An array containing the details of the suborders.
trucks	array	An array containing the details of the trucks.
trailers	array	An array containing the details of the trailers.
drivers	array	An array containing the details of the drivers.
dayslotOrder	number	The order of the day slot.
maxDayslotNum	array	An array containing the maximum day slot numbers.
tran_com	array	An array containing the details of the transportation company.
tran_com2	array	An array containing the details of the secondary transportation company.
total55eq	number	The total 55eq.
event_comments	string	The comments for the event, if any.
IsNetwork	boolean	Indicates whether the schedule is part of a network.
event_id	number	The identifier for the event.
calFile	array	An array containing the calendar files.

Example URI

GET https://test-api.wastelinq.com/api/schedules_editexisting/id/

URI Parameters

HideShow

id: number (required)
The unique identifier for the Existing Calendar Event.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    "data": {
        "id": 98564,
        "myDate": "2024-04-09",
        "myTime": "00:00",
        "myTrailer": null,
        "myTruck": null,
        "myDriver": 537,
        "myTranCom": null,
        "name": "DEFAULT",
        "orders": [
            {
                "id": 546135,
                "GeneratorName": "Company A",
                "Order_Number": 585404,
                "pk_list": [
                    {
                        "content": [
                            {
                                "id": 1237973,
                                "contain_er_authorization_profile": false,
                                "is_approved_on_hold_tsdf": false,
                                "profile_name": "NON-HAZ WASTE WATER FROM BULK TANK",
                                "profile_number": 4235,
                                "tsdf_name": "Facility A",
                                "approval_number": "10000",
                                "process_code": "10000",
                                "waste_class": "Non-Hazardous",
                                "disposal_dot": "Non-Regulated Material per 40 & 49 CFR",
                                "mainfest_number": "100000",
                                "line_number": "1",
                                "container_type": "TT",
                                "container_size": "5000",
                                "container_unit": "G",
                                "container_count": 1,
                                "total_volume": 5000.0,
                                "total_weight": 41283.0,
                                "calendar_location": null,
                                "facility_name": "Facility 1"
                            }
                        ],
                        "totalElements": 1
                    }
                ],
                "ProdServs": [
                    {
                        "content": [
                            {
                                "id": 1434473,
                                "product_item": "880",
                                "product_type_name": "Transportation",
                                "description": "TRANSPORTATION - Fuel Surcharge",
                                "quanity": 145.0
                            }
                        ],
                        "totalElements": 
                    }
                ],
                "erAuth": false,
                "suborders": [],
                "trans_address": "132, My Street, Kingston, New York 12401.",
                "Scheduling_Note": null
            }
        ],
        "suborders": [],
        "trucks": [
            {
                "id": 302,
                "Value": "115",
                "Equipment_ID": "2007 Peterbilt 378 R/O Truck",
                "Vendor_id": null,
                "Broker_id": 31,
                "OutOfService": true
            }
                    ],
        "trailers": [
            {
                "id": 1714,
                "Value": "1",
                "Equipment_ID": "1",
                "Vendor_id": 3188,
                "Broker_id": 31,
                "OutOfService": false
            }
                    ],
        "drivers": [
            {
                "id": 536,
                "Driver_ID": 1,
                "Name": "Jane Doe",
                "Code": "109999999",
                "Status": "Active",
                "Created_date": null,
                "Modified_date": "2024-04-03T07:30:35.959322Z",
                "User_id": null,
                "Broker_id": 31,
                "FacilityName_id": null,
                "TransportationName_id": 21,
                "IsWasteLinq": true,
                "Email": null,
                "UserName": "testTime",
                "Password": "testPass",
                "Uid": null
            }
                    ],
        "dayslotOrder": 3,
        "maxDayslotNum": [
            1,
            2,
            3
        ],
        "tran_com": [
            {
                "id": 119473,
                "Tran_Com_Number": 69641,
                "Name": "1",
                "Portal_Default": false,
                "Transportation_State_ID": "1",
                "Transportation_EPA_ID": "1",
                "Transportation_Phone": "999-999-9999",
                "Address1": "1",
                "Address2": "1",
                "City": "1",
                "State": "GU",
                "Zip": "1",
                "Status": "Inactive",
                "Approval_Documents": "",
                "Created_date": "2024-04-04T03:47:05.055467Z",
                "Modified_date": "2024-04-04T06:30:43.294369Z",
                "User_id": 1941,
                "from_esc_id": null,
                "Broker_id": 31,
                "Sub_Field": null,
                "Preferred": true,
                "IsWasteLinq": false,
                "is_company_transportation": false
            }
        ],
        "tran_com2": [
            {
                "id": 119477,
                "Tran_Com_Number": 69645,
                "Name": "2",
                "Portal_Default": false,
                "Transportation_State_ID": "2",
                "Transportation_EPA_ID": "2",
                "Transportation_Phone": "222-222-2222",
                "Address1": "132, My Street, Kingston, New York 12401.",
                "Address2": "132, My Street, Kingston, New York 12401.",
                "City": "New York",
                "State": "NY",
                "Zip": "12401",
                "Status": "Active",
                "Approval_Documents": "",
                "Created_date": "2024-04-04T06:36:33.995708Z",
                "Modified_date": "2024-04-04T06:37:04.865563Z",
                "User_id": 1941,
                "from_esc_id": null,
                "Broker_id": 31,
                "Sub_Field": null,
                "Preferred": false,
                "IsWasteLinq": true,
                "is_company_transportation": false
            }
                    ],
            "total55eq": 91,
            "event_comments": null,
            "IsNetwork": false,
            "event_id": 98564,
            "calFile": []
        }
    }

Schedules Update Outbound ¶

Schedules Update Outbound
POST`/api/schedules_updateoutbound/`

Overview:

The Schedules Update Outbound API endpoint allows for the updating of existing outbound schedules in the WasteLinq system. This endpoint requires an Authorization token and a JSON body containing the details of the outbound schedule to be updated. The details include the object type, object ID, date, truck ID, trailer ID, and driver ID. Upon successful update, the API returns a success status and a JSON object containing the updated details of the outbound schedule. This API is primarily used for updating the details of existing outbound schedules in the system.

Response Description:

Name	Data Type	Description
type	string	The type of the schedule, in this case, ‘outbound’.
id	string	The unique identifier for the schedule.
driver	number	The identifier for the driver.
tran_com	number	The identifier for the transportation company, if any.
tran_com_name	number	The name of the transportation company, if any.
truck	number	The identifier for the truck.
trailer	number	The identifier for the trailer, if any.
date	string	The date of the schedule.
name	string	The name of the schedule.
dayslotOrder	number	The order of the day slot.
orders	array	An array containing the details of the orders.

Example URI

POST https://test-api.wastelinq.com/api/schedules_updateoutbound/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "objectType": "outbound",
  "objectID": "111526",
  "Date": "2024-04-02",
  "Truck_id": 322,
  "Trailer_id": null,
  "Driver_id": 557,
  "Third_Party_id": null
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "type": "outbound",
  "id": "111526",
  "driver": 557,
  "tran_com": null,
  "tran_com_name": null,
  "truck": 322,
  "trailer": null,
  "date": "2024-04-02",
  "name": "Company A",
  "dayslotOrder": 2,
  "orders": []
}

Schedules Delete Event ¶

Schedules Delete Event
POST`/api/schedules_deleteevent/`

Overview:

The Schedules Delete Event API endpoint allows for the deletion of existing schedules in the WasteLinq system. This endpoint requires an Authorization token and a JSON body containing the unique identifier (id) and the outbound status of the schedule to be deleted. Upon successful deletion, the API returns a success status and an empty JSON object. This API is primarily used for deleting existing schedules in the system.

Response Description:

Name	Data Type	Description
id	number	The unique identifier for the schedule.
outbound	boolean	Indicates whether the schedule is outbound.

Example URI

POST https://test-api.wastelinq.com/api/schedules_deleteevent/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "id": 97052,
  "outbound": false
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    ""
}

Schedules Edit Outbound ¶

Schedules Edit Outbound
GET`/api/schedules_editoutbound/{?id}`

Overview:

The Schedules Edit Outbound API endpoint allows for the editing of existing outbound schedules in the WasteLinq system. This endpoint requires an Authorization token and a JSON body containing the unique identifier (id) of the schedule to be edited. Upon successful editing, the API returns a success status and a JSON object containing the updated details of the outbound schedule. This API is primarily used for editing existing outbound schedules in the system.

Response Description:

Name	Data Type	Description
data	object	The main data object.
ContactList	array	An array containing the contact list.
id	number	The unique identifier for the contact.
order	string	The order number.
manifest	string	The manifest number.
generator	string	The name of the generator.
typesize	string	The type and size of the order.
tsdf	string	The name of the TSDF.
is_disposal_only	boolean	Indicates whether the schedule is for disposal only.
trucks	array	An array containing the details of the trucks.
trailers	array	An array containing the details of the trailers.
drivers	array	An array containing the details of the drivers.
tran_com	array	An array containing the details of the transportation company.
tran_com2	array	An array containing the details of the secondary transportation company.
outbound	object	The details of the outbound schedule.
shipment_comments	string	The comments for the shipment.
dayslotOrder	number	The order of the day slot.
maxDayslotNum	array	An array containing the maximum day slot numbers.

Example URI

GET https://test-api.wastelinq.com/api/schedules_editoutbound/?id=

URI Parameters

HideShow

id: number (optional)
The unique identifier for the Shipment.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    "data": {
        "ContactList": [
            {
                "content": [
                    {
                        "id": 295491,
                        "order": "582795",
                        "manifest": "10000",
                        "generator": "Company A",
                        "approval": "",
                        "typesize": "DF / 5",
                        "tsdf": "Company A"
                    }
                                ],
                "totalElements": 1
            }
        ]
        "is_disposal_only": false,
        "trucks": [
            {
                "id": 307,
                "Value": "122",
                "Equipment_ID": "2015 Mack 3",
                "Vendor_id": null,
                "Broker_id": 31,
                "OutOfService": false
            }
                    ],
        "trailers": [
            {
                "id": 1714,
                "Value": "1",
                "Equipment_ID": "1",
                "Vendor_id": 3188,
                "Broker_id": 31,
                "OutOfService": false
            }
                ],
        "drivers": [
            {
                "id": 536,
                "Driver_ID": 1,
                "Name": "Jane Doe",
                "Code": "109999999",
                "Status": "Active",
                "Created_date": null,
                "Modified_date": "2024-04-03T07:30:35.959322Z",
                "User_id": null,
                "Broker_id": 31,
                "FacilityName_id": null,
                "TransportationName_id": 21,
                "IsWasteLinq": true,
                "Email": null,
                "UserName": "testTime",
                "Password": "testPass",
                "Uid": null
            }
                    ],
        "tran_com": [
            {
                "id": 119473,
                "Tran_Com_Number": 69641,
                "Name": "1",
                "Portal_Default": false,
                "Transportation_State_ID": "1",
                "Transportation_EPA_ID": "1",
                "Transportation_Phone": "999-999-9999",
                "Address1": "1",
                "Address2": "1",
                "City": "1",
                "State": "GU",
                "Zip": "1",
                "Status": "Inactive",
                "Approval_Documents": "",
                "Created_date": "2024-04-04T03:47:05.055467Z",
                "Modified_date": "2024-04-04T06:30:43.294369Z",
                "User_id": 1941,
                "from_esc_id": null,
                "Broker_id": 31,
                "Sub_Field": null,
                "Preferred": true,
                "IsWasteLinq": false,
                "is_company_transportation": false
            }
        ],
        "tran_com2": [
            {
                "id": 119477,
                "Tran_Com_Number": 69645,
                "Name": "2",
                "Portal_Default": false,
                "Transportation_State_ID": "2",
                "Transportation_EPA_ID": "2",
                "Transportation_Phone": "222-222-2222",
                "Address1": "132, My Street, Kingston, New York 12401.",
                "Address2": "132, My Street, Kingston, New York 12401.",
                "City": "New York",
                "State": "NY",
                "Zip": "12401",
                "Status": "Active",
                "Approval_Documents": "",
                "Created_date": "2024-04-04T06:36:33.995708Z",
                "Modified_date": "2024-04-04T06:37:04.865563Z",
                "User_id": 1941,
                "from_esc_id": null,
                "Broker_id": 31,
                "Sub_Field": null,
                "Preferred": false,
                "IsWasteLinq": true,
                "is_company_transportation": false
            }
            ],
        "outbound": {
            "id": 111526,
            "Shipment_Date": "2024-04-04",
            "Truck_Assigned_id": 322,
            "Trailer_Number_id": null,
            "Driver_id": 557,
            "Third_Party_id": null
        },
        "shipment_comments": "",
        "dayslotOrder": 1,
        "maxDayslotNum": [
            1
        ]
    }
}

Schedules Week Data Update ¶

Schedules Week Data Update
POST`/api/schedules_weekdataupdate/`

Overview:

The Schedules Week Data Update API endpoint allows for the updating of weekly schedule data in the WasteLinq system. This endpoint requires an Authorization token and a JSON body containing the unique identifier (id) and the outbound status of the schedule to be updated. Upon successful update, the API returns a success status and a JSON object containing the updated weekly schedule data. This API is primarily used for updating weekly schedule data in the system.

Response Description:

Name	Data Type	Description
weekData	array	An array containing the data for the week.
type	string	The type of the schedule, either ‘event’ or ‘inbound’.
date	string	The date of the schedule.
dayslotOrder	number/string	The order of the day slot.
driver	number/string	The identifier for the driver.
erAuth	string/boolean	The authorization status.
id	number	The unique identifier for the schedule.
name	string/number	The name of the schedule.
onHold	string/boolean	The hold status of the schedule.
orders	array	An array containing the details of the orders.
originOrderID	string	The original order ID.
restrictDay	string	The restricted day.
suborders	array	An array containing the details of the suborders.
trailer	string	The identifier for the trailer, if any.
tran_com	string	The identifier for the transportation company.
tran_com_name	string	The name of the transportation company.
truck	string	The identifier for the truck.
wmp_id	string/number	The WMP ID.
generator	number	The identifier for the generator (only for ‘inbound’).
generator_name	string	The name of the generator (only for ‘inbound’).
is_paper_work	boolean	Indicates whether the schedule is for paperwork (only for ‘inbound’).

Example URI

POST https://test-api.wastelinq.com/api/schedules_weekdataupdate/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "id": 97052,
  "outbound": false
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "weekData": [
    {
      "type": "event",
      "date": "2024-04-10",
      "dayslotOrder": 1,
      "driver": 949,
      "erAuth": "",
      "id": 97301,
      "name": "DEFAULT",
      "onHold": "",
      "orders": [
        [
          "544954",
          584223,
          false,
          false,
          1007558,
          "Ketra (BEAM Location) # 13",
          false
        ]
      ],
      "originOrderID": "",
      "restrictDay": "",
      "suborders": [],
      "trailer": null,
      "tran_com": "None",
      "tran_com_name": null,
      "truck": null,
      "wmp_id": ""
    },
    {
      "type": "inbound",
      "date": "2024-04-08",
      "dayslotOrder": "",
      "driver": "UA",
      "erAuth": false,
      "id": 542640,
      "name": 581909,
      "onHold": false,
      "orders": [],
      "originOrderID": "",
      "restrictDay": "",
      "suborders": [],
      "trailer": "",
      "tran_com": "",
      "tran_com_name": "",
      "truck": "",
      "wmp_id": 612785,
      "generator": 1021602,
      "generator_name": "Company A",
      "is_paper_work": false
    }
  ]
}

Schedules Export Calendar To CSV ¶

Schedules Export Calendar To CSV
POST`/api/schedules_export_calendar_to_csv/`

Overview:

The Schedules Export Calendar To CSV API endpoint allows for the exporting of schedule data to a CSV file. This endpoint requires an Authorization token and a JSON body containing the date range, disposal facility calendar setting, and transportation name calendar setting. Upon successful export, the API returns a success status and a PDF file containing the exported schedule data. This API is primarily used for exporting schedule data for record-keeping and offline use.

Response Description:

Name	Data Type	Description
DateList	string (JSON array)	A stringified JSON array containing date objects with “strDate” and “date” properties.
UAList	string (JSON array)	A stringified JSON array containing driver objects with “driver” and “lists” properties.
date_range	string	The range of dates for the schedule.
disposalfacility_calendar	string	The disposal facility calendar setting.
myList	string (JSON array)	A stringified JSON array containing driver objects with “driver” and “lists” properties.
transportationname_calendar	string	The transportation name calendar setting.

Example URI

POST https://test-api.wastelinq.com/api/schedules_export_calendar_to_csv/

Request

HideShow

Headers

Content-Type: application/html
Authorization: {TOKEN}

Body

DateList: "[{\"strDate\":\"Name\"},{\"date\":\"2024-04-08\",\"strDate\":\"Mon, Apr 8\"},{\"date\":\"2024-04-09\",\"strDate\":\"Tues, Apr 9\"},{\"date\":\"2024-04-10\",\"strDate\":\"Weds, Apr 10\"},{\"date\":\"2024-04-11\",\"strDate\":\"Thurs, Apr 11\"},{\"date\":\"2024-04-12\",\"strDate\":\"Fri, Apr 12\"},{\"date\":\"2024-04-13\",\"strDate\":\"Sat, Apr 13\"},{\"date\":\"2024-04-14\",\"strDate\":\"Sun, Apr 14\"}]"
UAList: "[{\"driver\":\"UA\",\"lists\":[{\"date\":\"2024-04-08\",\"list\":[{\"title\":\"\",\"orders\":\"581909   (1021602) \",\"outbounds\":null}]},{\"date\":\"2024-04-09\",\"list\":[]},{\"date\":\"2024-04-10\",\"list\":[]},{\"date\":\"2024-04-11\",\"list\":[]},{\"date\":\"2024-04-12\",\"list\":[]},{\"date\":\"2024-04-13\",\"list\":[]},{\"date\":\"2024-04-14\",\"list\":[]}]}]"
date_range: "/8/2024 - 4"
disposalfacility_calendar: "All"
myList: "[{\"driver\":\"jane Doe\",\"lists\":[{\"date
transportationname_calendar: "All"

Response 200

HideShow

Headers

Content-Type: PDF

Schedules Make Calendar Search ¶

Schedules Make Calendar Search
POST`/api/schedules_makeCalendarSearch/`

Overview:

The Schedules Make Calendar Search API endpoint allows for the searching of schedules in the WasteLinq system based on a provided search string and search type. This endpoint requires an Authorization token and a JSON body containing the search string and the type of search to be performed. Upon successful search, the API returns a success status and a JSON object containing the date of the schedule that matches the search criteria. This API is primarily used for searching schedules in the system.

Response Description:

Name	Data Type	Description
data	object	The main data object.
date	string	The date of the schedule.
searchString	string	The search string used to filter the results.
type_search	string	The type of search performed, in this case, ‘order’.

Example URI

POST https://test-api.wastelinq.com/api/schedules_makeCalendarSearch/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "searchString": "585404",
  "type_search": "order"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": {
    "date": "2024-04-09"
  }
}

Schedules Day Slot Status ¶

Schedules Day Slot Status
POST`/api/schedules_dayslotStatus/`

Overview:

The Schedules Day Slot Status API endpoint allows for the updating of the status of a day slot in the WasteLinq system. This endpoint requires an Authorization token and a JSON body containing the new status, date, and new driver. Upon successful update, the API returns a success status and a JSON object containing the updated details of the day slot. This API is primarily used for updating the status of day slots in the system.

Response Description:

Name	Data Type	Description
type	string	The type of the schedule, in this case, ‘dayslotStatus’.
id	string	The unique identifier for the schedule.
driver	string	The identifier for the driver.
date	string	The date of the schedule.
name	string	The name of the schedule.
orders	array	An array containing the details of the orders.
Status_name	string	The status name of the schedule.
restrictDay	boolean	Indicates whether the day is restricted.
affectedOutbounds	array	An array containing the details of the affected outbounds.
affectedOrders	array	An array containing the details of the affected orders.
affectedSuborders	array	An array containing the details of the affected suborders.
affectedEvents	array	An array containing the details of the affected events.
affectedEscpickup	array	An array containing the details of the affected ESC pickups.
affectedEsctenday	array	An array containing the details of the affected ESC ten day pickups.

Example URI

POST https://test-api.wastelinq.com/api/schedules_dayslotStatus/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "newStatus": "13",
  "date": "2024-04-09",
  "newDriver": "537"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "type": "dayslotStatus",
  "id": "2786",
  "driver": "537",
  "date": "2024-04-09",
  "name": "Training",
  "orders": [],
  "Status_name": "Training",
  "restrictDay": true,
  "affectedOutbounds": [],
  "affectedOrders": [
    {
      "id": "546135",
      "name": 585404,
      "date": "2024-04-09",
      "wmp_id": 618192,
      "generator": 1006384,
      "generator_name": "Company A",
      "is_paper_work": false,
      "erAuth": false,
      "onHold": false
    }
  ],
  "affectedSuborders": [],
  "affectedEvents": [
    98564
  ],
  "affectedEscpickup": [],
  "affectedEsctenday": []
}

Schedules Get Pick Up Packaged Items ¶

Schedules Get Pick Up Packaged Items
GET`/api/schedules_getPickUpPackagedItems/{?id,orderID}`

Overview:

The Schedules Get Pick Up Packaged Items API endpoint allows for the retrieval of packaged items for a specific pick up in the WasteLinq system. This endpoint requires an Authorization token and a JSON body containing the item ID and order ID. Upon successful retrieval, the API returns a success status and a JSON object containing the details of the packaged items. This API is primarily used for retrieving packaged items for pick ups in the system.

Response Description:

Name	Data Type	Description
ContactList	array	An array containing the contact list.
id	number	The unique identifier for the contact.
profile_name	string	The profile name of the contact.
profile_number	number	The profile number of the contact.
tsdf_name	string	The TSDF name of the contact.
approval_number	string	The approval number of the contact.
process_code	string	The process code of the contact.
waste_class	string	The waste class of the contact.
disposal_dot	string	The disposal DOT of the contact.
mainfest_number	string	The manifest number of the contact.
line_number	string	The line number of the contact.
container_type	string	The container type of the contact.
container_size	string	The container size of the contact.
container_unit	string	The container unit of the contact.
container_count	number	The container count of the contact.
total_volume	number	The total volume of the contact.
total_weight	number	The total weight of the contact.
calendarLocation	string	The calendar location of the contact.
facility_name	string	The facility name of the contact.
ProdServs	array	An array containing the product services.
product_item	string	The product item of the service.
product_type_name	string	The product type name of the service.
description	string	The description of the service.
quanity	number	The quantity of the service.
is_disposal_only	boolean	Indicates whether the contact is disposal only.
manyManifests	boolean	Indicates whether the contact has many manifests.
GeneratorName	string	The name of the generator.

Example URI

GET https://test-api.wastelinq.com/api/schedules_getPickUpPackagedItems/?id=&orderID=

URI Parameters

HideShow

id: number (required)
The unique identifier for the Item.
orderID: number (required)
The unique identifier for the Order.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "ContactList": [
    {
      "content": [
        {
          "id": 1237973,
          "profile_name": "NON-HAZ WASTE WATER FROM BULK TANK",
          "profile_number": 4235,
          "tsdf_name": "Company A",
          "approval_number": "12345678",
          "process_code": "8015",
          "waste_class": "Non-Hazardous",
          "disposal_dot": "NON-REGULATED MATERIAL PER 40 & 49 CFR",
          "mainfest_number": "12345678",
          "line_number": "1",
          "container_type": "TT",
          "container_size": "5000",
          "container_unit": "G",
          "container_count": 1,
          "total_volume": 5000,
          "total_weight": 41283,
          "calendarLocation": null,
          "facility_name": "Facility A"
        }
      ],
      "totalElements": 1
    }
  ],
  "ProdServs": [
    {
      "content": [
        {
          "id": 1434473,
          "product_item": "880",
          "product_type_name": "Transportation",
          "description": "TRANSPORTATION - Fuel Surcharge",
          "quanity": 145
        },
        {
          "id": 1434474,
          "product_item": "860",
          "product_type_name": "Transportation",
          "description": "TRANSPORTATION - Bulk per Hour",
          "quanity": 1
        }
      ],
      "totalElements": 2
    }
  ],
  "is_disposal_only": false,
  "manyManifests": false,
  "GeneratorName": "Company A"
}

Schedules Get DayslotPaperwork ESC ¶

Schedules Get DayslotPaperwork ESC
POST`/api/schedules_getDayslotPaperworkESC/`

Overview:

The Schedules Get DayslotPaperwork ESC API endpoint allows for the retrieval of paperwork for a specific day slot in the WasteLinq system. This endpoint requires an Authorization token and a JSON body containing the date and driver ID. Upon successful retrieval, the API returns a success status and a JSON object containing the details of the day slot paperwork. This API is primarily used for retrieving paperwork for day slots in the system.

Response Description:

Name	Data Type	Description
allEvents	array	An array containing all the events.
event_id	number	The unique identifier for the event.
type	string	The type of the schedule, in this case, ‘event’.
entryNum	number	The entry number of the event.
title	string	The title of the event.
date	string	The date of the event.
note	string	Any notes associated with the event.
time	string	The time of the event.
orders	array	An array containing the details of the orders.
id	number	The unique identifier for the order.
Order_Number	number	The order number.
GeneratorName	string	The name of the generator.
ProdServs	array	An array containing the product services.
pk_list	array	An array containing the pk list.
suborders	array	An array containing the details of the suborders.

Example URI

POST https://test-api.wastelinq.com/api/schedules_getDayslotPaperworkESC/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "data_day": "2024-04-11",
  "data_driverid": "949"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "allEvents": [
    {
      "event_id": 98870,
      "type": "event",
      "entryNum": 1,
      "title": "DEFAULT",
      "date": "2024-04-11",
      "note": null,
      "time": "12:00 AM",
      "orders": [
        {
          "id": 547129,
          "Order_Number": 586398,
          "GeneratorName": "Company A",
          "ProdServs": [
            {
              "content": [
                {
                  "id": 1438070,
                  "product_item": "860",
                  "product_type_name": "Transportation",
                  "description": "TRANSPORTATION - Bulk per Hour",
                  "quanity": 8
                },
                {
                  "id": 1438072,
                  "product_item": "880",
                  "product_type_name": "Transportation",
                  "description": "TRANSPORTATION - Fuel Surcharge",
                  "quanity": 1080
                }
              ],
              "totalElements": 2
            }
          ],
          "pk_list": [
            {
              "content": [
                {
                  "id": 1240767,
                  "profile_name": "USED OIL With Water",
                  "profile_number": 138572,
                  "tsdf_name": "Company A",
                  "approval_number": "",
                  "process_code": "6103",
                  "waste_class": "USED OIL",
                  "disposal_dot": "NON-REGULATED MATERIAL PER 40 & 49 CFR (USED OIL, WATER)",
                  "mainfest_number": "123456789",
                  "line_number": "1",
                  "container_type": "TT",
                  "container_size": "5000",
                  "container_unit": "G",
                  "container_count": 1,
                  "total_volume": 2000,
                  "total_weight": 16680,
                  "calendarLocation": null,
                  "facility_name": "Company A"
                }
              ],
              "totalElements": 1
            }
          ]
        }
      ],
      "suborders": []
    }
  ]
}

Schedules Get Facilities ¶

Schedules Get Facilities
GET`/api/schedules_getFacilities`

Overview:

The Schedules Get Facilities API endpoint allows for the retrieval of facility details in the WasteLinq system. This endpoint requires an Authorization token. Upon successful retrieval, the API returns a success status and a JSON object containing the details of the facilities. This API is primarily used for retrieving facility details in the system.

Response Description:

Name	Data Type	Description
tsdf	array	An array containing the details of the TSDF.
id	number	The unique identifier for the TSDF.
Name	string	The name of the TSDF.
EPA_ID	string	The EPA ID of the TSDF.
State_ID	string	The state ID of the TSDF.
Region	string	The region of the TSDF.
Address1	string	The first line of the address of the TSDF.
Address2	string	The second line of the address of the TSDF.
City	string	The city of the TSDF.
State	string	The state of the TSDF.
Zip	string	The zip code of the TSDF.
Phone	string	The phone number of the TSDF.
Sales_Tax_Rate	number	The sales tax rate of the TSDF.
Broker_id	number	The broker ID associated with the TSDF.
status	string	The status of the TSDF.
is_wastelinq	boolean	Indicates whether the TSDF is in WasteLinq.
ltl_pickup_day	string	The LTL pickup day of the TSDF.

Example URI

GET https://test-api.wastelinq.com/api/schedules_getFacilities

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "tsdf": [
    {
      "id": 71,
      "Name": "Company A",
      "EPA_ID": "123456789",
      "State_ID": "New York",
      "Region": "New York",
      "Address1": "132, My Street, Kingston, New York 12401.",
      "Address2": "132, My Street, Kingston, New York 12401.",
      "City": "New York",
      "State": "NY",
      "Zip": "12401",
      "Phone": "100-100-1000",
      "Sales_Tax_Rate": null,
      "Broker_id": 31,
      "status": "Active",
      "is_wastelinq": false,
      "ltl_pickup_day": null
    }
  ]
}

Schedules Get Sub Orders ¶

Schedules Get Sub Orders
GET`/api/schedules_get_sub_orders/{?esc_order_id}`

Overview:

The Schedules Get Sub Orders API endpoint allows for the retrieval of sub order details in the WasteLinq system. This endpoint requires an Authorization token. Upon successful retrieval, the API returns a success status and a JSON object containing the details of the sub orders. This API is primarily used for retrieving sub order details in the system.

Response Description:

Name	Data Type	Description
items	array	An array containing the items.
Order_Number	number	The order number of the item.
scheduled_date	string	The scheduled date of the item.
requested_date	string	The requested date of the item.
city_state	string	The city and state of the item.
pickup_location	string	The pickup location of the item.
first_network_order_logistics_status	string	The first network order logistics status of the item.
id	number	The unique identifier for the item.
df	string	The df of the item.
Pick_Up_Date	string	The pick up date of the item.
ESC	string	The ESC of the item.
driver	number	The driver of the item.
facilityName	array	An array containing the facility names of the item.
generatorFacilityName	string	The generator facility name of the item.
gen_transportation_note	string	The generator transportation note of the item.
gen_facility_hours	string	The generator facility hours of the item.
wmp_id	number	The wmp id of the item.
erAuth	boolean	Indicates whether the item has er authorization.
notPrior	boolean	Indicates whether the item is not prior.
schedulingnote	string	The scheduling note of the item.
gen_equipment_requirements	string	The generator equipment requirements of the item.
suborderList	array	An array containing the suborder list of the item.
showSuborder	boolean	Indicates whether to show the suborder of the item.
count	number	The count of the item.
cont_type	array	An array containing the container types of the item.
55eq	number	The 55eq of the item.
dateless	boolean	Indicates whether the item is dateless.
hide	boolean	Indicates whether to hide the item.
trans_zone	string	The trans zone of the item.
special_handling	string	The special handling of the item.
IsNetwork	boolean	Indicates whether the item is a network.
suborderLock	boolean	Indicates whether the suborder is locked.

Example URI

GET https://test-api.wastelinq.com/api/schedules_get_sub_orders/?esc_order_id=

URI Parameters

HideShow

esc_order_id: number (required)
The unique identifier for the ESC order.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "items": [
    {
      "Order_Number": 585197,
      "scheduled_date": null,
      "requested_date": "2024-04-09",
      "city_state": "Kingston, New York",
      "pickup_location": "132, My Street, Kingston, New York 12401.",
      "first_network_order_logistics_status": "",
      "id": 545928,
      "df": "Company A",
      "Pick_Up_Date": "2024-04-09",
      "ESC": "Company A",
      "driver": null,
      "facilityName": [
        "Company A"
      ],
      "generatorFacilityName": "Company A",
      "gen_transportation_note": "",
      "gen_facility_hours": null,
      "wmp_id": 617855,
      "erAuth": false,
      "notPrior": true,
      "schedulingnote": null,
      "gen_equipment_requirements": "",
      "suborderList": [
        {
          "id": 453114,
          "name": "585197-01",
          "Name": "585197-01",
          "uinum": "585197-01",
          "disposalFacility": "Company A",
          "facilityName": [
            "Company A"
          ],
          "count": 1,
          "cont_type": [
            "CM"
          ],
          "55eq": 4000,
          "parentLock": true,
          "schedulingnote": null,
          "trans_zone": "NB4",
          "sub_order_id": 545928,
          "city_state": "Kingston, New York",
          "pickup_location": "132, My Street, Kingston, New York 12401.",
          "is_approved_on_hold": false,
          "is_er_authorization": false,
          "hide": true
        }
      ],
      "showSuborder": true,
      "count": 1,
      "cont_type": [
        "CM"
      ],
      "55eq": 4000,
      "dateless": false,
      "hide": false,
      "trans_zone": "NB4",
      "special_handling": ""
    }
  ],
  "IsNetwork": false,
  "suborderLock": true
}

Schedules Get Suborder PickUp Packaged Items ¶

Schedules Get Suborder PickUp Packaged Items
GET`/api/schedules_getSuborderPickUpPackagedItems`

Overview:

The Schedules Get Suborder PickUp Packaged Items API endpoint allows for the retrieval of packaged items for a specific suborder in the WasteLinq system. This endpoint requires an Authorization token. Upon successful retrieval, the API returns a success status and a JSON object containing the details of the packaged items for the specified suborder. This API is primarily used for fetching packaged items details in the system.

Response Description:

Name	Data Type	Description
ContactList	array	An array containing the contact list.
id	number	The unique identifier for the contact.
profile_name	string	The profile name of the contact.
profile_number	number	The profile number of the contact.
tsdf_name	string	The tsdf name of the contact.
approval_number	string	The approval number of the contact.
process_code	string	The process code of the contact.
waste_class	string	The waste class of the contact.
disposal_dot	string	The disposal dot of the contact.
mainfest_number	string	The mainfest number of the contact.
line_number	string	The line number of the contact.
container_type	string	The container type of the contact.
container_size	number	The container size of the contact.
container_unit	string	The container unit of the contact.
container_count	number	The container count of the contact.
total_volume	number	The total volume of the contact.
total_weight	number	The total weight of the contact.
calendarLocation	string	The calendar location of the contact.
facility_name	string	The facility name of the contact.
totalElements	number	The total number of elements in the contact list.
is_disposal_only	boolean	Indicates whether the contact is disposal only.
parentOrder	number	The parent order of the contact.
ProdServs	array	An array containing the product services of the contact.
GeneratorName	string	The generator name of the contact.

Example URI

GET https://test-api.wastelinq.com/api/schedules_getSuborderPickUpPackagedItems

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "ContactList": [
    {
      "content": [
        {
          "id": 1234731,
          "profile_name": "PTFE - Landfill Only",
          "profile_number": 91497,
          "tsdf_name": "Company A",
          "approval_number": "1123457",
          "process_code": "7603",
          "waste_class": "Non-Hazardous",
          "disposal_dot": "NONRCRA / NONDOT REGULATED MATERIAL (PTFE)",
          "mainfest_number": "1231234",
          "line_number": "1",
          "container_type": "CW",
          "container_size": "202",
          "container_unit": "P",
          "container_count": 12,
          "total_volume": 2424,
          "total_weight": 20216.16,
          "calendarLocation": null,
          "facility_name": "Company A"
        }
      ],
      "totalElements": 1
    }
  ],
  "is_disposal_only": false,
  "parentOrder": 544761,
  "ProdServs": [
    {
      "content": [],
      "totalElements": 0
    }
  ],
  "GeneratorName": "CDI Energy Products"
}

Schedules Get Outbound ¶

Schedules Get Outbound
GET`/api/schedules_getOutbound`

Overview:

The Schedules Get Outbound API endpoint allows for the retrieval of outbound schedules in the WasteLinq system. This endpoint requires an Authorization token. Upon successful retrieval, the API returns a success status and a JSON object containing the details of the outbound schedules. This API is primarily used for fetching outbound schedules in the system.

Response Description:

Name	Data Type	Description
ContactList	array	An array containing the contact list.
id	number	The unique identifier for the contact.
manifest	string	The manifest of the contact.
order	number	The order of the contact.
generator	string	The generator of the contact.
tsdf	string	The tsdf of the contact.
approval	string	The approval of the contact.
typesize	string	The type and size of the contact.
contcnt	number	The count of the contact.
totalElements	number	The total number of elements in the contact list.
is_disposal_only	boolean	Indicates whether the contact is disposal only.

Example URI

GET https://test-api.wastelinq.com/api/schedules_getOutbound

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "ContactList": [
    {
      "content": [
        {
          "id": 286553,
          "manifest": "1237456754",
          "order": 571815,
          "generator": "Company A",
          "tsdf": null,
          "approval": "1231231231",
          "typesize": "DF / 55",
          "contcnt": 3
        }
      ],
      "totalElements": 1
    }
  ],
  "is_disposal_only": false
}

Schedules Create Outbound From Scheduler ¶

Schedules Create Outbound From Scheduler
POST`/api/schedules_createOutboundFromScheduler`

Overview:

The Schedules Create Outbound From Scheduler API endpoint allows for the creation of a new outbound schedule in the WasteLinq system. This endpoint requires an Authorization token and a JSON object containing the details of the outbound schedule to be created. Upon successful creation, the API returns a success status and a JSON object containing the details of the newly created outbound schedule. This API is primarily used for creating new outbound schedules in the system.

Response Description:

Name	Data Type	Description
type	string	The type of the schedule.
id	string	The unique identifier for the schedule.
driver	number	The driver assigned to the schedule.
tran_com	string	The transport company assigned to the schedule.
truck	number	The truck assigned to the schedule.
trailer	number	The trailer assigned to the schedule.
date	string	The date of the schedule.
name	string	The name of the schedule.
orders	array	An array containing the orders in the schedule.
dayslotOrder	number	The order of the day slot.
objectType	string	The type of the object.
objectID	number	The unique identifier for the object.
Date	string	The date of the object.
Truck_id	number	The identifier for the truck.
Trailer_id	number	The identifier for the trailer.
Driver_id	number	The identifier for the driver.
Tran_Com_id	number	The identifier for the transport company.

Example URI

POST https://test-api.wastelinq.com/api/schedules_createOutboundFromScheduler

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "objectType": "outbound",
  "objectID": 102295,
  "Date": "2024-04-07",
  "Truck_id": 200,
  "Trailer_id": 450,
  "Driver_id": 1037,
  "Tran_Com_id": null
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "type": "outbound",
  "id": "102295",
  "driver": 1037,
  "tran_com": "None",
  "truck": 200,
  "trailer": 450,
  "date": "2024-04-07",
  "name": "Company A",
  "orders": [],
  "dayslotOrder": 1
}

Schedules Get ESCs ¶

Schedules Get ESCs
GET`/api/schedules_getESCs`

Overview:

The Schedules Get ESCs API endpoint allows for the retrieval of Environmental Service Companies (ESCs) in the WasteLinq system. This endpoint requires an Authorization token. Upon successful retrieval, the API returns a success status and a JSON object containing a list of ESCs. This API is primarily used for retrieving ESCs in the system.

Response Description:

Name	Data Type	Description
id	number	The unique identifier for the broker.
Broker_Name	string	The name of the broker.
NumberOfUsers	number	The number of users associated with the broker.
NumberOfPortalUsers	number	The number of portal users associated with the broker.
Product_id	number	The identifier for the product associated with the broker.
EManifest	boolean	Indicates whether the broker uses EManifest.
IsWasteLinq	boolean	Indicates whether the broker uses WasteLinq.
IsNetwork	boolean	Indicates whether the broker is part of a network.
is_in_network_system	boolean	Indicates whether the broker is in a network system.
Avalara	boolean	Indicates whether the broker uses Avalara.
Paytech	boolean	Indicates whether the broker uses Paytech.

Example URI

GET https://test-api.wastelinq.com/api/schedules_getESCs

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "list_esc": [
    {
      "id": 115,
      "Broker_Name": "Company A",
      "NumberOfUsers": 4,
      "NumberOfPortalUsers": 0,
      "Product_id": 2,
      "EManifest": false,
      "IsWasteLinq": false,
      "IsNetwork": false,
      "is_in_network_system": true,
      "Avalara": false,
      "Paytech": false
    }
  ]
}

Schedules Esc Pickup ¶

Schedules Esc Pickup
GET`/api/schedules_escpickup`

Overview:

The Schedules ESC Pickup API endpoint allows for the retrieval of pickup details for a specific Environmental Service Company (ESC) in the WasteLinq system. This endpoint requires an Authorization token. Upon successful retrieval, the API returns a success status and a JSON object containing the details of the pickups. This API is primarily used for retrieving pickup details for ESCs in the system.

Response Description:

Name	Data Type	Description
success	boolean	Indicates whether the request was successful
content	array	An array of shipment objects
id	number	The unique identifier for the shipment
shipment_number	number	The shipment number
esc	string	The name of the Environmental Services Company (ESC)
pick_up_location	string	The pick-up location for the shipment
deliver_location	string	The delivery location for the shipment
55_eqv	number	The equivalent of 55-gallon drums for the shipment
is_wastelinq	boolean	Indicates whether the shipment is managed by WasteLinq
city_state	string	The city and state of the ESC
hide	boolean	Indicates whether the shipment is hidden
shipment_date	string	The date of the shipment
totalElements	number	The total number of shipments

Example URI

GET https://test-api.wastelinq.com/api/schedules_escpickup

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 102482,
      "shipment_number": 87983,
      "esc": "Company A",
      "pick_up_location": "Company A",
      "deliver_location": "",
      "55_eqv": 8.7,
      "is_wastelinq": true,
      "city_state": "New York",
      "hide": true,
      "shipment_date": "2024-02-01"
    }
  ],
  "totalElements": 1
}

Schedules Create Esc Pickup From Scheduler ¶

Schedules Create Esc Pickup From Scheduler
POST`/api/schedules_createEscpickupFromScheduler`

Overview:

The Schedules Create ESC Pickup From Scheduler API endpoint allows for the creation of new pickup details for a specific Environmental Services Company (ESC) in the WasteLinq system. This endpoint requires an Authorization token. Upon successful creation, the API returns a success status and a JSON object containing the details of the newly created pickup. This API is primarily used for creating new pickup details for ESCs in the system.

Response Description:

Name	Data Type	Description
type	string	The type of the object, in this case, “escpickup”
id	string	The unique identifier for the escpickup
driver	number	The identifier for the driver
tran_com	string	The transport company associated with the escpickup
truck	number	The identifier for the truck.
trailer	number	The identifier for the trailer.
date	string	The date of the escpickup
name	string	The name of the escpickup, which includes the company, location, and other details
orders	array	An array of orders associated with the escpickup
dayslotOrder	number	The order of the day slot
objectType	string	The type of the object, in this case, “escpickup”
objectID	number	The unique identifier for the escpickup
Date	string	The date of the escpickup
Name	string	The name of the escpickup, which includes the company, location, and other details
Truck_id	number	The identifier for the truck.
Trailer_id	number	The identifier for the trailer.
Time	string	The time of the escpickup
Driver_id	string	The identifier for the driver
Tran_Com_id	number	The identifier for the transportation company.
parentLock	boolean	Indicates whether the parent of the escpickup is locked

Example URI

POST https://test-api.wastelinq.com/api/schedules_createEscpickupFromScheduler

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "objectType": "escpickup",
  "objectID": 102482,
  "Date": "2024-04-07",
  "Name": "Company A",
  "Truck_id": null,
  "Trailer_id": null,
  "Time": "12:00 AM",
  "Driver_id": "859",
  "Tran_Com_id": null,
  "parentLock": false
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "type": "escpickup",
  "id": "102482",
  "driver": 859,
  "tran_com": "None",
  "truck": null,
  "trailer": null,
  "date": "2024-04-07",
  "name": "Company A",
  "orders": [],
  "dayslotOrder": 1
}

Schedules Create Esc Ten Days From Scheduler ¶

Schedules Create Esc Ten Days From Schedule
POST`/api/schedules_createEsctendayFromScheduler`

Overview:

The Schedules Create Esc Ten Days From Scheduler API endpoint allows for the creation of a new Environmental Services Company (ESC) ten-day schedule in the WasteLinq system. This endpoint requires an Authorization token and a JSON object containing the details of the ESC ten-day schedule to be created. Upon successful creation, the API returns a success status and a JSON object containing the details of the newly created ESC ten-day schedule. This API is primarily used for creating new ESC ten-day schedules in the system.

Response Description:

Name	Data Type	Description
type	string	The type of the schedule.
id	string	The unique identifier for the schedule.
driver	string	The driver assigned to the schedule.
tran_com	string	The transport company assigned to the schedule.
truck	number	The truck assigned to the schedule.
trailer	number	The trailer assigned to the schedule.
date	string	The date of the schedule.
name	string	The name of the schedule.
orders	array	An array containing the orders in the schedule.
dayslotOrder	number	The order of the day slot.

Example URI

POST https://test-api.wastelinq.com/api/schedules_createEsctendayFromScheduler

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "objectType": "esctenday",
  "objectID": 107142,
  "Date": "2024-04-08",
  "Name": "Company A",
  "Truck_id": 200,
  "Trailer_id": 450,
  "Time": "12:00 AM",
  "Driver_id": "160_fac",
  "Tran_Com_id": null,
  "parentLock": false
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "type": "esctenday",
  "id": "107142",
  "driver": "160_fac",
  "tran_com": "None",
  "truck": 200,
  "trailer": 450,
  "date": "2024-04-08",
  "name": "Company A",
  "orders": [],
  "dayslotOrder": 1
}

Schedules Esc Ten Day ¶

Schedules Esc Ten Day
GET`/api/schedules_esctenday`

Overview:

The Schedules ESC Ten Day API endpoint allows for the retrieval of ten-day shipment details for a specific Environmental Services Company (ESC) in the WasteLinq system. This endpoint requires an Authorization token. Upon successful retrieval, the API returns a success status and a JSON object containing the details of the ten-day shipments. This API is primarily used for retrieving ten-day shipment details for ESCs in the system.

Response Description:

Name	Data Type	Description
success	boolean	Indicates whether the request was successful.
content	array	An array containing the shipment details.
id	number	The unique identifier for the shipment.
shipment_number	number	The shipment number.
esc	string	The name of the Environmental Service Center.
pick_up_location	string	The pick up location for the shipment.
deliver_location	string	The delivery location for the shipment.
55_eqv	number	The equivalent of 55-gallon drums for the shipment.
is_wastelinq	boolean	Indicates whether the shipment is in WasteLinq.
city_state	string	The city and state of the shipment.
hide	boolean	Indicates whether the shipment is hidden.
shipment_date	date	The date of the shipment.
totalElements	number	The total number of elements in the content array.

Example URI

GET https://test-api.wastelinq.com/api/schedules_esctenday

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{'success': True, 'content': [{'id': 107728, 'shipment_number': 93227, 'esc': 'Company A', 'pick_up_location': 'Location A', 'deliver_location': 'Location B', '55_eqv': 61.199999999999996, 'is_wastelinq': True, 'city_state': 'New York', 'hide': True, 'shipment_date': datetime.date(2024, 2, 29)}], 'totalElements': 1}

Schedules Update Existing Esc Ten Days ¶

Schedules Update Existing Esc Ten Days
POST`/api/schedules_updateExistingEsctenday`

Overview:

The Schedules Update Existing Esc Ten Days API endpoint allows for the updating of an existing Environmental Services Company (ESC) ten-day schedule in the WasteLinq system. This endpoint requires an Authorization token and a JSON object containing the details of the ESC ten-day schedule to be updated. Upon successful update, the API returns a success status and a JSON object containing the updated details of the ESC ten-day schedule. This API is primarily used for updating existing ESC ten-day schedules in the system.

Response Description:

Name	Data Type	Description
objectType	string	The type of the object.
objectID	string	The unique identifier for the object.
Date	string	The date of the object.
Truck_id	number	The identifier for the truck.
Trailer_id	number	The identifier for the trailer.
Driver_id	string	The identifier for the driver.
Third_Party_id	number	The identifier for the third party.
Name	string	The name of the object.
Shipment_Comments	string	The comments for the shipment.
type	string	The type of the schedule.
id	string	The unique identifier for the schedule.
driver	string	The driver assigned to the schedule.
tran_com	number	The transport company assigned to the schedule.
tran_com_name	string	The name of the transport company.
truck	string	The truck assigned to the schedule.
trailer	string	The trailer assigned to the schedule.
date	string	The date of the schedule.
name	string	The name of the schedule.
dayslotOrder	number	The order of the day slot.
orders	array	An array containing the orders in the schedule.

Example URI

POST https://test-api.wastelinq.com/api/schedules_updateExistingEsctenday

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "objectType": "esctenday",
  "objectID": "107142",
  "Date": "2024-04-07",
  "Truck_id": null,
  "Trailer_id": null,
  "Driver_id": "160_fac",
  "Third_Party_id": null,
  "Name": "Company A",
  "Shipment_Comments": ""
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "type": "esctenday",
  "id": "107142",
  "driver": "160_fac",
  "tran_com": null,
  "tran_com_name": null,
  "truck": "",
  "trailer": "",
  "date": "2024-04-08",
  "name": "Company A",
  "dayslotOrder": 1,
  "orders": []
}

Schedules Get Scheduled Esc Ten Days ¶

Schedules Get Scheduled Esc Ten Days
GET`/api/schedules_getScheduledEsctenday`

Overview:

The Schedules Get Scheduled Esc Ten Days API endpoint allows for the retrieval of scheduled ten-day details for a specific Environmental Services Company (ESC) in the WasteLinq system. This endpoint requires an Authorization token. Upon successful retrieval, the API returns a success status and a JSON object containing the details of the scheduled ten-day shipments. This API is primarily used for retrieving scheduled ten-day shipment details for ESCs in the system.

Response Description:

Name	Data Type	Description
ContactList	array	An array containing the contact details.
is_disposal_only	boolean	Indicates whether the order is disposal only.
trucks	array	An array containing the truck details.
trailers	array	An array containing the trailer details.
drivers	array	An array containing the driver details.
tran_com	array	An array containing the transport company details.
tran_com2	array	An array containing the secondary transport company details.
outbound	object	An object containing the outbound shipment details.
shipment_comments	string	The comments for the shipment.
dayslotOrder	number	The order of the day slot.
maxDayslotNum	number	The maximum number of day slots.
esc_name	string	The name of the Environmental Services Company.
flag_facility	boolean	Indicates whether the facility is flagged.
driver_id	number	The unique identifier for the driver.
dayslotRecord_date	date	The date of the day slot record.

Example URI

GET https://test-api.wastelinq.com/api/schedules_getScheduledEsctenday

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{'ContactList': [{'content': [{'id': 288559, 'manifest': '123456789', 'order': 577024, 'generator': 'Company A', 'tsdf': 'Company B', 'approval': '', 'typesize': 'DM / 55'}], 'totalElements': 1}], 'is_disposal_only': False, 'trucks': [], 'trailers': [], 'drivers': [], 'tran_com': [], 'tran_com2': [], 'outbound': {'id': 107728, 'Shipment_Date': datetime.date(2024, 3, 3), 'Truck_Assigned_id': 321, 'Trailer_Number_id': None, 'Driver_id': None, 'Third_Party_id': None}, 'shipment_comments': '', 'dayslotOrder': None, 'maxDayslotNum': None, 'esc_name': '', 'flag_facility': False, 'driver_id': None, 'dayslotRecord_date': None}

Schedules Update Existing Esc Pickup ¶

Schedules Update Existing Esc Pickup
POST`/api/schedules_updateExistingEscpickup`

Overview:

The Schedules Update Existing Esc Pickup API endpoint allows for the updating of an existing Environmental Services Company (ESC) pickup schedule in the WasteLinq system. This endpoint requires an Authorization token and a JSON object containing the details of the ESC pickup schedule to be updated. Upon successful update, the API returns a success status and a JSON object containing the updated details of the ESC pickup schedule. This API is primarily used for updating existing ESC pickup schedules in the system.

Response Description:

Name	Data Type	Description
type	string	The type of the schedule.
id	string	The unique identifier for the schedule.
driver	string	The driver assigned to the schedule.
tran_com	number	The transport company assigned to the schedule.
tran_com_name	string	The name of the transport company.
truck	string	The truck assigned to the schedule.
trailer	string	The trailer assigned to the schedule.
date	string	The date of the schedule.
name	string	The name of the schedule.
dayslotOrder	number	The order of the day slot.
orders	array	An array containing the orders in the schedule.
objectType	string	The type of the object.
objectID	string	The unique identifier for the object.
Date	string	The date of the object.
Truck_id	number	The identifier for the truck.
Trailer_id	number	The identifier for the trailer.
Driver_id	string	The identifier for the driver.
Third_Party_id	number	The identifier for the third party.
Name	string	The name of the object.
Shipment_Comments	string	The comments for the shipment.

Example URI

POST https://test-api.wastelinq.com/api/schedules_updateExistingEscpickup

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "objectType": "escpickup",
  "objectID": "107142",
  "Date": "2024-04-07",
  "Truck_id": null,
  "Trailer_id": null,
  "Driver_id": "160_fac",
  "Third_Party_id": null,
  "Name": "Company A",
  "Shipment_Comments": ""
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "type": "escpickup",
  "id": "107142",
  "driver": "160_fac",
  "tran_com": null,
  "tran_com_name": null,
  "truck": "",
  "trailer": "",
  "date": "2024-04-08",
  "name": "Company A",
  "dayslotOrder": 1,
  "orders": []
}

Schedules Get Scheduled Esc Pickup ¶

Schedules Get Scheduled Esc Pickup
GET`/api/schedules_getScheduledEscpickup`

Overview:

The Schedules Get Scheduled Esc Pickup API endpoint retrieves a scheduled Environmental Services Company (ESC) pickup from the WasteLinq system. The response includes an array of contact objects with details of the pickup schedule and related entities. This API is primarily used for retrieving existing ESC pickup schedules in the system.

Response Description:

Name	Data Type	Description
ContactList	array	An array of contact objects
content	array	An array of content objects
id	number	The unique identifier for the content
manifest	string	The manifest of the content
order	number	The order of the content
generator	string	The generator of the content
tsdf	string	The tsdf of the content
approval	string	The approval of the content
typesize	string	The type size of the content
totalElements	number	The total number of elements in the contact list
is_disposal_only	boolean	Indicates whether it is disposal only
trucks	array	An array of trucks
trailers	array	An array of trailers
drivers	array	An array of drivers
tran_com	array	An array of transport companies
tran_com2	array	An array of secondary transport companies
outbound	object	An object containing outbound details
id	number	The unique identifier for the outbound
Shipment_Date	string	The shipment date of the outbound
Truck_Assigned_id	number	Not provided
Trailer_Number_id	number	Not provided
Driver_id	number	The identifier for the driver
Third_Party_id	number	Not provided
shipment_comments	string	The comments for the shipment
dayslotOrder	number	The order of the day slot
maxDayslotNum	array	An array of maximum day slot numbers
esc_name	string	The name of the ESC
flag_facility	boolean	Indicates whether the facility is flagged
driver_id	string	The identifier for the driver
dayslotRecord_date	string	Not provided

Example URI

GET https://test-api.wastelinq.com/api/schedules_getScheduledEscpickup

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "ContactList": [
    {
      "content": [
        {
          "id": 280413,
          "manifest": "01240084",
          "order": 571527,
          "generator": "Company A",
          "tsdf": "Company A",
          "approval": "09090909",
          "typesize": "DF / 55"
        }
      ],
      "totalElements": 1
    }
  ],
  "is_disposal_only": false,
  "trucks": [],
  "trailers": [],
  "drivers": [],
  "tran_com": [],
  "tran_com2": [],
  "outbound": {
    "id": 102482,
    "Shipment_Date": "2024-04-07",
    "Truck_Assigned_id": null,
    "Trailer_Number_id": null,
    "Driver_id": 835,
    "Third_Party_id": null
  },
  "shipment_comments": "",
  "dayslotOrder": 1,
  "maxDayslotNum": [
    1
  ],
  "esc_name": "Company A",
  "flag_facility": false,
  "driver_id": "835",
  "dayslotRecord_date": null
}

Schedules Disposals ¶

Schedules Disposals
GET`/api/schedules_disposals`

Overview:

The Schedules Disposals API endpoint allows for the retrieval of disposal details in the WasteLinq system. This endpoint requires an Authorization token. Upon successful retrieval, the API returns a success status and a JSON object containing the details of the disposals. This API is primarily used for retrieving disposal details in the system.

Response Description:

Name	Data Type	Description
success	boolean	Indicates whether the request was successful.
content	array	An array containing the content of the response.
id	number	The unique identifier for the content.
wmp_id	number	The Waste Management Plan identifier for the content.
Order_Number	string	The order number.
ESC_Order_Number	number	The Environmental Services Company order number.
generator	string	The generator of the order.
status	string	The status of the order.
inslot_status	string	The in-slot status of the order.
tsdf	string	The Treatment, Storage, and Disposal Facility for the order.
ESC	string	The Environmental Services Company for the order.
erAuth	boolean	Indicates whether the order is authorized for emergency response.
ReqDate	string	The requested date for the order.
dateless	boolean	Indicates whether the order is dateless.
totalElements	number	The total number of elements in the content array.

Example URI

GET https://test-api.wastelinq.com/api/schedules_disposals

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 542054,
      "wmp_id": 612089,
      "Order_Number": "581321-02",
      "ESC_Order_Number": 581321,
      "generator": "Company A",
      "status": "Disposal Only",
      "inslot_status": null,
      "tsdf": "Company A",
      "ESC": "Company A",
      "erAuth": false,
      "ReqDate": null,
      "dateless": true
    }
  ],
  "totalElements": 1
}

Schedules Disposal Status Change ¶

Schedules Disposal Status Change
GET`/api/schedules_disposalStatusChange/{?id}`

Overview:

The Schedules Disposal Status Change API endpoint allows for the updating of the status of a disposal in the WasteLinq system. This endpoint requires an Authorization token and the unique identifier of the schedule whose disposal status needs to be updated. Upon successful update, the API returns a success status and a JSON object containing the updated time and date of the disposal. This API is primarily used for updating disposal status in the system.

Response Description:

Name	Data Type	Description
time	string	The time of the disposal.
date	string	The date of the disposal.

Example URI

GET https://test-api.wastelinq.com/api/schedules_disposalStatusChange/?id=

URI Parameters

HideShow

id: number (required)
The unique identifier for the schedule.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{'time': '13:00', 'date': '08-02-2021'}

Schedules Update Disposal Only ¶

Schedules Update Disposal Only
POST`/api/schedules_updateDisposalOnly/{?id}`

Overview:

The Schedules Update Disposal Only API endpoint allows for the updating of the disposal only status of a schedule in the WasteLinq system. This endpoint requires an Authorization token and the unique identifier of the schedule whose disposal only status needs to be updated. Upon successful update, the API returns a success status and a JSON object containing the updated status. This API is primarily used for updating disposal only status in the system.

Response Description:

Name	Data Type	Description
removeMe	boolean	Indicates whether the object should be removed.
displaySubmitted	boolean	Indicates whether the submitted data should be displayed.
objectType	string	The type of the object.
objectID	number	The unique identifier for the object.
newDate	string	The new date for the object.
newTime	string	The new time for the object.

Example URI

POST https://test-api.wastelinq.com/api/schedules_updateDisposalOnly/?id=

URI Parameters

HideShow

id: number (required)
The unique identifier for the schedule.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "objectType": "status",
  "objectID": 542054,
  "newDate": "2024-04-10",
  "newTime": "12:00 AM"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "removeMe": true,
  "displaySubmitted": false
}

Menu ¶

Other APIs docs ¶

Overview ¶

Bearer Token ¶

Error Messages ¶

APIs ¶

Schedules ESC ¶

Schedules ESCGET/api/schedules_esc/{?page,pageSize,filter,sort}

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Schedules Inbound ¶

Schedules InboundGET/api/schedules_inbound/{?page,pageSize,selectedFields,filter,sort}

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Schedules Weekdata ¶

Schedules WeekdataGET/api/schedules_weekdata/{?page,pageSize,selectedFields,filter,sort}

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Schedules Update ¶

Schedules UpdatePOST/api/schedules_update/

Overview: ¶

Response Description: ¶

Example URI

Headers

Body

Headers

Body

Schedules Create Event ¶

Schedules Create EventPOST/api/schedules_createevent/

Overview: ¶

Response Description: ¶

Example URI

Headers

Body

Headers

Body

Schedules Edit Existing ¶

Schedules Edit ExistingGET/api/schedules_editexisting/{id}/

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Schedules Update Outbound ¶

Schedules Update OutboundPOST/api/schedules_updateoutbound/

Overview: ¶

Response Description: ¶

Example URI

Headers

Body

Headers

Body

Schedules Delete Event ¶

Schedules Delete EventPOST/api/schedules_deleteevent/

Overview: ¶

Response Description: ¶

Example URI

Headers

Body

Headers

Body

Schedules Edit Outbound ¶

Schedules Edit OutboundGET/api/schedules_editoutbound/{?id}

Overview: ¶

Response Description: ¶

Example URI

Headers

Other APIs docs

Bearer Token

Error Messages

Schedules ESC
GET`/api/schedules_esc/{?page,pageSize,filter,sort}`

Overview:

Response Description:

Schedules Inbound
GET`/api/schedules_inbound/{?page,pageSize,selectedFields,filter,sort}`

Overview:

Response Description:

Schedules Weekdata
GET`/api/schedules_weekdata/{?page,pageSize,selectedFields,filter,sort}`

Overview:

Response Description:

Schedules Update
POST`/api/schedules_update/`

Overview:

Response Description:

Schedules Create Event
POST`/api/schedules_createevent/`

Overview:

Response Description:

Schedules Edit Existing
GET`/api/schedules_editexisting/{id}/`

Overview:

Response Description:

Schedules Update Outbound
POST`/api/schedules_updateoutbound/`

Overview:

Response Description:

Schedules Delete Event
POST`/api/schedules_deleteevent/`

Overview:

Response Description:

Schedules Edit Outbound
GET`/api/schedules_editoutbound/{?id}`

Overview:

Response Description:

Schedules Week Data Update
POST`/api/schedules_weekdataupdate/`

Overview:

Response Description:

Schedules Export Calendar To CSV
POST`/api/schedules_export_calendar_to_csv/`

Overview:

Response Description:

Schedules Make Calendar Search
POST`/api/schedules_makeCalendarSearch/`

Overview:

Response Description:

Schedules Day Slot Status
POST`/api/schedules_dayslotStatus/`

Overview:

Response Description:

Schedules Get Pick Up Packaged Items
GET`/api/schedules_getPickUpPackagedItems/{?id,orderID}`

Overview:

Response Description:

Schedules Get DayslotPaperwork ESC
POST`/api/schedules_getDayslotPaperworkESC/`

Overview:

Response Description:

Schedules Get Facilities
GET`/api/schedules_getFacilities`

Overview:

Response Description:

Schedules Get Sub Orders
GET`/api/schedules_get_sub_orders/{?esc_order_id}`

Overview:

Response Description: