Get Loads


Description

This method is used to get loads.

Authentication

Requires HTTP BASIC authentication. The authenticating user must have ROLE_LOAD_PERMITTED and ROLE_POST_LOAD_PERMITTED assigned.

HTTP Methods

Accepts GET requests.

URI

/api/users/{userUuid}/loads/{loadUuid}

Path Variables

Name Required/Optional Description Validation
userUuid required The UUID of the user in the system User UUID should exist in the system.
loadUuid required The UUID of the load in the system Load UUID should exist in the system.

HTTP Parameters

No HTTP Parameters

Curl Example

Request

curl -k -u apiuser:test "https://www.factorsnetwork.com/api/users/3be13e8e-00be-498d-a843-d6aad5af4cc1/loads/4323a42b-6091-431f-b0f3-270b48c807a9"

Response

{
  "load": {
    "id": "4323a42b-6091-431f-b0f3-270b48c807a9",
    "dispatchNumber" : "949-394-1484",
    "equipmentType" : "Van",
    "fullOrLTL" : "LTL",
    "dateAvailable" : "10/19/2016",
    "deliveryDate" : "10/19/2016",
    "pickUpPoint" : "LAS VEGAS NV",
    "destination" : "LAS VEGAS NV",
    "hoursOld" : 0.0,
    "company" : "XYZ transportation",
    "distance" : 0.0,
    "debtorUuid" : "2g111448-0d0e-437a-b425-e4e30f628d4c",
    "rate" : "$0.00",
    "weight" : 0.0,
    "length" : 0.0,
    "height" : 0.0,
    "width" : 0.0,
    "loadsCount" : 1,
    "loadStatus" : "Active",
    "owner" : "fname lname",
    "postedBy" : "apiuser",
    "comment": "test comments"
  }
}

Note: Responses will not be pretty printed when using the API, but have been formatted here for documentation purposes.