Get Hauler

GET /haulers/{hauler_uuid}

Get hauler.

Roles

Users with the following roles may access this endoint:

Admin
Dispatcher
ThirdPartyDispatcher

Breaking Changes

No breaking changes.

Request

Sample Request

GET /haulers/{hauler_uuid}/
Authorization: Bearer {your-auth-token}
Content-Type: application/json

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: 66
Content-Type: application/json
Date: Sat, 20 Aug 2022 01:42:36 GMT
Server: WSGIServer/0.2 CPython/3.9.5
X-API-VERSION: 2019/02/08
X-REQUEST-ID: 53f3c13a-e9b8-492b-abf9-0ca3f386541e

{
"id": "571821f4-0079-4e0d-bd84-1dbe45fcd678",
"name": "Hauler 1"
}

Path Parameters

hauler_uuid String, Required

Third party hauler identifier.

• Valid UUID.

Query Parameters

note

No query parameters.

Request Headers

Refer to ListHaulersRequestHeadersModel 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, Optional

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 ThirdPartyHaulerModel for more details.

id String

Third party hauler identifier.

• Valid UUID.

---

name String

Name (free text).

• At least 1 and no more than 64 characters.

Code Samples

cURL

curl --request GET --include \
--header "Authorization: Bearer {your-auth-token}" \
--header "Content-Type: application/json" \
127.0.0.1:8003/haulers/{hauler_uuid}

Python

import requests, json

response = requests.get(
  'http://localhost:8003/haulers/{hauler_uuid}',
  headers={
    'Authorization': 'Bearer {your-auth-token}',
    'Content-Type': 'application/json'
  },
  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 = "/haulers/{hauler_uuid}";

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

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