Skip to main content

Update Truck

PATCH /locations/{location_id}/trucks/{truck_id}

Update truck.

Roles​

Users with the following roles may access this endoint:

Admin
ClientCustomer
CrmUser
Dispatcher
Driver
ThirdPartyDispatcher
ThirdPartyDriver

Breaking Changes​

2021/05/07

Request​

PATCH /locations/{location_id}/trucks/{truck_id}/
Authorization: Bearer {your-auth-token}
Content-Type: application/json
X-API-VERSION: 2021/11/04
x-tenant-id: {your-tenant-id}
{
"driver_id": null
}

Path Parameters​

location_id Integer, Required

Location identifier.

truck_id Integer, Required

Truck identifier.

Query Parameters​

note

Not available after version 2021/04/07. Refer to UpdateTruckQueryParamsModel for use with previous versions.

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.

Content-Type String, Optional

Default Value: application/json

One of the following MIME types:

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​

Refer to UpdateTruckRequestModel for more details.

driver_id String, Optional

Driver identifier. A null driver_id resets the truck to have no driver.

Response​

Response Headers​

Refer to StandardResponseHeadersModel for more details.

Content-Type String, Optional

Default Value: application/json

One of the following MIME types:

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

driver_id String

Driver identifier.

id Integer

Resource identifier.

interface_color String

Hex string color identifier.

  • At least 7 and no more than 7 characters.

location_id Integer

Location identifier.

name String

Name (free text).

  • At least 1 and no more than 64 characters.

notes String

Notes (free text).

  • At least 0 and no more than 2048 characters.

out_of_service Boolean

Truck out of service.

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

require_odometer Boolean

Require odometer.

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

third_party_hauler_id String

Third party hauler identifier.

  • Valid UUID.

trailer_id Integer

Trailer record identifier.

type String

Truck type (free text).

  • At least 1 and no more than 50 characters.

weight Float

Truck empty weight.

  • Less than or equal to 10000000.
  • Greater than or equal to 0.

Code Samples​

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}/trucks/{truck_id}";

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

        // Body
        String body = "{\"driver_id\": null}";

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