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": "d77d575f-5797-4e9f-a4dc-5f33df58cca0",
  "name": "sample string 2",
  "description": "sample string 3",
  "code": "sample string 4",
  "_parent_id": "4ef5960c-ebec-49b9-8567-a76a0eee7834",
  "_parent_code": "sample string 6",
  "sales_organization_id": "788b7b2a-eb6b-4eb7-bc5b-7556e18ddbbb",
  "sales_organization_code": "sample string 8",
  "sales_organization": {
    "id": "3ac61755-4f71-4b21-a093-7a7b9cb18b08",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "db_country_id": "1b07ad8b-cdf6-4ae1-9ceb-948d9be16490",
    "db_currency_id": "258779ab-87ac-4589-9553-f4e4ade14e8e",
    "db_language_id": "a5ba8b5e-28c8-4b22-8013-0de211991027",
    "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": "2026-01-14T05:27:44.5394776+00:00"
  },
  "modified_dateutc": "2026-01-14T05:27:44.5394776+00:00"
}