Jump to

• Request
• Response

Retrieve Notification Preferences for Accounts

post

/rest/apis/customer/v-model/notificationPreferencesForAccounts/

This operation retrieves notification preferences for an input list of accounts and a notification type for the account.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• accounts: array accounts

{
    "type":"object",
    "properties":{
        "accounts":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "description":"Sequence is the primary key of the input and output, a numeric value which is the pointer for values in input and output.",
                        "example":"19"
                    },
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                        "example":"1575649032"
                    },
                    "notificationType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Notification Type indicates the type of Notification used as Notification Preference.",
                        "example":"CM-OUTAGENOTIF"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1AccNtfPref"
    }
}

Nested Schema : accounts

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "description":"Sequence is the primary key of the input and output, a numeric value which is the pointer for values in input and output.",
                "example":"19"
            },
            "accountId":{
                "type":"string",
                "maxLength":10,
                "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                "example":"1575649032"
            },
            "notificationType":{
                "type":"string",
                "maxLength":30,
                "description":"Notification Type indicates the type of Notification used as Notification Preference.",
                "example":"CM-OUTAGENOTIF"
            }
        }
    }
}

Nested Schema : items

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: 1575649032
• notificationType: string
  Maximum Length: 30

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

  Example: CM-OUTAGENOTIF
• sequence: number
  Sequence is the primary key of the input and output, a numeric value which is the pointer for values in input and output.

  Example: 19

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "description":"Sequence is the primary key of the input and output, a numeric value which is the pointer for values in input and output.",
            "example":"19"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "example":"1575649032"
        },
        "notificationType":{
            "type":"string",
            "maxLength":30,
            "description":"Notification Type indicates the type of Notification used as Notification Preference.",
            "example":"CM-OUTAGENOTIF"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accounts: array accounts

{
    "type":"object",
    "properties":{
        "accounts":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "description":"Sequence is the primary key of the input and output, a numeric value which is the pointer for values in input and output.",
                        "example":"19"
                    },
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                        "example":"1575649032"
                    },
                    "notificationType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Notification Type indicates the type of Notification used as Notification Preference.",
                        "example":"CM-OUTAGENOTIF"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1AccNtfPref"
    }
}

Nested Schema : accounts

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "description":"Sequence is the primary key of the input and output, a numeric value which is the pointer for values in input and output.",
                "example":"19"
            },
            "accountId":{
                "type":"string",
                "maxLength":10,
                "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                "example":"1575649032"
            },
            "notificationType":{
                "type":"string",
                "maxLength":30,
                "description":"Notification Type indicates the type of Notification used as Notification Preference.",
                "example":"CM-OUTAGENOTIF"
            }
        }
    }
}

Nested Schema : items

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: 1575649032
• notificationType: string
  Maximum Length: 30

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

  Example: CM-OUTAGENOTIF
