Oracle Utilities REST API for Metering and Customer Information

Get Customer Activity History

get

https://server:port/spl/rest/apis/customer/interactions/customerActivityHistory/{accountId}

This operation retrieves the particular account's activity history.

Request

Path Parameters

accountId(required): string

Query Parameters

fromDateTime(required): string
limit: number
toDateTime(required): string

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1-GtCuAcHi

Type: object

Show Source

accountId: string

Maximum Length: 10

The Account ID for which the customer activity history is returned.

Example: 1589809888
fromDateTime: string (date-time)

From Date Time is a required input of date range for which the customer activity history is returned.
interactions: array interactions
interactionTypes: array interactionTypes
limit: number

Minimum Value: 0

Maximum Value: 99999

The limit element is an integer value that specifies the paging size for number of records to return when serving a client request.

Example: 20
toDateTime: string (date-time)

To Date Time is a required input of date range for which the customer activity history is returned.

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The Account ID for which the customer activity history is returned.",
            "example":"1589809888"
        },
        "fromDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"From Date Time is a required input of date range for which the customer activity history is returned."
        },
        "toDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"To Date Time is a required input of date range for which the customer activity history is returned."
        },
        "limit":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"The limit element is an integer value that specifies the paging size for number of records to return when serving a client request.",
            "example":"20"
        },
        "interactions":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"string",
                        "maxLength":14,
                        "description":"Unique identifier of the row.  This is a concatenation of the \"activity type\" and the entity PK 1-5.",
                        "example":"BL549134324111"
                    },
                    "interactionDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Account Activity Date Time",
                        "example":"2008-11-01T00:00:00-04:00"
                    },
                    "interactionType":{
                        "type":"string",
                        "maxLength":2,
                        "description":"Account Activity Type",
                        "example":"BL"
                    },
                    "primaryText":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Primary text",
                        "example":"Bill for $1002.43"
                    },
                    "secondaryText":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Secondary text",
                        "example":"Due 11-17-2008"
                    },
                    "tertiaryText":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Tertiary text",
                        "example":"1037 days in bill period"
                    },
                    "displayIconOracle":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Icon Name from Redwood library for example \"ico-contacts.svg\", \"ico-check.svg\". This is the URL value from the display icon reference code definition.",
                        "example":"ico-financials.svg"
                    },
                    "navigationInfo":{
                        "type":"object",
                        "properties":{
                            "navigationType":{
                                "type":"string",
                                "maxLength":32,
                                "description":"Navigation Type is a lookup with valid values: URL, data",
                                "example":"data"
                            },
                            "navigationContext":{
                                "type":"string",
                                "maxLength":32,
                                "description":"Navigation Context includes navigation option, navigation key, context fields(1-5), and context values (1-5).",
                                "example":"navigationOption : customerContactMaint1\n\nnavigationKey: customerContactMaint\n\ncontextField1 : CC_ID\n\ncontextValue1 : 5545313333"
                            }
                        }
                    }
                }
            }
        },
        "interactionTypes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "type":{
                        "type":"string",
                        "maxLength":12,
                        "description":"List of Interaction Type Codes for the client to use upon rendering."
                    },
                    "description":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description of the interaction type value."
                    },
                    "displayIconOracle":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Icon Name from Redwood library for example \"ico-contacts.svg\", \"ico-check.svg\". This is the URL value from the display icon reference code definition.",
                        "example":"ico-financials.svg"
                    },
                    "tags":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Tag value for grouping of Interaction Types by categories."
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1-GtCuAcHi"
    }
}

