GET API/V1/Customization/Units
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Unit Id |
integer |
None. |
| RelatedToUnitId |
Return only units related to the specified unit id |
integer |
None. |
| IncludeNonRelational |
Include non-relational units in the result |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of iMDsoft.API.Metavision.Data.Customization.Unit| Name | Description | Type | Additional information |
|---|---|---|---|
| Unit |
Coded element with unit id, unit name as description, unit code as the code. Serialized as "Unit"; the CLR property is named UnitElement because C# forbids a member sharing the name of its enclosing type (CS0542). |
iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
| Group |
Coded element with unit group id, unit group name as description, unit group code as the code |
iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
| Multiplier |
Multiplier used to convert from this unit relative to the base unit |
decimal number |
None. |
| Addition |
Addition offset applied when converting from this unit relative to the base unit |
decimal number |
None. |
| IsBaseUnit |
Indicates whether this unit is the base unit of its group |
boolean |
None. |
| PerKg |
Indicates whether this unit is expressed per kilogram |
boolean |
None. |
| ParentUnitId |
Parent unit id, when this unit is derived from another unit |
integer |
None. |
| IsRelational |
Indicates whether this unit is relational |
boolean |
None. |
| IsTime |
Indicates whether this unit represents time |
boolean |
None. |
| IsVolume |
Indicates whether this unit represents volume |
boolean |
None. |
Response Formats
application/json, text/json
[
{
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"group": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"multiplier": 1.0,
"addition": 2.0,
"isBaseUnit": true,
"perKg": true,
"parentUnitId": 1,
"isRelational": true,
"isTime": true,
"isVolume": true
},
{
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"group": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"multiplier": 1.0,
"addition": 2.0,
"isBaseUnit": true,
"perKg": true,
"parentUnitId": 1,
"isRelational": true,
"isTime": true,
"isVolume": true
}
]