Oracle Utilities REST API for Metering and Customer Information

Get Install Event

get

/rest/apis/meter/v-model/installEvents/{installEventId}

Request

Path Parameters

installEventId(required): string
Install Event ID is a system assigned random number that stays with install event record.
Example:
```
850626819111
```

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : D1InstallEve

Type: object

Show Source

_self: string

_self
armingStatus: string

Allowed Values: [ "D1AM", "D1NA" ]

A flag that indicates if the device has been armed or not. * `D1AM` - Armed, * `D1NA` - Not Armed

Example: D1AM
creationDateTime: string (date-time)

Create Date/Time

Example: 2012-08-24T02:36:22-07:00
crew: string

Maximum Length: 60

Crew
deviceConfiguration: object deviceConfiguration
eventDateTime: string (date-time)

Use Event Date / Time to define when the status changed.

Example: 2021-10-22T00:00:00-11:00
externalId: string

Maximum Length: 60

External ID is used by external system to identify the install event.

Example: 12345
installationConstant: number

Minimum Value: -999999.999999

Maximum Value: 999999.999999

A value (other than 1) used to indicate that when calculating consumption, the installation requires that measurement data be multiplied by this value to get accurate results.

Example: 1.000000
installDateTime: string (date-time)

Installation Date/Time is the date/time when the device was installed at service point.

Example: 2010-01-01T00:00:00-08:00
installEventId: string

Maximum Length: 12

Install Event ID is a system assigned random number that stays with install event record.

Example: 850626819111
mdmExternalId: string

Maximum Length: 60

MDM External ID

Example: 56789
onOffHistory: object onOffHistory
removalDateTime: string (date-time)

Enter the Removal Date/Time showing when the device is removed from the service point.
removalType: string

Allowed Values: [ "D1OE", "D1PR" ]

A flag that indicates the removal type. * `D1OE` - Office Exchange, * `D1PR` - Physical Removal

Example: D1PR
servicePoint: object servicePoint
status: string

Maximum Length: 12

The current status of the install event.

Example: DISCONN-COMM
statusDateTime: string (date-time)

Status Date/Time

Example: 2012-08-24T03:49:39-07:00
statusReason: object statusReason

Status Reason indicates the reason for status change of the install event.
version: number

Minimum Value: -99999

Maximum Value: 99999

The Version number is used for internal concurrency checks.

Example: 1

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "installEventId":{
            "type":"string",
            "maxLength":12,
            "description":"Install Event ID is a system assigned random number that stays with install event record.",
            "example":"850626819111"
        },
        "deviceConfiguration":{
            "type":"object",
            "properties":{
                "deviceConfigurationId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Device Configuration"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "servicePoint":{
            "type":"object",
            "properties":{
                "spId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Service Point ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"The current status of the install event.",
            "example":"DISCONN-COMM"
        },
        "installDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Installation Date/Time is the date/time when the device was installed at service point.",
            "example":"2010-01-01T00:00:00-08:00"
        },
        "installationConstant":{
            "type":"number",
            "maximum":999999.999999,
            "minimum":-999999.999999,
            "description":"A value (other than 1) used to indicate that when calculating consumption, the installation requires that measurement data be multiplied by this value to get accurate results.",
            "example":"1.000000"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External ID is used by external system to identify the install event.",
            "example":"12345"
        },
        "mdmExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"MDM External ID",
            "example":"56789"
        },
        "eventDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Use Event Date / Time to define when the status changed.",
            "example":"2021-10-22T00:00:00-11:00"
        },
        "removalType":{
            "type":"string",
            "enum":[
                "D1OE",
                "D1PR"
            ],
            "description":"A flag that indicates the removal type.\n* `D1OE` - Office Exchange,\n* `D1PR` - Physical Removal",
            "example":"D1PR"
        },
        "crew":{
            "type":"string",
            "maxLength":60,
            "description":"Crew"
        },
        "armingStatus":{
            "type":"string",
            "enum":[
                "D1AM",
                "D1NA"
            ],
            "description":"A flag that indicates if the device has been armed or not.\n* `D1AM` - Armed,\n* `D1NA` - Not Armed",
            "example":"D1AM"
        },
        "statusDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Status Date/Time",
            "example":"2012-08-24T03:49:39-07:00"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time",
            "example":"2012-08-24T02:36:22-07:00"
        },
        "removalDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Enter the Removal Date/Time showing when the device is removed from the service point."
        },
        "statusReason":{
            "type":"object",
            "description":"Status Reason indicates the reason for status change of the install event.",
            "properties":{
                "statusReason":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Status Reason indicates the reason for status change of the install event."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        },
        "onOffHistory":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"A unique Sequence number is given to each entry after the information is saved.",
                                "example":"1"
                            },
                            "eventDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Use Event Date / Time to define when the status changed.",
                                "example":"2021-10-22T00:00:00-11:00"
                            },
                            "deviceOnOffStatus":{
                                "type":"string",
                                "enum":[
                                    "D1OF",
                                    "D1ON"
                                ],
                                "description":"Device On/Off Status:\n* `D1OF` - Off,\n* `D1ON` - On"
                            },
                            "activityId":{
                                "type":"string",
                                "maxLength":14,
                                "description":"Activity ID"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"D1InstallEve"
    }
}

Nested Schema : deviceConfiguration

Type: object

Show Source

_link: string

_link
deviceConfigurationId: string

Maximum Length: 12

Device Configuration

{
    "type":"object",
    "properties":{
        "deviceConfigurationId":{
            "type":"string",
            "maxLength":12,
            "description":"Device Configuration"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : onOffHistory

Type: object

Show Source

_data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"A unique Sequence number is given to each entry after the information is saved.",
                        "example":"1"
                    },
                    "eventDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Use Event Date / Time to define when the status changed.",
                        "example":"2021-10-22T00:00:00-11:00"
                    },
                    "deviceOnOffStatus":{
                        "type":"string",
                        "enum":[
                            "D1OF",
                            "D1ON"
                        ],
                        "description":"Device On/Off Status:\n* `D1OF` - Off,\n* `D1ON` - On"
                    },
                    "activityId":{
                        "type":"string",
                        "maxLength":14,
                        "description":"Activity ID"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : servicePoint

Type: object

Show Source

_link: string

_link
spId: string

Maximum Length: 12

Service Point ID

{
    "type":"object",
    "properties":{
        "spId":{
            "type":"string",
            "maxLength":12,
            "description":"Service Point ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : statusReason

Type: object

Status Reason indicates the reason for status change of the install event.

Show Source

_link: string

_link
statusReason: string

Maximum Length: 30

Status Reason indicates the reason for status change of the install event.

{
    "type":"object",
    "description":"Status Reason indicates the reason for status change of the install event.",
    "properties":{
        "statusReason":{
            "type":"string",
            "maxLength":30,
            "description":"Status Reason indicates the reason for status change of the install event."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"A unique Sequence number is given to each entry after the information is saved.",
                "example":"1"
            },
            "eventDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Use Event Date / Time to define when the status changed.",
                "example":"2021-10-22T00:00:00-11:00"
            },
            "deviceOnOffStatus":{
                "type":"string",
                "enum":[
                    "D1OF",
                    "D1ON"
                ],
                "description":"Device On/Off Status:\n* `D1OF` - Off,\n* `D1ON` - On"
            },
            "activityId":{
                "type":"string",
                "maxLength":14,
                "description":"Activity ID"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"The Version number is used for internal concurrency checks.",
                "example":"1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

activityId: string

Maximum Length: 14

Activity ID
deviceOnOffStatus: string

Allowed Values: [ "D1OF", "D1ON" ]

Device On/Off Status: * `D1OF` - Off, * `D1ON` - On
eventDateTime: string (date-time)

Use Event Date / Time to define when the status changed.

Example: 2021-10-22T00:00:00-11:00
sequence: number

Minimum Value: -99999

Maximum Value: 99999

A unique Sequence number is given to each entry after the information is saved.

Example: 1
version: number

Minimum Value: -99999

Maximum Value: 99999

The Version number is used for internal concurrency checks.

Example: 1

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"A unique Sequence number is given to each entry after the information is saved.",
            "example":"1"
        },
        "eventDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Use Event Date / Time to define when the status changed.",
            "example":"2021-10-22T00:00:00-11:00"
        },
        "deviceOnOffStatus":{
            "type":"string",
            "enum":[
                "D1OF",
                "D1ON"
            ],
            "description":"Device On/Off Status:\n* `D1OF` - Off,\n* `D1ON` - On"
        },
        "activityId":{
            "type":"string",
            "maxLength":14,
            "description":"Activity ID"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        }
    }
}

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