Jump to

• Request
• Response

Retrieve Notification Preferences for Accounts

post

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

This operation retrieves notification preferences for a list of accounts, service agreements, or premises for a specified notification type.

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",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence is a primary key that uniquely identifies an entry within the input or output list. Each entry represents a combination of notification type, account, service agreement, and premise.",
                        "example":"19"
                    },
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Account ID is the unique ID generated on create of an account. This field identifies the account for which notification preferences are retrieved.",
                        "example":"1575649032"
                    },
                    "saId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Agreement ID is the unique ID generated on create of a service agreement. This field identifies the service agreement for which notification preferences are retrieved.",
                        "example":"8805757605"
                    },
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID is the unique ID generated on create of a premise. This field identifies the premise for which notification preferences are retrieved.",
                        "example":"2242620736"
                    },
                    "notificationType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The notification type for which the notification preferences are retrieved.",
                        "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",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence is a primary key that uniquely identifies an entry within the input or output list. Each entry represents a combination of notification type, account, service agreement, and premise.",
                "example":"19"
            },
            "accountId":{
                "type":"string",
                "maxLength":10,
                "description":"Account ID is the unique ID generated on create of an account. This field identifies the account for which notification preferences are retrieved.",
                "example":"1575649032"
            },
            "saId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Agreement ID is the unique ID generated on create of a service agreement. This field identifies the service agreement for which notification preferences are retrieved.",
                "example":"8805757605"
            },
            "premiseId":{
                "type":"string",
                "maxLength":10,
                "description":"Premise ID is the unique ID generated on create of a premise. This field identifies the premise for which notification preferences are retrieved.",
                "example":"2242620736"
            },
            "notificationType":{
                "type":"string",
                "maxLength":30,
                "description":"The notification type for which the notification preferences are retrieved.",
                "example":"CM-OUTAGENOTIF"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID is the unique ID generated on create of an account. This field identifies the account for which notification preferences are retrieved.

  Example: 1575649032
• notificationType: string
  Maximum Length: 30

  The notification type for which the notification preferences are retrieved.

  Example: CM-OUTAGENOTIF
• premiseId: string
  Maximum Length: 10

  Premise ID is the unique ID generated on create of a premise. This field identifies the premise for which notification preferences are retrieved.

  Example: 2242620736
• saId: string
  Maximum Length: 10

  Service Agreement ID is the unique ID generated on create of a service agreement. This field identifies the service agreement for which notification preferences are retrieved.

  Example: 8805757605
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence is a primary key that uniquely identifies an entry within the input or output list. Each entry represents a combination of notification type, account, service agreement, and premise.

  Example: 19

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence is a primary key that uniquely identifies an entry within the input or output list. Each entry represents a combination of notification type, account, service agreement, and premise.",
            "example":"19"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID is the unique ID generated on create of an account. This field identifies the account for which notification preferences are retrieved.",
            "example":"1575649032"
        },
        "saId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement ID is the unique ID generated on create of a service agreement. This field identifies the service agreement for which notification preferences are retrieved.",
            "example":"8805757605"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID is the unique ID generated on create of a premise. This field identifies the premise for which notification preferences are retrieved.",
            "example":"2242620736"
        },
        "notificationType":{
            "type":"string",
            "maxLength":30,
            "description":"The notification type for which the notification preferences are retrieved.",
            "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",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence is a primary key that uniquely identifies an entry within the input or output list. Each entry represents a combination of notification type, account, service agreement, and premise.",
                        "example":"19"
                    },
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Account ID is the unique ID generated on create of an account. This field identifies the account for which notification preferences are retrieved.",
                        "example":"1575649032"
                    },
                    "saId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Agreement ID is the unique ID generated on create of a service agreement. This field identifies the service agreement for which notification preferences are retrieved.",
                        "example":"8805757605"
                    },
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID is the unique ID generated on create of a premise. This field identifies the premise for which notification preferences are retrieved.",
                        "example":"2242620736"
                    },
                    "notificationType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The notification type for which the notification preferences are retrieved.",
                        "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",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence is a primary key that uniquely identifies an entry within the input or output list. Each entry represents a combination of notification type, account, service agreement, and premise.",
                "example":"19"
            },
            "accountId":{
                "type":"string",
                "maxLength":10,
                "description":"Account ID is the unique ID generated on create of an account. This field identifies the account for which notification preferences are retrieved.",
                "example":"1575649032"
            },
            "saId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Agreement ID is the unique ID generated on create of a service agreement. This field identifies the service agreement for which notification preferences are retrieved.",
                "example":"8805757605"
            },
            "premiseId":{
                "type":"string",
                "maxLength":10,
                "description":"Premise ID is the unique ID generated on create of a premise. This field identifies the premise for which notification preferences are retrieved.",
                "example":"2242620736"
            },
            "notificationType":{
                "type":"string",
                "maxLength":30,
                "description":"The notification type for which the notification preferences are retrieved.",
                "example":"CM-OUTAGENOTIF"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID is the unique ID generated on create of an account. This field identifies the account for which notification preferences are retrieved.

  Example: 1575649032
• notificationType: string
  Maximum Length: 30

  The notification type for which the notification preferences are retrieved.

  Example: CM-OUTAGENOTIF
• premiseId: string
  Maximum Length: 10

  Premise ID is the unique ID generated on create of a premise. This field identifies the premise for which notification preferences are retrieved.

  Example: 2242620736
• saId: string
  Maximum Length: 10

  Service Agreement ID is the unique ID generated on create of a service agreement. This field identifies the service agreement for which notification preferences are retrieved.

  Example: 8805757605
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence is a primary key that uniquely identifies an entry within the input or output list. Each entry represents a combination of notification type, account, service agreement, and premise.

  Example: 19

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence is a primary key that uniquely identifies an entry within the input or output list. Each entry represents a combination of notification type, account, service agreement, and premise.",
            "example":"19"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID is the unique ID generated on create of an account. This field identifies the account for which notification preferences are retrieved.",
            "example":"1575649032"
        },
        "saId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement ID is the unique ID generated on create of a service agreement. This field identifies the service agreement for which notification preferences are retrieved.",
            "example":"8805757605"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID is the unique ID generated on create of a premise. This field identifies the premise for which notification preferences are retrieved.",
            "example":"2242620736"
        },
        "notificationType":{
            "type":"string",
            "maxLength":30,
            "description":"The notification type for which the notification preferences are retrieved.",
            "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",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence is a primary key that uniquely identifies an entry within the input or output list. Each entry represents a combination of notification type, account, service agreement, and premise.",
                        "example":"19"
                    },
                    "notificationLevel":{
                        "type":"string",
                        "enum":[
                            "C1AC",
                            "C1SA"
                        ],
                        "description":"This indicates whether contact preferences are maintained by account or by service agreement.\n* `C1AC` - By Account,\n* `C1SA` - By Service Agreement",
                        "example":"C1AC"
                    },
                    "isSpRequired":{
                        "type":"boolean",
                        "description":"This indicates whether the notification type is only allowed on service agreements whose SA type requires a service point.",
                        "example":"true"
                    },
                    "subscriptionOrPush":{
                        "type":"string",
                        "enum":[
                            "C1PU",
                            "C1SU"
                        ],
                        "description":"This indicates whether the notification type is a subscription or push subtype.\n* `C1PU` - Push,\n* `C1SU` - Subscription",
                        "example":"C1SU"
                    },
                    "isOptOutAllowed":{
                        "type":"boolean",
                        "description":"For push notifications, this indicates whether the parent notification type allows users to opt out of receiving notifications of that type.",
                        "example":"true"
                    },
                    "isCustomerContactRequired":{
                        "type":"boolean",
                        "description":"This indicates whether the notification type is configured with a customer contact type used to record the notification.",
                        "example":"true"
                    },
                    "parentNotificationType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"For individual push notification types, this is the parent type.\nPreferences 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 the 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 a 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 ID generated on create of a person contact.",
                                            "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":"The language used by the person receiving the notification. This determines the appropriate notification template to use.",
                                            "example":"ENG"
                                        },
                                        "firstName":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"For a person, this field is the first name. If the system does not use a name separator, this field contains the entity name.\nFor a business, this field is the entity name.",
                                            "example":"John"
                                        },
                                        "lastName":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"The person's last name. If the system does not use a name separator, this field is null. For a business, this field is also null.",
                                            "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 specifies the person's time zone. If no time zone is assigned to the person, the time zone configured in Installation Options is used by default. The Do Not Disturb From and Do Not Disturb To times are interpreted based on this time zone.",
                                            "example":"USPACIFIC"
                                        },
                                        "dndStartTime":{
                                            "type":"string",
                                            "description":"Do Not Disturb From specifies the start of the time range during which the person will not receive notifications.",
                                            "example":"08.00.00"
                                        },
                                        "dndEndTime":{
                                            "type":"string",
                                            "description":"Do Not Disturb From specifies the end of the time range during which the person will not receive notifications.",
                                            "example":"20.30.00"
                                        },
                                        "overrideDND":{
                                            "type":"boolean",
                                            "description":"Override Do Not Disturb is a boolean value that indicates whether the person allows notifications to be received during the Do Not Disturb (DND) time range.",
                                            "example":"true"
                                        },
                                        "templateName":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Template Name identifies the template used to send the notification to the person. The appropriate template is determined based on the person's language.",
                                            "example":"Outage Notification (English)"
                                        },
                                        "notificationTypeDescription":{
                                            "type":"string",
                                            "maxLength":100,
                                            "description":"Description"
                                        },
                                        "parentNotificationTypeDescription":{
                                            "type":"string",
                                            "maxLength":100,
                                            "description":"Description"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "sas":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "saId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Service Agreement ID is the unique ID generated on create of a service agreement. This field identifies the service agreement for which notification preferences are retrieved.",
                                    "example":"8805757605"
                                },
                                "saNotificationPreferences":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "saNotificationPreferenceId":{
                                                "type":"string",
                                                "maxLength":14,
                                                "description":"SA Notification Preference ID is the unique ID generated on create of an SA notification preference.",
                                                "example":"54192836673724"
                                            },
                                            "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 ID generated on create of a person contact.",
                                                        "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":"The language used by the person receiving the notification. This determines the appropriate notification template to use.",
                                                        "example":"ENG"
                                                    },
                                                    "firstName":{
                                                        "type":"string",
                                                        "maxLength":50,
                                                        "description":"For a person, this field is the first name. If the system does not use a name separator, this field contains the entity name.\nFor a business, this field is the entity name.",
                                                        "example":"John"
                                                    },
                                                    "lastName":{
                                                        "type":"string",
                                                        "maxLength":50,
                                                        "description":"The person's last name. If the system does not use a name separator, this field is null. For a business, this field is also null.",
                                                        "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 specifies the person's time zone. If no time zone is assigned to the person, the time zone configured in Installation Options is used by default. The Do Not Disturb From and Do Not Disturb To times are interpreted based on this time zone.",
                                                        "example":"USPACIFIC"
                                                    },
                                                    "dndStartTime":{
                                                        "type":"string",
                                                        "description":"Do Not Disturb From specifies the start of the time range during which the person will not receive notifications.",
                                                        "example":"08.00.00"
                                                    },
                                                    "dndEndTime":{
                                                        "type":"string",
                                                        "description":"Do Not Disturb From specifies the end of the time range during which the person will not receive notifications.",
                                                        "example":"20.30.00"
                                                    },
                                                    "overrideDND":{
                                                        "type":"boolean",
                                                        "description":"Override Do Not Disturb is a boolean value that indicates whether the person allows notifications to be received during the Do Not Disturb (DND) time range.",
                                                        "example":"true"
                                                    },
                                                    "templateName":{
                                                        "type":"string",
                                                        "maxLength":254,
                                                        "description":"Template Name identifies the template used to send the notification to the person. The appropriate template is determined based on the person's language.",
                                                        "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 boolean flag indicates whether an error was encountered while processing the input set.",
                                "example":"false"
                            },
                            "errorReference":{
                                "type":"object",
                                "properties":{
                                    "category":{
                                        "type":"number",
                                        "maximum":99999,
                                        "minimum":-99999,
                                        "description":"This is 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 error message text based on the message category and message number. This field provides details about 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",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence is a primary key that uniquely identifies an entry within the input or output list. Each entry represents a combination of notification type, account, service agreement, and premise.",
                "example":"19"
            },
            "notificationLevel":{
                "type":"string",
                "enum":[
                    "C1AC",
                    "C1SA"
                ],
                "description":"This indicates whether contact preferences are maintained by account or by service agreement.\n* `C1AC` - By Account,\n* `C1SA` - By Service Agreement",
                "example":"C1AC"
            },
            "isSpRequired":{
                "type":"boolean",
                "description":"This indicates whether the notification type is only allowed on service agreements whose SA type requires a service point.",
                "example":"true"
            },
            "subscriptionOrPush":{
                "type":"string",
                "enum":[
                    "C1PU",
                    "C1SU"
                ],
                "description":"This indicates whether the notification type is a subscription or push subtype.\n* `C1PU` - Push,\n* `C1SU` - Subscription",
                "example":"C1SU"
            },
            "isOptOutAllowed":{
                "type":"boolean",
                "description":"For push notifications, this indicates whether the parent notification type allows users to opt out of receiving notifications of that type.",
                "example":"true"
            },
            "isCustomerContactRequired":{
                "type":"boolean",
                "description":"This indicates whether the notification type is configured with a customer contact type used to record the notification.",
                "example":"true"
            },
            "parentNotificationType":{
                "type":"string",
                "maxLength":30,
                "description":"For individual push notification types, this is the parent type.\nPreferences 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 the 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 a 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 ID generated on create of a person contact.",
                                    "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":"The language used by the person receiving the notification. This determines the appropriate notification template to use.",
                                    "example":"ENG"
                                },
                                "firstName":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"For a person, this field is the first name. If the system does not use a name separator, this field contains the entity name.\nFor a business, this field is the entity name.",
                                    "example":"John"
                                },
                                "lastName":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"The person's last name. If the system does not use a name separator, this field is null. For a business, this field is also null.",
                                    "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 specifies the person's time zone. If no time zone is assigned to the person, the time zone configured in Installation Options is used by default. The Do Not Disturb From and Do Not Disturb To times are interpreted based on this time zone.",
                                    "example":"USPACIFIC"
                                },
                                "dndStartTime":{
                                    "type":"string",
                                    "description":"Do Not Disturb From specifies the start of the time range during which the person will not receive notifications.",
                                    "example":"08.00.00"
                                },
                                "dndEndTime":{
                                    "type":"string",
                                    "description":"Do Not Disturb From specifies the end of the time range during which the person will not receive notifications.",
                                    "example":"20.30.00"
                                },
                                "overrideDND":{
                                    "type":"boolean",
                                    "description":"Override Do Not Disturb is a boolean value that indicates whether the person allows notifications to be received during the Do Not Disturb (DND) time range.",
                                    "example":"true"
                                },
                                "templateName":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Template Name identifies the template used to send the notification to the person. The appropriate template is determined based on the person's language.",
                                    "example":"Outage Notification (English)"
                                },
                                "notificationTypeDescription":{
                                    "type":"string",
                                    "maxLength":100,
                                    "description":"Description"
                                },
                                "parentNotificationTypeDescription":{
                                    "type":"string",
                                    "maxLength":100,
                                    "description":"Description"
                                }
                            }
                        }
                    }
                }
            },
            "sas":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "saId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Service Agreement ID is the unique ID generated on create of a service agreement. This field identifies the service agreement for which notification preferences are retrieved.",
                            "example":"8805757605"
                        },
                        "saNotificationPreferences":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "saNotificationPreferenceId":{
                                        "type":"string",
                                        "maxLength":14,
                                        "description":"SA Notification Preference ID is the unique ID generated on create of an SA notification preference.",
                                        "example":"54192836673724"
                                    },
                                    "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 ID generated on create of a person contact.",
                                                "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":"The language used by the person receiving the notification. This determines the appropriate notification template to use.",
                                                "example":"ENG"
                                            },
                                            "firstName":{
                                                "type":"string",
                                                "maxLength":50,
                                                "description":"For a person, this field is the first name. If the system does not use a name separator, this field contains the entity name.\nFor a business, this field is the entity name.",
                                                "example":"John"
                                            },
                                            "lastName":{
                                                "type":"string",
                                                "maxLength":50,
                                                "description":"The person's last name. If the system does not use a name separator, this field is null. For a business, this field is also null.",
                                                "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 specifies the person's time zone. If no time zone is assigned to the person, the time zone configured in Installation Options is used by default. The Do Not Disturb From and Do Not Disturb To times are interpreted based on this time zone.",
                                                "example":"USPACIFIC"
                                            },
                                            "dndStartTime":{
                                                "type":"string",
                                                "description":"Do Not Disturb From specifies the start of the time range during which the person will not receive notifications.",
                                                "example":"08.00.00"
                                            },
                                            "dndEndTime":{
                                                "type":"string",
                                                "description":"Do Not Disturb From specifies the end of the time range during which the person will not receive notifications.",
                                                "example":"20.30.00"
                                            },
                                            "overrideDND":{
                                                "type":"boolean",
                                                "description":"Override Do Not Disturb is a boolean value that indicates whether the person allows notifications to be received during the Do Not Disturb (DND) time range.",
                                                "example":"true"
                                            },
                                            "templateName":{
                                                "type":"string",
                                                "maxLength":254,
                                                "description":"Template Name identifies the template used to send the notification to the person. The appropriate template is determined based on the person's language.",
                                                "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 boolean flag indicates whether an error was encountered while processing the input set.",
                        "example":"false"
                    },
                    "errorReference":{
                        "type":"object",
                        "properties":{
                            "category":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"This is 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 error message text based on the message category and message number. This field provides details about the error encountered."
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• cisDivision: string
  Maximum Length: 5

  CIS Division defines the jurisdiction that governs the account.

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

  Example: true
• isOptOutAllowed: boolean
  For push notifications, this indicates whether the parent notification type allows users to opt out of receiving notifications of that type.

  Example: true
• isSpRequired: boolean
  This indicates whether the notification type is only allowed on service agreements whose SA type requires a service point.

  Example: true
• notificationLevel: string
  Allowed Values: [ "C1AC", "C1SA" ]

  This indicates whether contact preferences are maintained by account or by service agreement. * `C1AC` - By Account, * `C1SA` - By Service Agreement

  Example: C1AC
• notificationPreferences: array notificationPreferences
• 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
• sas: array sas
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence is a primary key that uniquely identifies an entry within the input or output list. Each entry represents a combination of notification type, account, service agreement, and premise.

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

  This indicates whether the notification type is a subscription or push subtype. * `C1PU` - Push, * `C1SU` - Subscription

  Example: C1SU

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence is a primary key that uniquely identifies an entry within the input or output list. Each entry represents a combination of notification type, account, service agreement, and premise.",
            "example":"19"
        },
        "notificationLevel":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1SA"
            ],
            "description":"This indicates whether contact preferences are maintained by account or by service agreement.\n* `C1AC` - By Account,\n* `C1SA` - By Service Agreement",
            "example":"C1AC"
        },
        "isSpRequired":{
            "type":"boolean",
            "description":"This indicates whether the notification type is only allowed on service agreements whose SA type requires a service point.",
            "example":"true"
        },
        "subscriptionOrPush":{
            "type":"string",
            "enum":[
                "C1PU",
                "C1SU"
            ],
            "description":"This indicates whether the notification type is a subscription or push subtype.\n* `C1PU` - Push,\n* `C1SU` - Subscription",
            "example":"C1SU"
        },
        "isOptOutAllowed":{
            "type":"boolean",
            "description":"For push notifications, this indicates whether the parent notification type allows users to opt out of receiving notifications of that type.",
            "example":"true"
        },
        "isCustomerContactRequired":{
            "type":"boolean",
            "description":"This indicates whether the notification type is configured with a customer contact type used to record the notification.",
            "example":"true"
        },
        "parentNotificationType":{
            "type":"string",
            "maxLength":30,
            "description":"For individual push notification types, this is the parent type.\nPreferences 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 the 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 a 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 ID generated on create of a person contact.",
                                "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":"The language used by the person receiving the notification. This determines the appropriate notification template to use.",
                                "example":"ENG"
                            },
                            "firstName":{
                                "type":"string",
                                "maxLength":50,
                                "description":"For a person, this field is the first name. If the system does not use a name separator, this field contains the entity name.\nFor a business, this field is the entity name.",
                                "example":"John"
                            },
                            "lastName":{
                                "type":"string",
                                "maxLength":50,
                                "description":"The person's last name. If the system does not use a name separator, this field is null. For a business, this field is also null.",
                                "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 specifies the person's time zone. If no time zone is assigned to the person, the time zone configured in Installation Options is used by default. The Do Not Disturb From and Do Not Disturb To times are interpreted based on this time zone.",
                                "example":"USPACIFIC"
                            },
                            "dndStartTime":{
                                "type":"string",
                                "description":"Do Not Disturb From specifies the start of the time range during which the person will not receive notifications.",
                                "example":"08.00.00"
                            },
                            "dndEndTime":{
                                "type":"string",
                                "description":"Do Not Disturb From specifies the end of the time range during which the person will not receive notifications.",
                                "example":"20.30.00"
                            },
                            "overrideDND":{
                                "type":"boolean",
                                "description":"Override Do Not Disturb is a boolean value that indicates whether the person allows notifications to be received during the Do Not Disturb (DND) time range.",
                                "example":"true"
                            },
                            "templateName":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Template Name identifies the template used to send the notification to the person. The appropriate template is determined based on the person's language.",
                                "example":"Outage Notification (English)"
                            },
                            "notificationTypeDescription":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Description"
                            },
                            "parentNotificationTypeDescription":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Description"
                            }
                        }
                    }
                }
            }
        },
        "sas":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "saId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Agreement ID is the unique ID generated on create of a service agreement. This field identifies the service agreement for which notification preferences are retrieved.",
                        "example":"8805757605"
                    },
                    "saNotificationPreferences":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "saNotificationPreferenceId":{
                                    "type":"string",
                                    "maxLength":14,
                                    "description":"SA Notification Preference ID is the unique ID generated on create of an SA notification preference.",
                                    "example":"54192836673724"
                                },
                                "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 ID generated on create of a person contact.",
                                            "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":"The language used by the person receiving the notification. This determines the appropriate notification template to use.",
                                            "example":"ENG"
                                        },
                                        "firstName":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"For a person, this field is the first name. If the system does not use a name separator, this field contains the entity name.\nFor a business, this field is the entity name.",
                                            "example":"John"
                                        },
                                        "lastName":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"The person's last name. If the system does not use a name separator, this field is null. For a business, this field is also null.",
                                            "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 specifies the person's time zone. If no time zone is assigned to the person, the time zone configured in Installation Options is used by default. The Do Not Disturb From and Do Not Disturb To times are interpreted based on this time zone.",
                                            "example":"USPACIFIC"
                                        },
                                        "dndStartTime":{
                                            "type":"string",
                                            "description":"Do Not Disturb From specifies the start of the time range during which the person will not receive notifications.",
                                            "example":"08.00.00"
                                        },
                                        "dndEndTime":{
                                            "type":"string",
                                            "description":"Do Not Disturb From specifies the end of the time range during which the person will not receive notifications.",
                                            "example":"20.30.00"
                                        },
                                        "overrideDND":{
                                            "type":"boolean",
                                            "description":"Override Do Not Disturb is a boolean value that indicates whether the person allows notifications to be received during the Do Not Disturb (DND) time range.",
                                            "example":"true"
                                        },
                                        "templateName":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Template Name identifies the template used to send the notification to the person. The appropriate template is determined based on the person's language.",
                                            "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 boolean flag indicates whether an error was encountered while processing the input set.",
                    "example":"false"
                },
                "errorReference":{
                    "type":"object",
                    "properties":{
                        "category":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"This is 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 error message text based on the message category and message number. This field provides details about the error encountered."
                }
            }
        }
    }
}

