Get Subcategories

GET https://api.boomandbucket.com/taxonomyservice/taxonomy/subcategory

This endpoint retrieves detailed taxonomy information for a specific subcategory of equipment.

Response Format

The response is a JSON object representing a subcategory, with the following fields:

  • entityId: An object containing a unique identifier (value) for the subcategory.
  • name: An object with translations array providing subcategory names in multiple languages.
  • slug: A string representing a URL-friendly version of the subcategory name.
  • taxonomizedCategoryId: An object with a value field indicating the associated category ID.
  • usedForIds: An array of objects, each with a value field indicating IDs for which the subcategory is Used For. Used For is a way to describe the various industries a piece of equipment may be in.
  • meterTypeForValuation: An object detailing the type of meter used for valuation, with translations.
  • marketplaceCategory: An object containing details about the marketplace category, such as ID, slug, synonyms, and image URI.

Translations Object

The translations arrays in name and meterTypeForValuation contain objects for each supported language, each with fields:

  • languageId (integer): The ID for the language.
  • languageShortCode (string): A short code representing the language.
  • text (string): The translated text for the subcategory or meter type.
  • description (string): A description of the text in the specific language.

Sample Response

[
  {
    "entityId": {
      "value": "bf3641e5-7d59-4dc0-92f4-93812620c14c"
    },
    "name": {
      "translations": [
        {
          "languageId": 0,
          "languageShortCode": "en_US",
          "text": "Aerial Work Platforms",
          "description": "Aerial Work Platforms"
        },
        {
          "languageId": 1,
          "languageShortCode": "es_MX",
          "text": "",
          "description": ""
        },
        {
          "languageId": 2,
          "languageShortCode": "fr_CA",
          "text": "",
          "description": ""
        }
      ]
    },
    "slug": "aerial-work-platforms",
    "taxonomizedCategoryId": {
      "value": "97a349a8-7700-422f-978b-b3be154172e7"
    },
    "usedForIds": [
      {
        "value": 7
      },
      {
        "value": 8
      },
      {
        "value": 9
      },
      {
        "value": 11
      },
      {
        "value": 12
      },
      {
        "value": 13
      },
      {
        "value": 14
      },
      {
        "value": 15
      },
      {
        "value": 16
      },
      {
        "value": 17
      },
      {
        "value": 22
      }
    ],
    "meterTypeForValuation": {
      "displayName": {
        "translations": [
          {
            "languageId": 0,
            "languageShortCode": "en_US",
            "text": "Operating Hours",
            "description": "Operating hours for an engine"
          },
          {
            "languageId": 1,
            "languageShortCode": "es_MX",
            "text": "",
            "description": ""
          },
          {
            "languageId": 2,
            "languageShortCode": "fr_CA",
            "text": "",
            "description": ""
          }
        ]
      },
      "name": "EngineOperatingTime",
      "id": 0,
      "rawTranslationKey": "EngineOperatingTime",
      "translationKey": "enum.EngineOperatingTime"
    },
    "marketplaceCategory": {
      "id": {
        "value": 47291582
      },
      "slug": "lifts",
      "synonyms": [
        "lifts",
        "lift",
        "Articulated Boom Lift",
        "Platform Lift"
      ],
      "categoryState": 1,
      "imageUri": "https://via.placeholder.com/250",
      "translationKey": "eq.lifts",
      "category": null
    }
  }
]

RESPONSES

status: OK