• sequence: number
  Sequence is the primary key of the input and output, a numeric value which is the pointer for values in input and output.

  Example: 19

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "description":"Sequence is the primary key of the input and output, a numeric value which is the pointer for values in input and output.",
            "example":"19"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "example":"1575649032"
        },
        "notificationType":{
            "type":"string",
            "maxLength":30,
            "description":"Notification Type indicates the type of Notification used as Notification Preference.",
            "example":"CM-OUTAGENOTIF"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1AccNtfPref

Type: object

Show Source

• accounts: array accounts

{
    "type":"object",
    "properties":{
        "accounts":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "description":"Sequence is the primary key of the input and output, a numeric value which is the pointer for values in input and output.",
                        "example":"19"
                    },
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                        "example":"1575649032"
                    },
                    "notificationType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Notification Type indicates the type of Notification used as Notification Preference.",
                        "example":"CM-OUTAGENOTIF"
                    },
                    "subscriptionOrPush":{
                        "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":"C1SU"
                    },
                    "isOptOutAllowed":{
                        "type":"boolean",
                        "description":"For push notification, this indicates if its parent notification type allows user to opt-out from receiving notifications of that type.",
                        "example":"true"
                    },
                    "isCustomerContactRequired":{
                        "type":"boolean",
                        "description":"This indicates of the notification type is configured with a customer contact type that is used to record a record of the notification.",
                        "example":"true"
                    },
                    "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-NOTICIES"
                    },
                    "cisDivision":{
                        "type":"string",
                        "maxLength":5,
                        "description":"CIS Division defines the jurisdiction that governs this account.",
                        "example":"CA"
                    },
                    "notificationPreferences":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "notificationPreferenceId":{
                                    "type":"string",
                                    "maxLength":14,
                                    "description":"Notification Preference ID is the unique ID generated on create of Notification Preference.",
                                    "example":"95058374991172"
                                },
                                "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"
                                },
                                "personContact":{
                                    "type":"object",
                                    "properties":{
                                        "contactId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Person Contact ID is the unique generated ID on create of Person Contact Details.",
                                            "example":"1461171925"
                                        },
                                        "personId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Person ID is the unique ID generated on create of a Person.",
                                            "example":"1469201746"
                                        },
                                        "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"
                                        },
                                        "firstName":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"The Person's First Name. The value of this will be the ENTITY NAME if the system doesn't use name separator. For Business, ENTITY NAME is the value of the First Name.",
                                            "example":"John"
                                        },
                                        "lastName":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"The Person's Last Name. The value of this will be NULL if the system doesn't use name separator. For Business, NULL is the value of the Last Name.",
                                            "example":"Doe"
                                        },
                                        "contactValue":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Contact Value is the information of the Person Contact where the notification will be sent.",
                                            "example":"[e-mail]"
                                        },
                                        "timeZone":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Time Zone is the Person's Time Zone. If the person is not assigned to a Time Zone, by default it is the Installation Options Time Zone value. Do Not Disturb To and From are based on this Time Zone code.",
                                            "example":"USPACIFIC"
                                        },
                                        "dndStartTime":{
                                            "type":"string",
                                            "description":"Do Not Disturb From is the start of the range wherein the Person won't receive any notifications.",
                                            "example":"08.00.00"
                                        },
                                        "dndEndTime":{
                                            "type":"string",
                                            "description":"Do Not Disturb To is the end of the range wherein the Person won't receive any notifications.",
                                            "example":"20.30.00"
                                        },
                                        "overrideDND":{
                                            "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"
                                        },
                                        "templateName":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Template Name is the template to be used in sending the notification to the Person. Template Name is based on the language of the Person.",
                                            "example":"Outage Notification (English)"
                                        },
                                        "notificationTypeDescription":{
                                            "type":"string",
                                            "maxLength":100,
                                            "description":"Description"
                                        },
                                        "parentNotificationTypeDescription":{
                                            "type":"string",
                                            "maxLength":100,
                                            "description":"Description"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "errorInformation":{
                        "type":"object",
                        "properties":{
                            "isInError":{
                                "type":"boolean",
                                "description":"This is the boolean flag, wherein we determine if the input set encountered an error.",
                                "example":"false"
                            },
                            "errorReference":{
                                "type":"object",
                                "properties":{
                                    "category":{
                                        "type":"number",
                                        "maximum":99999,
                                        "minimum":-99999,
                                        "description":"This displays the Message Category of the error."
                                    },
                                    "number":{
                                        "type":"number",
                                        "maximum":99999,
                                        "minimum":-99999,
                                        "description":"This is the Message Number of the error."
                                    }
                                }
                            },
                            "errorMessage":{
                                "type":"string",
                                "maxLength":254,
                                "description":"This is the Message Text error, generated by Message Category and Message Number. This contains the details of the error encountered."
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1AccNtfPref"
    }
}

Nested Schema : accounts

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "description":"Sequence is the primary key of the input and output, a numeric value which is the pointer for values in input and output.",
                "example":"19"
            },
            "accountId":{
                "type":"string",
                "maxLength":10,
                "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                "example":"1575649032"
            },
            "notificationType":{
                "type":"string",
                "maxLength":30,
                "description":"Notification Type indicates the type of Notification used as Notification Preference.",
                "example":"CM-OUTAGENOTIF"
            },
            "subscriptionOrPush":{
                "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":"C1SU"
            },
            "isOptOutAllowed":{
                "type":"boolean",
                "description":"For push notification, this indicates if its parent notification type allows user to opt-out from receiving notifications of that type.",
                "example":"true"
            },
            "isCustomerContactRequired":{
                "type":"boolean",
                "description":"This indicates of the notification type is configured with a customer contact type that is used to record a record of the notification.",
                "example":"true"
            },
            "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-NOTICIES"
            },
            "cisDivision":{
                "type":"string",
                "maxLength":5,
                "description":"CIS Division defines the jurisdiction that governs this account.",
                "example":"CA"
            },
            "notificationPreferences":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "notificationPreferenceId":{
                            "type":"string",
                            "maxLength":14,
                            "description":"Notification Preference ID is the unique ID generated on create of Notification Preference.",
                            "example":"95058374991172"
                        },
                        "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"
                        },
                        "personContact":{
                            "type":"object",
                            "properties":{
                                "contactId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Person Contact ID is the unique generated ID on create of Person Contact Details.",
                                    "example":"1461171925"
                                },
                                "personId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Person ID is the unique ID generated on create of a Person.",
                                    "example":"1469201746"
                                },
                                "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"
                                },
                                "firstName":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"The Person's First Name. The value of this will be the ENTITY NAME if the system doesn't use name separator. For Business, ENTITY NAME is the value of the First Name.",
                                    "example":"John"
                                },
                                "lastName":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"The Person's Last Name. The value of this will be NULL if the system doesn't use name separator. For Business, NULL is the value of the Last Name.",
                                    "example":"Doe"
                                },
                                "contactValue":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Contact Value is the information of the Person Contact where the notification will be sent.",
                                    "example":"[e-mail]"
                                },
                                "timeZone":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Time Zone is the Person's Time Zone. If the person is not assigned to a Time Zone, by default it is the Installation Options Time Zone value. Do Not Disturb To and From are based on this Time Zone code.",
                                    "example":"USPACIFIC"
                                },
                                "dndStartTime":{
                                    "type":"string",
                                    "description":"Do Not Disturb From is the start of the range wherein the Person won't receive any notifications.",
                                    "example":"08.00.00"
                                },
                                "dndEndTime":{
                                    "type":"string",
                                    "description":"Do Not Disturb To is the end of the range wherein the Person won't receive any notifications.",
                                    "example":"20.30.00"
                                },
                                "overrideDND":{
                                    "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"
                                },
                                "templateName":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Template Name is the template to be used in sending the notification to the Person. Template Name is based on the language of the Person.",
                                    "example":"Outage Notification (English)"
                                },
                                "notificationTypeDescription":{
                                    "type":"string",
                                    "maxLength":100,
                                    "description":"Description"
                                },
                                "parentNotificationTypeDescription":{
                                    "type":"string",
                                    "maxLength":100,
                                    "description":"Description"
                                }
                            }
                        }
                    }
                }
            },
            "errorInformation":{
                "type":"object",
                "properties":{
                    "isInError":{
                        "type":"boolean",
                        "description":"This is the boolean flag, wherein we determine if the input set encountered an error.",
                        "example":"false"
                    },
                    "errorReference":{
                        "type":"object",
                        "properties":{
                            "category":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"This displays the Message Category of the error."
                            },
                            "number":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"This is the Message Number of the error."
                            }
                        }
                    },
                    "errorMessage":{
                        "type":"string",
                        "maxLength":254,
                        "description":"This is the Message Text error, generated by Message Category and Message Number. This contains the details of the error encountered."
                    }
                }
            }
        }
    }
}