Nested Schema : errorInformation

Type: object

Show Source

• errorMessage: string
  Maximum Length: 254

  This is the error message text based on the message category and message number. This field provides details about the error encountered.
• errorReference: object errorReference
• isInError: boolean
  This boolean flag indicates whether an error was encountered while processing the input set.

  Example: false

{
    "type":"object",
    "properties":{
        "isInError":{
            "type":"boolean",
            "description":"This boolean flag indicates whether an error was encountered while processing the input set.",
            "example":"false"
        },
        "errorReference":{
            "type":"object",
            "properties":{
                "category":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"This is 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 error message text based on the message category and message number. This field provides details about 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 a 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 ID generated on create of a person contact.",
                        "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":"The language used by the person receiving the notification. This determines the appropriate notification template to use.",
                        "example":"ENG"
                    },
                    "firstName":{
                        "type":"string",
                        "maxLength":50,
                        "description":"For a person, this field is the first name. If the system does not use a name separator, this field contains the entity name.\nFor a business, this field is the entity name.",
                        "example":"John"
                    },
                    "lastName":{
                        "type":"string",
                        "maxLength":50,
                        "description":"The person's last name. If the system does not use a name separator, this field is null. For a business, this field is also null.",
                        "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 specifies the person's time zone. If no time zone is assigned to the person, the time zone configured in Installation Options is used by default. The Do Not Disturb From and Do Not Disturb To times are interpreted based on this time zone.",
                        "example":"USPACIFIC"
                    },
                    "dndStartTime":{
                        "type":"string",
                        "description":"Do Not Disturb From specifies the start of the time range during which the person will not receive notifications.",
                        "example":"08.00.00"
                    },
                    "dndEndTime":{
                        "type":"string",
                        "description":"Do Not Disturb From specifies the end of the time range during which the person will not receive notifications.",
                        "example":"20.30.00"
                    },
                    "overrideDND":{
                        "type":"boolean",
                        "description":"Override Do Not Disturb is a boolean value that indicates whether the person allows notifications to be received during the Do Not Disturb (DND) time range.",
                        "example":"true"
                    },
                    "templateName":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Template Name identifies the template used to send the notification to the person. The appropriate template is determined based on the person's language.",
                        "example":"Outage Notification (English)"
                    },
                    "notificationTypeDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Description"
                    },
                    "parentNotificationTypeDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Description"
                    }
                }
            }
        }
    }
}

