ListClasses

Returns a list of object classes in a specified classifier. The action can also return the metadata associated with each object class and the labels of the images associated with each object class.

Type: synchronous

Parameter Description Required
classifier The name of the classifier that contains the object classes. Yes
imagelabels A Boolean value (default false) that specifies whether to return the labels of images associated with each object class. No
maxresults The maximum number of object classes to return in the response. No
metadata A Boolean value (default false) that specifies whether to return the metadata associated with each object class. No
start The starting point for the list when you set the maxresults parameter. For example, to start listing object classes from the tenth object class in the classifier, set start=10. The entries in the classifier are indexed from 1. No

Example

The following example lists up to 10 object classes contained in the vehicles classifier:

/action=ListClasses&classifier=vehicles
                   &metadata=TRUE
                   &imagelabels=TRUE
                   &start=1
                   &maxresults=10

Response

The response always includes the identifier of each object class that is returned. The following example response also includes metadata and image labels:

<autnresponse>
  <action>LISTCLASSES</action>
  <response>SUCCESS</response>
  <responsedata>
    <class>
      <identifier>cars</identifier>
      <imagelabels>
        <imagelabel>car1</imagelabel>
        <imagelabel>car2</imagelabel>
        ...
      </imagelabels>
      <metadata>
        <item>
          <key>Name</key>
          <value>Value</value>
        </item>
        ...
      </metadata>
    </class>
    <class>
      <identifier>vans</identifier>
      <imagelabels>
        <imagelabel>van1</imagelabel>
        <imagelabel>van2</imagelabel>
        <imagelabel>van3</imagelabel>
        ...
      </imagelabels>
    </class>
  </responsedata>
</autnresponse>

_HP_HTML5_bannerTitle.htm