Jump to

• Request
• Response

Get Template Based Notification Types

get

/rest/apis/customer/c1Admin/templateBasedNotifTypes/

This operation retrieves subscription information and individual push template-based notification types.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1ReTmpNtfTy

Type: object

Show Source

• notificationTypes: object notificationTypes

{
    "type":"object",
    "properties":{
        "notificationTypes":{
            "type":"object",
            "properties":{
                "notificationType":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "notificationType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Notification Type indicates the type of Notification used as Notification Preference.",
                                "example":"START-SERVICE-CONFIRMATION"
                            },
                            "notificationPushSub":{
                                "type":"string",
                                "enum":[
                                    "C1PU",
                                    "C1SU"
                                ],
                                "description":"This indicates if the notification type is of subscription or push sub-type.\n* `C1PU` - Push,\n* `C1SU` - Subscription",
                                "example":"C1PU"
                            },
                            "isCustomerContactRequired":{
                                "type":"boolean",
                                "description":"This indicates if the notification type is configured with a customer contact type that is used to record a record of the notification.",
                                "example":"true"
                            },
                            "overrideDoNotDisturb":{
                                "type":"boolean",
                                "description":"Override Do Not Disturb is the boolean value wherein the person permits to receive notifications outside the DND Time range.",
                                "example":"true"
                            },
                            "hasOverrideDelivery":{
                                "type":"boolean",
                                "description":"This indicates if there is an override delivery algorithm plugged into the notification type, meaning the delivery information is obtained from a source other than contact preferences, such as an email address stored on a transaction.",
                                "example":"true"
                            },
                            "descriptions":{
                                "type":"object",
                                "properties":{
                                    "description":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "description":{
                                                    "type":"string",
                                                    "maxLength":100,
                                                    "description":"Description"
                                                },
                                                "language":{
                                                    "type":"string",
                                                    "maxLength":3,
                                                    "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                                                    "example":"ENG"
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "deliveryTypes":{
                                "type":"object",
                                "properties":{
                                    "deliveryType":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "deliveryType":{
                                                    "type":"string",
                                                    "enum":[
                                                        "EMAI",
                                                        "FAX ",
                                                        "IVR ",
                                                        "SMS "
                                                    ],
                                                    "description":"Delivery Type is the type of delivery by which the notification will be sent to the Person Contact.\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS",
                                                    "example":"EMAI"
                                                },
                                                "isDefaultEnabled":{
                                                    "type":"boolean",
                                                    "description":"This indicates if a notification can be sent without an active preference and without an opt-out preference.",
                                                    "example":"true"
                                                },
                                                "templateNames":{
                                                    "type":"object",
                                                    "properties":{
                                                        "templateName":{
                                                            "type":"array",
                                                            "items":{
                                                                "type":"object",
                                                                "properties":{
                                                                    "language":{
                                                                        "type":"string",
                                                                        "maxLength":3,
                                                                        "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                                                                        "example":"ENG"
                                                                    },
                                                                    "templateName":{
                                                                        "type":"string",
                                                                        "maxLength":254,
                                                                        "description":"This is a reference to a value stored in an external system used to send a communication by merging template data with static information.",
                                                                        "example":"BILL_DUE_SUB_EMAIL"
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "parentNotificationType":{
                                "type":"object",
                                "properties":{
                                    "parentNotificationType":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"For individual push notification types, this is the parent type. Preferences are set for the parent type and are used when creating individual push notifications.",
                                        "example":"SERVICE-NOTICES"
                                    },
                                    "allowOptOut":{
                                        "type":"string",
                                        "enum":[
                                            "C1NO",
                                            "C1YS"
                                        ],
                                        "description":"For push notification, this indicates if its parent notification type allows user to opt-out from receiving notifications of that type.\n* `C1NO` - No,\n* `C1YS` - Yes",
                                        "example":"C1YS"
                                    },
                                    "descriptions":{
                                        "type":"object",
                                        "properties":{
                                            "description":{
                                                "type":"array",
                                                "items":{
                                                    "type":"object",
                                                    "properties":{
                                                        "description":{
                                                            "type":"string",
                                                            "maxLength":100,
                                                            "description":"Description"
                                                        },
                                                        "language":{
                                                            "type":"string",
                                                            "maxLength":3,
                                                            "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                                                            "example":"ENG"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1ReTmpNtfTy"
    }
}

Nested Schema : notificationTypes

Type: object

Show Source

• notificationType: array notificationType

{
    "type":"object",
    "properties":{
        "notificationType":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "notificationType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Notification Type indicates the type of Notification used as Notification Preference.",
                        "example":"START-SERVICE-CONFIRMATION"
                    },
                    "notificationPushSub":{
                        "type":"string",
                        "enum":[
                            "C1PU",
                            "C1SU"
                        ],
                        "description":"This indicates if the notification type is of subscription or push sub-type.\n* `C1PU` - Push,\n* `C1SU` - Subscription",
                        "example":"C1PU"
                    },
                    "isCustomerContactRequired":{
                        "type":"boolean",
                        "description":"This indicates if the notification type is configured with a customer contact type that is used to record a record of the notification.",
                        "example":"true"
                    },
                    "overrideDoNotDisturb":{
                        "type":"boolean",
                        "description":"Override Do Not Disturb is the boolean value wherein the person permits to receive notifications outside the DND Time range.",
                        "example":"true"
                    },
                    "hasOverrideDelivery":{
                        "type":"boolean",
                        "description":"This indicates if there is an override delivery algorithm plugged into the notification type, meaning the delivery information is obtained from a source other than contact preferences, such as an email address stored on a transaction.",
                        "example":"true"
                    },
                    "descriptions":{
                        "type":"object",
                        "properties":{
                            "description":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "description":{
                                            "type":"string",
                                            "maxLength":100,
                                            "description":"Description"
                                        },
                                        "language":{
                                            "type":"string",
                                            "maxLength":3,
                                            "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                                            "example":"ENG"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "deliveryTypes":{
                        "type":"object",
                        "properties":{
                            "deliveryType":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "deliveryType":{
                                            "type":"string",
                                            "enum":[
                                                "EMAI",
                                                "FAX ",
                                                "IVR ",
                                                "SMS "
                                            ],
                                            "description":"Delivery Type is the type of delivery by which the notification will be sent to the Person Contact.\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS",
                                            "example":"EMAI"
                                        },
                                        "isDefaultEnabled":{
                                            "type":"boolean",
                                            "description":"This indicates if a notification can be sent without an active preference and without an opt-out preference.",
                                            "example":"true"
                                        },
                                        "templateNames":{
                                            "type":"object",
                                            "properties":{
                                                "templateName":{
                                                    "type":"array",
                                                    "items":{
                                                        "type":"object",
                                                        "properties":{
                                                            "language":{
                                                                "type":"string",
                                                                "maxLength":3,
                                                                "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                                                                "example":"ENG"
                                                            },
                                                            "templateName":{
                                                                "type":"string",
                                                                "maxLength":254,
                                                                "description":"This is a reference to a value stored in an external system used to send a communication by merging template data with static information.",
                                                                "example":"BILL_DUE_SUB_EMAIL"
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "parentNotificationType":{
                        "type":"object",
                        "properties":{
                            "parentNotificationType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"For individual push notification types, this is the parent type. Preferences are set for the parent type and are used when creating individual push notifications.",
                                "example":"SERVICE-NOTICES"
                            },
                            "allowOptOut":{
                                "type":"string",
                                "enum":[
                                    "C1NO",
                                    "C1YS"
                                ],
                                "description":"For push notification, this indicates if its parent notification type allows user to opt-out from receiving notifications of that type.\n* `C1NO` - No,\n* `C1YS` - Yes",
                                "example":"C1YS"
                            },
                            "descriptions":{
                                "type":"object",
                                "properties":{
                                    "description":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "description":{
                                                    "type":"string",
                                                    "maxLength":100,
                                                    "description":"Description"
                                                },
                                                "language":{
                                                    "type":"string",
                                                    "maxLength":3,
                                                    "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                                                    "example":"ENG"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : notificationType

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "notificationType":{
                "type":"string",
                "maxLength":30,
                "description":"Notification Type indicates the type of Notification used as Notification Preference.",
                "example":"START-SERVICE-CONFIRMATION"
            },
            "notificationPushSub":{
                "type":"string",
                "enum":[
                    "C1PU",
                    "C1SU"
                ],
                "description":"This indicates if the notification type is of subscription or push sub-type.\n* `C1PU` - Push,\n* `C1SU` - Subscription",
                "example":"C1PU"
            },
            "isCustomerContactRequired":{
                "type":"boolean",
                "description":"This indicates if the notification type is configured with a customer contact type that is used to record a record of the notification.",
                "example":"true"
            },
            "overrideDoNotDisturb":{
                "type":"boolean",
                "description":"Override Do Not Disturb is the boolean value wherein the person permits to receive notifications outside the DND Time range.",
                "example":"true"
            },
            "hasOverrideDelivery":{
                "type":"boolean",
                "description":"This indicates if there is an override delivery algorithm plugged into the notification type, meaning the delivery information is obtained from a source other than contact preferences, such as an email address stored on a transaction.",
                "example":"true"
            },
            "descriptions":{
                "type":"object",
                "properties":{
                    "description":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "description":{
                                    "type":"string",
                                    "maxLength":100,
                                    "description":"Description"
                                },
                                "language":{
                                    "type":"string",
                                    "maxLength":3,
                                    "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                                    "example":"ENG"
                                }
                            }
                        }
                    }
                }
            },
            "deliveryTypes":{
                "type":"object",
                "properties":{
                    "deliveryType":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "deliveryType":{
                                    "type":"string",
                                    "enum":[
                                        "EMAI",
                                        "FAX ",
                                        "IVR ",
                                        "SMS "
                                    ],
                                    "description":"Delivery Type is the type of delivery by which the notification will be sent to the Person Contact.\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS",
                                    "example":"EMAI"
                                },
                                "isDefaultEnabled":{
                                    "type":"boolean",
                                    "description":"This indicates if a notification can be sent without an active preference and without an opt-out preference.",
                                    "example":"true"
                                },
                                "templateNames":{
                                    "type":"object",
                                    "properties":{
                                        "templateName":{
                                            "type":"array",
                                            "items":{
                                                "type":"object",
                                                "properties":{
                                                    "language":{
                                                        "type":"string",
                                                        "maxLength":3,
                                                        "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                                                        "example":"ENG"
                                                    },
                                                    "templateName":{
                                                        "type":"string",
                                                        "maxLength":254,
                                                        "description":"This is a reference to a value stored in an external system used to send a communication by merging template data with static information.",
                                                        "example":"BILL_DUE_SUB_EMAIL"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "parentNotificationType":{
                "type":"object",
                "properties":{
                    "parentNotificationType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"For individual push notification types, this is the parent type. Preferences are set for the parent type and are used when creating individual push notifications.",
                        "example":"SERVICE-NOTICES"
                    },
                    "allowOptOut":{
                        "type":"string",
                        "enum":[
                            "C1NO",
                            "C1YS"
                        ],
                        "description":"For push notification, this indicates if its parent notification type allows user to opt-out from receiving notifications of that type.\n* `C1NO` - No,\n* `C1YS` - Yes",
                        "example":"C1YS"
                    },
                    "descriptions":{
                        "type":"object",
                        "properties":{
                            "description":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "description":{
                                            "type":"string",
                                            "maxLength":100,
                                            "description":"Description"
                                        },
                                        "language":{
                                            "type":"string",
                                            "maxLength":3,
                                            "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                                            "example":"ENG"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• deliveryTypes: object deliveryTypes
• descriptions: object descriptions
• hasOverrideDelivery: boolean
  This indicates if there is an override delivery algorithm plugged into the notification type, meaning the delivery information is obtained from a source other than contact preferences, such as an email address stored on a transaction.

  Example: true
• isCustomerContactRequired: boolean
  This indicates if the notification type is configured with a customer contact type that is used to record a record of the notification.

  Example: true
• notificationPushSub: string
  Allowed Values: [ "C1PU", "C1SU" ]

  This indicates if the notification type is of subscription or push sub-type. * `C1PU` - Push, * `C1SU` - Subscription

  Example: C1PU
• notificationType: string
  Maximum Length: 30

  Notification Type indicates the type of Notification used as Notification Preference.

  Example: START-SERVICE-CONFIRMATION
• overrideDoNotDisturb: boolean
  Override Do Not Disturb is the boolean value wherein the person permits to receive notifications outside the DND Time range.

  Example: true
• parentNotificationType: object parentNotificationType

{
    "type":"object",
    "properties":{
        "notificationType":{
            "type":"string",
            "maxLength":30,
            "description":"Notification Type indicates the type of Notification used as Notification Preference.",
            "example":"START-SERVICE-CONFIRMATION"
        },
        "notificationPushSub":{
            "type":"string",
            "enum":[
                "C1PU",
                "C1SU"
            ],
            "description":"This indicates if the notification type is of subscription or push sub-type.\n* `C1PU` - Push,\n* `C1SU` - Subscription",
            "example":"C1PU"
        },
        "isCustomerContactRequired":{
            "type":"boolean",
            "description":"This indicates if the notification type is configured with a customer contact type that is used to record a record of the notification.",
            "example":"true"
        },
        "overrideDoNotDisturb":{
            "type":"boolean",
            "description":"Override Do Not Disturb is the boolean value wherein the person permits to receive notifications outside the DND Time range.",
            "example":"true"
        },
        "hasOverrideDelivery":{
            "type":"boolean",
            "description":"This indicates if there is an override delivery algorithm plugged into the notification type, meaning the delivery information is obtained from a source other than contact preferences, such as an email address stored on a transaction.",
            "example":"true"
        },
        "descriptions":{
            "type":"object",
            "properties":{
                "description":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "description":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Description"
                            },
                            "language":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                                "example":"ENG"
                            }
                        }
                    }
                }
            }
        },
        "deliveryTypes":{
            "type":"object",
            "properties":{
                "deliveryType":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "deliveryType":{
                                "type":"string",
                                "enum":[
                                    "EMAI",
                                    "FAX ",
                                    "IVR ",
                                    "SMS "
                                ],
                                "description":"Delivery Type is the type of delivery by which the notification will be sent to the Person Contact.\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS",
                                "example":"EMAI"
                            },
                            "isDefaultEnabled":{
                                "type":"boolean",
                                "description":"This indicates if a notification can be sent without an active preference and without an opt-out preference.",
                                "example":"true"
                            },
                            "templateNames":{
                                "type":"object",
                                "properties":{
                                    "templateName":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "language":{
                                                    "type":"string",
                                                    "maxLength":3,
                                                    "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                                                    "example":"ENG"
                                                },
                                                "templateName":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"This is a reference to a value stored in an external system used to send a communication by merging template data with static information.",
                                                    "example":"BILL_DUE_SUB_EMAIL"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "parentNotificationType":{
            "type":"object",
            "properties":{
                "parentNotificationType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"For individual push notification types, this is the parent type. Preferences are set for the parent type and are used when creating individual push notifications.",
                    "example":"SERVICE-NOTICES"
                },
                "allowOptOut":{
                    "type":"string",
                    "enum":[
                        "C1NO",
                        "C1YS"
                    ],
                    "description":"For push notification, this indicates if its parent notification type allows user to opt-out from receiving notifications of that type.\n* `C1NO` - No,\n* `C1YS` - Yes",
                    "example":"C1YS"
                },
                "descriptions":{
                    "type":"object",
                    "properties":{
                        "description":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "description":{
                                        "type":"string",
                                        "maxLength":100,
                                        "description":"Description"
                                    },
                                    "language":{
                                        "type":"string",
                                        "maxLength":3,
                                        "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                                        "example":"ENG"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : deliveryTypes

Type: object

Show Source

• deliveryType: array deliveryType

{
    "type":"object",
    "properties":{
        "deliveryType":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "deliveryType":{
                        "type":"string",
                        "enum":[
                            "EMAI",
                            "FAX ",
                            "IVR ",
                            "SMS "
                        ],
                        "description":"Delivery Type is the type of delivery by which the notification will be sent to the Person Contact.\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS",
                        "example":"EMAI"
                    },
                    "isDefaultEnabled":{
                        "type":"boolean",
                        "description":"This indicates if a notification can be sent without an active preference and without an opt-out preference.",
                        "example":"true"
                    },
                    "templateNames":{
                        "type":"object",
                        "properties":{
                            "templateName":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "language":{
                                            "type":"string",
                                            "maxLength":3,
                                            "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                                            "example":"ENG"
                                        },
                                        "templateName":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"This is a reference to a value stored in an external system used to send a communication by merging template data with static information.",
                                            "example":"BILL_DUE_SUB_EMAIL"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : descriptions

Type: object

Show Source

• description: array description

{
    "type":"object",
    "properties":{
        "description":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "description":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Description"
                    },
                    "language":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                        "example":"ENG"
                    }
                }
            }
        }
    }
}

Nested Schema : parentNotificationType

Type: object

Show Source

• allowOptOut: string
  Allowed Values: [ "C1NO", "C1YS" ]

  For push notification, this indicates if its parent notification type allows user to opt-out from receiving notifications of that type. * `C1NO` - No, * `C1YS` - Yes

  Example: C1YS
• descriptions: object descriptions
• parentNotificationType: string
  Maximum Length: 30

  For individual push notification types, this is the parent type. Preferences are set for the parent type and are used when creating individual push notifications.

  Example: SERVICE-NOTICES

{
    "type":"object",
    "properties":{
        "parentNotificationType":{
            "type":"string",
            "maxLength":30,
            "description":"For individual push notification types, this is the parent type. Preferences are set for the parent type and are used when creating individual push notifications.",
            "example":"SERVICE-NOTICES"
        },
        "allowOptOut":{
            "type":"string",
            "enum":[
                "C1NO",
                "C1YS"
            ],
            "description":"For push notification, this indicates if its parent notification type allows user to opt-out from receiving notifications of that type.\n* `C1NO` - No,\n* `C1YS` - Yes",
            "example":"C1YS"
        },
        "descriptions":{
            "type":"object",
            "properties":{
                "description":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "description":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Description"
                            },
                            "language":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                                "example":"ENG"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : deliveryType

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "deliveryType":{
                "type":"string",
                "enum":[
                    "EMAI",
                    "FAX ",
                    "IVR ",
                    "SMS "
                ],
                "description":"Delivery Type is the type of delivery by which the notification will be sent to the Person Contact.\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS",
                "example":"EMAI"
            },
            "isDefaultEnabled":{
                "type":"boolean",
                "description":"This indicates if a notification can be sent without an active preference and without an opt-out preference.",
                "example":"true"
            },
            "templateNames":{
                "type":"object",
                "properties":{
                    "templateName":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "language":{
                                    "type":"string",
                                    "maxLength":3,
                                    "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                                    "example":"ENG"
                                },
                                "templateName":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"This is a reference to a value stored in an external system used to send a communication by merging template data with static information.",
                                    "example":"BILL_DUE_SUB_EMAIL"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• deliveryType: string
  Allowed Values: [ "EMAI", "FAX ", "IVR ", "SMS " ]

  Delivery Type is the type of delivery by which the notification will be sent to the Person Contact. * `EMAI` - Email, * `FAX ` - Fax, * `IVR ` - IVR, * `SMS ` - SMS

  Example: EMAI
• isDefaultEnabled: boolean
  This indicates if a notification can be sent without an active preference and without an opt-out preference.

  Example: true
• templateNames: object templateNames

{
    "type":"object",
    "properties":{
        "deliveryType":{
            "type":"string",
            "enum":[
                "EMAI",
                "FAX ",
                "IVR ",
                "SMS "
            ],
            "description":"Delivery Type is the type of delivery by which the notification will be sent to the Person Contact.\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS",
            "example":"EMAI"
        },
        "isDefaultEnabled":{
            "type":"boolean",
            "description":"This indicates if a notification can be sent without an active preference and without an opt-out preference.",
            "example":"true"
        },
        "templateNames":{
            "type":"object",
            "properties":{
                "templateName":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "language":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                                "example":"ENG"
                            },
                            "templateName":{
                                "type":"string",
                                "maxLength":254,
                                "description":"This is a reference to a value stored in an external system used to send a communication by merging template data with static information.",
                                "example":"BILL_DUE_SUB_EMAIL"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : templateNames

Type: object

Show Source

• templateName: array templateName

{
    "type":"object",
    "properties":{
        "templateName":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "language":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                        "example":"ENG"
                    },
                    "templateName":{
                        "type":"string",
                        "maxLength":254,
                        "description":"This is a reference to a value stored in an external system used to send a communication by merging template data with static information.",
                        "example":"BILL_DUE_SUB_EMAIL"
                    }
                }
            }
        }
    }
}

Nested Schema : templateName

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "language":{
                "type":"string",
                "maxLength":3,
                "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                "example":"ENG"
            },
            "templateName":{
                "type":"string",
                "maxLength":254,
                "description":"This is a reference to a value stored in an external system used to send a communication by merging template data with static information.",
                "example":"BILL_DUE_SUB_EMAIL"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• language: string
  Maximum Length: 3

  Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.

  Example: ENG
• templateName: string
  Maximum Length: 254

  This is a reference to a value stored in an external system used to send a communication by merging template data with static information.

  Example: BILL_DUE_SUB_EMAIL

{
    "type":"object",
    "properties":{
        "language":{
            "type":"string",
            "maxLength":3,
            "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
            "example":"ENG"
        },
        "templateName":{
            "type":"string",
            "maxLength":254,
            "description":"This is a reference to a value stored in an external system used to send a communication by merging template data with static information.",
            "example":"BILL_DUE_SUB_EMAIL"
        }
    }
}

Nested Schema : description

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "description":{
                "type":"string",
                "maxLength":100,
                "description":"Description"
            },
            "language":{
                "type":"string",
                "maxLength":3,
                "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                "example":"ENG"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• description: string
  Maximum Length: 100

  Description
• language: string
  Maximum Length: 3

  Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.

  Example: ENG

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "maxLength":100,
            "description":"Description"
        },
        "language":{
            "type":"string",
            "maxLength":3,
            "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
            "example":"ENG"
        }
    }
}

Nested Schema : descriptions

Type: object

Show Source

• description: array description

{
    "type":"object",
    "properties":{
        "description":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "description":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Description"
                    },
                    "language":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                        "example":"ENG"
                    }
                }
            }
        }
    }
}

Nested Schema : description

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "description":{
                "type":"string",
                "maxLength":100,
                "description":"Description"
            },
            "language":{
                "type":"string",
                "maxLength":3,
                "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
                "example":"ENG"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• description: string
  Maximum Length: 100

  Description
• language: string
  Maximum Length: 3

  Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.

  Example: ENG

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "maxLength":100,
            "description":"Description"
        },
        "language":{
            "type":"string",
            "maxLength":3,
            "description":"Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.",
            "example":"ENG"
        }
    }
}

400 Response

Bad Request

Body ()

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

Body ()

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

Back to Top