Get a measure family

GET

/api/rest/v1/measure-families/{code}

This endpoint allows you to get the information about a given measure family.

Response Example

200 - Example 1

{
    "code": "Area",
    "standard": "SQUARE_METER",
    "units": [
        {
            "code": "SQUARE_MILLIMETER",
            "convert": {
                "mul": "0.001"
            },
            "symbol": "mm²"
        },
        {
            "code": "SQUARE_CENTIMETER",
            "convert": {
                "mul": "0.001"
            },
            "symbol": "cm²"
        }
    ]
}

Request

Path Params

code

string

required

Code of the resource

Responses

🟢200OK

application/json

Body

code

string

required

Measure family code

standard

string

optional

Measure family standard

units

array [object {3}]

optional

Family units

code

string

optional

Measure code

convert

object

optional

Mathematic operation to convert the unit into the standard unit

symbol

string

optional

Measure symbol

🟠401Authentication required

🟠403Access forbidden

🟠404Resource not found

🟠406Not Acceptable

Modified at 2023-08-15 05:53:55

Get list of measure familiy

Get list of measurement families