GET Vehicle/GetVehicle?active={active}&location={location}&type={type}

Get a list of vehicles.

Request Information

URI Parameters

Name	Description	Type	Additional Information
active	Whether the vehicles are active or inactive (0 = All, 1 = Active Only, 2 = Inactive Only)	VehicleActivity	Default value is ActiveOnly
location	Location of the vehicles	string	Default value is string.Empty
type	Type of the vehicles	string	Default value is string.Empty

Body Parameters

Response Information

Resource Description

Get a list of vehicles.

AgvVehicle

Name	Description	Type
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

Sample:

{
  "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-04-29T08:22:24.7087468+00:00",
      "SerialNum": "sample string 9",
      "LicPlate": "sample string 10",
      "LicExpire": "2024-04-29T08:22:24.7087468+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-04-29T08:22:24.7087468+00:00",
      "LastLLTimeReport": "2024-04-29T08:22:24.7087468+00:00",
      "AVLID": "sample string 15",
      "Capacity": 1.1,
      "CapacityType": "sample string 16",
      "AgVehicleGuid": "143f25e8-1a60-4b5c-96bc-04d5a2a6a886",
      "VehiclePlannedAcreList": [
        {
          "PlannedDate": "2024-04-29T08:22:24.7097438+00:00",
          "PlannedAcres": 1.1
        },
        {
          "PlannedDate": "2024-04-29T08:22:24.7097438+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-04-29T08:22:24.7087468+00:00",
      "SerialNum": "sample string 9",
      "LicPlate": "sample string 10",
      "LicExpire": "2024-04-29T08:22:24.7087468+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-04-29T08:22:24.7087468+00:00",
      "LastLLTimeReport": "2024-04-29T08:22:24.7087468+00:00",
      "AVLID": "sample string 15",
      "Capacity": 1.1,
      "CapacityType": "sample string 16",
      "AgVehicleGuid": "143f25e8-1a60-4b5c-96bc-04d5a2a6a886",
      "VehiclePlannedAcreList": [
        {
          "PlannedDate": "2024-04-29T08:22:24.7097438+00:00",
          "PlannedAcres": 1.1
        },
        {
          "PlannedDate": "2024-04-29T08:22:24.7097438+00:00",
          "PlannedAcres": 1.1
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<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>143f25e8-1a60-4b5c-96bc-04d5a2a6a886</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-04-29T08:22:24.7087468+00:00</d2p1:LastLLDateReport>
      <d2p1:LastLLTimeReport>2024-04-29T08:22:24.7087468+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-04-29T08:22:24.7087468+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-04-29T08:22:24.7087468+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-04-29T08:22:24.7097438+00:00</d2p1:PlannedDate>
        </d2p1:ClsVehicle.ClsVehiclePlannedAcres>
        <d2p1:ClsVehicle.ClsVehiclePlannedAcres>
          <d2p1:PlannedAcres>1.1</d2p1:PlannedAcres>
          <d2p1:PlannedDate>2024-04-29T08:22:24.7097438+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>143f25e8-1a60-4b5c-96bc-04d5a2a6a886</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-04-29T08:22:24.7087468+00:00</d2p1:LastLLDateReport>
      <d2p1:LastLLTimeReport>2024-04-29T08:22:24.7087468+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-04-29T08:22:24.7087468+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-04-29T08:22:24.7087468+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-04-29T08:22:24.7097438+00:00</d2p1:PlannedDate>
        </d2p1:ClsVehicle.ClsVehiclePlannedAcres>
        <d2p1:ClsVehicle.ClsVehiclePlannedAcres>
          <d2p1:PlannedAcres>1.1</d2p1:PlannedAcres>
          <d2p1:PlannedDate>2024-04-29T08:22:24.7097438+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>