Oracle Utilities REST API for Metering and Customer Information

Get Notification Preferences

get

/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}

This operation retrieves notification preferences for a person associated with a billing account.

Request

Path Parameters

accountId(required): string
The Account ID is a system-assigned random number that stays with an account for life.
Example:
```
0833559999
```
personId(required): string
Person ID is a system-assigned random number that stays with a person for the life of the system.
Example:
```
3903069999
```

Query Parameters

notificationType: 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 : C1ComPrefer

Type: object

Show Source

accountId: string

Maximum Length: 10

The Account ID is a system-assigned random number that stays with an account for life.

Example: 0833559999
notificationType: string

Maximum Length: 30

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

Example: ZZBUG23605115
notificationTypeList: array notificationTypeList
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

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "example":"0833559999"
        },
        "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"
        },
        "notificationType":{
            "type":"string",
            "maxLength":30,
            "description":"Notification Type displays the code for the notification preferences for the customer in context.",
            "example":"ZZBUG23605115"
        },
        "notificationTypeList":{
            "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"
                    },
                    "isOptOutAllowed":{
                        "type":"boolean",
                        "description":"isOptOutAllowed allows customer to opt out of notification preferences when defined as true.",
                        "example":"true"
                    },
                    "isOptedOut":{
                        "type":"boolean",
                        "description":"isOptedOut is defined as true if a customer opts out of the notifications preferences.",
                        "example":"true"
                    },
                    "optOutPreferenceId":{
                        "type":"string",
                        "maxLength":14,
                        "description":"When opt out is supported, the preference to opt out is also stored in the communication preference entity as Communication Preference Id.",
                        "example":"74703875639999"
                    },
                    "subscriptionOrPush":{
                        "type":"string",
                        "enum":[
                            "C1PU",
                            "C1SU"
                        ],
                        "description":"Subscription/Push defines if a notification is a push or a subscription type notification.\n* `C1PU` - Push,\n* `C1SU` - Subscription",
                        "example":"C1PU"
                    },
                    "otherPushPreferences":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":0,
                        "description":"The Count tallies additional active push preferences for the account and any other related persons. If no other persons have an active preference for the parent notification type, the system uses its default notification method.",
                        "example":"1"
                    },
                    "notificationOption":{
                        "type":"array",
                        "description":"If the notification type is a subscription, an optional list of notification option extension fields to capture",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Sequence if the notification type is a subscription that allows for an option to be set.",
                                    "example":"10"
                                },
                                "label":{
                                    "type":"string",
                                    "maxLength":60,
                                    "description":"Label of the option if allowed for the subscription notification type.",
                                    "example":"Days Before"
                                },
                                "dataType":{
                                    "type":"string",
                                    "maxLength":106,
                                    "description":"Data type lookup field for the option value.",
                                    "example":"NUMB"
                                },
                                "required":{
                                    "type":"string",
                                    "enum":[
                                        "N   ",
                                        "Y   "
                                    ],
                                    "description":"Required Y or N flag\n* `N   ` - No,\n* `Y   ` - Yes",
                                    "example":"N"
                                },
                                "precision":{
                                    "type":"number",
                                    "maximum":"9999999999",
                                    "minimum":"-9999999999",
                                    "description":"Precision, if numeric",
                                    "example":"1"
                                },
                                "scale":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Scale, if numeric",
                                    "example":"0"
                                },
                                "sign":{
                                    "type":"boolean",
                                    "description":"Sign, if numeric",
                                    "example":"false"
                                },
                                "transactionalBOXpath":{
                                    "type":"string",
                                    "maxLength":4000,
                                    "description":"Path to the option value being stored.",
                                    "example":"dueInfo/numberOfDaysBeforeDue"
                                },
                                "value":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Value of the option that is set for the customer subscription.",
                                    "example":"3"
                                },
                                "validValue":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "label":{
                                                "type":"string",
                                                "maxLength":10,
                                                "description":"Label of the notification option parameter value that can be provided as a setting.",
                                                "example":"Account Balance"
                                            },
                                            "value":{
                                                "type":"string",
                                                "maxLength":254,
                                                "description":"Value of the option that is set for the customer subscription.",
                                                "example":"3"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "notificationPreferenceList":{
                        "type":"array",
                        "description":"A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types",
                        "items":{
                            "type":"object",
                            "properties":{
                                "deliveryType":{
                                    "type":"string",
                                    "enum":[
                                        "EMAI",
                                        "FAX ",
                                        "IVR ",
                                        "MPSH",
                                        "SMS "
                                    ],
                                    "description":"Delivery type\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `MPSH` - Mobile Application Push,\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":"The Notification Preference ID is the unique system generated primary key for the Notification Preference record.",
                                    "example":"95058374991172"
                                },
                                "keepPreference":{
                                    "type":"boolean",
                                    "description":"Keep preference flag can be true or false for contact preferences.",
                                    "example":"false"
                                },
                                "notificationOption":{
                                    "type":"array",
                                    "description":"If the notification type is a subscription, an optional list of notification option extension fields to capture",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "sequence":{
                                                "type":"number",
                                                "maximum":999,
                                                "minimum":-999,
                                                "description":"Sequence if the notification type is a subscription that allows for an option to be set.",
                                                "example":"10"
                                            },
                                            "value":{
                                                "type":"string",
                                                "maxLength":254,
                                                "description":"Value of the option that is set for the customer subscription.",
                                                "example":"3"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1ComPrefer"
    }
}

Nested Schema : notificationTypeList

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"
            },
            "isOptOutAllowed":{
                "type":"boolean",
                "description":"isOptOutAllowed allows customer to opt out of notification preferences when defined as true.",
                "example":"true"
            },
            "isOptedOut":{
                "type":"boolean",
                "description":"isOptedOut is defined as true if a customer opts out of the notifications preferences.",
                "example":"true"
            },
            "optOutPreferenceId":{
                "type":"string",
                "maxLength":14,
                "description":"When opt out is supported, the preference to opt out is also stored in the communication preference entity as Communication Preference Id.",
                "example":"74703875639999"
            },
            "subscriptionOrPush":{
                "type":"string",
                "enum":[
                    "C1PU",
                    "C1SU"
                ],
                "description":"Subscription/Push defines if a notification is a push or a subscription type notification.\n* `C1PU` - Push,\n* `C1SU` - Subscription",
                "example":"C1PU"
            },
            "otherPushPreferences":{
                "type":"number",
                "maximum":99999,
                "minimum":0,
                "description":"The Count tallies additional active push preferences for the account and any other related persons. If no other persons have an active preference for the parent notification type, the system uses its default notification method.",
                "example":"1"
            },
            "notificationOption":{
                "type":"array",
                "description":"If the notification type is a subscription, an optional list of notification option extension fields to capture",
                "items":{
                    "type":"object",
                    "properties":{
                        "sequence":{
                            "type":"number",
                            "maximum":999,
                            "minimum":-999,
                            "description":"Sequence if the notification type is a subscription that allows for an option to be set.",
                            "example":"10"
                        },
                        "label":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Label of the option if allowed for the subscription notification type.",
                            "example":"Days Before"
                        },
                        "dataType":{
                            "type":"string",
                            "maxLength":106,
                            "description":"Data type lookup field for the option value.",
                            "example":"NUMB"
                        },
                        "required":{
                            "type":"string",
                            "enum":[
                                "N   ",
                                "Y   "
                            ],
                            "description":"Required Y or N flag\n* `N   ` - No,\n* `Y   ` - Yes",
                            "example":"N"
                        },
                        "precision":{
                            "type":"number",
                            "maximum":"9999999999",
                            "minimum":"-9999999999",
                            "description":"Precision, if numeric",
                            "example":"1"
                        },
                        "scale":{
                            "type":"number",
                            "maximum":999,
                            "minimum":-999,
                            "description":"Scale, if numeric",
                            "example":"0"
                        },
                        "sign":{
                            "type":"boolean",
                            "description":"Sign, if numeric",
                            "example":"false"
                        },
                        "transactionalBOXpath":{
                            "type":"string",
                            "maxLength":4000,
                            "description":"Path to the option value being stored.",
                            "example":"dueInfo/numberOfDaysBeforeDue"
                        },
                        "value":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Value of the option that is set for the customer subscription.",
                            "example":"3"
                        },
                        "validValue":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "label":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Label of the notification option parameter value that can be provided as a setting.",
                                        "example":"Account Balance"
                                    },
                                    "value":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Value of the option that is set for the customer subscription.",
                                        "example":"3"
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "notificationPreferenceList":{
                "type":"array",
                "description":"A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types",
                "items":{
                    "type":"object",
                    "properties":{
                        "deliveryType":{
                            "type":"string",
                            "enum":[
                                "EMAI",
                                "FAX ",
                                "IVR ",
                                "MPSH",
                                "SMS "
                            ],
                            "description":"Delivery type\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `MPSH` - Mobile Application Push,\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":"The Notification Preference ID is the unique system generated primary key for the Notification Preference record.",
                            "example":"95058374991172"
                        },
                        "keepPreference":{
                            "type":"boolean",
                            "description":"Keep preference flag can be true or false for contact preferences.",
                            "example":"false"
                        },
                        "notificationOption":{
                            "type":"array",
                            "description":"If the notification type is a subscription, an optional list of notification option extension fields to capture",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "sequence":{
                                        "type":"number",
                                        "maximum":999,
                                        "minimum":-999,
                                        "description":"Sequence if the notification type is a subscription that allows for an option to be set.",
                                        "example":"10"
                                    },
                                    "value":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Value of the option that is set for the customer subscription.",
                                        "example":"3"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

isOptedOut: boolean

isOptedOut is defined as true if a customer opts out of the notifications preferences.

Example: true
isOptOutAllowed: boolean

isOptOutAllowed allows customer to opt out of notification preferences when defined as true.

Example: true
notificationOption: array notificationOption

If the notification type is a subscription, an optional list of notification option extension fields to capture
notificationPreferenceList: array notificationPreferenceList

A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types
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
optOutPreferenceId: string

Maximum Length: 14

When opt out is supported, the preference to opt out is also stored in the communication preference entity as Communication Preference Id.

Example: 74703875639999
otherPushPreferences: number

Minimum Value: 0

Maximum Value: 99999

The Count tallies additional active push preferences for the account and any other related persons. If no other persons have an active preference for the parent notification type, the system uses its default notification method.

Example: 1
subscriptionOrPush: string

Allowed Values: [ "C1PU", "C1SU" ]

Subscription/Push defines if a notification is a push or a subscription type notification. * `C1PU` - Push, * `C1SU` - Subscription

Example: C1PU

{
    "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"
        },
        "isOptOutAllowed":{
            "type":"boolean",
            "description":"isOptOutAllowed allows customer to opt out of notification preferences when defined as true.",
            "example":"true"
        },
        "isOptedOut":{
            "type":"boolean",
            "description":"isOptedOut is defined as true if a customer opts out of the notifications preferences.",
            "example":"true"
        },
        "optOutPreferenceId":{
            "type":"string",
            "maxLength":14,
            "description":"When opt out is supported, the preference to opt out is also stored in the communication preference entity as Communication Preference Id.",
            "example":"74703875639999"
        },
        "subscriptionOrPush":{
            "type":"string",
            "enum":[
                "C1PU",
                "C1SU"
            ],
            "description":"Subscription/Push defines if a notification is a push or a subscription type notification.\n* `C1PU` - Push,\n* `C1SU` - Subscription",
            "example":"C1PU"
        },
        "otherPushPreferences":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"The Count tallies additional active push preferences for the account and any other related persons. If no other persons have an active preference for the parent notification type, the system uses its default notification method.",
            "example":"1"
        },
        "notificationOption":{
            "type":"array",
            "description":"If the notification type is a subscription, an optional list of notification option extension fields to capture",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence if the notification type is a subscription that allows for an option to be set.",
                        "example":"10"
                    },
                    "label":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Label of the option if allowed for the subscription notification type.",
                        "example":"Days Before"
                    },
                    "dataType":{
                        "type":"string",
                        "maxLength":106,
                        "description":"Data type lookup field for the option value.",
                        "example":"NUMB"
                    },
                    "required":{
                        "type":"string",
                        "enum":[
                            "N   ",
                            "Y   "
                        ],
                        "description":"Required Y or N flag\n* `N   ` - No,\n* `Y   ` - Yes",
                        "example":"N"
                    },
                    "precision":{
                        "type":"number",
                        "maximum":"9999999999",
                        "minimum":"-9999999999",
                        "description":"Precision, if numeric",
                        "example":"1"
                    },
                    "scale":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Scale, if numeric",
                        "example":"0"
                    },
                    "sign":{
                        "type":"boolean",
                        "description":"Sign, if numeric",
                        "example":"false"
                    },
                    "transactionalBOXpath":{
                        "type":"string",
                        "maxLength":4000,
                        "description":"Path to the option value being stored.",
                        "example":"dueInfo/numberOfDaysBeforeDue"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Value of the option that is set for the customer subscription.",
                        "example":"3"
                    },
                    "validValue":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "label":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Label of the notification option parameter value that can be provided as a setting.",
                                    "example":"Account Balance"
                                },
                                "value":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Value of the option that is set for the customer subscription.",
                                    "example":"3"
                                }
                            }
                        }
                    }
                }
            }
        },
        "notificationPreferenceList":{
            "type":"array",
            "description":"A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types",
            "items":{
                "type":"object",
                "properties":{
                    "deliveryType":{
                        "type":"string",
                        "enum":[
                            "EMAI",
                            "FAX ",
                            "IVR ",
                            "MPSH",
                            "SMS "
                        ],
                        "description":"Delivery type\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `MPSH` - Mobile Application Push,\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":"The Notification Preference ID is the unique system generated primary key for the Notification Preference record.",
                        "example":"95058374991172"
                    },
                    "keepPreference":{
                        "type":"boolean",
                        "description":"Keep preference flag can be true or false for contact preferences.",
                        "example":"false"
                    },
                    "notificationOption":{
                        "type":"array",
                        "description":"If the notification type is a subscription, an optional list of notification option extension fields to capture",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Sequence if the notification type is a subscription that allows for an option to be set.",
                                    "example":"10"
                                },
                                "value":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Value of the option that is set for the customer subscription.",
                                    "example":"3"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : notificationOption

Type: array

If the notification type is a subscription, an optional list of notification option extension fields to capture

Show Source

Array of: object items

{
    "type":"array",
    "description":"If the notification type is a subscription, an optional list of notification option extension fields to capture",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence if the notification type is a subscription that allows for an option to be set.",
                "example":"10"
            },
            "label":{
                "type":"string",
                "maxLength":60,
                "description":"Label of the option if allowed for the subscription notification type.",
                "example":"Days Before"
            },
            "dataType":{
                "type":"string",
                "maxLength":106,
                "description":"Data type lookup field for the option value.",
                "example":"NUMB"
            },
            "required":{
                "type":"string",
                "enum":[
                    "N   ",
                    "Y   "
                ],
                "description":"Required Y or N flag\n* `N   ` - No,\n* `Y   ` - Yes",
                "example":"N"
            },
            "precision":{
                "type":"number",
                "maximum":"9999999999",
                "minimum":"-9999999999",
                "description":"Precision, if numeric",
                "example":"1"
            },
            "scale":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Scale, if numeric",
                "example":"0"
            },
            "sign":{
                "type":"boolean",
                "description":"Sign, if numeric",
                "example":"false"
            },
            "transactionalBOXpath":{
                "type":"string",
                "maxLength":4000,
                "description":"Path to the option value being stored.",
                "example":"dueInfo/numberOfDaysBeforeDue"
            },
            "value":{
                "type":"string",
                "maxLength":254,
                "description":"Value of the option that is set for the customer subscription.",
                "example":"3"
            },
            "validValue":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "label":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Label of the notification option parameter value that can be provided as a setting.",
                            "example":"Account Balance"
                        },
                        "value":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Value of the option that is set for the customer subscription.",
                            "example":"3"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : notificationPreferenceList

Type: array

A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types

Show Source

Array of: object items

{
    "type":"array",
    "description":"A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types",
    "items":{
        "type":"object",
        "properties":{
            "deliveryType":{
                "type":"string",
                "enum":[
                    "EMAI",
                    "FAX ",
                    "IVR ",
                    "MPSH",
                    "SMS "
                ],
                "description":"Delivery type\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `MPSH` - Mobile Application Push,\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":"The Notification Preference ID is the unique system generated primary key for the Notification Preference record.",
                "example":"95058374991172"
            },
            "keepPreference":{
                "type":"boolean",
                "description":"Keep preference flag can be true or false for contact preferences.",
                "example":"false"
            },
            "notificationOption":{
                "type":"array",
                "description":"If the notification type is a subscription, an optional list of notification option extension fields to capture",
                "items":{
                    "type":"object",
                    "properties":{
                        "sequence":{
                            "type":"number",
                            "maximum":999,
                            "minimum":-999,
                            "description":"Sequence if the notification type is a subscription that allows for an option to be set.",
                            "example":"10"
                        },
                        "value":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Value of the option that is set for the customer subscription.",
                            "example":"3"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

dataType: string

Maximum Length: 106

Data type lookup field for the option value.

Example: NUMB
label: string

Maximum Length: 60

Label of the option if allowed for the subscription notification type.

Example: Days Before
precision: number

Minimum Value: -9999999999

Maximum Value: 9999999999

Precision, if numeric

Example: 1
required: string

Allowed Values: [ "N ", "Y " ]

Required Y or N flag * `N ` - No, * `Y ` - Yes

Example: N
scale: number

Minimum Value: -999

Maximum Value: 999

Scale, if numeric

Example: 0
sequence: number

Minimum Value: -999

Maximum Value: 999

Sequence if the notification type is a subscription that allows for an option to be set.

Example: 10
sign: boolean

Sign, if numeric

Example: false
transactionalBOXpath: string

Maximum Length: 4000

Path to the option value being stored.

Example: dueInfo/numberOfDaysBeforeDue
validValue: array validValue
value: string

Maximum Length: 254

Value of the option that is set for the customer subscription.

Example: 3

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence if the notification type is a subscription that allows for an option to be set.",
            "example":"10"
        },
        "label":{
            "type":"string",
            "maxLength":60,
            "description":"Label of the option if allowed for the subscription notification type.",
            "example":"Days Before"
        },
        "dataType":{
            "type":"string",
            "maxLength":106,
            "description":"Data type lookup field for the option value.",
            "example":"NUMB"
        },
        "required":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"Required Y or N flag\n* `N   ` - No,\n* `Y   ` - Yes",
            "example":"N"
        },
        "precision":{
            "type":"number",
            "maximum":"9999999999",
            "minimum":"-9999999999",
            "description":"Precision, if numeric",
            "example":"1"
        },
        "scale":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Scale, if numeric",
            "example":"0"
        },
        "sign":{
            "type":"boolean",
            "description":"Sign, if numeric",
            "example":"false"
        },
        "transactionalBOXpath":{
            "type":"string",
            "maxLength":4000,
            "description":"Path to the option value being stored.",
            "example":"dueInfo/numberOfDaysBeforeDue"
        },
        "value":{
            "type":"string",
            "maxLength":254,
            "description":"Value of the option that is set for the customer subscription.",
            "example":"3"
        },
        "validValue":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "label":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Label of the notification option parameter value that can be provided as a setting.",
                        "example":"Account Balance"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Value of the option that is set for the customer subscription.",
                        "example":"3"
                    }
                }
            }
        }
    }
}