Nested Schema : items

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: 1575649032
• cisDivision: string
  Maximum Length: 5

  CIS Division defines the jurisdiction that governs this account.

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

  Example: true
• isOptOutAllowed: boolean
  For push notification, this indicates if its parent notification type allows user to opt-out from receiving notifications of that type.

  Example: true
• notificationPreferences: array notificationPreferences
• notificationType: string
  Maximum Length: 30

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

  Example: CM-OUTAGENOTIF
• 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-NOTICIES
• sequence: number
  Sequence is the primary key of the input and output, a numeric value which is the pointer for values in input and output.

  Example: 19
• subscriptionOrPush: string
  Allowed Values: [ "C1PU", "C1SU" ]

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

  Example: C1SU

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "description":"Sequence is the primary key of the input and output, a numeric value which is the pointer for values in input and output.",
            "example":"19"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "example":"1575649032"
        },
        "notificationType":{
            "type":"string",
            "maxLength":30,
            "description":"Notification Type indicates the type of Notification used as Notification Preference.",
            "example":"CM-OUTAGENOTIF"
        },
        "subscriptionOrPush":{
            "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":"C1SU"
        },
        "isOptOutAllowed":{
            "type":"boolean",
            "description":"For push notification, this indicates if its parent notification type allows user to opt-out from receiving notifications of that type.",
            "example":"true"
        },
        "isCustomerContactRequired":{
            "type":"boolean",
            "description":"This indicates of the notification type is configured with a customer contact type that is used to record a record of the notification.",
            "example":"true"
        },
        "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-NOTICIES"
        },
        "cisDivision":{
            "type":"string",
            "maxLength":5,
            "description":"CIS Division defines the jurisdiction that governs this account.",
            "example":"CA"
        },
        "notificationPreferences":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "notificationPreferenceId":{
                        "type":"string",
                        "maxLength":14,
                        "description":"Notification Preference ID is the unique ID generated on create of Notification Preference.",
                        "example":"95058374991172"
                    },
                    "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"
                    },
                    "personContact":{
                        "type":"object",
                        "properties":{
                            "contactId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Person Contact ID is the unique generated ID on create of Person Contact Details.",
                                "example":"1461171925"
                            },
                            "personId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Person ID is the unique ID generated on create of a Person.",
                                "example":"1469201746"
                            },
                            "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"
                            },
                            "firstName":{
                                "type":"string",
                                "maxLength":50,
                                "description":"The Person's First Name. The value of this will be the ENTITY NAME if the system doesn't use name separator. For Business, ENTITY NAME is the value of the First Name.",
                                "example":"John"
                            },
                            "lastName":{
                                "type":"string",
                                "maxLength":50,
                                "description":"The Person's Last Name. The value of this will be NULL if the system doesn't use name separator. For Business, NULL is the value of the Last Name.",
                                "example":"Doe"
                            },
                            "contactValue":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Contact Value is the information of the Person Contact where the notification will be sent.",
                                "example":"[e-mail]"
                            },
                            "timeZone":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Time Zone is the Person's Time Zone. If the person is not assigned to a Time Zone, by default it is the Installation Options Time Zone value. Do Not Disturb To and From are based on this Time Zone code.",
                                "example":"USPACIFIC"
                            },
                            "dndStartTime":{
                                "type":"string",
                                "description":"Do Not Disturb From is the start of the range wherein the Person won't receive any notifications.",
                                "example":"08.00.00"
                            },
                            "dndEndTime":{
                                "type":"string",
                                "description":"Do Not Disturb To is the end of the range wherein the Person won't receive any notifications.",
                                "example":"20.30.00"
                            },
                            "overrideDND":{
                                "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"
                            },
                            "templateName":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Template Name is the template to be used in sending the notification to the Person. Template Name is based on the language of the Person.",
                                "example":"Outage Notification (English)"
                            },
                            "notificationTypeDescription":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Description"
                            },
                            "parentNotificationTypeDescription":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Description"
                            }
                        }
                    }
                }
            }
        },
        "errorInformation":{
            "type":"object",
            "properties":{
                "isInError":{
                    "type":"boolean",
                    "description":"This is the boolean flag, wherein we determine if the input set encountered an error.",
                    "example":"false"
                },
                "errorReference":{
                    "type":"object",
                    "properties":{
                        "category":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"This displays the Message Category of the error."
                        },
                        "number":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"This is the Message Number of the error."
                        }
                    }
                },
                "errorMessage":{
                    "type":"string",
                    "maxLength":254,
                    "description":"This is the Message Text error, generated by Message Category and Message Number. This contains the details of the error encountered."
                }
            }
        }
    }
}

