Jump to

• Request
• Response

Update Tip Action

post

/apis/tips-v1/{utilityCode}/energy_guide/customers/{id}/tips/{tipId}/action

Updates the customer's currently recorded action for the tip. Default value for all of a customer's tips is NOT_YET.

Request

Path Parameters

• id(required): integer
  The unique identifier of the customer.
• tipId(required): string
  The unique identifier of the tip.
• utilityCode(required): string
  A 3- or 4-character representation of the client code, in all uppercase characters. Valid example "UTIL".

Body ()

The tip action to record, for example {"status": "DONE"}.

Root Schema : TipActionUpdateRequest

Type: object

Update Tip Status

Show Source

• status(required): string
  Allowed Values: [ "DONE", "WILL_DO", "NO_THANKS", "NOT_YET" ]

  The status of a tip for a particular customer.

{
    "type":"object",
    "description":"Update Tip Status",
    "required":[
        "status"
    ],
    "properties":{
        "status":{
            "$ref":"#/definitions/CustomersTipStatus"
        }
    },
    "example":{
        "status":"WILL_DO"
    }
}

Example:

{
    "status":"WILL_DO"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful response

Body ()

Root Schema : TipActionUpdateResponse

Type: object

Show Source

• response: boolean
  true, confirming that update was succesful

{
    "type":"object",
    "properties":{
        "response":{
            "description":"true, confirming that update was succesful",
            "type":"boolean"
        }
    },
    "example":{
        "response":true
    }
}

Example:

{
    "response":true
}

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