1. REST API for Oracle IoT Fleet Monitoring Cloud Service
  2. Tasks
  3. Shipment Management

Retrieve shipment by ID

get

/fleetMonitoring/clientapi/v2/shipments/{id}

This operation returns the details of a shipment specified by its shipment ID.

Request

Path Parameters
Query Parameters
  • The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
  • The comma-separated list of fields to be shown in response. By default all response object fields will be present.

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : Shipment_receive
Type: object
Show Source
Nested Schema : ExternalEntityIDRefs_receive
Type: object
Show Source
Nested Schema : Equipment_receive
Type: object
Show Source
Nested Schema : MetricResultMap_receive
Type: object
Show Source
Nested Schema : stops
Type: array
List of stops
Show Source
Nested Schema : metricResults
Type: array
The metric result lists of an entity.
Show Source
Nested Schema : MetricResult_receive
Type: object
Show Source
Nested Schema : GeoPosition_receive
Type: object
Show Source
Nested Schema : params
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : additionalElements
Type: array
Property description was not set
Show Source
Nested Schema : Stops_receive
Type: object
Show Source

401 Response

Unauthorized. The request requires user authentication.

404 Response

Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.

406 Response

Request Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

Examples

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/fleetMonitoring/clientapi/v2/shipments/{id}

Example of Response Body

The following example shows the content of the response body in JSON format:

{
    "id": "FB7FD9B7-11C5-49E9-B02B-E0D8547FD22C",
    "externalId": "Planned-Shipment-2",
    "name": "Planned_Shipment-2",
    "cost": 60,
    "isTPLManaged": false,
    "equipment": {
        "externalId": "EQUIP-3",
        "groupId": "TestGrp"
    },
    "orderCount": 3,
    "shipUnitCount": 4,
    "carrierName": "MyGlobalCarrier",
    "domainName": "D1",
    "weight": 6.5,
    "volume": 6.8,
    "loadedDistance": 6.8,
    "weightUtilization": 1.2,
    "volumeUtilization": 3.6,
    "equipmentUtilization": 8.9,
    "unLoadedDistance": 7.8,
    "earliestStartTime": 1512905400000,
    "latestStartTime": 1518078200000,
    "externalReference": "BM1234565",
    "driverId": {
        "loginId": "iotFmDriver8"
    },
    "powerUnitId": {},
    "stops": [
        {
            "address": "500 Oracle Parkway::Redwood City::CA::US::94065",
            "geoLocation": [
                -122.26223,
                37.53084
            ],
            "estimatedTimeToNextStop": 792,
            "distanceToNextStop": 288,
            "expectedDurationFromStart": 0,
            "city": "Redwood City",
            "country": "US",
            "estimatedArrivalTime": 1517305083000,
            "estimatedDepartureTime": 1517300083000,
            "plannedArrivalTime": 1517305083000,
            "plannedDepartureTime": 1517405083000,
            "postalCode": "94065",
            "state": "CA",
            "stopDurationInSeconds": 0,
            "stopType": "P",
            "street": "500 Oracle Parkway",
            "stopSequence": 1
        },
        {
            "address": "4210 Network Circle::Santa Clara::CA::US::95054",
            "geoLocation": [
                -121.95267,
                37.39124
            ],
            "estimatedTimeToNextStop": 78,
            "distanceToNextStop": 25,
            "expectedDurationFromStart": 792,
            "city": "Santa Clara",
            "country": "US",
            "estimatedArrivalTime": 1517305083000,
            "estimatedDepartureTime": 1517405083000,
            "plannedArrivalTime": 1517305083000,
            "plannedDepartureTime": 1517405083000,
            "postalCode": "95054",
            "state": "CA",
            "stopDurationInSeconds": 0,
            "stopType": "P",
            "street": "4210 Network Circle",
            "stopSequence": 2
        },
        {
            "address": "475 Sansome Street::San Francisco::CA::US::94111",
            "geoLocation": [
                -122.40143,
                37.79461
            ],
            "estimatedTimeToNextStop": 366,
            "distanceToNextStop": 21.000000000000004,
            "expectedDurationFromStart": 870,
            "city": "San Francisco",
            "country": "US",
            "estimatedArrivalTime": 1517516083000,
            "estimatedDepartureTime": 1518516083000,
            "plannedArrivalTime": 1517516083000,
            "plannedDepartureTime": 1518516083000,
            "postalCode": "94111",
            "state": "CA",
            "stopDurationInSeconds": 0,
            "stopType": "D",
            "street": "475 Sansome Street",
            "stopSequence": 3
        }
    ],
    "lastModifiedBy": "iot",
    "lastModifiedTime": "2018-04-18T09:24:10.980Z",
    "lastModifiedTimeAsString": 1524043450980,
    "createdBy": "iot",
    "createdTime": "2018-04-18T09:15:27.121Z",
    "startTime": 0,
    "endTime": 0,
    "costCurrency": "EURO",
    "status": "PLANNED",
    "stopCount": 3,
    "stopsCompleted": 0,
    "links": [
        {
            "href": "https://iotserver:443/fleetMonitoring/clientapi/v2/shipments/FB7FD9B7-11C5-49E9-B02B-E0D8547FD22C/",
            "rel": "self"
        },
        {
            "href": "https://iotserver:443/fleetMonitoring/clientapi/v2/shipments/FB7FD9B7-11C5-49E9-B02B-E0D8547FD22C/",
            "rel": "canonical"
        }
    ]
}



Complete cURL Example

The following example shows a complete cURL command that you can use to perform the described operation:

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/fleetMonitoring/clientapi/v2/shipments/6aa56c2f334f-3ae2



Note that in the request, https://iotserver will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is https://myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.