Nested Schema : errorInformation

Type: object

Show Source

• errorMessage: string
  Maximum Length: 254

  This is the Message Text error, generated by Message Category and Message Number. This contains the details of the error encountered.
• errorReference: object errorReference
• isInError: boolean
  This is the boolean flag, wherein we determine if the input set encountered an error.

  Example: false

{
    "type":"object",
    "properties":{
        "isInError":{
            "type":"boolean",
            "description":"This is the boolean flag, wherein we determine if the input set encountered an error.",
            "example":"false"
        },
        "errorReference":{
            "type":"object",
            "properties":{
                "category":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"This displays the Message Category of the error."
                },
                "number":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"This is the Message Number of the error."
                }
            }
        },
        "errorMessage":{
            "type":"string",
            "maxLength":254,
            "description":"This is the Message Text error, generated by Message Category and Message Number. This contains the details of the error encountered."
        }
    }
}

Nested Schema : notificationPreferences

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "notificationPreferenceId":{
                "type":"string",
                "maxLength":14,
                "description":"Notification Preference ID is the unique ID generated on create of Notification Preference.",
                "example":"95058374991172"
            },
            "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"
            },
            "personContact":{
                "type":"object",
                "properties":{
                    "contactId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person Contact ID is the unique generated ID on create of Person Contact Details.",
                        "example":"1461171925"
                    },
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID is the unique ID generated on create of a Person.",
                        "example":"1469201746"
                    },
                    "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"
                    },
                    "firstName":{
                        "type":"string",
                        "maxLength":50,
                        "description":"The Person's First Name. The value of this will be the ENTITY NAME if the system doesn't use name separator. For Business, ENTITY NAME is the value of the First Name.",
                        "example":"John"
                    },
                    "lastName":{
                        "type":"string",
                        "maxLength":50,
                        "description":"The Person's Last Name. The value of this will be NULL if the system doesn't use name separator. For Business, NULL is the value of the Last Name.",
                        "example":"Doe"
                    },
                    "contactValue":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Contact Value is the information of the Person Contact where the notification will be sent.",
                        "example":"[e-mail]"
                    },
                    "timeZone":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Time Zone is the Person's Time Zone. If the person is not assigned to a Time Zone, by default it is the Installation Options Time Zone value. Do Not Disturb To and From are based on this Time Zone code.",
                        "example":"USPACIFIC"
                    },
                    "dndStartTime":{
                        "type":"string",
                        "description":"Do Not Disturb From is the start of the range wherein the Person won't receive any notifications.",
                        "example":"08.00.00"
                    },
                    "dndEndTime":{
                        "type":"string",
                        "description":"Do Not Disturb To is the end of the range wherein the Person won't receive any notifications.",
                        "example":"20.30.00"
                    },
                    "overrideDND":{
                        "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"
                    },
                    "templateName":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Template Name is the template to be used in sending the notification to the Person. Template Name is based on the language of the Person.",
                        "example":"Outage Notification (English)"
                    },
                    "notificationTypeDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Description"
                    },
                    "parentNotificationTypeDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Description"
                    }
                }
            }
        }
    }
}

