Get Vehicle Type Compatibilities
get
/equipmentGroups/{equipmentGroupGid}/vehicleTypeCompatibilities
Request
Path Parameters
-
equipmentGroupGid(required): string
Resource ID
Query Parameters
-
expand: string
Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
-
fields: string
Comma-delimited string of field names that you wanted returned in a GET request.
-
limit: integer(int32)
Positive integer value that specifies the maximum number of items returned by the server.
-
offset: integer(int32)
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
-
orderBy: string
Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q: string
Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : equipmentGroups.vehicleTypeCompatibilities
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
vehicleTypeGid: string
The GID for the vehicle type. Vehicle type generally refers to the type of equipment (aircraft) that will be linked to an air schedule. Vehicle types contain door height and width dimensions that must be added to the equipment group so that ship units assigned to that equipment group can fit through the door when they are loaded onto the plane. For example, you can create a ship unit with dimensions of 10 feet in height by 10 feet in width. You can then assign that ship unit to an equipment group. If you create a vehicle type and assign it to that equipment group, then the vehicle type's door dimensions must be larger than those of the ship unit (for example, 20 feet in height and 20 feet in width).
If these door dimensions are not larger than the ship unit dimensions and the equipment group is assigned to a shipment, shipment planning produces an infeasible shipment with this equipment group.
If you setup your vehicle types without any equipment groups, the system will check the ship unit against door dimensions on the vehicle type "loose freight" scenario.
If you make an association between the vehicle type and an equipment group, then the system no longer does the door dimension check, but does a check to see if the equipment group assigned to the shipment is compatible with the equipment group(s) associated with the vehicle type.