Nested Schema : sas

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "saId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Agreement ID is the unique ID generated on create of a service agreement. This field identifies the service agreement for which notification preferences are retrieved.",
                "example":"8805757605"
            },
            "saNotificationPreferences":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "saNotificationPreferenceId":{
                            "type":"string",
                            "maxLength":14,
                            "description":"SA Notification Preference ID is the unique ID generated on create of an SA notification preference.",
                            "example":"54192836673724"
                        },
                        "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 ID generated on create of a person contact.",
                                    "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":"The language used by the person receiving the notification. This determines the appropriate notification template to use.",
                                    "example":"ENG"
                                },
                                "firstName":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"For a person, this field is the first name. If the system does not use a name separator, this field contains the entity name.\nFor a business, this field is the entity name.",
                                    "example":"John"
                                },
                                "lastName":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"The person's last name. If the system does not use a name separator, this field is null. For a business, this field is also null.",
                                    "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 specifies the person's time zone. If no time zone is assigned to the person, the time zone configured in Installation Options is used by default. The Do Not Disturb From and Do Not Disturb To times are interpreted based on this time zone.",
                                    "example":"USPACIFIC"
                                },
                                "dndStartTime":{
                                    "type":"string",
                                    "description":"Do Not Disturb From specifies the start of the time range during which the person will not receive notifications.",
                                    "example":"08.00.00"
                                },
                                "dndEndTime":{
                                    "type":"string",
                                    "description":"Do Not Disturb From specifies the end of the time range during which the person will not receive notifications.",
                                    "example":"20.30.00"
                                },
                                "overrideDND":{
                                    "type":"boolean",
                                    "description":"Override Do Not Disturb is a boolean value that indicates whether the person allows notifications to be received during the Do Not Disturb (DND) time range.",
                                    "example":"true"
                                },
                                "templateName":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Template Name identifies the template used to send the notification to the person. The appropriate template is determined based on the person's language.",
                                    "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 is 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 is 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 a 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 a 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 ID generated on create of a person contact.",
                    "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":"The language used by the person receiving the notification. This determines the appropriate notification template to use.",
                    "example":"ENG"
                },
                "firstName":{
                    "type":"string",
                    "maxLength":50,
                    "description":"For a person, this field is the first name. If the system does not use a name separator, this field contains the entity name.\nFor a business, this field is the entity name.",
                    "example":"John"
                },
                "lastName":{
                    "type":"string",
                    "maxLength":50,
                    "description":"The person's last name. If the system does not use a name separator, this field is null. For a business, this field is also null.",
                    "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 specifies the person's time zone. If no time zone is assigned to the person, the time zone configured in Installation Options is used by default. The Do Not Disturb From and Do Not Disturb To times are interpreted based on this time zone.",
                    "example":"USPACIFIC"
                },
                "dndStartTime":{
                    "type":"string",
                    "description":"Do Not Disturb From specifies the start of the time range during which the person will not receive notifications.",
                    "example":"08.00.00"
                },
                "dndEndTime":{
                    "type":"string",
                    "description":"Do Not Disturb From specifies the end of the time range during which the person will not receive notifications.",
                    "example":"20.30.00"
                },
                "overrideDND":{
                    "type":"boolean",
                    "description":"Override Do Not Disturb is a boolean value that indicates whether the person allows notifications to be received during the Do Not Disturb (DND) time range.",
                    "example":"true"
                },
                "templateName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Template Name identifies the template used to send the notification to the person. The appropriate template is determined based on the person's language.",
                    "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 ID generated on create of a person contact.

  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 From specifies the end of the time range during which the person will not receive notifications.

  Example: 20.30.00
