POST api/Vehicles/Command?ticketID={ticketID}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
ticketID | globally unique identifier |
Required |
Body Parameters
VehicleName | Description | Type | Additional information |
---|---|---|---|
VehicleID | globally unique identifier |
None. |
|
MerchantID | integer |
None. |
|
SiteID | integer |
None. |
|
CustomerID | globally unique identifier |
None. |
|
ReceivableAccountID | globally unique identifier |
None. |
|
VIN | string |
None. |
|
LicensePlateNumber | string |
None. |
|
LicensePlateStateCode | string |
None. |
|
OdometerReading | integer |
None. |
|
OdometerUnitCode | string |
None. |
|
OdometerUnitDescription | string |
None. |
|
EngineOilItemCode | string |
None. |
|
EngineOilCapacity | decimal number |
None. |
|
GoushaCapacity | decimal number |
None. |
|
IsGoushaCapacityWithFilter | boolean |
None. |
|
OilViscosity | string |
None. |
|
Year | string |
None. |
|
MakeDescription | string |
None. |
|
ModelDescription | string |
None. |
|
EngineDescription | string |
None. |
|
MakeCode | string |
None. |
|
ModelCode | string |
None. |
|
EngineCode | string |
None. |
|
AAIALegacyVehicleID | integer |
None. |
|
Notes | string |
None. |
|
EngineOilChangeIntervalDistance | integer |
None. |
|
EngineOilChangeIntervalMonths | integer |
None. |
|
EngineOilChangeIntervalTypeCode | string |
None. |
|
EngineOilChangeIntervalOverrideDateTime | date |
None. |
|
EngineOilChangeIntervalOverrideReasonCode | string |
None. |
|
EngineOilChangeIntervalOverrideUserID | globally unique identifier |
None. |
|
EngineOilChangeIntervalOverrideUserName | string |
None. |
|
VehicleInternalCode | string |
None. |
|
InspectionDate | date |
None. |
|
EstimatedDailyUsage | decimal number |
None. |
|
ExternalVehicleID | string |
None. |
|
VehicleInformationSourceCode | string |
None. |
|
VehicleInformationCatalogLookupCode | string |
None. |
|
EngineOilChangeDueDate | date |
None. |
|
LoyaltyTrackingCode | string |
None. |
|
SubscriptionTrackingCode | string |
None. |
|
EngineOilCategoryCode | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "VehicleID": "c6a42fbc-d098-4765-b3ec-70a580a910b2", "MerchantID": 2, "SiteID": 3, "CustomerID": "c31e9b78-737a-4c09-841b-a3976bc7345b", "ReceivableAccountID": "ecd6bb50-ed65-4955-ba32-5f495afc29cd", "VIN": "sample string 6", "LicensePlateNumber": "sample string 7", "LicensePlateStateCode": "sample string 8", "OdometerReading": 9, "OdometerUnitCode": "sample string 10", "OdometerUnitDescription": "sample string 11", "EngineOilItemCode": "sample string 12", "EngineOilCapacity": 1.0, "GoushaCapacity": 1.0, "IsGoushaCapacityWithFilter": true, "OilViscosity": "sample string 13", "Year": "sample string 14", "MakeDescription": "sample string 15", "ModelDescription": "sample string 16", "EngineDescription": "sample string 17", "MakeCode": "sample string 18", "ModelCode": "sample string 19", "EngineCode": "sample string 20", "AAIALegacyVehicleID": 1, "Notes": "sample string 21", "EngineOilChangeIntervalDistance": 1, "EngineOilChangeIntervalMonths": 1, "EngineOilChangeIntervalTypeCode": "sample string 22", "EngineOilChangeIntervalOverrideDateTime": "2025-08-14T03:21:16.0975249+00:00", "EngineOilChangeIntervalOverrideReasonCode": "sample string 23", "EngineOilChangeIntervalOverrideUserID": "223fc712-f90e-4da9-8e2f-6e98ce71cf35", "EngineOilChangeIntervalOverrideUserName": "sample string 25", "VehicleInternalCode": "sample string 26", "InspectionDate": "2025-08-14T03:21:16.0975249+00:00", "EstimatedDailyUsage": 1.0, "ExternalVehicleID": "sample string 27", "VehicleInformationSourceCode": "sample string 28", "VehicleInformationCatalogLookupCode": "sample string 29", "EngineOilChangeDueDate": "2025-08-14T03:21:16.0975249+00:00", "LoyaltyTrackingCode": "sample string 30", "SubscriptionTrackingCode": "sample string 31", "EngineOilCategoryCode": "sample string 32" }
application/xml, text/xml
Sample:
<Vehicle xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <AAIALegacyVehicleID>1</AAIALegacyVehicleID> <CustomerID>c31e9b78-737a-4c09-841b-a3976bc7345b</CustomerID> <EngineCode>sample string 20</EngineCode> <EngineDescription>sample string 17</EngineDescription> <EngineOilCapacity>1</EngineOilCapacity> <EngineOilCategoryCode>sample string 32</EngineOilCategoryCode> <EngineOilChangeDueDate>2025-08-14T03:21:16.0975249+00:00</EngineOilChangeDueDate> <EngineOilChangeIntervalDistance>1</EngineOilChangeIntervalDistance> <EngineOilChangeIntervalMonths>1</EngineOilChangeIntervalMonths> <EngineOilChangeIntervalOverrideDateTime>2025-08-14T03:21:16.0975249+00:00</EngineOilChangeIntervalOverrideDateTime> <EngineOilChangeIntervalOverrideReasonCode>sample string 23</EngineOilChangeIntervalOverrideReasonCode> <EngineOilChangeIntervalOverrideUserID>223fc712-f90e-4da9-8e2f-6e98ce71cf35</EngineOilChangeIntervalOverrideUserID> <EngineOilChangeIntervalOverrideUserName>sample string 25</EngineOilChangeIntervalOverrideUserName> <EngineOilChangeIntervalTypeCode>sample string 22</EngineOilChangeIntervalTypeCode> <EngineOilItemCode>sample string 12</EngineOilItemCode> <EstimatedDailyUsage>1</EstimatedDailyUsage> <ExternalVehicleID>sample string 27</ExternalVehicleID> <GoushaCapacity>1</GoushaCapacity> <InspectionDate>2025-08-14T03:21:16.0975249+00:00</InspectionDate> <IsGoushaCapacityWithFilter>true</IsGoushaCapacityWithFilter> <LicensePlateNumber>sample string 7</LicensePlateNumber> <LicensePlateStateCode>sample string 8</LicensePlateStateCode> <LoyaltyTrackingCode>sample string 30</LoyaltyTrackingCode> <MakeCode>sample string 18</MakeCode> <MakeDescription>sample string 15</MakeDescription> <MerchantID>2</MerchantID> <ModelCode>sample string 19</ModelCode> <ModelDescription>sample string 16</ModelDescription> <Notes>sample string 21</Notes> <OdometerReading>9</OdometerReading> <OdometerUnitCode>sample string 10</OdometerUnitCode> <OdometerUnitDescription>sample string 11</OdometerUnitDescription> <OilViscosity>sample string 13</OilViscosity> <ReceivableAccountID>ecd6bb50-ed65-4955-ba32-5f495afc29cd</ReceivableAccountID> <SiteID>3</SiteID> <SubscriptionTrackingCode>sample string 31</SubscriptionTrackingCode> <VIN>sample string 6</VIN> <VehicleID>c6a42fbc-d098-4765-b3ec-70a580a910b2</VehicleID> <VehicleInformationCatalogLookupCode>sample string 29</VehicleInformationCatalogLookupCode> <VehicleInformationSourceCode>sample string 28</VehicleInformationSourceCode> <VehicleInternalCode>sample string 26</VehicleInternalCode> <Year>sample string 14</Year> </Vehicle>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |