Oracle Utilities REST API for Metering and Customer Information

Outage Events Persons Summary

post

/rest/apis/customer/service/outageEvent/personsSummary

This operation returns a summary of open, planned, and recently restored outages for a list of persons. For example, businesses managed by a key account manager or businesses of a related account hierarchy.

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

filters: object filters

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"object",
            "properties":{
                "persons":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "personId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"An optional input filter to find outage events for the Person ID."
                            },
                            "externalId":{
                                "type":"string",
                                "maxLength":60,
                                "description":"External ID"
                            }
                        }
                    }
                },
                "includeRecentlyRestored":{
                    "type":"boolean",
                    "description":"This field indicates if recently restored outage events should be included in the results."
                }
            }
        }
    },
    "xml":{
        "name":"C1OEPerSumry"
    }
}

Nested Schema : filters

Type: object

Show Source

includeRecentlyRestored: boolean

This field indicates if recently restored outage events should be included in the results.
persons: array persons

{
    "type":"object",
    "properties":{
        "persons":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"An optional input filter to find outage events for the Person ID."
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External ID"
                    }
                }
            }
        },
        "includeRecentlyRestored":{
            "type":"boolean",
            "description":"This field indicates if recently restored outage events should be included in the results."
        }
    }
}

Nested Schema : persons

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"An optional input filter to find outage events for the Person ID."
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External ID"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

externalId: string

Maximum Length: 60

External ID
personId: string

Maximum Length: 10

An optional input filter to find outage events for the Person ID.

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"An optional input filter to find outage events for the Person ID."
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External ID"
        }
    }
}

Root Schema : schema

Type: object

Show Source

filters: object filters

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"object",
            "properties":{
                "persons":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "personId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"An optional input filter to find outage events for the Person ID."
                            },
                            "externalId":{
                                "type":"string",
                                "maxLength":60,
                                "description":"External ID"
                            }
                        }
                    }
                },
                "includeRecentlyRestored":{
                    "type":"boolean",
                    "description":"This field indicates if recently restored outage events should be included in the results."
                }
            }
        }
    },
    "xml":{
        "name":"C1OEPerSumry"
    }
}

Nested Schema : filters

Type: object

Show Source

includeRecentlyRestored: boolean

This field indicates if recently restored outage events should be included in the results.
persons: array persons

{
    "type":"object",
    "properties":{
        "persons":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"An optional input filter to find outage events for the Person ID."
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External ID"
                    }
                }
            }
        },
        "includeRecentlyRestored":{
            "type":"boolean",
            "description":"This field indicates if recently restored outage events should be included in the results."
        }
    }
}

Nested Schema : persons

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"An optional input filter to find outage events for the Person ID."
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External ID"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

externalId: string

Maximum Length: 60

External ID
personId: string

Maximum Length: 10

An optional input filter to find outage events for the Person ID.

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"An optional input filter to find outage events for the Person ID."
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External ID"
        }
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1OEPerSumry

Type: object

Show Source

outageEventsSummary: array outageEventsSummary

{
    "type":"object",
    "properties":{
        "outageEventsSummary":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"An optional input filter to find outage events for the Person ID."
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External ID"
                    },
                    "countOpenEvents":{
                        "type":"number",
                        "maximum":999999,
                        "minimum":0,
                        "description":"The count of open outage events for the input criteria."
                    },
                    "countScheduledEvents":{
                        "type":"number",
                        "maximum":999999,
                        "minimum":0,
                        "description":"The count of scheduled events for the input criteria."
                    },
                    "countRecentlyRestoredEvents":{
                        "type":"number",
                        "maximum":999999,
                        "minimum":0,
                        "description":"The count of recently restored outage events for the input criteria."
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1OEPerSumry"
    }
}

Nested Schema : outageEventsSummary

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"An optional input filter to find outage events for the Person ID."
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External ID"
            },
            "countOpenEvents":{
                "type":"number",
                "maximum":999999,
                "minimum":0,
                "description":"The count of open outage events for the input criteria."
            },
            "countScheduledEvents":{
                "type":"number",
                "maximum":999999,
                "minimum":0,
                "description":"The count of scheduled events for the input criteria."
            },
            "countRecentlyRestoredEvents":{
                "type":"number",
                "maximum":999999,
                "minimum":0,
                "description":"The count of recently restored outage events for the input criteria."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

countOpenEvents: number

Minimum Value: 0

Maximum Value: 999999

The count of open outage events for the input criteria.
countRecentlyRestoredEvents: number

Minimum Value: 0

Maximum Value: 999999

The count of recently restored outage events for the input criteria.
countScheduledEvents: number

Minimum Value: 0

Maximum Value: 999999

The count of scheduled events for the input criteria.
externalId: string

Maximum Length: 60

External ID
personId: string

Maximum Length: 10

An optional input filter to find outage events for the Person ID.

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"An optional input filter to find outage events for the Person ID."
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External ID"
        },
        "countOpenEvents":{
            "type":"number",
            "maximum":999999,
            "minimum":0,
            "description":"The count of open outage events for the input criteria."
        },
        "countScheduledEvents":{
            "type":"number",
            "maximum":999999,
            "minimum":0,
            "description":"The count of scheduled events for the input criteria."
        },
        "countRecentlyRestoredEvents":{
            "type":"number",
            "maximum":999999,
            "minimum":0,
            "description":"The count of recently restored outage events for the input criteria."
        }
    }
}

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