• dndStartTime: string
  Do Not Disturb From specifies the start of the time range during which the person will not receive notifications.

  Example: 08.00.00
• firstName: string
  Maximum Length: 50

  For a person, this field is the first name. If the system does not use a name separator, this field contains the entity name. For a business, this field is the entity name.

  Example: John
• language: string
  Maximum Length: 3

  The language used by the person receiving the notification. This determines the appropriate notification template to use.

  Example: ENG
• lastName: string
  Maximum Length: 50

  The person's last name. If the system does not use a name separator, this field is null. For a business, this field is also null.

  Example: Doe
• notificationTypeDescription: string
  Maximum Length: 100

  Description
• overrideDND: boolean
  Override Do Not Disturb is a boolean value that indicates whether the person allows notifications to be received during the Do Not Disturb (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 identifies the template used to send the notification to the person. The appropriate template is determined based on the person's language.

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

  Time Zone specifies the person's time zone. If no time zone is assigned to the person, the time zone configured in Installation Options is used by default. The Do Not Disturb From and Do Not Disturb To times are interpreted based on this time zone.

  Example: USPACIFIC

{
    "type":"object",
    "properties":{
        "contactId":{
            "type":"string",
            "maxLength":10,
            "description":"Person Contact ID is the unique ID generated on create of a person contact.",
            "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":"The language used by the person receiving the notification. This determines the appropriate notification template to use.",
            "example":"ENG"
        },
        "firstName":{
            "type":"string",
            "maxLength":50,
            "description":"For a person, this field is the first name. If the system does not use a name separator, this field contains the entity name.\nFor a business, this field is the entity name.",
            "example":"John"
        },
        "lastName":{
            "type":"string",
            "maxLength":50,
            "description":"The person's last name. If the system does not use a name separator, this field is null. For a business, this field is also null.",
            "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 specifies the person's time zone. If no time zone is assigned to the person, the time zone configured in Installation Options is used by default. The Do Not Disturb From and Do Not Disturb To times are interpreted based on this time zone.",
            "example":"USPACIFIC"
        },
        "dndStartTime":{
            "type":"string",
            "description":"Do Not Disturb From specifies the start of the time range during which the person will not receive notifications.",
            "example":"08.00.00"
        },
        "dndEndTime":{
            "type":"string",
            "description":"Do Not Disturb From specifies the end of the time range during which the person will not receive notifications.",
            "example":"20.30.00"
        },
        "overrideDND":{
            "type":"boolean",
            "description":"Override Do Not Disturb is a boolean value that indicates whether the person allows notifications to be received during the Do Not Disturb (DND) time range.",
            "example":"true"
        },
        "templateName":{
            "type":"string",
            "maxLength":254,
            "description":"Template Name identifies the template used to send the notification to the person. The appropriate template is determined based on the person's language.",
            "example":"Outage Notification (English)"
        },
        "notificationTypeDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Description"
        },
        "parentNotificationTypeDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Description"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• saId: string
  Maximum Length: 10

  Service Agreement ID is the unique ID generated on create of a service agreement. This field identifies the service agreement for which notification preferences are retrieved.

  Example: 8805757605
• saNotificationPreferences: array saNotificationPreferences

{
    "type":"object",
    "properties":{
        "saId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement ID is the unique ID generated on create of a service agreement. This field identifies the service agreement for which notification preferences are retrieved.",
            "example":"8805757605"
        },
        "saNotificationPreferences":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "saNotificationPreferenceId":{
                        "type":"string",
                        "maxLength":14,
                        "description":"SA Notification Preference ID is the unique ID generated on create of an SA notification preference.",
                        "example":"54192836673724"
                    },
                    "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 ID generated on create of a person contact.",
                                "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":"The language used by the person receiving the notification. This determines the appropriate notification template to use.",
                                "example":"ENG"
                            },
                            "firstName":{
                                "type":"string",
                                "maxLength":50,
                                "description":"For a person, this field is the first name. If the system does not use a name separator, this field contains the entity name.\nFor a business, this field is the entity name.",
                                "example":"John"
                            },
                            "lastName":{
                                "type":"string",
                                "maxLength":50,
                                "description":"The person's last name. If the system does not use a name separator, this field is null. For a business, this field is also null.",
                                "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 specifies the person's time zone. If no time zone is assigned to the person, the time zone configured in Installation Options is used by default. The Do Not Disturb From and Do Not Disturb To times are interpreted based on this time zone.",
                                "example":"USPACIFIC"
                            },
                            "dndStartTime":{
                                "type":"string",
                                "description":"Do Not Disturb From specifies the start of the time range during which the person will not receive notifications.",
                                "example":"08.00.00"
                            },
                            "dndEndTime":{
                                "type":"string",
                                "description":"Do Not Disturb From specifies the end of the time range during which the person will not receive notifications.",
                                "example":"20.30.00"
                            },
                            "overrideDND":{
                                "type":"boolean",
                                "description":"Override Do Not Disturb is a boolean value that indicates whether the person allows notifications to be received during the Do Not Disturb (DND) time range.",
                                "example":"true"
                            },
                            "templateName":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Template Name identifies the template used to send the notification to the person. The appropriate template is determined based on the person's language.",
                                "example":"Outage Notification (English)"
                            },
                            "notificationTypeDescription":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Description"
                            },
                            "parentNotificationTypeDescription":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Description"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : saNotificationPreferences

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "saNotificationPreferenceId":{
                "type":"string",
                "maxLength":14,
                "description":"SA Notification Preference ID is the unique ID generated on create of an SA notification preference.",
                "example":"54192836673724"
            },
            "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 ID generated on create of a person contact.",
                        "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":"The language used by the person receiving the notification. This determines the appropriate notification template to use.",
                        "example":"ENG"
                    },
                    "firstName":{
                        "type":"string",
                        "maxLength":50,
                        "description":"For a person, this field is the first name. If the system does not use a name separator, this field contains the entity name.\nFor a business, this field is the entity name.",
                        "example":"John"
                    },
                    "lastName":{
                        "type":"string",
                        "maxLength":50,
                        "description":"The person's last name. If the system does not use a name separator, this field is null. For a business, this field is also null.",
                        "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 specifies the person's time zone. If no time zone is assigned to the person, the time zone configured in Installation Options is used by default. The Do Not Disturb From and Do Not Disturb To times are interpreted based on this time zone.",
                        "example":"USPACIFIC"
                    },
                    "dndStartTime":{
                        "type":"string",
                        "description":"Do Not Disturb From specifies the start of the time range during which the person will not receive notifications.",
                        "example":"08.00.00"
                    },
                    "dndEndTime":{
                        "type":"string",
                        "description":"Do Not Disturb From specifies the end of the time range during which the person will not receive notifications.",
                        "example":"20.30.00"
                    },
                    "overrideDND":{
                        "type":"boolean",
                        "description":"Override Do Not Disturb is a boolean value that indicates whether the person allows notifications to be received during the Do Not Disturb (DND) time range.",
                        "example":"true"
                    },
                    "templateName":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Template Name identifies the template used to send the notification to the person. The appropriate template is determined based on the person's language.",
                        "example":"Outage Notification (English)"
                    },
                    "notificationTypeDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Description"
                    },
                    "parentNotificationTypeDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Description"
                    }
                }
            }
        }
    }
}

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
• personContact: object personContact
• saNotificationPreferenceId: string
  Maximum Length: 14

  SA Notification Preference ID is the unique ID generated on create of an SA notification preference.

  Example: 54192836673724

