Get Dump Destination

GET /locations/{location_id}/dump_destinations/{dump_destination_id}

Get dump destination at a given location.

Roles

Users with the following roles may access this endoint:

Admin
ClientCustomer
CrmUser
Dispatcher
Driver
ThirdPartyDispatcher
ThirdPartyDriver

Breaking Changes

No breaking changes.

Request

Sample Request

GET /locations/{location_id}/dump_destinations/{dump_destination_id}/
Authorization: Bearer {your-auth-token}
Content-Type: application/json
x-tenant-id: {your-tenant-id}

Sample Response

Access-Control-Allow-Headers: Authorization, Accept, X-TENANT-ID, Content-Type
Access-Control-Allow-Methods: GET
Access-Control-Allow-Origin: *
Allow: GET
Content-Length: 105
Content-Type: application/json
Date: Sat, 20 Aug 2022 01:39:40 GMT
Server: WSGIServer/0.2 CPython/3.9.5
X-API-VERSION: 2019/02/08
X-REQUEST-ID: bde81787-d4f5-4991-a510-fd51f8348c58

{
"address": {},
"description": "Port Townsend Dump",
"id": 1,
"is_holding_yard": false,
"location_id": 1
}

Path Parameters

dump_destination_id Integer, Required

Dump destination identifier.

---

location_id Integer, Required

Location identifier.

Query Parameters

note

No query parameters.

Request Headers

Refer to StandardRequestHeadersModel for more details.

authorization String, Required

Authorization header (bearer with access token). See the Authentication Guide to get started.

• Matches ^bearer [a-z0-9-_=]+.[a-z0-9-_=]+.?[a-z0-9-_.+/=]*$
• No longer than 256 characters.
• At least 1 characters long.

---

x-api-version String, Optional

Request identifier.

• At least 1 and no more than 64 characters.
• Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

---

x-tenant-id Integer, Required

Tenant identifier. Contact CRO Software for more info if you don't already have this id. See list tenant ids for info on listing the tenants you have access to.

Request Body

note

No request body

Response

Response Headers

Refer to StandardResponseHeadersModel for more details.

x-api-version String

Request identifier.

• At least 1 and no more than 64 characters.
• Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

---

x-request-id String

Request identifier.

• Valid UUID.

Response Body

Refer to DumpDestinationModel for more details.

address Object

DumpDestinationAddressModel

---

contact Object

DumpDestinationContactModel

---

description String

Dump destination description.

• At least 0 and no more than 100 characters.

---

id Integer

Dump destination record identifier.

---

is_holding_yard Boolean

Location is holding yard.

• One of 0, 1, True, False (case insensitive).

---

location_id Integer

Location identifier.

Code Samples

cURL

curl --request GET --include \
--header "Authorization: Bearer {your-auth-token}" \
--header "Content-Type: application/json" \
--header "x-tenant-id: {your-tenant-id}" \
127.0.0.1:8003/locations/{location_id}/dump_destinations/{dump_destination_id}

Python

import requests, json

response = requests.get(
  'http://localhost:8003/locations/{location_id}/dump_destinations/{dump_destination_id}',
  headers={
    'Authorization': 'Bearer {your-auth-token}',
    'Content-Type': 'application/json',
    'x-tenant-id': '{your-tenant-id}'
  },
  parameters={
  }
)
results = json.loads(response.text)
print(results)

CSharp 2.0

using System;
using System.Net;
using System.Collections.Specialized;

namespace CROSoftware
{
public class DemoClient
{
    static public void Main ()
    {
        WebClient client = new WebClient();

        // URL    
        String url = "/locations/{location_id}/dump_destinations/{dump_destination_id}";

        // Headers
        client.Headers.Add("Authorization", "Bearer {your-auth-token}");
        client.Headers.Add("Content-Type", "application/json");
        client.Headers.Add("x-tenant-id", "{your-tenant-id}");

        string json = client.DownloadString(url);
        Console.WriteLine(json);
    }
}
}