Retrieves the equipment_family object with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
equipment_family| Name | Description | Type | Additional 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
{
"id": "00fa4809-9291-4842-a39e-bff15fd7c612",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "89b539f7-c7b8-4166-b596-5132c1123eb2",
"_parent_code": "sample string 6",
"sales_organization_id": "30b8916c-1013-4eb0-85c9-e5581761c250",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "88d8d184-e65e-4daf-8c3e-485f95cc5f83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84427c2c-0866-4cc7-a4b4-9f350d511e4e",
"db_currency_id": "b55b4c56-5575-4f7a-8940-fa541718cea2",
"db_language_id": "714881c7-ec75-4206-be42-e98945637575",
"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-13T17:20:41.2001377+00:00"
},
"modified_dateutc": "2025-10-13T17:20:41.2163366+00:00"
}