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": "f14dc3e8-9187-4fe2-bb1d-e4608e9d4264",
  "name": "sample string 2",
  "description": "sample string 3",
  "code": "sample string 4",
  "_parent_id": "4fed5c69-f442-4871-a9b9-54ad189da97a",
  "_parent_code": "sample string 6",
  "sales_organization_id": "9f26f150-0f6b-4116-ac37-6e39be455962",
  "sales_organization_code": "sample string 8",
  "sales_organization": {
    "id": "16d9013f-cfd0-4aca-8317-4e72ba9caea5",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "db_country_id": "947a885c-211e-4631-be47-ed6ee8f0f0fa",
    "db_currency_id": "a7eb0835-f8b4-418f-9894-597cdf77cdd5",
    "db_language_id": "f507e2de-48e4-4bf9-8824-0249f655938b",
    "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-07-17T10:25:36.3028991+00:00"
  },
  "modified_dateutc": "2025-07-17T10:25:36.3028991+00:00"
}