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
CrmUser
Dispatcher
Driver
ThirdPartyAdmin
ThirdPartyCrmUser
ThirdPartyDispatcher
ThirdPartyDriver

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}

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-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.

Accept String

Mime type (e.g. application/json).

  • At least 1 and no more than 256 characters.

x-request-id String

Request identifier.

  • Valid UUID.

Response Body

Refer to DumpDestinationModel for more details.

address Object

DumpDestinationAddressModel

Job dump destination address profile.


contact Object

DumpDestinationContactModel

Job dump destination contact profile.


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 --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}