Nested Schema : validValue

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "label":{
                "type":"string",
                "maxLength":10,
                "description":"Label of the notification option parameter value that can be provided as a setting.",
                "example":"Account Balance"
            },
            "value":{
                "type":"string",
                "maxLength":254,
                "description":"Value of the option that is set for the customer subscription.",
                "example":"3"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

label: string

Maximum Length: 10

Label of the notification option parameter value that can be provided as a setting.

Example: Account Balance
value: string

Maximum Length: 254

Value of the option that is set for the customer subscription.

Example: 3

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string",
            "maxLength":10,
            "description":"Label of the notification option parameter value that can be provided as a setting.",
            "example":"Account Balance"
        },
        "value":{
            "type":"string",
            "maxLength":254,
            "description":"Value of the option that is set for the customer subscription.",
            "example":"3"
        }
    }
}

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 ", "MPSH", "SMS " ]

Delivery type * `EMAI` - Email, * `FAX ` - Fax, * `IVR ` - IVR, * `MPSH` - Mobile Application Push, * `SMS ` - SMS

Example: SMS
deliveryTypeDescription: string

Maximum Length: 60

Delivery type description

Example: SMS
keepPreference: boolean

Keep preference flag can be true or false for contact preferences.

Example: false
nickname: string

Maximum Length: 100

