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": "9d13818f-a61b-46ec-8e46-fb2b62df8730",
  "name": "sample string 2",
  "description": "sample string 3",
  "code": "sample string 4",
  "_parent_id": "b064c834-3d0a-4ff8-8042-40dcab7837dc",
  "_parent_code": "sample string 6",
  "sales_organization_id": "c9341584-c2a6-4776-939b-677c37313ed4",
  "sales_organization_code": "sample string 8",
  "sales_organization": {
    "id": "d173e5a2-15c4-4171-80d6-52d821817a57",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "db_country_id": "a62131a3-d2dd-4e32-8f99-776f8559c5b1",
    "db_currency_id": "f190eaa8-0f24-4f70-bb8d-3259e71568f0",
    "db_language_id": "75c10c75-d2a4-40c8-b85b-681d279e573b",
    "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-06-21T12:16:45.2370483+00:00"
  },
  "modified_dateutc": "2025-06-21T12:16:45.2370483+00:00"
}