Jump to

• Request
• Response

Get Threshold Value for a Customer

get

/apis/threshold-v1/external/{utilityCode}/customers/{utilityCustomerId}/threshold

Returns a customer's threshold value using the utility customer identifier registered in the system.

Request

Path Parameters

• utilityCode(required): string
  Maximum Length: 4

  3-4 character utility representation, all caps. E.g. "UTIL", "ZOK1", "BGE".
• utilityCustomerId(required): string
  Utility internal customer ID

Back to Top

Response

200 Response

Returns the customer's threshold value.

Body ()

Root Schema : ExternalThresholdResponse

Type: object

Show Source

• response(required): object response

{
    "type":"object",
    "properties":{
        "response":{
            "type":"object",
            "properties":{
                "utilityCode":{
                    "type":"string",
                    "description":"The utility code requested"
                },
                "utilityCustomerId":{
                    "type":"string",
                    "description":"The customer ID the utility uses to identify the customer"
                },
                "threshold":{
                    "type":"number",
                    "format":"float",
                    "description":"The threshold value for the customer"
                },
                "percentage":{
                    "type":"number",
                    "format":"float",
                    "description":"The threshold value for the customer, represented as a percentage value. The value can range from 0 to 1000."
                }
            },
            "required":[
                "utilityCode",
                "utilityCustomerId"
            ]
        }
    },
    "required":[
        "response"
    ]
}

Nested Schema : response

Type: object

Show Source

• percentage: number(float)
  The threshold value for the customer, represented as a percentage value. The value can range from 0 to 1000.
• threshold: number(float)
  The threshold value for the customer
• utilityCode(required): string
  The utility code requested
• utilityCustomerId(required): string
  The customer ID the utility uses to identify the customer

{
    "type":"object",
    "properties":{
        "utilityCode":{
            "type":"string",
            "description":"The utility code requested"
        },
        "utilityCustomerId":{
            "type":"string",
            "description":"The customer ID the utility uses to identify the customer"
        },
        "threshold":{
            "type":"number",
            "format":"float",
            "description":"The threshold value for the customer"
        },
        "percentage":{
            "type":"number",
            "format":"float",
            "description":"The threshold value for the customer, represented as a percentage value. The value can range from 0 to 1000."
        }
    },
    "required":[
        "utilityCode",
        "utilityCustomerId"
    ]
}

400 Response

Utility does not support setting thresholds.

Body ()

Root Schema : ErrorDetails

Type: object

Show Source

• error(required): object error

{
    "type":"object",
    "properties":{
        "error":{
            "type":"object",
            "properties":{
                "httpStatus":{
                    "type":"integer",
                    "format":"int32",
                    "description":"The HTTP status code for the error"
                },
                "serviceErrorCode":{
                    "type":"string",
                    "description":"The identifying error code"
                },
                "details":{
                    "type":"string",
                    "description":"Additional details about the error"
                }
            },
            "required":[
                "httpStatus",
                "serviceErrorCode",
                "details"
            ]
        }
    },
    "required":[
        "error"
    ]
}

Nested Schema : error

Type: object

Show Source

• details(required): string
  Additional details about the error
• httpStatus(required): integer(int32)
  The HTTP status code for the error
• serviceErrorCode(required): string
  The identifying error code

{
    "type":"object",
    "properties":{
        "httpStatus":{
            "type":"integer",
            "format":"int32",
            "description":"The HTTP status code for the error"
        },
        "serviceErrorCode":{
            "type":"string",
            "description":"The identifying error code"
        },
        "details":{
            "type":"string",
            "description":"Additional details about the error"
        }
    },
    "required":[
        "httpStatus",
        "serviceErrorCode",
        "details"
    ]
}

404 Response

No customer with the given utilityCustomerId. No threshold set for the requested customer.

Body ()

Root Schema : ErrorDetails

Type: object

Show Source

• error(required): object error

{
    "type":"object",
    "properties":{
        "error":{
            "type":"object",
            "properties":{
                "httpStatus":{
                    "type":"integer",
                    "format":"int32",
                    "description":"The HTTP status code for the error"
                },
                "serviceErrorCode":{
                    "type":"string",
                    "description":"The identifying error code"
                },
                "details":{
                    "type":"string",
                    "description":"Additional details about the error"
                }
            },
            "required":[
                "httpStatus",
                "serviceErrorCode",
                "details"
            ]
        }
    },
    "required":[
        "error"
    ]
}

Nested Schema : error

Type: object

Show Source

• details(required): string
  Additional details about the error
• httpStatus(required): integer(int32)
  The HTTP status code for the error
• serviceErrorCode(required): string
  The identifying error code

{
    "type":"object",
    "properties":{
        "httpStatus":{
            "type":"integer",
            "format":"int32",
            "description":"The HTTP status code for the error"
        },
        "serviceErrorCode":{
            "type":"string",
            "description":"The identifying error code"
        },
        "details":{
            "type":"string",
            "description":"Additional details about the error"
        }
    },
    "required":[
        "httpStatus",
        "serviceErrorCode",
        "details"
    ]
}

Back to Top