Retrieves the equipment_family object with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

equipment_family
NameDescriptionTypeAdditional information
id

Primary Key

 globally unique identifier

Required
name

Name of the equipment family

 string

Required

Max length: 50
description

Description of the equipment family

 string

Max length: 4000
code

The Id/Ref of the back office. Used by Embedded entity

 string

Max length: 50
_parent_id

Parent Equipment Family (Parent / Child) when adding/updating equipment_family

 globally unique identifier
_parent_code

Embedded entity "equipment_family" for parent (Parent / Child) using ERP PK when adding/updating equipment_family

 string
_parent_equipment_family

Embedded entity "equipment_family" for parent (Parent / Child) when adding/updating equipment_family

 equipment_family
sales_organization_id

FK of sales_organization. Filled if specific of one SO, empty if can be used by all

 globally unique identifier
sales_organization_code

Embedded entity "sales_organization" using ERP PK when adding/updating company_type

 string
sales_organization

Embedded entity "sales_organization" when adding/updating company_type

 sales_organization
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

 date

Response Formats

application/json, text/json

Sample: 
{
  "id": "c8a53438-a843-4477-bc7d-64964d268d82",
  "name": "sample string 2",
  "description": "sample string 3",
  "code": "sample string 4",
  "_parent_id": "614204de-fab5-4d70-9a4d-54e067bdeed8",
  "_parent_code": "sample string 6",
  "sales_organization_id": "7b58666e-55d8-4065-8adc-6405019981fc",
  "sales_organization_code": "sample string 8",
  "sales_organization": {
    "id": "fe4b9411-1d0e-430b-a9f0-4293fb479cb2",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "db_country_id": "f1fcc465-508f-4a7c-a572-76ab0780c846",
    "db_currency_id": "157f8442-0e85-4af3-93c8-b2a9d699202e",
    "db_language_id": "89bd74c7-69c2-46ca-9bca-2a1a44a85676",
    "accountancy_code": "sample string 8",
    "archived": true,
    "default_unit_of_measure_system_type": "sample string 10",
    "street": "sample string 11",
    "street2": "sample string 12",
    "street_number": "sample string 13",
    "zip": "sample string 14",
    "city": "sample string 15",
    "email": "sample string 16",
    "phone": "sample string 17",
    "fax": "sample string 18",
    "url": "sample string 19",
    "vat_reg_code": "sample string 20",
    "modified_dateutc": "2025-10-16T05:38:42.521999+00:00"
  },
  "modified_dateutc": "2025-10-16T05:38:42.521999+00:00"
}