HolderTypeView

Holder type information

organizationCodestringrequired

Organization code

Default value:

Example: ORG123

codestringrequired

Code of the holder type

Default value:

Example: BUILDING

typestringrequired

Type category

Default value:

Example: ASSET

naturestring | nullnullable

Nature of the holder type (PHYSICAL, LOGICAL, PROPERTY_DYNAMIC)

Default value:

Example: PHYSICAL

equipmentDestinationstring | nullnullable

Equipment destination classification

Default value:

Example: WALL

names object[]required

Localized names for this holder type

Array [

singularstringrequired

Singular form of the name

Default value:

Example: Building

pluralstringrequired

Plural form of the name

Default value:

Example: Buildings

languagestringrequired

Language code

Default value:

Example: en

]

numberOfAssetsint32nullable

Number of assets of this holder type

Default value:

Example: 42

importErrors object

oneOf

• ImportErrors
• null

duplicatesint32required

Number of duplicate entries

Default value:

Example: 0

othersint32required

Number of other errors

Default value:

Example: 0

recommendedPropertyCodesstring[]required

Codes of properties recommended for this holder type

Default value:

Example: ["PROP_AREA","PROP_HEIGHT"]

mandatoryPropertyCodesstring[]required

Codes of properties mandatory for this holder type

Default value:

Example: ["PROP_REFERENCE"]

HolderTypeView

{
  "organizationCode": "ORG123",
  "code": "BUILDING",
  "type": "ASSET",
  "nature": "PHYSICAL",
  "equipmentDestination": "WALL",
  "names": [
    {
      "singular": "Building",
      "plural": "Buildings",
      "language": "en"
    }
  ],
  "numberOfAssets": 42,
  "importErrors": {
    "duplicates": 0,
    "others": 0
  },
  "recommendedPropertyCodes": [
    "PROP_AREA",
    "PROP_HEIGHT"
  ],
  "mandatoryPropertyCodes": [
    "PROP_REFERENCE"
  ]
}