Nested Schema : errorReference

Type: object

Show Source

• category: number
  Minimum Value: -99999

  Maximum Value: 99999

  This displays the Message Category of the error.
• number: number
  Minimum Value: -99999

  Maximum Value: 99999

  This is the Message Number of the error.

{
    "type":"object",
    "properties":{
        "category":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"This displays the Message Category of the error."
        },
        "number":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"This is the Message Number of the error."
        }
    }
}

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
• notificationPreferenceId: string
  Maximum Length: 14

  Notification Preference ID is the unique ID generated on create of Notification Preference.

  Example: 95058374991172
• personContact: object personContact

{
    "type":"object",
    "properties":{
        "notificationPreferenceId":{
            "type":"string",
            "maxLength":14,
            "description":"Notification Preference ID is the unique ID generated on create of Notification Preference.",
            "example":"95058374991172"
        },
        "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"
        },
        "personContact":{
            "type":"object",
            "properties":{
                "contactId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person Contact ID is the unique generated ID on create of Person Contact Details.",
                    "example":"1461171925"
                },
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person ID is the unique ID generated on create of a Person.",
                    "example":"1469201746"
                },
                "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"
                },
                "firstName":{
                    "type":"string",
                    "maxLength":50,
                    "description":"The Person's First Name. The value of this will be the ENTITY NAME if the system doesn't use name separator. For Business, ENTITY NAME is the value of the First Name.",
                    "example":"John"
                },
                "lastName":{
                    "type":"string",
                    "maxLength":50,
                    "description":"The Person's Last Name. The value of this will be NULL if the system doesn't use name separator. For Business, NULL is the value of the Last Name.",
                    "example":"Doe"
                },
                "contactValue":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Contact Value is the information of the Person Contact where the notification will be sent.",
                    "example":"[e-mail]"
                },
                "timeZone":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Time Zone is the Person's Time Zone. If the person is not assigned to a Time Zone, by default it is the Installation Options Time Zone value. Do Not Disturb To and From are based on this Time Zone code.",
                    "example":"USPACIFIC"
                },
                "dndStartTime":{
                    "type":"string",
                    "description":"Do Not Disturb From is the start of the range wherein the Person won't receive any notifications.",
                    "example":"08.00.00"
                },
                "dndEndTime":{
                    "type":"string",
                    "description":"Do Not Disturb To is the end of the range wherein the Person won't receive any notifications.",
                    "example":"20.30.00"
                },
                "overrideDND":{
                    "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"
                },
                "templateName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Template Name is the template to be used in sending the notification to the Person. Template Name is based on the language of the Person.",
                    "example":"Outage Notification (English)"
                },
                "notificationTypeDescription":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Description"
                },
                "parentNotificationTypeDescription":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Description"
                }
            }
        }
    }
}

