Jump to

• Request
• Response
• Examples

Retrieve tripTemplate details

get

/fleetMonitoring/clientapi/v2/tripTemplates/{tripTemplateId}

This operation returns the details of a trip template that is specified by its ID.

Request

Path Parameters

• tripTemplateId: string
  ID of tripTemplate to be retrieved from FleetMonitoring Application.

Query Parameters

• expand(optional): string
  The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
• fields(optional): string
  The comma-separated list of fields to be shown in response. By default all response object fields will be present.

Header Parameters

• X-ORACLE-IOT-ORG(optional): string
  To allow targeting requests to different organizations. The header value should contain the organization identifier(orgId). This header is optional, if not provided orgId will be ORA_DEFAULT_ORG

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.resource+json;type=singular

200 Response

Successfully processed.

Body ()

Root Schema : TripTemplate_receive

Type: object

Show Source

• destination: object TripStop_receive
• expectedDuration: integer
  Expected duration of TripTemplate (second)
• id: string
  TripTemplate ID
• name: string
  TripTemplate name
• source: object TripStop_receive
• stops: array stops
  List of stops that are part of TripTemplate
• stopsClassification: string
  One of [SINGLE_STOP, DUAL_STOP, TRIPLE_STOP, MULTI_STOP, NON_STOP].
• totalStops: integer
  Total stops in TripTemplate
• tripLength: number
  Trip Distance
• tripLengthClassification: string
  One of [SHORT, MEDIUM, LONG].

{
    "type":"object",
    "required":[
        "id",
        "name",
        "source",
        "destination",
        "stops",
        "expectedDuration",
        "tripLength",
        "totalStops",
        "stopsClassification",
        "tripLengthClassification"
    ],
    "properties":{
        "tripLength":{
            "description":"Trip Distance",
            "type":"number"
        },
        "totalStops":{
            "description":"Total stops in TripTemplate",
            "type":"integer"
        },
        "name":{
            "description":"TripTemplate name",
            "type":"string"
        },
        "destination":{
            "$ref":"#/definitions/TripStop_receive"
        },
        "stopsClassification":{
            "description":"One of [SINGLE_STOP, DUAL_STOP, TRIPLE_STOP, MULTI_STOP, NON_STOP].",
            "type":"string"
        },
        "tripLengthClassification":{
            "description":"One of [SHORT, MEDIUM, LONG].",
            "type":"string"
        },
        "id":{
            "description":"TripTemplate ID",
            "type":"string"
        },
        "source":{
            "$ref":"#/definitions/TripStop_receive"
        },
        "stops":{
            "description":"List of stops that are part of TripTemplate",
            "type":"array",
            "items":{
                "$ref":"#/definitions/TripStop_receive"
            }
        },
        "expectedDuration":{
            "description":"Expected duration of TripTemplate (second)",
            "type":"integer"
        }
    }
}

Nested Schema : TripStop_receive

Type: object

Show Source

• address: string
  Unified full address, e.g. 500 Oracle Parkway::Redwood City::CA::US::94065 . Must be provided if geoLocation is not specified.
• city: string
  Name of City
• country: string
  Name of country
• distanceToNextStop: number
  Estimated distance to next stop
• estimatedTimeToNextStop: integer
  Estimated time it will take to reach next stop (second)
• expectedDurationFromStart: integer
  Expected duration to reach from Start to this Stop (second)
• geoLocation: object GeoPosition_receive
• postalCode: string
  Postal/Zip code
• state: string
  Name of State
• stopSequence: integer
  Property description was not set
• street: string
  Name of Street

{
    "type":"object",
    "required":[
        "address",
        "geoLocation",
        "estimatedTimeToNextStop",
        "distanceToNextStop",
        "expectedDurationFromStart",
        "city",
        "postalCode",
        "street",
        "stopSequence",
        "state",
        "country"
    ],
    "properties":{
        "estimatedTimeToNextStop":{
            "description":"Estimated time it will take to reach next stop (second)",
            "type":"integer"
        },
        "distanceToNextStop":{
            "description":"Estimated distance to next stop",
            "type":"number"
        },
        "country":{
            "description":"Name of country",
            "type":"string"
        },
        "stopSequence":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "address":{
            "description":"Unified full address, e.g. 500 Oracle Parkway::Redwood City::CA::US::94065 . Must be provided if geoLocation is not specified.",
            "type":"string"
        },
        "geoLocation":{
            "$ref":"#/definitions/GeoPosition_receive"
        },
        "city":{
            "description":"Name of City",
            "type":"string"
        },
        "street":{
            "description":"Name of Street",
            "type":"string"
        },
        "postalCode":{
            "description":"Postal/Zip code",
            "type":"string"
        },
        "expectedDurationFromStart":{
            "description":"Expected duration to reach from Start to this Stop (second)",
            "type":"integer"
        },
        "state":{
            "description":"Name of State",
            "type":"string"
        }
    }
}

