Oracle Utilities REST API for Metering and Customer Information

Get Premise Activity History

get

/rest/apis/customer/interactions/premiseActivityHistory/{premiseId}

This operation retrieves the historical activity history for a premise that may span across multiple customers with service agreements for service points of the premise over time.

Request

Path Parameters

premiseId(required): string
The Premise ID is a system assigned random number that stays with a premise for life.
Example:
```
2242620736
```

Query Parameters

fromDateTime: string
From Date Time is a required input of date range for which the premise activity history is returned.
Example:
```
2016-01-20T20:00:00-08:00
```
limit: number

The limit element is an integer value that specifies the paging size for number of records to return when serving a client request.
toDateTime: string
To Date Time is a required input of date range for which the premise activity history is returned.
Example:
```
2017-01-20T20:00:00-08:00
```

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1PremActHis

Type: object

Show Source

fromDateTime: string (date-time)

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

Example: 2016-01-20T20:00:00-08:00
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.
moreRecordsExist: boolean

The hasMore element indicates whether there are more items or result records to be retrieved.

Example: true
premiseActivities: array premiseActivities
premiseActivityTypes: array premiseActivityTypes
premiseId: string

Maximum Length: 10

The Premise ID is a system assigned random number that stays with a premise for life.

Example: 2242620736
toDateTime: string (date-time)

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

Example: 2017-01-20T20:00:00-08:00

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":"10",
            "description":"The Premise ID is a system assigned random number that stays with a premise for life.",
            "example":"2242620736"
        },
        "fromDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"From Date Time is a required input of date range for which the premise activity history is returned.",
            "example":"2016-01-20T20:00:00-08:00"
        },
        "toDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"To Date Time is a required input of date range for which the premise activity history is returned.",
            "example":"2017-01-20T20:00:00-08:00"
        },
        "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."
        },
        "moreRecordsExist":{
            "type":"boolean",
            "description":"The hasMore element indicates whether there are more items or result records to be retrieved.",
            "example":"true"
        },
        "premiseActivities":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"string",
                        "maxLength":"32",
                        "description":"Unique identifier of the row.",
                        "example":"CC99068699010240467016"
                    },
                    "premiseActivityType":{
                        "type":"string",
                        "maxLength":"12",
                        "description":"Premise Activity Type .For example: SV is Severance Process",
                        "example":"CC"
                    },
                    "premiseActivityDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Premise Activity Date Time",
                        "example":"2016-05-23T20:21:44-07:00"
                    },
                    "primaryText":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Primary text for the premise activities",
                        "example":"Customer Contact - General customer contact"
                    },
                    "secondaryText":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Primary text for the premise activities",
                        "example":"Customer Contact - General customer contact"
                    },
                    "tertiaryText":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Primary text for the premise activities",
                        "example":"Customer Contact - General customer contact"
                    },
                    "displayIconOracle":{
                        "type":"string",
                        "maxLength":"150",
                        "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."
                    },
                    "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"
                            }
                        }
                    }
                }
            }
        },
        "premiseActivityTypes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "premiseActivityType":{
                        "type":"string",
                        "maxLength":"12",
                        "description":"Premise Activity Type .For example: SV is Severance Process",
                        "example":"CC"
                    },
                    "description":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Primary text for the premise activities",
                        "example":"Customer Contact - General customer contact"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1PremActHis"
    }
}

Nested Schema : premiseActivities

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "maxLength":"32",
                "description":"Unique identifier of the row.",
                "example":"CC99068699010240467016"
            },
            "premiseActivityType":{
                "type":"string",
                "maxLength":"12",
                "description":"Premise Activity Type .For example: SV is Severance Process",
                "example":"CC"
            },
            "premiseActivityDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Premise Activity Date Time",
                "example":"2016-05-23T20:21:44-07:00"
            },
            "primaryText":{
                "type":"string",
                "maxLength":"60",
                "description":"Primary text for the premise activities",
                "example":"Customer Contact - General customer contact"
            },
            "secondaryText":{
                "type":"string",
                "maxLength":"60",
                "description":"Primary text for the premise activities",
                "example":"Customer Contact - General customer contact"
            },
            "tertiaryText":{
                "type":"string",
                "maxLength":"60",
                "description":"Primary text for the premise activities",
                "example":"Customer Contact - General customer contact"
            },
            "displayIconOracle":{
                "type":"string",
                "maxLength":"150",
                "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."
            },
            "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 : premiseActivityTypes

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "premiseActivityType":{
                "type":"string",
                "maxLength":"12",
                "description":"Premise Activity Type .For example: SV is Severance Process",
                "example":"CC"
            },
            "description":{
                "type":"string",
                "maxLength":"60",
                "description":"Primary text for the premise activities",
                "example":"Customer Contact - General customer contact"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

displayIconOracle: string

Maximum Length: 150

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.
id: string

Maximum Length: 32

Unique identifier of the row.

Example: CC99068699010240467016
navigationInfo: object navigationInfo
premiseActivityDateTime: string (date-time)

Premise Activity Date Time

Example: 2016-05-23T20:21:44-07:00
premiseActivityType: string

Maximum Length: 12

Premise Activity Type .For example: SV is Severance Process

Example: CC
primaryText: string

Maximum Length: 60

Primary text for the premise activities

Example: Customer Contact - General customer contact
secondaryText: string

Maximum Length: 60

Primary text for the premise activities

Example: Customer Contact - General customer contact
tertiaryText: string

Maximum Length: 60

Primary text for the premise activities

Example: Customer Contact - General customer contact

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"32",
            "description":"Unique identifier of the row.",
            "example":"CC99068699010240467016"
        },
        "premiseActivityType":{
            "type":"string",
            "maxLength":"12",
            "description":"Premise Activity Type .For example: SV is Severance Process",
            "example":"CC"
        },
        "premiseActivityDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Premise Activity Date Time",
            "example":"2016-05-23T20:21:44-07:00"
        },
        "primaryText":{
            "type":"string",
            "maxLength":"60",
            "description":"Primary text for the premise activities",
            "example":"Customer Contact - General customer contact"
        },
        "secondaryText":{
            "type":"string",
            "maxLength":"60",
            "description":"Primary text for the premise activities",
            "example":"Customer Contact - General customer contact"
        },
        "tertiaryText":{
            "type":"string",
            "maxLength":"60",
            "description":"Primary text for the premise activities",
            "example":"Customer Contact - General customer contact"
        },
        "displayIconOracle":{
            "type":"string",
            "maxLength":"150",
            "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."
        },
        "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

Primary text for the premise activities

Example: Customer Contact - General customer contact
premiseActivityType: string

Maximum Length: 12

Premise Activity Type .For example: SV is Severance Process

Example: CC

{
    "type":"object",
    "properties":{
        "premiseActivityType":{
            "type":"string",
            "maxLength":"12",
            "description":"Premise Activity Type .For example: SV is Severance Process",
            "example":"CC"
        },
        "description":{
            "type":"string",
            "maxLength":"60",
            "description":"Primary text for the premise activities",
            "example":"Customer Contact - General customer contact"
        }
    }
}

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."
        }
    }
}