Jump to

• Request
• Response

Get Customer List

get

/apis/customer-data-v2/{utilityCode}/customers

Returns the list of customers satisfying the query parameters.

Request

Path Parameters

• utilityCode(required): string
  A 3- or 4-character representation of the client code. Valid examples - "UTIL" and "util"

Query Parameters

• accountNumber(required): string
  Customer account number
• name: string
  The customer's name. Valid example - "Bobby%20Fischer"

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Customers matching this query returned.

Body ()

Root Schema : CustomersResponse

Type: object

Show Source

• response: array response

{
    "type":"object",
    "properties":{
        "response":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Customer"
            }
        }
    },
    "example":{
        "response":{
            "id":1071,
            "name":"David Bowie",
            "recipient":"RECIPIENT",
            "utilityCustomerId":"1872099045-387109999",
            "utilityInternalId":"1872099045",
            "utilityInternalId2":"18720-99045"
        }
    }
}

Example:

{
    "response":{
        "id":1071,
        "name":"David Bowie",
        "recipient":"RECIPIENT",
        "utilityCustomerId":"1872099045-387109999",
        "utilityInternalId":"1872099045",
        "utilityInternalId2":"18720-99045"
    }
}

Nested Schema : response

Type: array

Show Source

• Array of: object Customer

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Customer"
    }
}

Nested Schema : Customer

Type: object

Show Source

• id: integer
  The internal customer id

  Example: 31
• name: string
  The customer's name

  Example: David Bowie
• recipient: string
  Allowed Values: [ "RECIPIENT", "CONTROL" ]

  Whether this customer is a recipient, or in the control group. This field is optional

  Example: RECIPIENT
• utilityCustomerId: string
  The utility-company-provided customer id

  Example: 1872099045-387109999
• utilityInternalId: string
  The internal utility id for this customer. This field is optional

  Example: 1872099045
• utilityInternalId2: string
  A second internal utility id for this customer. This field is optional

  Example: 18720-99045

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"The internal customer id",
            "example":31
        },
        "name":{
            "type":"string",
            "description":"The customer's name",
            "example":"David Bowie"
        },
        "recipient":{
            "$ref":"#/definitions/Recipient"
        },
        "utilityCustomerId":{
            "type":"string",
            "description":"The utility-company-provided customer id",
            "example":"1872099045-387109999"
        },
        "utilityInternalId":{
            "type":"string",
            "description":"The internal utility id for this customer.  This field is optional",
            "example":"1872099045"
        },
        "utilityInternalId2":{
            "type":"string",
            "description":"A second internal utility id for this customer.  This field is optional",
            "example":"18720-99045"
        }
    }
}

400 Response

Invalid request

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• details: string
  Details about the error.
• errorMessage: string
  Short failure explanation.
• httpStatus: integer
  Minimum Value: 100

  Maximum Value: 600

  The HTTP status code for the error.
• serviceErrorCode: string
  An error code for the error.

{
    "type":"object",
    "properties":{
        "httpStatus":{
            "description":"The HTTP status code for the error.",
            "type":"integer",
            "minimum":100,
            "maximum":600
        },
        "serviceErrorCode":{
            "description":"An error code for the error.",
            "type":"string"
        },
        "errorMessage":{
            "description":"Short failure explanation.",
            "type":"string"
        },
        "details":{
            "description":"Details about the error.",
            "type":"string"
        }
    },
    "additionalProperties":false
}

401 Response

Authorization failure

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• details: string
  Details about the error.
• errorMessage: string
  Short failure explanation.
• httpStatus: integer
  Minimum Value: 100

  Maximum Value: 600

  The HTTP status code for the error.
• serviceErrorCode: string
  An error code for the error.

{
    "type":"object",
    "properties":{
        "httpStatus":{
            "description":"The HTTP status code for the error.",
            "type":"integer",
            "minimum":100,
            "maximum":600
        },
        "serviceErrorCode":{
            "description":"An error code for the error.",
            "type":"string"
        },
        "errorMessage":{
            "description":"Short failure explanation.",
            "type":"string"
        },
        "details":{
            "description":"Details about the error.",
            "type":"string"
        }
    },
    "additionalProperties":false
}

404 Response

Customer not found

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• details: string
  Details about the error.
• errorMessage: string
  Short failure explanation.
• httpStatus: integer
  Minimum Value: 100

  Maximum Value: 600

  The HTTP status code for the error.
• serviceErrorCode: string
  An error code for the error.

{
    "type":"object",
    "properties":{
        "httpStatus":{
            "description":"The HTTP status code for the error.",
            "type":"integer",
            "minimum":100,
            "maximum":600
        },
        "serviceErrorCode":{
            "description":"An error code for the error.",
            "type":"string"
        },
        "errorMessage":{
            "description":"Short failure explanation.",
            "type":"string"
        },
        "details":{
            "description":"Details about the error.",
            "type":"string"
        }
    },
    "additionalProperties":false
}

500 Response

Internal error

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• details: string
  Details about the error.
• errorMessage: string
  Short failure explanation.
• httpStatus: integer
  Minimum Value: 100

  Maximum Value: 600

  The HTTP status code for the error.
• serviceErrorCode: string
  An error code for the error.

{
    "type":"object",
    "properties":{
        "httpStatus":{
            "description":"The HTTP status code for the error.",
            "type":"integer",
            "minimum":100,
            "maximum":600
        },
        "serviceErrorCode":{
            "description":"An error code for the error.",
            "type":"string"
        },
        "errorMessage":{
            "description":"Short failure explanation.",
            "type":"string"
        },
        "details":{
            "description":"Details about the error.",
            "type":"string"
        }
    },
    "additionalProperties":false
}

Back to Top