Nested Schema : stops

Type: array

List of stops that are part of TripTemplate

Show Source

• Array of: object TripStop_receive

{
    "description":"List of stops that are part of TripTemplate",
    "type":"array",
    "items":{
        "$ref":"#/definitions/TripStop_receive"
    }
}

Nested Schema : GeoPosition_receive

Type: object

Show Source

• additionalElements: array additionalElements
  Property description was not set
• altitude: number
  Property description was not set
• latitude: number
  Property description was not set
• longitude: number
  Property description was not set
• valid: boolean
  Property description was not set

{
    "properties":{
        "additionalElements":{
            "description":"Property description was not set",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "altitude":{
            "description":"Property description was not set",
            "type":"number"
        },
        "latitude":{
            "description":"Property description was not set",
            "type":"number"
        },
        "longitude":{
            "description":"Property description was not set",
            "type":"number"
        },
        "valid":{
            "description":"Property description was not set",
            "type":"boolean"
        }
    },
    "required":[
        "additionalElements",
        "latitude",
        "longitude",
        "altitude",
        "valid"
    ],
    "type":"object"
}

Nested Schema : additionalElements

Type: array

Property description was not set

Show Source

• Array of: string

{
    "description":"Property description was not set",
    "items":{
        "type":"string"
    },
    "type":"array"
}

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

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.

Back to Top

Examples

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

Example of Response Body

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

{
    "tripLength":0.0,
    "totalStops":12345,
    "name":"TripTemplate name",
    "destination":{
        "estimatedTimeToNextStop":1469184297746,
        "distanceToNextStop":0.0,
        "country":"Name of country",
        "stopSequence":12345,
        "address":"Unified full address, e.g. 500 Oracle Parkway::Redwood City::CA::US::94065 . Must be provided if geoLocation is not specified.",
        "geoLocation":[longitude,latitude],
        "city":"Name of City",
        "street":"Name of Street",
        "postalCode":"Postal/Zip code",
        "expectedDurationFromStart":12345,
        "state":"Name of State"
    },
    "stopsClassification":"One of [SINGLE_STOP, DUAL_STOP, TRIPLE_STOP, MULTI_STOP, NON_STOP].",
    "tripLengthClassification":"One of [SHORT, MEDIUM, LONG].",
    "id":"4ad632ec5bb6-3f54",
    "source":{
        "estimatedTimeToNextStop":1469184297746,
        "distanceToNextStop":0.0,
        "country":"Name of country",
        "stopSequence":12345,
        "address":"Unified full address, e.g. 500 Oracle Parkway::Redwood City::CA::US::94065 . Must be provided if geoLocation is not specified.",
        "geoLocation":[longitude,latitude],
        "city":"Name of City",
        "street":"Name of Street",
        "postalCode":"Postal/Zip code",
        "expectedDurationFromStart":12345,
        "state":"Name of State"
    },
    "stops":[
        {
            "estimatedTimeToNextStop":1469184297746,
            "distanceToNextStop":0.0,
            "country":"Name of country",
            "stopSequence":12345,
            "address":"Unified full address, e.g. 500 Oracle Parkway::Redwood City::CA::US::94065 . Must be provided if geoLocation is not specified.",
            "geoLocation":[longitude,latitude],
            "city":"Name of City",
            "street":"Name of Street",
            "postalCode":"Postal/Zip code",
            "expectedDurationFromStart":12345,
            "state":"Name of State"
        }
    ],
    "expectedDuration":12345
} 

Complete cURL Example

The following example shows the complete cURL command that can be used to perform the described operation:

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

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.

Back to Top