Get all Vehicle Sales
get
/crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleSales
Request
Path Parameters
-
VehicleIdentificationNumber: string
Identifier to Vehicles
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- RowFinder: Finder Variables:
- SaleNumber; string;
- PrimaryKey: Finder Variables:
- VehicleSaleId; integer;
- RowFinder: Finder Variables:
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2 -
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : autoVehicles-VehicleSales
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The vehicle sales resource is used to view, create, update, or delete a vehicle sale. -
hasMore(optional):
boolean
Title:
HasMore
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : autoVehicles-VehicleSales-item
Type:
Show Source
object
-
AccountId(optional):
integer(int64)
Title:
Account ID
The unique identifier of the account. -
AttributeCategory(optional):
string
Title:
Attribute Category
Maximum Length:30
A system-generated read-only attribute used by the application framework. -
CertificationDate(optional):
string(date)
Title:
Certification Date
The date of the certification. -
CertificationNumber(optional):
string
Title:
Certification
Maximum Length:300
The certification number. -
ContractEndDate(optional):
string(date)
Title:
Contract End
The date when the contract ends. -
CorpCurrencyCode(optional):
string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the record. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the record. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the record was created. -
CurcyConvRateType(optional):
string
Title:
Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the record. -
CurrencyCode(optional):
string
Title:
Currency Code
Maximum Length:15
The currency code associated with the record like USD or EUR. -
CustomerId(optional):
integer(int64)
Title:
Customer ID
The unique identifier of the customer. -
DealerAgentId(optional):
integer(int64)
Title:
Dealer Agent ID
The unique identifier of the dealer selling the vehicle. -
DepositDate(optional):
string(date)
Title:
Deposit Date
The date when the deposit was made. -
DownPaymentAmount(optional):
number
Title:
Down Payment
The amount to be paid as down payment. -
FinanceType(optional):
string
Title:
Finance Type
Maximum Length:30
The type of the finance. -
FinancierAccountId(optional):
integer(int64)
Title:
Financier Account ID
Indicates the unique identifier of the financier. -
InsuranceProvider(optional):
string
Title:
Insurance Provider
Maximum Length:300
The name of the insurance provider. -
InsuranceRenewalDate(optional):
string(date)
Title:
Insurance Renewal
The date when the insurance is renewed. -
LastPaymentDate(optional):
string(date)
Title:
Last Payment
The date when the last payment was made. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the record was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin(optional):
string
Title:
Last Update Login
Maximum Length:32
The login of the user who last updated the record. -
LeaseEndDate(optional):
string(date)
Title:
Lease End
The date when the lease ends. -
links(optional):
array Items
Title:
Items
Link Relations -
MilesAllowed(optional):
number
Title:
Miles Allowed
Indicates the miles that the vehicle can cover. -
MilesTerm(optional):
string
Title:
Miles Term
Maximum Length:30
Indicates the mile terms. -
MonthlyPaymentAmount(optional):
number
Title:
Monthly Payment
The monthly payment amount. -
NextCertificationDate(optional):
string(date)
Title:
Next Certification Date
The date when the next certification is to be done. -
ObjectVersionNumber(optional):
integer(int32)
Title:
Object Version Number
A system-generated read-only attribute used by the application framework. -
OdometerReading(optional):
number
Title:
Odometer Reading
The reading of the odometer. -
OpportunityId(optional):
integer(int64)
Title:
Opportunity ID
The unique identifier of the opportunity. -
OrderDate(optional):
string(date)
Title:
Order Date
The date of the order. -
OrgId(optional):
integer(int64)
Title:
Business Unit
The business unit associated with record. -
OriginSystem(optional):
string
Title:
Origin System
Maximum Length:400
The application from where the order originated. -
OriginSystemReference(optional):
string
Title:
Origin System Reference
Maximum Length:400
The unique identifier of the record in the source application. -
QuoteDate(optional):
string(date)
Title:
Quote Date
The date when the quote was made. -
RegistrationDate(optional):
string(date)
Title:
Registration Date
The date of the registration. -
RemainingPaymentAmount(optional):
number
Title:
Remaining Payment
The remaining payment amount. -
SaleDate(optional):
string(date)
Title:
Sale Date
The date of the sale. -
SaleNumber(optional):
string
Title:
Sale Number
Maximum Length:30
The public unique identifier of the record. -
SalesContactFirstName(optional):
string
Title:
First Name
Maximum Length:100
The first name of the sales contact. -
SalesContactLastName(optional):
string
Title:
Last Name
Maximum Length:100
The last name of the sales contact. -
SalesStatus(optional):
string
Title:
Status
Maximum Length:30
The status of the sale. -
SalesType(optional):
string
Title:
Type
Maximum Length:30
The type of the sale. -
SecurityDepositAmount(optional):
number
Title:
Security Deposit
The security deposit amount for the sale. -
SellingDealerId(optional):
integer(int64)
Title:
Dealer ID
The unique identifier of the dealer agent. -
StockNumber(optional):
string
Title:
Stock Number
Maximum Length:100
The stock number of the vehicle. -
UOM(optional):
string
Title:
UOM
Maximum Length:30
Indicates the unit of measure. -
VehicleId(optional):
integer(int64)
Title:
Vehicle ID
The unique identifier of the vehicle. -
VehicleSaleId(optional):
integer(int64)
Title:
Sale ID
The unique identifier of the sale.
- FinanceType LOV
-
Method: getPath:
/crmRestApi/resources/11.13.18.05/fndStaticLookups
- MilesTerm LOV
-
Method: getPath:
/crmRestApi/resources/11.13.18.05/fndStaticLookups
- SalesStatus LOV
-
Method: getPath:
/crmRestApi/resources/11.13.18.05/fndStaticLookups
- SalesType LOV
-
Method: getPath:
/crmRestApi/resources/11.13.18.05/fndStaticLookups
- UOM LOV
-
Method: getPath:
/crmRestApi/resources/11.13.18.05/fndStaticLookups
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.