Nested Schema : personContact

Type: object

Show Source

• contactId: string
  Maximum Length: 10

  Person Contact ID is the unique generated ID on create of Person Contact Details.

  Example: 1461171925
• contactValue: string
  Maximum Length: 254

  Contact Value is the information of the Person Contact where the notification will be sent.

  Example: [e-mail]
• dndEndTime: string
  Do Not Disturb To is the end of the range wherein the Person won't receive any notifications.

  Example: 20.30.00
• dndStartTime: string
  Do Not Disturb From is the start of the range wherein the Person won't receive any notifications.

  Example: 08.00.00
• firstName: string
  Maximum Length: 50

  The Person's First Name. The value of this will be the ENTITY NAME if the system doesn't use name separator. For Business, ENTITY NAME is the value of the First Name.

  Example: John
• 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
• lastName: string
  Maximum Length: 50

  The Person's Last Name. The value of this will be NULL if the system doesn't use name separator. For Business, NULL is the value of the Last Name.

  Example: Doe
• notificationTypeDescription: string
  Maximum Length: 100

  Description
• overrideDND: boolean
  Override Do Not Disturb is the boolean value wherein the person permits to receive notifications outside the DND Time range.

  Example: true
• parentNotificationTypeDescription: string
  Maximum Length: 100

  Description
• personId: string
  Maximum Length: 10

  Person ID is the unique ID generated on create of a Person.

  Example: 1469201746
• templateName: string
  Maximum Length: 254

  Template Name is the template to be used in sending the notification to the Person. Template Name is based on the language of the Person.

  Example: Outage Notification (English)
• timeZone: string
  Maximum Length: 10

  Time Zone is the Person's Time Zone. If the person is not assigned to a Time Zone, by default it is the Installation Options Time Zone value. Do Not Disturb To and From are based on this Time Zone code.

  Example: USPACIFIC

{
    "type":"object",
    "properties":{
        "contactId":{
            "type":"string",
            "maxLength":10,
            "description":"Person Contact ID is the unique generated ID on create of Person Contact Details.",
            "example":"1461171925"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is the unique ID generated on create of a Person.",
            "example":"1469201746"
        },
        "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"
        },
        "firstName":{
            "type":"string",
            "maxLength":50,
            "description":"The Person's First Name. The value of this will be the ENTITY NAME if the system doesn't use name separator. For Business, ENTITY NAME is the value of the First Name.",
            "example":"John"
        },
        "lastName":{
            "type":"string",
            "maxLength":50,
            "description":"The Person's Last Name. The value of this will be NULL if the system doesn't use name separator. For Business, NULL is the value of the Last Name.",
            "example":"Doe"
        },
        "contactValue":{
            "type":"string",
            "maxLength":254,
            "description":"Contact Value is the information of the Person Contact where the notification will be sent.",
            "example":"[e-mail]"
        },
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"Time Zone is the Person's Time Zone. If the person is not assigned to a Time Zone, by default it is the Installation Options Time Zone value. Do Not Disturb To and From are based on this Time Zone code.",
            "example":"USPACIFIC"
        },
        "dndStartTime":{
            "type":"string",
            "description":"Do Not Disturb From is the start of the range wherein the Person won't receive any notifications.",
            "example":"08.00.00"
        },
        "dndEndTime":{
            "type":"string",
            "description":"Do Not Disturb To is the end of the range wherein the Person won't receive any notifications.",
            "example":"20.30.00"
        },
        "overrideDND":{
            "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"
        },
        "templateName":{
            "type":"string",
            "maxLength":254,
            "description":"Template Name is the template to be used in sending the notification to the Person. Template Name is based on the language of the Person.",
            "example":"Outage Notification (English)"
        },
        "notificationTypeDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Description"
        },
        "parentNotificationTypeDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Description"
        }
    }
}

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