Oracle Utilities REST API for Metering and Customer Information

Get Push Notification Details

get

/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{notificationType}/getNotificationDetails

This operation retrieves handling of a parent push notification type for an account, and indicates whether it is opted out. If not, it returns an active preferences or, if none, the default recipient for each type.

Request

Path Parameters

accountId(required): string
The Account ID is a system-assigned random number that stays with an account for life.
Example:
```
0833559999
```
notificationType(required): string
Notification Type displays the code for the notification preferences for the customer in context.
Example:
```
ZZBUG23605115
```

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1PushNtfDts

Type: object

Show Source

defaultDetails: object defaultDetails
isOptedOut: boolean

opt out
notificationPreferences: array notificationPreferences

{
    "type":"object",
    "properties":{
        "isOptedOut":{
            "type":"boolean",
            "description":"opt out"
        },
        "notificationPreferences":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                        "example":"3903069999"
                    },
                    "personName":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The Person Name captures the legal name of the person or business. The name is case sensitive.",
                        "example":"Dowd,Pat"
                    },
                    "deliveryType":{
                        "type":"string",
                        "enum":[
                            "EMAI",
                            "FAX ",
                            "IVR ",
                            "SMS "
                        ],
                        "description":"Delivery type\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS",
                        "example":"SMS"
                    },
                    "deliveryTypeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Delivery type description",
                        "example":"SMS"
                    },
                    "contactDetailId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person contact details ID",
                        "example":"3904719666"
                    },
                    "contactDetailValue":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Person contact details value",
                        "example":"1234567"
                    },
                    "nickname":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Person contact details nickname"
                    },
                    "notificationPreferenceId":{
                        "type":"string",
                        "maxLength":14,
                        "description":"Communication Preference"
                    }
                }
            }
        },
        "defaultDetails":{
            "type":"object",
            "properties":{
                "individualNotificationTypes":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "notificationType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Notification Type displays the code for the notification preferences for the customer in context.",
                                "example":"ZZBUG23605115"
                            },
                            "notificationTypeDescription":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Notification Type displays the description for the notification preferences for the customer in context.",
                                "example":"Test for Bug 23605115"
                            },
                            "personId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                                "example":"3903069999"
                            },
                            "personName":{
                                "type":"string",
                                "maxLength":254,
                                "description":"The Person Name captures the legal name of the person or business. The name is case sensitive.",
                                "example":"Dowd,Pat"
                            },
                            "deliveryType":{
                                "type":"string",
                                "enum":[
                                    "EMAI",
                                    "FAX ",
                                    "IVR ",
                                    "SMS "
                                ],
                                "description":"Delivery type\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS",
                                "example":"SMS"
                            },
                            "deliveryTypeDescription":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Delivery type description",
                                "example":"SMS"
                            },
                            "contactDetailId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Person contact details ID",
                                "example":"3904719666"
                            },
                            "contactDetailValue":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Person contact details value",
                                "example":"1234567"
                            },
                            "nickname":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Person contact details nickname"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1PushNtfDts"
    }
}

Nested Schema : defaultDetails

Type: object

Show Source

individualNotificationTypes: array individualNotificationTypes

{
    "type":"object",
    "properties":{
        "individualNotificationTypes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "notificationType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Notification Type displays the code for the notification preferences for the customer in context.",
                        "example":"ZZBUG23605115"
                    },
                    "notificationTypeDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Notification Type displays the description for the notification preferences for the customer in context.",
                        "example":"Test for Bug 23605115"
                    },
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                        "example":"3903069999"
                    },
                    "personName":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The Person Name captures the legal name of the person or business. The name is case sensitive.",
                        "example":"Dowd,Pat"
                    },
                    "deliveryType":{
                        "type":"string",
                        "enum":[
                            "EMAI",
                            "FAX ",
                            "IVR ",
                            "SMS "
                        ],
                        "description":"Delivery type\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS",
                        "example":"SMS"
                    },
                    "deliveryTypeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Delivery type description",
                        "example":"SMS"
                    },
                    "contactDetailId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person contact details ID",
                        "example":"3904719666"
                    },
                    "contactDetailValue":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Person contact details value",
                        "example":"1234567"
                    },
                    "nickname":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Person contact details nickname"
                    }
                }
            }
        }
    }
}

Nested Schema : notificationPreferences

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                "example":"3903069999"
            },
            "personName":{
                "type":"string",
                "maxLength":254,
                "description":"The Person Name captures the legal name of the person or business. The name is case sensitive.",
                "example":"Dowd,Pat"
            },
            "deliveryType":{
                "type":"string",
                "enum":[
                    "EMAI",
                    "FAX ",
                    "IVR ",
                    "SMS "
                ],
                "description":"Delivery type\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS",
                "example":"SMS"
            },
            "deliveryTypeDescription":{
                "type":"string",
                "maxLength":60,
                "description":"Delivery type description",
                "example":"SMS"
            },
            "contactDetailId":{
                "type":"string",
                "maxLength":10,
                "description":"Person contact details ID",
                "example":"3904719666"
            },
            "contactDetailValue":{
                "type":"string",
                "maxLength":254,
                "description":"Person contact details value",
                "example":"1234567"
            },
            "nickname":{
                "type":"string",
                "maxLength":100,
                "description":"Person contact details nickname"
            },
            "notificationPreferenceId":{
                "type":"string",
                "maxLength":14,
                "description":"Communication Preference"
            }
        }
    }
}

