POST Vehicle/PostVehicle
Create a new vehicle.
Request Information
URI Parameters
Body Parameters
Vehicle object to create.
ClsVehiclePostName | Description | Type | Additional Information |
---|---|---|---|
Id |
Id of the Vehicle |
string |
Max length: 10 |
Description |
Description of the Vehicle |
string |
Max length: 30 |
Type |
Type of the Vehicle |
string |
Max length: 20 |
Year |
Model Year of the Vehicle |
string |
Max length: 10 |
Make |
Make / Model of the Vehicle |
string |
Max length: 30 |
PurchaseDate |
Purchase Date of the Vehicle |
date | |
SerialNum |
Serial Number of the Vehicle |
string |
Max length: 30 |
LicPlate |
License Plate of the Vehicle |
string |
Max length: 20 |
LicExpire |
License Expiration of the Vehicle |
date | |
Weight |
Weight of the Vehicle |
string |
Max length: 10 |
Notes |
Notes of the Vehicle |
string |
Max length: 255 |
InActive |
Inactivity of the Vehicle |
boolean | |
LocationID |
Location of the Vehicle |
string |
Max length: 6 |
LastLat |
Last Latitude of the Vehicle |
decimal number | |
LastLon |
Last Longitude of the Vehicle |
decimal number | |
LastSpeed |
Last Speed of the Vehicle |
decimal number | |
LastDirection |
Last Direction of the Vehicle |
string |
Max length: 20 |
LastLLDateReport |
Last Date Report of the Vehicle |
date | |
LastLLTimeReport |
Last Time Report of the Vehicle |
date | |
AVLID |
AVL ID of the Vehicle |
string |
Max length: 20 |
Capacity |
Capacity of the Vehicle |
decimal number | |
CapacityType |
Capacity Type of the Vehicle |
string | |
VehiclePlannedAcreList | Collection of ClsVehiclePlannedAcres |
Request Formats
application/json, text/json
{ "Id": "sample string 3", "Description": "sample string 4", "Type": "sample string 5", "Year": "sample string 6", "Make": "sample string 7", "PurchaseDate": "2024-11-21T10:09:00.8159842+00:00", "SerialNum": "sample string 8", "LicPlate": "sample string 9", "LicExpire": "2024-11-21T10:09:00.8159842+00:00", "Weight": "sample string 10", "Notes": "sample string 11", "InActive": true, "LocationID": "sample string 12", "LastLat": 1.1, "LastLon": 1.1, "LastSpeed": 1.1, "LastDirection": "sample string 13", "LastLLDateReport": "2024-11-21T10:09:00.8159842+00:00", "LastLLTimeReport": "2024-11-21T10:09:00.8159842+00:00", "AVLID": "sample string 14", "Capacity": 1.1, "CapacityType": "sample string 15", "VehiclePlannedAcreList": [ { "PlannedDate": "2024-11-21T10:09:00.8169836+00:00", "PlannedAcres": 1.1 }, { "PlannedDate": "2024-11-21T10:09:00.8169836+00:00", "PlannedAcres": 1.1 } ] }
application/xml, text/xml
<ClsVehicle.ClsVehiclePost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Vehicle"> <AVLID>sample string 14</AVLID> <Capacity>1.1</Capacity> <CapacityType>sample string 15</CapacityType> <Description>sample string 4</Description> <Id>sample string 3</Id> <InActive>true</InActive> <LastDirection>sample string 13</LastDirection> <LastLLDateReport>2024-11-21T10:09:00.8159842+00:00</LastLLDateReport> <LastLLTimeReport>2024-11-21T10:09:00.8159842+00:00</LastLLTimeReport> <LastLat>1.1</LastLat> <LastLon>1.1</LastLon> <LastSpeed>1.1</LastSpeed> <LicExpire>2024-11-21T10:09:00.8159842+00:00</LicExpire> <LicPlate>sample string 9</LicPlate> <LocationID>sample string 12</LocationID> <Make>sample string 7</Make> <Notes>sample string 11</Notes> <PurchaseDate>2024-11-21T10:09:00.8159842+00:00</PurchaseDate> <SerialNum>sample string 8</SerialNum> <Type>sample string 5</Type> <VehiclePlannedAcreList> <ClsVehicle.ClsVehiclePlannedAcres> <PlannedAcres>1.1</PlannedAcres> <PlannedDate>2024-11-21T10:09:00.8169836+00:00</PlannedDate> </ClsVehicle.ClsVehiclePlannedAcres> <ClsVehicle.ClsVehiclePlannedAcres> <PlannedAcres>1.1</PlannedAcres> <PlannedDate>2024-11-21T10:09:00.8169836+00:00</PlannedDate> </ClsVehicle.ClsVehiclePlannedAcres> </VehiclePlannedAcreList> <Weight>sample string 10</Weight> <Year>sample string 6</Year> </ClsVehicle.ClsVehiclePost>
application/x-www-form-urlencoded
Response Information
Resource Description
Create a new vehicle.
AgvVehicleName | Description | Type | Additional Information |
---|---|---|---|
Status |
0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful. |
string | |
Message |
Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know. |
string | |
ErrorList |
List of errors from the API |
Collection of string | |
WarningList |
List of warnings from the API |
Collection of string | |
Count |
Count of how many Vehicle JSON dictionaries. |
string | |
VehicleList |
JSON dictionary of Vehicles |
Collection of ClsVehicle |
Response Formats
application/json, text/json
{ "Status": "sample string 1", "Message": "sample string 2", "ErrorList": [ "sample string 1", "sample string 2" ], "WarningList": [ "sample string 1", "sample string 2" ], "Count": "2", "VehicleList": [ { "Id": "sample string 4", "Description": "sample string 5", "Type": "sample string 6", "Year": "sample string 7", "Make": "sample string 8", "PurchaseDate": "2024-11-21T10:09:00.8339831+00:00", "SerialNum": "sample string 9", "LicPlate": "sample string 10", "LicExpire": "2024-11-21T10:09:00.8339831+00:00", "Weight": "sample string 11", "Notes": "sample string 12", "InActive": true, "LocationID": "sample string 13", "LastLat": 1.1, "LastLon": 1.1, "LastSpeed": 1.1, "LastDirection": "sample string 14", "LastLLDateReport": "2024-11-21T10:09:00.8339831+00:00", "LastLLTimeReport": "2024-11-21T10:09:00.8339831+00:00", "AVLID": "sample string 15", "Capacity": 1.1, "CapacityType": "sample string 16", "AgVehicleGuid": "a6cadbe3-83c9-4d95-bff3-ca584edb8565", "VehiclePlannedAcreList": [ { "PlannedDate": "2024-11-21T10:09:00.8339831+00:00", "PlannedAcres": 1.1 }, { "PlannedDate": "2024-11-21T10:09:00.8339831+00:00", "PlannedAcres": 1.1 } ] }, { "Id": "sample string 4", "Description": "sample string 5", "Type": "sample string 6", "Year": "sample string 7", "Make": "sample string 8", "PurchaseDate": "2024-11-21T10:09:00.8339831+00:00", "SerialNum": "sample string 9", "LicPlate": "sample string 10", "LicExpire": "2024-11-21T10:09:00.8339831+00:00", "Weight": "sample string 11", "Notes": "sample string 12", "InActive": true, "LocationID": "sample string 13", "LastLat": 1.1, "LastLon": 1.1, "LastSpeed": 1.1, "LastDirection": "sample string 14", "LastLLDateReport": "2024-11-21T10:09:00.8339831+00:00", "LastLLTimeReport": "2024-11-21T10:09:00.8339831+00:00", "AVLID": "sample string 15", "Capacity": 1.1, "CapacityType": "sample string 16", "AgVehicleGuid": "a6cadbe3-83c9-4d95-bff3-ca584edb8565", "VehiclePlannedAcreList": [ { "PlannedDate": "2024-11-21T10:09:00.8339831+00:00", "PlannedAcres": 1.1 }, { "PlannedDate": "2024-11-21T10:09:00.8339831+00:00", "PlannedAcres": 1.1 } ] } ] }
application/xml, text/xml
<AgvVehicle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Vehicle"> <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </ErrorList> <Message>sample string 2</Message> <Status>sample string 1</Status> <VehicleList xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Vehicle"> <d2p1:ClsVehicle> <d2p1:AVLID>sample string 15</d2p1:AVLID> <d2p1:AgVehicleGuid>a6cadbe3-83c9-4d95-bff3-ca584edb8565</d2p1:AgVehicleGuid> <d2p1:Capacity>1.1</d2p1:Capacity> <d2p1:CapacityType>sample string 16</d2p1:CapacityType> <d2p1:Description>sample string 5</d2p1:Description> <d2p1:Id>sample string 4</d2p1:Id> <d2p1:InActive>true</d2p1:InActive> <d2p1:LastDirection>sample string 14</d2p1:LastDirection> <d2p1:LastLLDateReport>2024-11-21T10:09:00.8339831+00:00</d2p1:LastLLDateReport> <d2p1:LastLLTimeReport>2024-11-21T10:09:00.8339831+00:00</d2p1:LastLLTimeReport> <d2p1:LastLat>1.1</d2p1:LastLat> <d2p1:LastLon>1.1</d2p1:LastLon> <d2p1:LastSpeed>1.1</d2p1:LastSpeed> <d2p1:LicExpire>2024-11-21T10:09:00.8339831+00:00</d2p1:LicExpire> <d2p1:LicPlate>sample string 10</d2p1:LicPlate> <d2p1:LocationID>sample string 13</d2p1:LocationID> <d2p1:Make>sample string 8</d2p1:Make> <d2p1:Notes>sample string 12</d2p1:Notes> <d2p1:PurchaseDate>2024-11-21T10:09:00.8339831+00:00</d2p1:PurchaseDate> <d2p1:SerialNum>sample string 9</d2p1:SerialNum> <d2p1:Type>sample string 6</d2p1:Type> <d2p1:VehiclePlannedAcreList> <d2p1:ClsVehicle.ClsVehiclePlannedAcres> <d2p1:PlannedAcres>1.1</d2p1:PlannedAcres> <d2p1:PlannedDate>2024-11-21T10:09:00.8339831+00:00</d2p1:PlannedDate> </d2p1:ClsVehicle.ClsVehiclePlannedAcres> <d2p1:ClsVehicle.ClsVehiclePlannedAcres> <d2p1:PlannedAcres>1.1</d2p1:PlannedAcres> <d2p1:PlannedDate>2024-11-21T10:09:00.8339831+00:00</d2p1:PlannedDate> </d2p1:ClsVehicle.ClsVehiclePlannedAcres> </d2p1:VehiclePlannedAcreList> <d2p1:Weight>sample string 11</d2p1:Weight> <d2p1:Year>sample string 7</d2p1:Year> </d2p1:ClsVehicle> <d2p1:ClsVehicle> <d2p1:AVLID>sample string 15</d2p1:AVLID> <d2p1:AgVehicleGuid>a6cadbe3-83c9-4d95-bff3-ca584edb8565</d2p1:AgVehicleGuid> <d2p1:Capacity>1.1</d2p1:Capacity> <d2p1:CapacityType>sample string 16</d2p1:CapacityType> <d2p1:Description>sample string 5</d2p1:Description> <d2p1:Id>sample string 4</d2p1:Id> <d2p1:InActive>true</d2p1:InActive> <d2p1:LastDirection>sample string 14</d2p1:LastDirection> <d2p1:LastLLDateReport>2024-11-21T10:09:00.8339831+00:00</d2p1:LastLLDateReport> <d2p1:LastLLTimeReport>2024-11-21T10:09:00.8339831+00:00</d2p1:LastLLTimeReport> <d2p1:LastLat>1.1</d2p1:LastLat> <d2p1:LastLon>1.1</d2p1:LastLon> <d2p1:LastSpeed>1.1</d2p1:LastSpeed> <d2p1:LicExpire>2024-11-21T10:09:00.8339831+00:00</d2p1:LicExpire> <d2p1:LicPlate>sample string 10</d2p1:LicPlate> <d2p1:LocationID>sample string 13</d2p1:LocationID> <d2p1:Make>sample string 8</d2p1:Make> <d2p1:Notes>sample string 12</d2p1:Notes> <d2p1:PurchaseDate>2024-11-21T10:09:00.8339831+00:00</d2p1:PurchaseDate> <d2p1:SerialNum>sample string 9</d2p1:SerialNum> <d2p1:Type>sample string 6</d2p1:Type> <d2p1:VehiclePlannedAcreList> <d2p1:ClsVehicle.ClsVehiclePlannedAcres> <d2p1:PlannedAcres>1.1</d2p1:PlannedAcres> <d2p1:PlannedDate>2024-11-21T10:09:00.8339831+00:00</d2p1:PlannedDate> </d2p1:ClsVehicle.ClsVehiclePlannedAcres> <d2p1:ClsVehicle.ClsVehiclePlannedAcres> <d2p1:PlannedAcres>1.1</d2p1:PlannedAcres> <d2p1:PlannedDate>2024-11-21T10:09:00.8339831+00:00</d2p1:PlannedDate> </d2p1:ClsVehicle.ClsVehiclePlannedAcres> </d2p1:VehiclePlannedAcreList> <d2p1:Weight>sample string 11</d2p1:Weight> <d2p1:Year>sample string 7</d2p1:Year> </d2p1:ClsVehicle> </VehicleList> <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </WarningList> </AgvVehicle>