[{"entityId":{"value":"bf3641e5-7d59-4dc0-92f4-93812620c14c"},"name":{"translations":[{"languageId":0,"languageShortCode":"en_US","text":"Aerial Work Platforms","description":"Aerial Work Platforms"},{"languageId":1,"languageShortCode":"es_MX","text":"","description":""},{"languageId":2,"languageShortCode":"fr_CA","text":"","description":""}]},"slug":"aerial-work-platforms","taxonomizedCategoryId":{"value":"97a349a8-7700-422f-978b-b3be154172e7"},"usedForIds":[{"value":7},{"value":8},{"value":9},{"value":11},{"value":12},{"value":13},{"value":14},{"value":15},{"value":16},{"value":17},{"value":22}],"meterTypeForValuation":{"displayName":{"translations":[{"languageId":0,"languageShortCode":"en_US","text":"Operating Hours","description":"Operating hours for an engine"},{"languageId":1,"languageShortCode":"es_MX","text":"","description":""},{"languageId":2,"languageShortCode":"fr_CA","text":"","description":""}]},"name":"EngineOperatingTime","id":0,"rawTranslationKey":"EngineOperatingTime","translationKey":"enum.EngineOperatingTime"},"marketplaceCategory":{"id":{"value":47291582},"slug":"lifts","synonyms":["lifts","lift","Articulated Boom Lift","Platform Lift"],"categoryState":1,"imageUri":"https://via.placeholder.com/250","translationKey":"eq.lifts","category":null}},{"entityId":{"value":"0e017b03-6230-42ee-b0ab-f5e214c94f74"},"name":{"translations":[{"languageId":0,"languageShortCode":"en_US","text":"All Terrain Cranes","description":"All Terrain Cranes"},{"languageId":1,"languageShortCode":"es_MX","text":"","description":""},{"languageId":2,"languageShortCode":"fr_CA","text":"","description":""}]},"slug":"all-terrain-cranes","taxonomizedCategoryId":{"value":"412c362c-cde5-4cac-b4bd-79a41f3ab104"},"usedForIds":[{"value":6},{"value":19}],"meterTypeForValuation":{"displayName":{"translations":[{"languageId":0,"languageShortCode":"en_US","text":"Operating Hours","description":"Operating hours for an engine"},{"languageId":1,"languageShortCode":"es_MX","text":"","description":""},{"languageId":2,"languageShortCode":"fr_CA","text":"","description":""}]},"name":"EngineOperatingTime","id":0,"rawTranslationKey":"EngineOperatingTime","translationKey":"enum.EngineOperatingTime"},"marketplaceCategory":{"id":{"value":22443233},"slug":"cranes","synonyms":["cranes","crane","Mounted Boom Truck Crane"],"categoryState":1,"imageUri":"https://via.placeholder.com/250","translationKey":"eq.cranes","category":null}},{"entityId":{"value":"4f9b04ef-6aa7-4abb-bae9-35e39e7e22d5"},"name":{"translations":[{"languageId":0,"languageShortCode":"en_US","text":"Articulated Tractors","description":"Articulated Tractors"},{"languageId":1,"languageShortCode":"es_MX","text":"","description":""},{"languageId":2,"languageShortCode":"fr_CA","text":"","description":""}]},"slug":"articulated-tractors","taxonomizedCategoryId":{"value":"ef2978b0-8aa9-4432-9265-986e56eb14c5"},"usedForIds":[],"meterTypeForValuation":{"displayName":{"translations":[{"languageId":0,"languageShortCode":"en_US","text":"Operating Hours","description":"Operating hours for an engine"},{"languageId":1,"languageShortCode":"es_MX","text":"","description":""},{"languageId":2,"languageShortCode":"fr_CA","text":"","description":""}]},"name":"EngineOperatingTime","id":0,"rawTranslationKey":"EngineOperatingTime","translationKey":"enum.EngineOperatingTime"},"marketplaceCategory":{"id":{"value":12222059},"slug":"agricultural-equipment","synonyms":["agriculturalequipment","agriculturalequipment","Round Balers","Combine","Utility Tractors","Zero-Turn Mowers","Combines","Tractor Loaders","Compact Utility Tractors","Manure Spreaders","Lawn \u0026 Garden Tractors","Rakes","Planters: Drawn","Bale Spears, etc.","Miscellaneous Tractor Attachments","Combine Platforms","Rotary Cutters: Heavy-Duty","Grain Carts","Baler","Mower Conditioners","Tractor","Field Cultivators","Row Crop Tractors","Stand-On Mowers","Bale Wrappers","Compact Utility Tractor","Compact Tractor","Miscellaneous Ag","Corn and Row Crop headers","Header carts","Windrower","Vertical Tillage","Self-Propelled Forage Harvesters","Rototillers","Planter","Rippers","Rotary Cutters","Precision Ag","Gravity Wagon","Tedders","Anhydrous Application","Attachments for Harvesting","Commercial Walk-Behind Mowers","Cutting Platform","Attachments for Hay","Track Tractors","Attachments: Tillage","Gravity Wagons and Boxes","Square Balers","Bale Grinders \u0026 Feeders","Rake","Rotary Cutters: Medium-Duty","Harvester","Grain Auger","Fertilizer Spreaders","Lawn Mower","Brush Mower","Self-Propelled Sprayers","Rolling Harrows","Snow Blowers for Lawn \u0026 Garden Tractors","Farm Tractor Mounted Blades, Box Blades","Moldboard Plows","Dry Spinner Spreaders","Mower Conditioner","Grooming Mowers","Compact and Garden Tractor Blades","Grooming Mower","Attachments for Lawn \u0026 Garden Tractors","Miscellaneous Turf","Mower","Bale Accumulators","Heavy Harrows","Hay Mowers Mounted","Disks","Bale Stabber","Strip Tillers","Mowers for Lawn \u0026 Garden Tractors","Bales Movers","Self-Propelled Applicators","Large Square Balers","Self Propelled Applicator","Harrow","Commercial Mowing Attachments","Gas Tiller"],"categoryState":1,"imageUri":"https://via.placeholder.com/250","translationKey":"eq.agricultural-equipment","category":null}}]