Nested Schema : individualNotificationTypes

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "notificationType":{
                "type":"string",
                "maxLength":30,
                "description":"Notification Type displays the code for the notification preferences for the customer in context.",
                "example":"ZZBUG23605115"
            },
            "notificationTypeDescription":{
                "type":"string",
                "maxLength":100,
                "description":"Notification Type displays the description for the notification preferences for the customer in context.",
                "example":"Test for Bug 23605115"
            },
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                "example":"3903069999"
            },
            "personName":{
                "type":"string",
                "maxLength":254,
                "description":"The Person Name captures the legal name of the person or business. The name is case sensitive.",
                "example":"Dowd,Pat"
            },
            "deliveryType":{
                "type":"string",
                "enum":[
                    "EMAI",
                    "FAX ",
                    "IVR ",
                    "SMS "
                ],
                "description":"Delivery type\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS",
                "example":"SMS"
            },
            "deliveryTypeDescription":{
                "type":"string",
                "maxLength":60,
                "description":"Delivery type description",
                "example":"SMS"
            },
            "contactDetailId":{
                "type":"string",
                "maxLength":10,
                "description":"Person contact details ID",
                "example":"3904719666"
            },
            "contactDetailValue":{
                "type":"string",
                "maxLength":254,
                "description":"Person contact details value",
                "example":"1234567"
            },
            "nickname":{
                "type":"string",
                "maxLength":100,
                "description":"Person contact details nickname"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

contactDetailId: string

Maximum Length: 10

Person contact details ID

Example: 3904719666
contactDetailValue: string

Maximum Length: 254

Person contact details value

Example: 1234567
deliveryType: string

Allowed Values: [ "EMAI", "FAX ", "IVR ", "SMS " ]

Delivery type * `EMAI` - Email, * `FAX ` - Fax, * `IVR ` - IVR, * `SMS ` - SMS

Example: SMS
deliveryTypeDescription: string

Maximum Length: 60

Delivery type description

Example: SMS
nickname: string

Maximum Length: 100

Person contact details nickname
notificationType: string

Maximum Length: 30

Notification Type displays the code for the notification preferences for the customer in context.

Example: ZZBUG23605115
notificationTypeDescription: string

Maximum Length: 100

Notification Type displays the description for the notification preferences for the customer in context.

Example: Test for Bug 23605115
personId: string

Maximum Length: 10

Person ID is a system-assigned random number that stays with a person for the life of the system.

Example: 3903069999
personName: string

Maximum Length: 254

The Person Name captures the legal name of the person or business. The name is case sensitive.

Example: Dowd,Pat

{
    "type":"object",
    "properties":{
        "notificationType":{
            "type":"string",
            "maxLength":30,
            "description":"Notification Type displays the code for the notification preferences for the customer in context.",
            "example":"ZZBUG23605115"
        },
        "notificationTypeDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Notification Type displays the description for the notification preferences for the customer in context.",
            "example":"Test for Bug 23605115"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
            "example":"3903069999"
        },
        "personName":{
            "type":"string",
            "maxLength":254,
            "description":"The Person Name captures the legal name of the person or business. The name is case sensitive.",
            "example":"Dowd,Pat"
        },
        "deliveryType":{
            "type":"string",
            "enum":[
                "EMAI",
                "FAX ",
                "IVR ",
                "SMS "
            ],
            "description":"Delivery type\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS",
            "example":"SMS"
        },
        "deliveryTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Delivery type description",
            "example":"SMS"
        },
        "contactDetailId":{
            "type":"string",
            "maxLength":10,
            "description":"Person contact details ID",
            "example":"3904719666"
        },
        "contactDetailValue":{
            "type":"string",
            "maxLength":254,
            "description":"Person contact details value",
            "example":"1234567"
        },
        "nickname":{
            "type":"string",
            "maxLength":100,
            "description":"Person contact details nickname"
        }
    }
}

Nested Schema : items

Type: object

Show Source

contactDetailId: string

Maximum Length: 10

Person contact details ID

Example: 3904719666
contactDetailValue: string

Maximum Length: 254

Person contact details value

Example: 1234567
deliveryType: string

Allowed Values: [ "EMAI", "FAX ", "IVR ", "SMS " ]

Delivery type * `EMAI` - Email, * `FAX ` - Fax, * `IVR ` - IVR, * `SMS ` - SMS

Example: SMS
deliveryTypeDescription: string

Maximum Length: 60

Delivery type description

Example: SMS
nickname: string

Maximum Length: 100

Person contact details nickname
notificationPreferenceId: string

Maximum Length: 14

Communication Preference
personId: string

Maximum Length: 10

Person ID is a system-assigned random number that stays with a person for the life of the system.

Example: 3903069999
personName: string

Maximum Length: 254

The Person Name captures the legal name of the person or business. The name is case sensitive.

Example: Dowd,Pat

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
            "example":"3903069999"
        },
        "personName":{
            "type":"string",
            "maxLength":254,
            "description":"The Person Name captures the legal name of the person or business. The name is case sensitive.",
            "example":"Dowd,Pat"
        },
        "deliveryType":{
            "type":"string",
            "enum":[
                "EMAI",
                "FAX ",
                "IVR ",
                "SMS "
            ],
            "description":"Delivery type\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS",
            "example":"SMS"
        },
        "deliveryTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Delivery type description",
            "example":"SMS"
        },
        "contactDetailId":{
            "type":"string",
            "maxLength":10,
            "description":"Person contact details ID",
            "example":"3904719666"
        },
        "contactDetailValue":{
            "type":"string",
            "maxLength":254,
            "description":"Person contact details value",
            "example":"1234567"
        },
        "nickname":{
            "type":"string",
            "maxLength":100,
            "description":"Person contact details nickname"
        },
        "notificationPreferenceId":{
            "type":"string",
            "maxLength":14,
            "description":"Communication Preference"
        }
    }
}

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