Retrieve Notification Preferences for Accounts
post
https://server:port/spl/rest/apis/customer/v-model/notificationPreferencesForAccounts/
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Nested Schema : items
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
The Account ID is a system-assigned random number that stays with an account for life.Example:1575649032
-
notificationType: string
Maximum Length:
30
Notification Type indicates the type of Notification used as Notification Preference.Example:CM-OUTAGENOTIF
-
sequence: number
Sequence is the primary key of the input and output, a numeric value which is the pointer for values in input and output.Example:
19
Nested Schema : items
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
The Account ID is a system-assigned random number that stays with an account for life.Example:1575649032
-
notificationType: string
Maximum Length:
30
Notification Type indicates the type of Notification used as Notification Preference.Example:CM-OUTAGENOTIF
-
sequence: number
Sequence is the primary key of the input and output, a numeric value which is the pointer for values in input and output.Example:
19
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : items
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
The Account ID is a system-assigned random number that stays with an account for life.Example:1575649032
-
cisDivision: string
Maximum Length:
5
CIS Division defines the jurisdiction that governs this account.Example:CA
-
errorInformation: object
errorInformation
-
notificationPreferences: array
notificationPreferences
-
notificationType: string
Maximum Length:
30
Notification Type indicates the type of Notification used as Notification Preference.Example:CM-OUTAGENOTIF
-
sequence: number
Sequence is the primary key of the input and output, a numeric value which is the pointer for values in input and output.Example:
19
Nested Schema : errorInformation
Type:
Show Source
object
-
errorMessage: string
Maximum Length:
254
This is the Message Text error, generated by Message Category and Message Number. This contains the details of the error encountered. -
errorReference: object
errorReference
-
isInError: boolean
This is the boolean flag, wherein we determine if the input set encountered an error.Example:
false
Nested Schema : errorReference
Type:
Show Source
object
-
category: number
Minimum Value:
-99999
Maximum Value:99999
This displays the Message Category of the error. -
number: number
Minimum Value:
-99999
Maximum Value:99999
This is the Message Number of the error.
Nested Schema : items
Type:
Show Source
object
-
deliveryType: string
Maximum Length:
4
Delivery Type is the type of delivery by which the notification will be sent to the Person Contact.Example:EMAI
-
notificationPreferenceId: string
Maximum Length:
14
Notification Preference ID is the unique ID generated on create of Notification Preference.Example:95058374991172
-
personContact: object
personContact
Nested Schema : personContact
Type:
Show Source
object
-
contactId: string
Maximum Length:
10
Person Contact ID is the unique generated ID on create of Person Contact Details.Example:1461171925
-
contactValue: string
Maximum Length:
254
Contact Value is the information of the Person Contact where the notification will be sent.Example:johndoe@email.com
-
dndFrom: string
Do Not Disturb From is the start of the range wherein the Person won't receive any notifications.Example:
08.00.00
-
dndTo: string
Do Not Disturb To is the end of the range wherein the Person won't receive any notifications.Example:
20.30.00
-
firstName: string
Maximum Length:
50
The Person's First Name. The value of this will be the ENTITY NAME if the system doesn't use name separator. For Business, ENTITY NAME is the value of the First Name.Example:John
-
language: string
Maximum Length:
3
Language is the language used by the Person who will be receiving the notification. This is used to retrieve the correct template of the notification to be sent.Example:ENG
-
lastName: string
Maximum Length:
50
The Person's Last Name. The value of this will be NULL if the system doesn't use name separator. For Business, NULL is the value of the Last Name.Example:Doe
-
overrideDND: boolean
Override Do Not Disturb is the boolean value wherein the person permits to receive notifications outside the DND Time range.Example:
true
-
personId: string
Maximum Length:
10
Person ID is the unique ID generated on create of a Person.Example:1469201746
-
template: string
Maximum Length:
254
Template Name is the template to be used in sending the notification to the Person. Template Name is based on the language of the Person.Example:Outage Notification (English)
-
timeZone: string
Maximum Length:
10
Time Zone is the Person's Time Zone. If the person is not assigned to a Time Zone, by default it is the Installation Options Time Zone value. Do Not Disturb To and From are based on this Time Zone code.Example:USPACIFIC
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.