Nested Schema : interactions

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "maxLength":14,
                "description":"Unique identifier of the row.  This is a concatenation of the \"activity type\" and the entity PK 1-5.",
                "example":"BL549134324111"
            },
            "interactionDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Account Activity Date Time",
                "example":"2008-11-01T00:00:00-04:00"
            },
            "interactionType":{
                "type":"string",
                "maxLength":2,
                "description":"Account Activity Type",
                "example":"BL"
            },
            "primaryText":{
                "type":"string",
                "maxLength":1000,
                "description":"Primary text",
                "example":"Bill for $1002.43"
            },
            "secondaryText":{
                "type":"string",
                "maxLength":1000,
                "description":"Secondary text",
                "example":"Due 11-17-2008"
            },
            "tertiaryText":{
                "type":"string",
                "maxLength":1000,
                "description":"Tertiary text",
                "example":"1037 days in bill period"
            },
            "displayIconOracle":{
                "type":"string",
                "maxLength":12,
                "description":"Icon Name from Redwood library for example \"ico-contacts.svg\", \"ico-check.svg\". This is the URL value from the display icon reference code definition.",
                "example":"ico-financials.svg"
            },
            "navigationInfo":{
                "type":"object",
                "properties":{
                    "navigationType":{
                        "type":"string",
                        "maxLength":32,
                        "description":"Navigation Type is a lookup with valid values: URL, data",
                        "example":"data"
                    },
                    "navigationContext":{
                        "type":"string",
                        "maxLength":32,
                        "description":"Navigation Context includes navigation option, navigation key, context fields(1-5), and context values (1-5).",
                        "example":"navigationOption : customerContactMaint1\n\nnavigationKey: customerContactMaint\n\ncontextField1 : CC_ID\n\ncontextValue1 : 5545313333"
                    }
                }
            }
        }
    }
}

Nested Schema : interactionTypes

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "type":{
                "type":"string",
                "maxLength":12,
                "description":"List of Interaction Type Codes for the client to use upon rendering."
            },
            "description":{
                "type":"string",
                "maxLength":60,
                "description":"Description of the interaction type value."
            },
            "displayIconOracle":{
                "type":"string",
                "maxLength":12,
                "description":"Icon Name from Redwood library for example \"ico-contacts.svg\", \"ico-check.svg\". This is the URL value from the display icon reference code definition.",
                "example":"ico-financials.svg"
            },
            "tags":{
                "type":"string",
                "maxLength":10,
                "description":"Tag value for grouping of Interaction Types by categories."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

displayIconOracle: string

Maximum Length: 12

Icon Name from Redwood library for example "ico-contacts.svg", "ico-check.svg". This is the URL value from the display icon reference code definition.

Example: ico-financials.svg
id: string

Maximum Length: 14

Unique identifier of the row. This is a concatenation of the "activity type" and the entity PK 1-5.

Example: BL549134324111
interactionDateTime: string (date-time)

Account Activity Date Time

Example: 2008-11-01T00:00:00-04:00
interactionType: string

Maximum Length: 2

Account Activity Type

Example: BL
navigationInfo: object navigationInfo
primaryText: string

Maximum Length: 1000

Primary text

Example: Bill for $1002.43
secondaryText: string

Maximum Length: 1000

Secondary text

Example: Due 11-17-2008
tertiaryText: string

Maximum Length: 1000

Tertiary text

Example: 1037 days in bill period

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":14,
            "description":"Unique identifier of the row.  This is a concatenation of the \"activity type\" and the entity PK 1-5.",
            "example":"BL549134324111"
        },
        "interactionDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Account Activity Date Time",
            "example":"2008-11-01T00:00:00-04:00"
        },
        "interactionType":{
            "type":"string",
            "maxLength":2,
            "description":"Account Activity Type",
            "example":"BL"
        },
        "primaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Primary text",
            "example":"Bill for $1002.43"
        },
        "secondaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Secondary text",
            "example":"Due 11-17-2008"
        },
        "tertiaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Tertiary text",
            "example":"1037 days in bill period"
        },
        "displayIconOracle":{
            "type":"string",
            "maxLength":12,
            "description":"Icon Name from Redwood library for example \"ico-contacts.svg\", \"ico-check.svg\". This is the URL value from the display icon reference code definition.",
            "example":"ico-financials.svg"
        },
        "navigationInfo":{
            "type":"object",
            "properties":{
                "navigationType":{
                    "type":"string",
                    "maxLength":32,
                    "description":"Navigation Type is a lookup with valid values: URL, data",
                    "example":"data"
                },
                "navigationContext":{
                    "type":"string",
                    "maxLength":32,
                    "description":"Navigation Context includes navigation option, navigation key, context fields(1-5), and context values (1-5).",
                    "example":"navigationOption : customerContactMaint1\n\nnavigationKey: customerContactMaint\n\ncontextField1 : CC_ID\n\ncontextValue1 : 5545313333"
                }
            }
        }
    }
}

Nested Schema : navigationInfo

Type: object

