Communication APIs Documentation
Overview ¶
The Communication APIs provide endpoints for managing profiles, portal profiles, orders, notification profiles, contacts, shipment requests, and more. These APIs allow you to retrieve and update communication details, create orders, acknowledge notifications, and track shipments. These are RESTful APIs that use the HTTP protocol for communication.
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
For example:
Authorization: Bearer 5262d64b892e8d4341000001Error 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.
Communication ¶
communication_profiles ¶
communication_profilesGET/api/communication/profiles/
Overview:
The communication_profiles endpoint, accessible at /api/communication/profiles/, is a GET request that is used to retrieve a list of profiles.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of communication profiles. |
| id | number | The ID of the communication profile. |
| Date_Submitted | string | The date the profile was submitted. |
| Generator_Id | number | The ID of the generator. |
| Generator | string | The name of the generator. |
| Billto | string | The bill-to name. |
| Internal_Profile_Id | number | The internal profile ID. |
| Profile_Id | number | The profile ID. |
| Profile_Number | number | The profile number. |
| Profile_Name | string | The profile name. |
| Class | string | The class of the profile. |
| Profile_Status | string | The status of the profile. |
| Re_cert_Change_Status | string | The re-certification change status. |
| Approval_Status | string | The approval status. |
| ER_Authorization | string | The ER authorization status. |
| Disposal_Facility | string | The disposal facility. |
| Assign_To | string | The name of the assignee. |
| Assign_To_Id | number | The ID of the assignee. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/communication/profiles/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 1,
"Date_Submitted": "05/11/2020",
"Generator_Id": 39842,
"Generator": "Company ABC",
"Billto": "Company ABC",
"Internal_Profile_Id": 66708,
"Profile_Id": 118864,
"Profile_Number": 63130,
"Profile_Name": "Flammable Liquid Waste",
"Class": "Hazardous",
"Profile_Status": "Expired",
"Re_cert_Change_Status": "Pending Approval",
"Approval_Status": "Expired",
"ER_Authorization": "No",
"Disposal_Facility": "Company ABC",
"Assign_To": "Jane Doe",
"Assign_To_Id": 1017
}
],
"totalElements": 300
}communication_portal_profiles ¶
communication_portal_profilesGET/api/communication/portal/profiles/
Overview:
The communication_portal_profiles endpoint, accessible at /api/communication/portal/profiles/, is a GET request that is used to retrieve a list of portal profiles.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of portal profiles. |
| profiles | array | An array of profiles. |
| id | number | The ID of the profile. |
| Profile_Id | number | The profile ID. |
| username | string | The username. |
| Generator_Id | number | The ID of the generator. |
| Generator | string | The name of the generator. |
| Profile_Name | string | The name of the profile. |
| Date_Submitted | string | The date the profile was submitted. |
| Origination | string | The origination of the profile. |
| Profile_Number | number | The profile number. |
| Assigned_To | string | The name of the assignee. |
| Assigned_To_Id | number | The ID of the assignee. |
| Disposal_Facility | string | The disposal facility. |
| Disposal_Facility_Id | string | The ID of the disposal facility. |
| Class | string | The class of the profile. |
| wastecode | string | The waste code. |
| cswastecode | string | The CS waste code. |
| Profile_Status | string | The status of the profile. |
| Re_cert_Change_Status | string | The re-certification change status. |
| hasprofile | number | The profile ID. |
| assignedList | array | An array of assigned contacts. |
| id | number | The ID of the contact. |
| first_name | string | The first name of the contact. |
| last_name | string | The last name of the contact. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/communication/portal/profiles/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"profiles": [
{
"id": 1,
"Profile_Id": 311263,
"username": "janedoe@wastelinq.com",
"Generator_Id": 41301,
"Generator": "Company ABC",
"Profile_Name": "test",
"Date_Submitted": "08-12-2024",
"Origination": "Portal - janedoe@wastelinq.com",
"Profile_Number": 212725,
"Assigned_To": "Jane Doe",
"Assigned_To_Id": 1880,
"Disposal_Facility": "",
"Disposal_Facility_Id": "0",
"Class": "Non-hazardous",
"wastecode": "",
"cswastecode": "concep",
"Profile_Status": "New",
"Re_cert_Change_Status": "",
"hasprofile": 311263
}
],
"assignedList": [
{
"id": 1812,
"first_name": "jane",
"last_name": "doe"
}
]
},
"totalElements": 1
}update_disposal_recert_change_to_non_renewal ¶
update_disposal_recert_change_to_non_renewalPOST/api/communication/profiles/update_disposal_recert_change_to_non_renewal/
Overview:
The update_disposal_recert_change_to_non_renewal endpoint, accessible at /api/communication/profiles/update_disposal_recert_change_to_non_renewal/, is a POST request that is used to update the disposal recertification status of a contact.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| tsdfId | number | The TSDF ID. |
| success | boolean | Indicates whether the operation was successful. |
| data | string | The data. |
| errormsg | string | The error message. |
Example URI
POST [Communication APIs](https://test-api.wastelinq.com)./api/communication/profiles/update_disposal_recert_change_to_non_renewal/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"tsdfId": 66708
}Response
200Headers
Content-Type: application/jsonBody
{
"success": "true",
"data": "",
"errormsg": ""
}communication_orders ¶
communication_ordersGET/api/communication/orders/{?page,pageSize,selectedFields,filter,sort}
Overview:
The communication_orders endpoint, accessible at /api/communication/orders/, is a GET request that is used to retrieve a list of orders.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of orders. |
| id | number | The ID of the order. |
| Order_Number | number | The order number. |
| Date_Created | string | The date the order was created. |
| Scheduled_Date | string | The scheduled date. |
| Manifest_No | string | The manifest number. |
| TSDF | string | The TSDF. |
| TSDF_Work | string | The TSDF work. |
| Status | string | The status of the order. |
| Generator_Id | number | The ID of the generator. |
| Generator | string | The name of the generator. |
| Network_Order_No | string | The network order number. |
| Logistics_Type | string | The logistics type. |
| Network_In-Slot | string | The network in-slot. |
| Network_Freight | string | The network freight. |
| Network_Status | string | The network status. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/communication/orders/?page=&pageSize=&selectedFields=&filter=&sort=
URI Parameters
- page
number(required)The page number.
- pageSize
number(required)The number of items per page.
- selectedFields
string(required)The selected fields.
- filter
string(required)The filter.
- sort
string(required)The sort order.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 285281,
"Order_Number": 324550,
"Date_Created": "01/03/2022",
"Scheduled_Date": "08/24/2022",
"Manifest_No": "22222",
"TSDF": "Company ABC",
"TSDF_Work": "3309561",
"Status": "Invoiced",
"Generator_Id": 39931,
"Generator": "Company ABC",
"Network_Order_No": "324550-01",
"Logistics_Type": "Generator Pickup",
"Network_In-Slot": "12/01/2022 2:30 PM",
"Network_Freight": "08/24/2022",
"Network_Status": "Submitted"
}
],
"totalElements": 255
}notification_profiles ¶
notification_profilesGET/api/communication/notification/profiles/
Overview:
The notification_profiles endpoint, accessible at /api/communication/notification/profiles/, is a GET request that is used to retrieve a list of notifications in all profiles.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of notification profiles. |
| id | number | The ID of the notification profile. |
| Notification_Id | number | The notification ID. |
| Profile_Id | number | The profile ID. |
| Profile_Name | string | The name of the profile. |
| Profile_Number | number | The profile number. |
| Type | number | The type of the profile. |
| Generator_Id | number | The ID of the generator. |
| Generator_Name | string | The name of the generator. |
| Bill_To | string | The bill-to name. |
| Notification_Date | string | The date the notification was created. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/communication/notification/profiles/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 140854,
"Notification_Id": 140854,
"Profile_Id": 268627,
"Profile_Name": "Blast Media Dust Test 1",
"Profile_Number": 170125,
"Type": 1,
"Generator_Id": 40629,
"Generator_Name": "Company ABC",
"Bill_To": "",
"Notification_Date": "08/16/2024 01:51 PM"
}
],
"totalElements": 1775
}notification_profiles_acknowledge ¶
notification_profiles_acknowledgePOST/api/communication/notification/profiles/acknowledge/
Overview:
The notification_profiles_acknowledge endpoint, accessible at /api/communication/notification/profiles/acknowledge/, is a POST request that is used to acknowledge a notification profile.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| id | number | The ID of the notification profile. |
| success | boolean | Indicates whether the operation was successful. |
Example URI
POST [Communication APIs](https://test-api.wastelinq.com)./api/communication/notification/profiles/acknowledge/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"id": 140854
}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"id": 140854
}communication_contacts ¶
communication_contactsGET/api/communication/contacts/{?page,pageSize,selectedFields,filter,sort}
Overview:
The communication_contacts endpoint, accessible at /api/communication/contacts/, is a GET request that is used to retrieve a list of contacts.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of contacts. |
| id | number | The ID of the contact. |
| First_Name | string | The first name of the contact. |
| Last_Name | string | The last name of the contact. |
| Title | string | The title of the contact. |
| Phone | string | The phone number of the contact. |
| string | The email address of the contact. | |
| Role | string | The role of the contact. |
| Role_Status | string | The status of the role. |
| Generator | string | The name of the generator. |
| Generator_Id | number | The ID of the generator. |
| Broker_Id | number | The ID of the broker. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/communication/contacts/?page=&pageSize=&selectedFields=&filter=&sort=
URI Parameters
- page
number(required)The page number.
- pageSize
number(required)The number of items per page.
- selectedFields
string(required)The selected fields.
- filter
string(required)The filter.
- sort
string(required)The sort.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": "619",
"First_Name": "Jane",
"Last_Name": "Doe",
"Title": null,
"Phone": null,
"Email": "janedoe@test.com",
"Role": "Contact",
"Role_Status": "Created",
"Generator": "Company ABC",
"Generator_Id": "65926",
"Broker_Id": 31
}
],
"totalElements": 16
}communication_shipment_requests ¶
communication_shipment_requestsGET/api/communication/shipment_requests/
Overview:
The communication_shipment_requests endpoint, accessible at /api/communication/shipment_requests/, is a GET request that is used to retrieve a list of shipment requests.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of shipment requests. |
| id | number | The ID of the shipment request. |
| Generator | string | The name of the generator. |
| ponumber | string | The PO number. |
| Generator_Id | number | The ID of the generator. |
| Shipment_Request_No | string | The shipment request number. |
| Inventory_No | string | The inventory number. |
| Order_Id | number | The order ID. |
| Order_Number | number | The order number. |
| Requested_Date | string | The requested date. |
| Type | string | The type of the shipment. |
| Count | string | The count. |
| Total_Weight | string | The total weight. |
| Status | string | The status of the shipment. |
| pickuptime | string | The pickup time. |
| comment_items | array | An array of comments. |
| attachment_items | array | An array of attachments. |
| listprofiles | array | An array of list profiles. |
| profilename | string | The profile name. |
| containertype | string | The container type. |
| containersize | string | The container size. |
| numofcontainers | string | The number of containers. |
| totalweight | string | The total weight. |
| shipmentunit | string | The shipment unit. |
| trackings | array | An array of trackings. |
| TrackingDate | string | The tracking date. |
| TrackingActivity | string | The tracking activity. |
| TrackingUser | string | The tracking user. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/communication/shipment_requests/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 51,
"Generator": "Company ABC",
"ponumber": "009731",
"Generator_Id": "41301",
"Shipment_Request_No": "10004",
"Inventory_No": "7-364-10004, 7-241-10010, 7-241-10011, 7-241-10012, 7-241-10013, 7-241-10014, 7-241-10015, 7-241-10016, 7-241-10017, 7-241-10018, 7-241-10019, 7-241-10020, 7-241-10021, 7-241-10022, 7-241-10023, 7-241-10024, 7-241-10025, 7-241-10026, 7-241-10027, 7-241-10028, 7-241-10029, 7-241-10030, 7-241-10031, 7-241-10032, 7-241-10033, 7-241-10034, 7-241-10035, 7-241-10036, 7-241-10037, 7-241-10038, 7-241-10039, 7-241-10040, 7-241-10041, 7-241-10042, 7-241-10043, 7-241-10044, 7-241-10045, 7-241-10046, 7-241-10047, 7-241-10048, 7-241-10049, 7-241-10050, 7-209-10005, 7-209-10006, 7-241-10051, 7-241-10052, 7-241-10053, 7-241-10054, 7-241-10055, 7-241-10056, 7-241-10057, 7-241-10058, 7-241-10059, 7-241-10060, 7-241-10061, 7-241-10062, 7-241-10063, 7-241-10064, 7-241-10065, 7-241-10066, 7-241-10067, 7-241-10068, 7-241-10069, 7-241-10070, 7-241-10071, 7-241-10072, 7-241-10073, 7-241-10074, 7-241-10075, 7-241-10076, 7-241-10077, 7-241-10078, 7-241-10079, 7-241-10080, 7-241-10081, 7-241-10082, 7-241-10083, 7-241-10084, 7-603-10086, 7-216-10007, 7-216-10008, 7-216-10009, 7-213-10085",
"Order_Id": 457118,
"Order_Number": 496387,
"Requested_Date": "05-15-2023",
"Type": "Packaged",
"Count": "83",
"Total_Weight": "41699.33",
"Status": "Invoiced",
"pickuptime": "10:00 AM",
"comment_items": [],
"attachment_items": [],
"listprofiles": [
{
"profilename": "Boric Acid - Solid",
"containertype": "DM",
"containersize": "55",
"numofcontainers": "1",
"totalweight": "502.7",
"shipmentunit": "P"
}
],
"trackings": [
{
"TrackingDate": "05-15-2023 15:23 PM",
"TrackingActivity": "Created order By",
"TrackingUser": "Jane Doe"
}
]
}
],
"totalElements": 35
}communication_shipment_requests_details ¶
communication_shipment_requests_detailsGET/api/communication/shipment_request/details/
Overview:
The communication_shipment_requests_details endpoint, accessible at /api/communication/shipment_request/details/, is a GET request that is used to retrieve the details of a shipment request.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | string | The content of the shipment request. |
| shipment_no | string | The shipment number. |
| shipment_items | array | An array of shipment items. |
| profilename | string | The profile name. |
| containertype | string | The container type. |
| containersize | string | The container size. |
| numofcontainers | string | The number of containers. |
| totalweight | string | The total weight. |
| shipmentunit | string | The shipment unit. |
| shipment_product_items | array | An array of shipment product items. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/communication/shipment_request/details/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": "{\"shipment_no\": \"10006\", \"shipment_items\": [{\"profilename\": \"Chemtherm 550\", \"containertype\": \"DM\", \"containersize\": \"55\", \"numofcontainers\": \"1\", \"totalweight\": \"502.70\", \"shipmentunit\": \"P\"}, {\"profilename\": \"Biobor Slop\", \"containertype\": \"DM\", \"containersize\": \"55\", \"numofcontainers\": \"1\", \"totalweight\": \"502.70\", \"shipmentunit\": \"P\"}, {\"profilename\": \"Etox HA & Etox Slops\", \"containertype\": \"TP\", \"containersize\": \"275\", \"numofcontainers\": \"1\", \"totalweight\": \"2377.22\", \"shipmentunit\": \"P\"}], \"shipment_product_items\": []}",
"totalElements": 3
}shipment_request_create_order ¶
shipment_request_create_orderPOST/api/communication/shipment_request/create_order/
Overview:
The shipment_request_create_order endpoint, accessible at /api/communication/shipment_request/create_order/, is a GET request that is used to create an order for a shipment request.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| shipmentid | number | The shipment ID. |
| success | boolean | Indicates whether the operation was successful. |
| content | string | The content of the shipment request. |
| generatorid | string | The generator ID. |
| orderid | number | The order ID. |
| ordernum | number | The order number. |
| totalElements | number | The total number of elements. |
Example URI
POST [Communication APIs](https://test-api.wastelinq.com)./api/communication/shipment_request/create_order/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"shipmentid": 42
}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"generatorid": "01-04-2023",
"orderid": 577871,
"ordernum": 617140
},
"totalElements": 1
}load_order_for_link ¶
load_order_for_linkGET/api/communication/shipment_request/load_order_for_link/
Overview:
The load_order_for_link endpoint, accessible at /api/communication/shipment_request/load_order_for_link/, is a GET request that is used to load an order for a link.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of orders. |
| orderId | number | The order ID. |
| orderNo | number | The order number. |
| manifestNo | string | The manifest number. |
| generator | string | The generator. |
| orderStatus | string | The order status. |
| purchaseOrder | string | The purchase order. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/communication/shipment_request/load_order_for_link/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"orderId": 557949,
"orderNo": 597218,
"manifestNo": "22222",
"generator": "Company ABC",
"orderStatus": "Order Scheduled",
"purchaseOrder": "1278537"
}
],
"totalElements": 224
}add_order_to_shipment ¶
add_order_to_shipmentPOST/api/communication/shipment_request/add_order_to_shipment/
Overview:
The add_order_to_shipment endpoint, accessible at /api/communication/shipment_request/add_order_to_shipment/, is a POST request that is used to add an order to a shipment.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| shipmentid | number | The shipment ID. |
| orderid | number | The order ID. |
| success | boolean | Indicates whether the operation was successful. |
| content | string | The content of the shipment request. |
| generatorid | number | The generator ID. |
| orderid | number | The order ID. |
| ordernum | number | The order number. |
| totalElements | number | The total number of elements. |
Example URI
POST [Communication APIs](https://test-api.wastelinq.com)./api/communication/shipment_request/add_order_to_shipment/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"shipmentid": 39,
"orderid": 557949
}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"generatorid": 40028,
"orderid": 557949,
"ordernum": 597218
},
"totalElements": 1
}communication_shipment_request_trackings ¶
communication_shipment_request_trackingsPOST/api/communication/shipment_request/trackings/
Overview:
The communication_shipment_request_trackings endpoint, accessible at /api/communication/shipment_request/trackings/, is a POST request that is used to retrieve the tracking details of a shipment request.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| shipmentid | number | The shipment ID. |
| success | boolean | Indicates whether the operation was successful. |
| content | string | The content of the shipment request. |
| TrackingDate | string | The tracking date. |
| TrackingActivity | string | The tracking activity. |
| TrackingUser | string | The tracking user. |
| totalElements | number | The total number of elements. |
Example URI
POST [Communication APIs](https://test-api.wastelinq.com)./api/communication/shipment_request/trackings/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"shipmentid": 51
}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": "[{\"TrackingDate\": \"05-10-2023 17:06 PM\", \"TrackingActivity\": \"Created By\", \"TrackingUser\": \"Jane Doe\"}, {\"TrackingDate\": \"05-10-2023 17:07 PM\", \"TrackingActivity\": \"Submitted By\", \"TrackingUser\": \"Jane Doe\"}, {\"TrackingDate\": \"05-15-2023 15:23 PM\", \"TrackingActivity\": \"Created order By\", \"TrackingUser\": \"Jane Doe\"}]",
"totalElements": 1
}communication_shipment_request_comments ¶
communication_shipment_request_commentsPOST/api/communication/shipment_request/comments/
Overview:
The communication_shipment_request_comments endpoint, accessible at /api/communication/shipment_request/comments/, is a POST request that is used to retrieve the comments of a shipment request.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| shipmentid | number | The shipment ID. |
| success | boolean | Indicates whether the operation was successful. |
| content | string | The content of the shipment request. |
| totalElements | number | The total number of elements. |
Example URI
POST [Communication APIs](https://test-api.wastelinq.com)./api/communication/shipment_request/comments/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"shipmentid": 51
}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": "[]",
"totalElements": 2
}communication_shipment_request_attachments ¶
communication_shipment_request_attachmentsPOST/api/communication/shipment_request/attachments/
Overview:
The communication_shipment_request_attachments endpoint, accessible at /api/communication/shipment_request/attachments/, is a POST request that is used to retrieve the attachments of a shipment request.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| shipmentid | number | The shipment ID. |
| success | boolean | Indicates whether the operation was successful. |
| content | string | The content of the shipment request. |
| totalElements | number | The total number of elements. |
Example URI
POST [Communication APIs](https://test-api.wastelinq.com)./api/communication/shipment_request/attachments/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"shipmentid": 51
}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": "[]",
"totalElements": 2
}communication_shipment_request_reject ¶
communication_shipment_request_rejectPOST/api/communication/shipment_request/reject/
Overview:
The communication_shipment_request_reject endpoint, accessible at /api/communication/shipment_request/reject/, is a POST request that is used to reject a shipment request.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| shipmentid | number | The shipment ID. |
| success | boolean | Indicates whether the operation was successful. |
Example URI
POST [Communication APIs](https://test-api.wastelinq.com)./api/communication/shipment_request/reject/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"shipmentid": 51
}Response
200Headers
Content-Type: application/jsonBody
{
"success": true
}generators_communication ¶
generators_communicationPOST/api/generators/{generator_id}/communication
Overview:
The generators_communication endpoint, accessible at /api/generators/{generator_id}/communication, is a POST request that is used to update the communication details of a generator.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| Contact_Frequency | string | The contact frequency. |
| Last_Time_Contacted | string | The last time the contact was made. |
| HistoryLogs | array | An array of history logs. |
| Action | string | The action. |
| Status | string | The status. |
| Action_Date | string | The action date. |
| Type_Name | string | The type name. |
| Type | string | The type. |
| Assigned_To_Name | string | The name of the assignee. |
| Assigned_To | string | The ID of the assignee. |
| Created_By_Name | string | The name of the creator. |
| Created_By | string | The ID of the creator. |
| Entry_Date | string | The entry date. |
| id | number | The ID of the history log. |
| message | string | The message. |
Example URI
POST [Communication APIs](https://test-api.wastelinq.com)./api/generators/generator_id/communication
URI Parameters
- generator_id
number(required)The ID of the generator.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"Contact_Frequency": "",
"Last_Time_Contacted": "",
"HistoryLogs": [
{
"Action": "",
"Status": "Incomplete",
"Action_Date": "08/20/2024",
"Type_Name": "Action Item - General",
"Type": "163",
"Assigned_To_Name": "Jane Doe",
"Assigned_To": "689",
"Created_By_Name": "Jane Doe",
"Created_By": "857",
"Entry_Date": "08/20/2024",
"id": -1
}
]
}Response
200Headers
Content-Type: application/jsonBody
{
"message": "success"
}generators_communication ¶
generators_communicationGET/api/generators/{generator_id}/communication
Overview:
The generators_communication endpoint, accessible at /api/generators/{generator_id}/communication, is a GET request that is used to retrieve the communication details of a generator.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| Contact_Frequency | string | The contact frequency. |
| Last_Time_Contacted | string | The last time the contact was made. |
| HistoryLogs | array | An array of history logs. |
| id | number | The ID of the history log. |
| Created_By_Name | string | The name of the creator. |
| Assigned_To_Name | string | The name of the assignee. |
| Type_Name | string | The type name. |
| Entry_Date | string | The entry date. |
| Action_Date | string | The action date. |
| Status | string | The status. |
| Action | string | The action. |
| Communication | number | The communication ID. |
| Created_By | number | The ID of the creator. |
| Assigned_To | number | The ID of the assignee. |
| Type | number | The type. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/generators/generator_id/communication
URI Parameters
- generator_id
number(required)The ID of the generator.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"Contact_Frequency": "",
"Last_Time_Contacted": "2024-08-19",
"HistoryLogs": [
{
"id": 163,
"Created_By_Name": "Jane Doe",
"Assigned_To_Name": "Jane Doe",
"Type_Name": "Action Item - General",
"Entry_Date": "2024-08-20",
"Action_Date": "2024-08-20",
"Status": "Incomplete",
"Action": "",
"Communication": 10229,
"Created_By": 857,
"Assigned_To": 689,
"Type": 163
}
]
}messages_summary ¶
messages_summaryGET/api/generator/profile/messages_summary/{generator_id}/
Overview:
The messages_summary endpoint, accessible at /api/generator/profile/messages_summary/{generator_id}/, is a GET request that is used to retrieve a summary of messages for a generator.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of messages. |
| messages | array | An array of messages. |
| id | number | The ID of the message. |
| is_private | boolean | Indicates whether the message is private. |
| has_reply | boolean | Indicates whether the message has a reply. |
| Date_Time | string | The date and time the message was sent. |
| Sender | string | The name of the sender. |
| Message | string | The message. |
| Due_Date | string | The due date. |
| current_user_is_network | boolean | Indicates whether the current user is in the network. |
| users | array | An array of users. |
| id | number | The ID of the user. |
| first_name | string | The first name of the user. |
| last_name | string | The last name of the user. |
| username | string | The username of the user. |
| is_network | boolean | Indicates whether the user is in the network. |
| files_list | array | An array of files. |
| all_links | array | An array of links. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/generator/profile/messages_summary/generator_id/
URI Parameters
- generator_id
number(required)The ID of the generator.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"messages": [
{
"id": 125013,
"is_private": true,
"has_reply": false,
"Date_Time": "08/12/2024 02:01 PM",
"Sender": "Jane Doe",
"Message": "@Jane Doe test",
"Due_Date": null
},
{
"id": 125012,
"is_private": true,
"has_reply": false,
"Date_Time": "08/12/2024 01:33 PM",
"Sender": "Jane Doe",
"Message": "@Jane Doe test",
"Due_Date": null
},
{
"id": 125011,
"is_private": true,
"has_reply": false,
"Date_Time": "08/12/2024 11:32 AM",
"Sender": "Jane Doe",
"Message": "@Jane Doe hi",
"Due_Date": null
}
],
"current_user_is_network": false,
"users": [
{
"id": 1928,
"first_name": "Jane",
"last_name": "Doe",
"username": "janedoe@gmail.com",
"is_network": false
}
],
"files_list": [],
"all_links": []
},
"totalElements": 3
}comment_summary ¶
comment_summaryGET/api/generator/profile/comment_summary/{generator_id}/
Overview:
The comment_summary endpoint, accessible at /api/generator/profile/comment_summary/{generator_id}/, is a GET request that is used to retrieve a summary of comments for a generator.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of comments. |
| comments | array | An array of comments. |
| id | number | The ID of the comment. |
| Date_Time | string | The date and time the comment was made. |
| Author | string | The name of the author. |
| editable | boolean | Indicates whether the comment is editable. |
| Message | string | The message. |
| current_user_is_network | boolean | Indicates whether the current user is in the network. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/generator/profile/comment_summary/generator_id/
URI Parameters
- generator_id
number(required)The ID of the generator.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"comments": [
{
"id": 40373,
"Date_Time": "08/20/2024 09:37 PM",
"Author": "Jane Doe",
"editable": true,
"Message": "test"
}
],
"current_user_is_network": false
},
"totalElements": 1
}get_all_attachments_summary ¶
get_all_attachments_summaryGET/api/generator/profile/get_all_attachments_summary/{generator_id}/
Overview:
The get_all_attachments_summary endpoint, accessible at /api/generator/profile/get_all_attachments_summary/{generator_id}/, is a GET request that is used to retrieve a summary of attachments for a generator.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of attachments. |
| files_list | array | An array of files. |
| id | number | The ID of the file. |
| Document_Name | string | The name of the document. |
| get_urldownload | string | The download URL. |
| Size | number | The size of the file. |
| Last_Modified | string | The last modified date. |
| Modified_By | string | The name of the user who modified the file. |
| Module | string | The module. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/generator/profile/get_all_attachments_summary/generator_id/
URI Parameters
- generator_id
number(required)The ID of the generator.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"files_list": [
{
"id": 8908,
"Document_Name": "test.pdf",
"get_urldownload": "api/documents/s3file_message/8908",
"Size": 185,
"Last_Modified": "08/12/2024 11:32 AM",
"Modified_By": "Jane Doe",
"Module": "Profile"
}
]
},
"totalElements": 1
}add_profile_message ¶
add_profile_messagePOST/api/generator/add/profile/message/
Overview:
The add_profile_message endpoint, accessible at /api/generator/add/profile/message/, is a POST request that is used to add a message to a generator profile.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| profile_id | number | The profile ID. |
| message | string | The message. |
| is_private | boolean | Indicates whether the message is private. |
| reply_for | string | The reply for. |
| due_date | string | The due date. |
| mentioned_users | string | The mentioned users. |
| success | boolean | Indicates whether the operation was successful. |
| data | string | The data. |
| message_id | number | The message ID. |
Example URI
POST [Communication APIs](https://test-api.wastelinq.com)./api/generator/add/profile/message/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"profile_id": 311280,
"message": "Jane Doe test",
"is_private": true,
"reply_for": "",
"due_date": "08/21/2024",
"mentioned_users": "486|"
}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"data": {
"message_id": 125017
}
}update_upload_file_for_profile_message ¶
update_upload_file_for_profile_messagePOST/api/generator/profile/update_upload_file_for_profile_message/{message_id}/{attached_file_id}/
Overview:
The update_upload_file_for_profile_message endpoint, accessible at /api/generator/profile/update_upload_file_for_profile_message/{message_id}/{attached_file_id}/, is a POST request that is used to update the uploaded file for a profile message.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of files. |
| files_list | array | An array of files. |
| id | number | The ID of the file. |
| file_name | string | The name of the file. |
| get_urldownload | string | The download URL. |
| all_links | array | An array of links. |
| totalElements | number | The total number of elements. |
Example URI
POST [Communication APIs](https://test-api.wastelinq.com)./api/generator/profile/update_upload_file_for_profile_message/message_id/attached_file_id/
URI Parameters
- message_id
number(required)The ID of the message.
- attached_file_id
number(required)The ID of the attached file.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"file": "dummy.txt"
}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"files_list": [
{
"id": 8910,
"file_name": "dummy.txt",
"get_urldownload": "api/documents/s3file_message/8910"
}
],
"all_links": [
"api/documents/s3file_message/8910"
]
},
"totalElements": 1
}profile_messages ¶
profile_messagesGET/api/generator/profile/messages/{message_id}/
Overview:
The profile_messages endpoint, accessible at /api/generator/profile/messages/{message_id}/, is a GET request that is used to retrieve the messages for a generator profile.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of messages. |
| messages | array | An array of messages. |
| id | number | The ID of the message. |
| is_private | boolean | Indicates whether the message is private. |
| has_reply | boolean | Indicates whether the message has a reply. |
| Date_Time | string | The date and time the message was sent. |
| Sender | string | The name of the sender. |
| Message | string | The message. |
| Due_Date | string | The due date. |
| source | string | The source of the message. |
| current_user_is_network | boolean | Indicates whether the current user is in the network. |
| profile_number | number | The profile number. |
| profile_id | number | The profile ID. |
| users | array | An array of users. |
| id | number | The ID of the user. |
| first_name | string | The first name of the user. |
| last_name | string | The last name of the user. |
| username | string | The username of the user. |
| is_network | boolean | Indicates whether the user is in the network. |
| files_list | array | An array of files. |
| all_links | array | An array of links. |
| is_network_profile | boolean | Indicates whether the profile is in the network. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/generator/profile/messages/message_id/
URI Parameters
- message_id
number(required)The ID of the message.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"messages": [
{
"id": 125017,
"is_private": true,
"has_reply": false,
"Date_Time": "08/20/2024 09:40 PM",
"Sender": "Jane Doe",
"Message": "Jane Doe test",
"Due_Date": "08-21-2024",
"source": "Enterprise"
}
],
"current_user_is_network": false,
"profile_number": 212742,
"profile_id": 311280,
"users": [
{
"id": 627,
"first_name": "Jane",
"last_name": "Doe",
"username": "janedoe_network",
"is_network": true
}
],
"files_list": [],
"all_links": [],
"is_network_profile": false
},
"totalElements": 1
}get_profile_message ¶
get_profile_messageGET/api/generator/get/profile/message/{message_id}/
Overview:
The get_profile_message endpoint, accessible at /api/generator/get/profile/message/{message_id}/, is a GET request that is used to retrieve a message for a generator profile.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of messages. |
| messages | array | An array of messages. |
| id | number | The ID of the message. |
| Date_Time | string | The date and time the message was sent. |
| Sender | string | The name of the sender. |
| Message | string | The message. |
| is_private | boolean | Indicates whether the message is private. |
| Due_Date | string | The due date. |
| profile_number | number | The profile number. |
| profile_id | number | The profile ID. |
| generator_id | number | The ID of the generator. |
| users | array | An array of users. |
| id | number | The ID of the user. |
| first_name | string | The first name of the user. |
| last_name | string | The last name of the user. |
| username | string | The username of the user. |
| is_network | boolean | Indicates whether the user is in the network. |
| reply_list | array | An array of replies. |
| id | number | The ID of the reply. |
| is_private | boolean | Indicates whether the reply is private. |
| Date_Time | string | The date and time the reply was sent. |
| Sender | string | The name of the sender. |
| Message | string | The message. |
| Logo | string | The logo of the sender. |
| files_list | array | An array of files. |
| id | number | The ID of the file. |
| file_name | string | The name of the file. |
| get_urldownload | string | The download URL. |
| all_links | array | An array of links. |
| current_user_is_network | boolean | Indicates whether the current user is in the network. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/generator/get/profile/message/message_id/
URI Parameters
- message_id
number(required)The ID of the message.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"messages": [
{
"id": 125017,
"Date_Time": "08/20/2024 09:40 PM",
"Sender": "Jane Doe",
"Message": "Jane Doe test",
"is_private": true,
"Due_Date": "08/21/2024"
}
],
"profile_number": 212742,
"profile_id": 311280,
"generator_id": 41024,
"users": [
{
"id": 627,
"first_name": "Jane",
"last_name": "Doe",
"username": "janedoe_network",
"is_network": true
}
],
"reply_list": [
{
"id": 125017,
"is_private": true,
"Date_Time": "08/20/2024 09:40 PM",
"Sender": "Jane Doe",
"Message": "Jane Doe test",
"Logo": "logo.png"
}
],
"files_list": [
{
"id": 8909,
"file_name": "dummy.txt",
"get_urldownload": "api/documents/s3file_message/8909"
}
],
"all_links": [
"api/documents/s3file_message/8909"
],
"current_user_is_network": false
},
"totalElements": 1
}add_profile_comment ¶
add_profile_commentPOST/api/generator/add/profile/comment/
Overview:
The add_profile_comment endpoint, accessible at /api/generator/add/profile/comment/, is a POST request that is used to add a comment to a generator profile.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| created_date | string | The created date. |
| created_by | string | The created by. |
| comment | string | The comment. |
| is_private | string | Indicates whether the comment is private. |
| profile_id | string | The profile ID. |
| id | string | The ID of the comment. |
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of comments. |
| id | number | The ID of the comment. |
| Date_Time | string | The date and time the comment was made. |
| Author | string | The name of the author. |
| Message | string | The message. |
| totalElements | number | The total number of elements. |
Example URI
POST [Communication APIs](https://test-api.wastelinq.com)./api/generator/add/profile/comment/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"created_date": "",
"created_by": "",
"comment": "test",
"is_private": "true",
"profile_id": "311280",
"id": "0"
}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 40374,
"Date_Time": "08/20/2024 10:03 PM",
"Author": "Jane Doe",
"Message": "test"
}
],
"totalElements": 1
}profile_comments ¶
profile_commentsGET/api/generator/profile/comments/{comment_id}/
Overview:
The profile_comments endpoint, accessible at /api/generator/profile/comments/{comment_id}/, is a GET request that is used to retrieve the comments for a generator profile.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of comments. |
| comments | array | An array of comments. |
| id | number | The ID of the comment. |
| Date_Time | string | The date and time the comment was made. |
| Author | string | The name of the author. |
| editable | boolean | Indicates whether the comment is editable. |
| Message | string | The message. |
| current_user_is_network | boolean | Indicates whether the current user is in the network. |
| profile_number | number | The profile number. |
| profile_id | number | The profile ID. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/generator/profile/comments/comment_id/
URI Parameters
- comment_id
number(required)The ID of the comment.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"comments": [
{
"id": 40374,
"Date_Time": "08/20/2024 10:03 PM",
"Author": "Jane Doe",
"editable": true,
"Message": "test"
}
],
"current_user_is_network": false,
"profile_number": 212742,
"profile_id": 311280
},
"totalElements": 1
}get_profile_comment ¶
get_profile_commentGET/api/generator/get/profile/comment/{comment_id}/
Overview:
The get_profile_comment endpoint, accessible at /api/generator/get/profile/comment/{comment_id}/, is a GET request that is used to retrieve a comment for a generator profile.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of comments. |
| comments | array | An array of comments. |
| id | number | The ID of the comment. |
| Date_Time | string | The date and time the comment was made. |
| Author | string | The name of the author. |
| comment | string | The comment. |
| is_private | boolean | Indicates whether the comment is private. |
| profile_number | number | The profile number. |
| profile_id | number | The profile ID. |
| current_user_is_network | boolean | Indicates whether the current user is in the network. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/generator/get/profile/comment/comment_id/
URI Parameters
- comment_id
number(required)The ID of the comment.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"comments": [
{
"id": 40374,
"Date_Time": "08/20/2024 10:03 PM",
"Author": "Jane Doe",
"comment": "test",
"is_private": true
}
],
"profile_number": 212742,
"profile_id": 311280,
"current_user_is_network": false
},
"totalElements": 1
}get_all_attachments ¶
get_all_attachmentsGET/api/generator/profile/get_all_attachments/{message_id}/
Overview:
The get_all_attachments endpoint, accessible at /api/generator/profile/get_all_attachments/{message_id}/, is a GET request that is used to retrieve all attachments for a generator profile.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of attachments. |
| files_list | array | An array of files. |
| id | number | The ID of the file. |
| Document_Name | string | The name of the document. |
| get_urldownload | string | The download URL. |
| Size | number | The size of the file. |
| Last_Modified | string | The last modified date. |
| Modified_By | string | The name of the user who modified the file. |
| Module | string | The module. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/generator/profile/get_all_attachments/message_id/
URI Parameters
- message_id
number(required)The ID of the message.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"files_list": [
{
"id": 8909,
"Document_Name": "dummy.txt",
"get_urldownload": "api/documents/s3file_message/8909",
"Size": 0,
"Last_Modified": "08/20/2024 09:40 PM",
"Modified_By": "Jane Doe",
"Module": "Profile"
}
]
},
"totalElements": 1
}add_order_message ¶
add_order_messagePOST/api/generator/add/order/message/
Overview:
The add_order_message endpoint, accessible at /api/generator/add/order/message/, is a POST request that is used to add a message to an order.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| order_id | number | The order ID. |
| message | string | The message. |
| is_private | boolean | Indicates whether the message is private. |
| reply_for | string | The reply for. |
| due_date | string | The due date. |
| mentioned_users | string | The mentioned users. |
| tsdf_selected | string | The TSDF selected. |
| success | boolean | Indicates whether the operation was successful. |
| data | string | The data. |
| message_id | number | The message ID. |
Example URI
POST [Communication APIs](https://test-api.wastelinq.com)./api/generator/add/order/message/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"order_id": 577810,
"message": "Jane Doe test",
"is_private": true,
"reply_for": "",
"due_date": "08/21/2024",
"mentioned_users": "1928|",
"tsdf_selected": "1324558|12162|22222|Enterprise"
}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"data": {
"message_id": 37351
}
}update_upload_file_for_order_message ¶
update_upload_file_for_order_messagePOST/api/generator/order/update_upload_file_for_order_message/
Overview:
The update_upload_file_for_order_message endpoint, accessible at /api/generator/order/update_upload_file_for_order_message/{message_id}/{attached_file_id}/, is a POST request that is used to update the uploaded file for an order message.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | string | The content. |
| files_list | array | An array of files. |
| id | number | The ID of the file. |
| file_name | string | The name of the file. |
| get_urldownload | string | The download URL. |
| all_links | array | An array of links. |
| totalElements | number | The total number of elements. |
Example URI
POST [Communication APIs](https://test-api.wastelinq.com)./api/generator/order/update_upload_file_for_order_message/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"file": "dummy.txt"
}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"files_list": [
{
"id": 2713,
"file_name": "dummy.txt",
"get_urldownload": "api/documents/s3file_order_message/2713"
}
],
"all_links": [
"api/documents/s3file_order_message/2713"
]
},
"totalElements": 1
}order_messages ¶
order_messagesGET/api/generator/order/messages/{message_id}/
Overview:
The order_messages endpoint, accessible at /api/generator/order/messages/{message_id}/, is a GET request that is used to retrieve the messages for an order.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of messages. |
| messages | array | An array of messages. |
| id | number | The ID of the message. |
| is_private | boolean | Indicates whether the message is private. |
| has_reply | boolean | Indicates whether the message has a reply. |
| Date_Time | string | The date and time the message was sent. |
| Sender | string | The name of the sender. |
| Message | string | The message. |
| Due_Date | string | The due date. |
| tsdfs | array | An array of TSDFs. |
| id | string | The ID of the TSDF. |
| value | string | The value of the TSDF. |
| current_user_is_network | boolean | Indicates whether the current user is in the network. |
| order_number | number | The order number. |
| order_id | number | The order ID. |
| users | array | An array of users. |
| id | number | The ID of the user. |
| first_name | string | The first name of the user. |
| last_name | string | The last name of the user. |
| username | string | The username of the user. |
| is_network | boolean | Indicates whether the user is in the network. |
| files_list | array | An array of files. |
| all_links | array | An array of links. |
| is_network_order | string | Indicates whether the order is in the network. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/generator/order/messages/message_id/
URI Parameters
- message_id
number(required)The ID of the message.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"messages": [
{
"id": 37351,
"is_private": true,
"has_reply": false,
"Date_Time": "08/20/2024 10:21 PM",
"Sender": "Jane Doe",
"Message": "Jane Doe test",
"Due_Date": "08-21-2024"
}
],
"tsdfs": [
{
"id": "1324558|12162|22222|Enterprise",
"value": "22222 - Company ABC"
}
],
"current_user_is_network": false,
"order_number": 617079,
"order_id": 577810,
"users": [
{
"id": 627,
"first_name": "Jane",
"last_name": "Doe",
"username": "janedoe_network",
"is_network": true
}
],
"files_list": [],
"all_links": [],
"is_network_order": "Enterprise"
},
"totalElements": 1
}get_order_message ¶
get_order_messageGET/api/generator/get/order/message/{message_id}/
Overview:
The get_order_message endpoint, accessible at /api/generator/get/order/message/{message_id}/, is a GET request that is used to retrieve a message for an order.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of messages. |
| messages | array | An array of messages. |
| id | number | The ID of the message. |
| is_private | boolean | Indicates whether the message is private. |
| has_reply | boolean | Indicates whether the message has a reply. |
| Date_Time | string | The date and time the message was sent. |
| Sender | string | The name of the sender. |
| Message | string | The message. |
| Due_Date | string | The due date. |
| tsdfs | array | An array of TSDFs. |
| id | string | The ID of the TSDF. |
| value | string | The value of the TSDF. |
| current_user_is_network | boolean | Indicates whether the current user is in the network. |
| order_number | number | The order number. |
| order_id | number | The order ID. |
| users | array | An array of users. |
| id | number | The ID of the user. |
| first_name | string | The first name of the user. |
| last_name | string | The last name of the user. |
| username | string | The username of the user. |
| is_network | boolean | Indicates whether the user is in the network. |
| reply_list | array | An array of replies. |
| id | number | The ID of the reply. |
| is_private | boolean | Indicates whether the reply is private. |
| Date_Time | string | The date and time the reply was sent. |
| Sender | string | The name of the sender. |
| Message | string | The message. |
| Logo | string | The logo of the sender. |
| tsdf_selected_display | string | The display of the TSDF selected. |
| files_list | array | An array of files. |
| id | number | The ID of the file. |
| file_name | string | The name of the file. |
| get_urldownload | string | The download URL. |
| all_links | array | An array of links. |
| is_network_order | string | Indicates whether the order is in the network. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/generator/get/order/message/message_id/
URI Parameters
- message_id
number(required)The ID of the message.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"messages": [
{
"id": 37352,
"Date_Time": "08/21/2024 01:31 AM",
"Sender": "Jane Doe",
"tsdf_selected": "1324614|9785|22222|Enterprise",
"Message": "Jane Doe test",
"tsdf_selected_display": "22222 - Company ABC",
"is_private": true,
"Due_Date": "08/21/2024"
}
],
"tsdfs": [
{
"id": "1324614|9785|22222|Enterprise",
"value": "22222 - Company ABC"
}
],
"order_number": 617138,
"generator_id": 85249,
"order_id": 577869,
"users": [
{
"id": 627,
"first_name": "Jane",
"last_name": "Doe",
"username": "janedoe_network",
"is_network": true
}
],
"reply_list": [
{
"id": 37352,
"is_private": true,
"Date_Time": "08-21-2024 01:31 AM",
"Sender": "Jane Doe",
"Message": "Jane Doe test",
"Logo": "logo.png",
"tsdf_selected_display": "22222 - Company ABC"
}
],
"files_list": [
{
"id": 2714,
"file_name": "dummy.txt",
"get_urldownload": "api/documents/s3file_order_message/2714"
},
{
"id": 2713,
"file_name": "dummy.txt",
"get_urldownload": "api/documents/s3file_order_message/2713"
}
],
"all_links": [
"api/documents/s3file_order_message/2714",
"api/documents/s3file_order_message/2713"
],
"current_user_is_network": false
},
"totalElements": 1
}add_order_comment ¶
add_order_commentPOST/api/generator/add/order/comment/
Overview:
The add_order_comment endpoint, accessible at /api/generator/add/order/comment/, is a POST request that is used to add a comment to an order.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| related_esc_order_comment | string | The related ESC order comment. |
| belong_network_order_comment | string | The belong network order comment. |
| created_date | string | The created date. |
| created_by | string | The created by. |
| comment | string | The comment. |
| is_private | string | Indicates whether the comment is private. |
| tsdf_selected | string | The TSDF selected. |
| order_id | string | The order ID. |
| id | string | The ID of the comment. |
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of comments. |
| id | number | The ID of the comment. |
| Date_Time | string | The date and time the comment was made. |
| Author | string | The name of the author. |
| Message | string | The message. |
| totalElements | number | The total number of elements. |
Example URI
POST [Communication APIs](https://test-api.wastelinq.com)./api/generator/add/order/comment/
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"related_esc_order_comment": "",
"belong_network_order_comment": "",
"created_date": "",
"created_by": "",
"comment": "test",
"is_private": "true",
"tsdf_selected": "1324614|9785|22222|Enterprise",
"order_id": "577869",
"id": "0"
}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 1633,
"Date_Time": "08/21/2024 01:39 AM",
"Author": "Jane Doe",
"Message": "test"
}
],
"totalElements": 1
}order_comments ¶
order_commentsGET/api/generator/order/comments/{comment_id}/
Overview:
The order_comments endpoint, accessible at /api/generator/order/comments/{comment_id}/, is a GET request that is used to retrieve the comments for an order.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of comments. |
| comments | array | An array of comments. |
| id | number | The ID of the comment. |
| Date_Time | string | The date and time the comment was made. |
| Author | string | The name of the author. |
| editable | boolean | Indicates whether the comment is editable. |
| Message | string | The message. |
| tsdfs | array | An array of TSDFs. |
| id | string | The ID of the TSDF. |
| value | string | The value of the TSDF. |
| current_user_is_network | boolean | Indicates whether the current user is in the network. |
| order_number | number | The order number. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/generator/order/comments/comment_id/
URI Parameters
- comment_id
number(required)The ID of the comment.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"comments": [
{
"id": 1633,
"Date_Time": "08/21/2024 01:39 AM",
"Author": "Jane Doe",
"editable": true,
"Message": "test"
}
],
"tsdfs": [
{
"id": "1324614|9785|22222|Enterprise",
"value": "22222 - Company ABC"
}
],
"current_user_is_network": false,
"order_number": 617138
},
"totalElements": 1
}get_order_comment ¶
get_order_commentGET/api/generator/get/order/comment/{comment_id}/
Overview:
The get_order_comment endpoint, accessible at /api/generator/get/order/comment/{comment_id}/, is a GET request that is used to retrieve a comment for an order.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of comments. |
| comments | array | An array of comments. |
| id | number | The ID of the comment. |
| Date_Time | string | The date and time the comment was made. |
| Author | string | The name of the author. |
| tsdf_selected | string | The TSDF selected. |
| comment | string | The comment. |
| is_private | boolean | Indicates whether the comment is private. |
| tsdf_selected_display | string | The display of the TSDF selected. |
| tsdfs | array | An array of TSDFs. |
| id | string | The ID of the TSDF. |
| value | string | The value of the TSDF. |
| order_number | number | The order number. |
| current_user_is_network | boolean | Indicates whether the current user is in the network. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/generator/get/order/comment/comment_id/
URI Parameters
- comment_id
number(required)The ID of the comment.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"comments": [
{
"id": 1633,
"Date_Time": "08/21/2024 01:39 AM",
"Author": "Jane Doe",
"tsdf_selected": "1324614|9785|22222|Enterprise",
"comment": "test",
"is_private": true,
"tsdf_selected_display": "22222 - Company ABC"
}
],
"tsdfs": [
{
"id": "1324614|9785|22222|Enterprise",
"value": "22222 - Company ABC"
}
],
"order_number": 617138,
"current_user_is_network": false
},
"totalElements": 1
}get_all_attachments ¶
get_all_attachmentsGET/api/generator/order/get_all_attachments/{generator_id}/
Overview:
The get_all_attachments endpoint, accessible at /api/generator/order/get_all_attachments/{generator_id}/, is a GET request that is used to retrieve all attachments for an order.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | array | An array of attachments. |
| files_list | array | An array of files. |
| id | number | The ID of the file. |
| Document_Name | string | The name of the document. |
| get_urldownload | string | The download URL. |
| Size | number | The size of the file. |
| Last_Modified | string | The last modified date. |
| Modified_By | string | The name of the user who modified the file. |
| Module | string | The module. |
| totalElements | number | The total number of elements. |
Example URI
GET [Communication APIs](https://test-api.wastelinq.com)./api/generator/order/get_all_attachments/generator_id/
URI Parameters
- generator_id
number(required)The ID of the generator.
Request
Headers
Content-Type: application/json
Authorization: {TOKEN}Response
200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"files_list": [
{
"id": 2713,
"Document_Name": "dummy.txt",
"get_urldownload": "api/documents/s3file_order_message/2713",
"Size": 0,
"Last_Modified": "08/21/2024 01:28 AM",
"Modified_By": "Jane Doe",
"Module": "Order"
}
]
},
"totalElements": 1
}