Jump to

• Request
• Response

Get Unit of Measure

get

/api/utilitiesAdmin/{version}/unitOfMeasure/{id}

Get details of a specific Unit of Measure record by its id.

Request

Path Parameters

• id(required): string
  Value of resource id field. Example: KW (for admin entity 'unitOfMeasure')
• version(required): string
  API version. Example: v1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Match One Schema

Show Source

• object unitOfMeasure

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/unitOfMeasure"
        }
    ]
}

Nested Schema : unitOfMeasure

Type: object

Show Source

• active: boolean
  Boolean that is true if active, false if inactive.
• code(required): string
  Code for the Unit of Measure.
• description(required): string
  Description
• id(required): string
  Identifier for the Unit of Measure record.
• serviceType(required): string
  Service Type for the Usage being measured.

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string",
            "description":"Service Type for the Usage being measured."
        },
        "code":{
            "type":"string",
            "description":"Code for the Unit of Measure."
        },
        "active":{
            "type":"boolean",
            "description":"Boolean that is true if active, false if inactive."
        },
        "description":{
            "type":"string",
            "description":"Description"
        },
        "id":{
            "type":"string",
            "description":"Identifier for the Unit of Measure record."
        }
    },
    "required":[
        "id",
        "code",
        "description",
        "serviceType"
    ]
}

Examples

Select an example unitOfMeasure

400 Response

An error is encountered due to an invalid request

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common\nlist."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which\ncan be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        }
    }
}

500 Response

An internal server error is encountered, due to an unknown reason

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common\nlist."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which\ncan be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        }
    }
}

Back to Top