Show Source

navigationContext: string

Maximum Length: 32

Navigation Context includes navigation option, navigation key, context fields(1-5), and context values (1-5).

Example: navigationOption : customerContactMaint1 navigationKey: customerContactMaint contextField1 : CC_ID contextValue1 : 5545313333
navigationType: string

Maximum Length: 32

Navigation Type is a lookup with valid values: URL, data

Example: data

{
    "type":"object",
    "properties":{
        "navigationType":{
            "type":"string",
            "maxLength":32,
            "description":"Navigation Type is a lookup with valid values: URL, data",
            "example":"data"
        },
        "navigationContext":{
            "type":"string",
            "maxLength":32,
            "description":"Navigation Context includes navigation option, navigation key, context fields(1-5), and context values (1-5).",
            "example":"navigationOption : customerContactMaint1\n\nnavigationKey: customerContactMaint\n\ncontextField1 : CC_ID\n\ncontextValue1 : 5545313333"
        }
    }
}

Nested Schema : items

Type: object

Show Source

description: string

Maximum Length: 60

Description of the interaction type value.
displayIconOracle: string

Maximum Length: 12

Icon Name from Redwood library for example "ico-contacts.svg", "ico-check.svg". This is the URL value from the display icon reference code definition.

Example: ico-financials.svg
tags: string

Maximum Length: 10

Tag value for grouping of Interaction Types by categories.
type: string

Maximum Length: 12

List of Interaction Type Codes for the client to use upon rendering.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "maxLength":12,
            "description":"List of Interaction Type Codes for the client to use upon rendering."
        },
        "description":{
            "type":"string",
            "maxLength":60,
            "description":"Description of the interaction type value."
        },
        "displayIconOracle":{
            "type":"string",
            "maxLength":12,
            "description":"Icon Name from Redwood library for example \"ico-contacts.svg\", \"ico-check.svg\". This is the URL value from the display icon reference code definition.",
            "example":"ico-financials.svg"
        },
        "tags":{
            "type":"string",
            "maxLength":10,
            "description":"Tag value for grouping of Interaction Types by categories."
        }
    }
}

400 Response

Bad Request

Root Schema : problemDetailDocument

Type: object

Show Source

detail: string

Maximum Length: 60

The long message description from the Oracle Utilities Application Framework in CDATA format.
httpStatus: number

Minimum Value: 0

Maximum Value: 9999

The HTTP Status code for the error.
problemInstance: string

Maximum Length: 60

Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
problemType: string

Maximum Length: 60

URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
serverMessage: object serverMessage
stackTrace: string

Maximum Length: 60

The stack trace shows where the error occurs during the execution of a program.
title: string

Maximum Length: 60

Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

callSequence: string

Maximum Length: 60

Delimited sequence of programs called.
longDescription: string

Maximum Length: 60

The long message description from the Oracle Utilities Application Framework in CDATA format.
messageCategory: number

Minimum Value: 0

Maximum Value: 0

Message Category within Oracle Utilities Application Framework.
messageNbr: number

Minimum Value: -99999

Maximum Value: 99999

Message Number within Oracle Utilities Application Framework.
messageText: string

Maximum Length: 60

Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
programName: string

Maximum Length: 60

Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Root Schema : problemDetailDocument

Type: object

Show Source

detail: string

Maximum Length: 60

The long message description from the Oracle Utilities Application Framework in CDATA format.
httpStatus: number

Minimum Value: 0

Maximum Value: 9999

The HTTP Status code for the error.
problemInstance: string

Maximum Length: 60

Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
problemType: string

Maximum Length: 60

URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
serverMessage: object serverMessage
stackTrace: string

Maximum Length: 60

The stack trace shows where the error occurs during the execution of a program.
title: string

Maximum Length: 60

Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

callSequence: string

Maximum Length: 60

Delimited sequence of programs called.
longDescription: string

Maximum Length: 60

The long message description from the Oracle Utilities Application Framework in CDATA format.
messageCategory: number

Minimum Value: 0

Maximum Value: 0

Message Category within Oracle Utilities Application Framework.
messageNbr: number

Minimum Value: -99999

Maximum Value: 99999

Message Number within Oracle Utilities Application Framework.
messageText: string

Maximum Length: 60

Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
programName: string

Maximum Length: 60

Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}