ListVehicleModels

Returns a list of vehicle models in a specified database. The action can also return information about the images and metadata associated with each vehicle model.

Type: synchronous

Parameter Description Required
database The name of the database that contains the vehicle models. Yes
identifier A comma-separated list of identifiers to specify the vehicle models to list. If you do not set this parameter, Media Server lists all of the vehicle models in the specified database. No
imagestatus A Boolean value (default false) that specifies whether to return the label and training status of each image associated with each vehicle model. No
maxresults The maximum number of vehicle models to return. No
metadata A Boolean value (default false) that specifies whether to return the metadata associated with each vehicle model. No
start The starting point for the list when you set the maxresults parameter. For example, to start listing vehicle models from the tenth model in the database, set start=10. The entries in the database are indexed from 1. No

Example

The following example lists up to 10 vehicle models contained in the Cars database:

/action=ListVehicleModels&database=Cars
                         &imagestatus=TRUE
                         &metadata=TRUE
                         &start=1
                         &maxresults=10

Response

The response always includes the following information for each vehicle model:

If you set the action parameter imagestatus to true, Media Server returns the status of each training image associated with each vehicle model.

<autnresponse>
  <action>LISTVEHICLEMODELS</action>
  <response>SUCCESS</response>
  <responsedata>
    <entry>
      <identifier>FordFocusRS</identifier>
      <numimages>3</numimages>
      <numtrained>1</numtrained>
      <numfailed>1</numfailed>
      <numuntrained>1</numuntrained>
      <vehiclemake>Ford</vehiclemake>
      <images>
        <image>
          <label>focus-rs-front</label>
          <status>trained</status>
          <hasimagedata>true</hasimagedata>
        </image>
        <image>
          <label>image2</label>
          <status>untrained</status>
          <hasimagedata>true</hasimagedata>
        </image>
        <image>
          <label>image3</label>
          <status>failed</status>
          <hasimagedata>true</hasimagedata>
        </image>
      </images>
      <metadata>
        <item>
          <key>type</key>
          <value>hatchback</value>
        </item>
      </metadata>
    </entry>
  </responsedata>
</autnresponse>

_HP_HTML5_bannerTitle.htm