Create Connection

POST /haulers/{hauler_uuid}/connections

Create a new hauler connection.

Roles

Users with the following roles may access this endoint:

Admin
Dispatcher
Driver
ThirdPartyDispatcher
ThirdPartyDriver

Breaking Changes

No breaking changes.

Request

Sample Request

POST /haulers/{hauler_uuid}/connections/
Authorization: Bearer {your-auth-token}
Content-Type: application/json
x-tenant-id: {your-tenant-id}
{
"tenant_code": "SMSCORP+3"
}

Sample Response

Access-Control-Allow-Headers: Authorization, Accept, X-TENANT-ID, Content-Type
Access-Control-Allow-Methods: GET,POST
Access-Control-Allow-Origin: *
Allow: GET,POST
Content-Length: 275
Content-Type: application/json
Date: Sat, 20 Aug 2022 01:46:18 GMT
Server: WSGIServer/0.2 CPython/3.9.5
X-API-VERSION: 2019/02/08
X-REQUEST-ID: c2bd0edf-ec90-4781-acac-bf12046f4b6c

{
"approved_by": null,
"approved_on": null,
"denied_on": null,
"is_approved": false,
"location_id": 3,
"provider_id": 34,
"provider_name": "SMS Corp - SMS RollOffs",
"requested_on": "2022-08-20T01:27:24.691708",
"third_party_hauler_id": "c7d862af-a21f-4035-bede-49c29a55120b"
}

Path Parameters

hauler_uuid String, Required

Third party hauler identifier.

• Valid UUID.

Query Parameters

note

No query parameters.

Request Headers

Refer to HaulersRequestHeadersModel 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.

---

Content-Type String, Optional

Default Value: application/json

One of the following MIME types:

• "application/json" Refer to the JSON Spec.

---

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

Refer to CreateHaulerConnectionRequestModel for more details.

tenant_code String, Required

Confirmation code for hauler creation.

• Matches ^^\+*+[0-9]{1,10}$
• At least 1 and no more than 128 characters.

Response

Response Headers

Refer to StandardResponseHeadersModel for more details.

Content-Type String, Optional

Default Value: application/json

One of the following MIME types:

• "application/json" Refer to the JSON Spec.

---

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

approved_by Integer

Approved by.

---

approved_on String

Approval date.

• Date in an ISO 8601 compatible format.

---

denied_on String

Denial date.

• Date in an ISO 8601 compatible format.

---

is_approved Boolean

Approved record state.

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

---

location_id Integer

Location identifier.

---

provider_id Integer

Bin provider identifier.

---

provider_name String

Name (free text).

• At least 1 and no more than 64 characters.

---

requested_on String

Requested date.

• Date occurring in the past in an ISO 8601 compatible format.

---

third_party_hauler_id String

Third party hauler identifier.

• Valid UUID.

Code Samples

cURL

curl --request POST --include \
--header "Authorization: Bearer {your-auth-token}" \
--header "Content-Type: application/json" \
--header "x-tenant-id: {your-tenant-id}" \
--data '{"tenant_code": "SMSCORP+3"}' \
127.0.0.1:8003/haulers/{hauler_uuid}/connections

Python

import requests, json

body = '''
    {
"tenant_code": "SMSCORP+3"
}
    '''
response = requests.post(
        'http://localhost:8003/haulers/{hauler_uuid}/connections',
        headers={
            'Authorization': 'Bearer {your-auth-token}',
            'Content-Type': 'application/json',
            'x-tenant-id': '{your-tenant-id}'
        },
        params={
        },
        data=body
    )
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}/connections";

        // 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}");

        // Body
        String body = "{\"tenant_code\": \"SMSCORP+3\"}";

        String json = client.UploadString(url, "post", body);
        Console.WriteLine(json);
    }
}
}