Jump to

• Request
• Response

Set or Update a Customer's Threshold

put

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

Sets or updates the threshold value for the specified customer.

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 identifier.

Body ()

The threshold information object.

Root Schema : ExternalThresholdRequest

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

{
    "type":"object",
    "properties":{
        "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."
        }
    }
}

Back to Top

Response

204 Response

Threshold has been successfully updated for the specified customer.

400 Response

Utility does not support setting thresholds. Threshold is either negative or too high.

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.

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