Person contact details nickname
notificationOption: array notificationOption

If the notification type is a subscription, an optional list of notification option extension fields to capture
notificationPreferenceId: string

Maximum Length: 14

The Notification Preference ID is the unique system generated primary key for the Notification Preference record.

Example: 95058374991172

{
    "type":"object",
    "properties":{
        "deliveryType":{
            "type":"string",
            "enum":[
                "EMAI",
                "FAX ",
                "IVR ",
                "MPSH",
                "SMS "
            ],
            "description":"Delivery type\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `MPSH` - Mobile Application Push,\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":"The Notification Preference ID is the unique system generated primary key for the Notification Preference record.",
            "example":"95058374991172"
        },
        "keepPreference":{
            "type":"boolean",
            "description":"Keep preference flag can be true or false for contact preferences.",
            "example":"false"
        },
        "notificationOption":{
            "type":"array",
            "description":"If the notification type is a subscription, an optional list of notification option extension fields to capture",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence if the notification type is a subscription that allows for an option to be set.",
                        "example":"10"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Value of the option that is set for the customer subscription.",
                        "example":"3"
                    }
                }
            }
        }
    }
}

Nested Schema : notificationOption

Type: array

If the notification type is a subscription, an optional list of notification option extension fields to capture

Show Source

Array of: object items

{
    "type":"array",
    "description":"If the notification type is a subscription, an optional list of notification option extension fields to capture",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence if the notification type is a subscription that allows for an option to be set.",
                "example":"10"
            },
            "value":{
                "type":"string",
                "maxLength":254,
                "description":"Value of the option that is set for the customer subscription.",
                "example":"3"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

sequence: number

Minimum Value: -999

Maximum Value: 999

Sequence if the notification type is a subscription that allows for an option to be set.

Example: 10
value: string

Maximum Length: 254

Value of the option that is set for the customer subscription.

Example: 3

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence if the notification type is a subscription that allows for an option to be set.",
            "example":"10"
        },
        "value":{
            "type":"string",
            "maxLength":254,
            "description":"Value of the option that is set for the customer subscription.",
            "example":"3"
        }
    }
}

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