{
    "type":"object",
    "properties":{
        "saNotificationPreferenceId":{
            "type":"string",
            "maxLength":14,
            "description":"SA Notification Preference ID is the unique ID generated on create of an SA notification preference.",
            "example":"54192836673724"
        },
        "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 ID generated on create of a person contact.",
                    "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":"The language used by the person receiving the notification. This determines the appropriate notification template to use.",
                    "example":"ENG"
                },
                "firstName":{
                    "type":"string",
                    "maxLength":50,
                    "description":"For a person, this field is the first name. If the system does not use a name separator, this field contains the entity name.\nFor a business, this field is the entity name.",
                    "example":"John"
                },
                "lastName":{
                    "type":"string",
                    "maxLength":50,
                    "description":"The person's last name. If the system does not use a name separator, this field is null. For a business, this field is also null.",
                    "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 specifies the person's time zone. If no time zone is assigned to the person, the time zone configured in Installation Options is used by default. The Do Not Disturb From and Do Not Disturb To times are interpreted based on this time zone.",
                    "example":"USPACIFIC"
                },
                "dndStartTime":{
                    "type":"string",
                    "description":"Do Not Disturb From specifies the start of the time range during which the person will not receive notifications.",
                    "example":"08.00.00"
                },
                "dndEndTime":{
                    "type":"string",
                    "description":"Do Not Disturb From specifies the end of the time range during which the person will not receive notifications.",
                    "example":"20.30.00"
                },
                "overrideDND":{
                    "type":"boolean",
                    "description":"Override Do Not Disturb is a boolean value that indicates whether the person allows notifications to be received during the Do Not Disturb (DND) time range.",
                    "example":"true"
                },
                "templateName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Template Name identifies the template used to send the notification to the person. The appropriate template is determined based on the person's language.",
                    "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 ID generated on create of a person contact.

  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 From specifies the end of the time range during which the person will not receive notifications.

  Example: 20.30.00
• dndStartTime: string
  Do Not Disturb From specifies the start of the time range during which the person will not receive notifications.

  Example: 08.00.00
• firstName: string
  Maximum Length: 50

  For a person, this field is the first name. If the system does not use a name separator, this field contains the entity name. For a business, this field is the entity name.

  Example: John
• language: string
  Maximum Length: 3

  The language used by the person receiving the notification. This determines the appropriate notification template to use.

  Example: ENG
• lastName: string
  Maximum Length: 50

  The person's last name. If the system does not use a name separator, this field is null. For a business, this field is also null.

  Example: Doe
• notificationTypeDescription: string
  Maximum Length: 100

  Description
• overrideDND: boolean
  Override Do Not Disturb is a boolean value that indicates whether the person allows notifications to be received during the Do Not Disturb (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 identifies the template used to send the notification to the person. The appropriate template is determined based on the person's language.

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

  Time Zone specifies the person's time zone. If no time zone is assigned to the person, the time zone configured in Installation Options is used by default. The Do Not Disturb From and Do Not Disturb To times are interpreted based on this time zone.

  Example: USPACIFIC

{
    "type":"object",
    "properties":{
        "contactId":{
            "type":"string",
            "maxLength":10,
            "description":"Person Contact ID is the unique ID generated on create of a person contact.",
            "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":"The language used by the person receiving the notification. This determines the appropriate notification template to use.",
            "example":"ENG"
        },
        "firstName":{
            "type":"string",
            "maxLength":50,
            "description":"For a person, this field is the first name. If the system does not use a name separator, this field contains the entity name.\nFor a business, this field is the entity name.",
            "example":"John"
        },
        "lastName":{
            "type":"string",
            "maxLength":50,
            "description":"The person's last name. If the system does not use a name separator, this field is null. For a business, this field is also null.",
            "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 specifies the person's time zone. If no time zone is assigned to the person, the time zone configured in Installation Options is used by default. The Do Not Disturb From and Do Not Disturb To times are interpreted based on this time zone.",
            "example":"USPACIFIC"
        },
        "dndStartTime":{
            "type":"string",
            "description":"Do Not Disturb From specifies the start of the time range during which the person will not receive notifications.",
            "example":"08.00.00"
        },
        "dndEndTime":{
            "type":"string",
            "description":"Do Not Disturb From specifies the end of the time range during which the person will not receive notifications.",
            "example":"20.30.00"
        },
        "overrideDND":{
            "type":"boolean",
            "description":"Override Do Not Disturb is a boolean value that indicates whether the person allows notifications to be received during the Do Not Disturb (DND) time range.",
            "example":"true"
        },
        "templateName":{
            "type":"string",
            "maxLength":254,
            "description":"Template Name identifies the template used to send the notification to the person. The appropriate template is determined based on the person's language.",
            "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