1. Oracle Utilities REST API for Metering and Customer Information
  2. Tasks
  3. V-Model
  4. Communications Preferences

Patch Communications Preferences

patch

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

This operation updates communication details for provided Account Id and Person Id combination.

Request

Path Parameters
Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
Nested Schema : notificationTypeList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : notificationOption
Type: array
If the notification type is a subscription, an optional list of notification option extension fields to capture
Show Source
Nested Schema : notificationPreferenceList
Type: array
A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 106
    Data type lookup field for the option value.
    Example: NUMB
  • Maximum Length: 60
    Label of the option if allowed for the subscription notification type.
    Example: Days Before
  • Minimum Value: -9.999999999E9
    Maximum Value: 9.999999999E9
    Precision, if numeric
    Example: 1
  • Allowed Values: [ "N ", "Y " ]
    Required Y or N flag * `N ` - No, * `Y ` - Yes
    Example: N
  • Minimum Value: -999
    Maximum Value: 999
    Scale, if numeric
    Example: 0
  • Minimum Value: -999
    Maximum Value: 999
    Sequence if the notification type is a subscription that allows for an option to be set.
    Example: 10
  • Sign, if numeric
    Example: false
  • Maximum Length: 4000
    Path to the option value being stored.
    Example: dueInfo/numberOfDaysBeforeDue
  • validValue
  • Maximum Length: 254
    Value of the option that is set for the customer subscription.
    Example: 3
Nested Schema : validValue
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : notificationTypeList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : notificationOption
Type: array
If the notification type is a subscription, an optional list of notification option extension fields to capture
Show Source
Nested Schema : notificationPreferenceList
Type: array
A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 106
    Data type lookup field for the option value.
    Example: NUMB
  • Maximum Length: 60
    Label of the option if allowed for the subscription notification type.
    Example: Days Before
  • Minimum Value: -9.999999999E9
    Maximum Value: 9.999999999E9
    Precision, if numeric
    Example: 1
  • Allowed Values: [ "N ", "Y " ]
    Required Y or N flag * `N ` - No, * `Y ` - Yes
    Example: N
  • Minimum Value: -999
    Maximum Value: 999
    Scale, if numeric
    Example: 0
  • Minimum Value: -999
    Maximum Value: 999
    Sequence if the notification type is a subscription that allows for an option to be set.
    Example: 10
  • Sign, if numeric
    Example: false
  • Maximum Length: 4000
    Path to the option value being stored.
    Example: dueInfo/numberOfDaysBeforeDue
  • validValue
  • Maximum Length: 254
    Value of the option that is set for the customer subscription.
    Example: 3
Nested Schema : validValue
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : C1ComPrefer
Type: object
Show Source
Nested Schema : notificationTypeList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : notificationOption
Type: array
If the notification type is a subscription, an optional list of notification option extension fields to capture
Show Source
Nested Schema : notificationPreferenceList
Type: array
A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 106
    Data type lookup field for the option value.
    Example: NUMB
  • Maximum Length: 60
    Label of the option if allowed for the subscription notification type.
    Example: Days Before
  • Minimum Value: -9.999999999E9
    Maximum Value: 9.999999999E9
    Precision, if numeric
    Example: 1
  • Allowed Values: [ "N ", "Y " ]
    Required Y or N flag * `N ` - No, * `Y ` - Yes
    Example: N
  • Minimum Value: -999
    Maximum Value: 999
    Scale, if numeric
    Example: 0
  • Minimum Value: -999
    Maximum Value: 999
    Sequence if the notification type is a subscription that allows for an option to be set.
    Example: 10
  • Sign, if numeric
    Example: false
  • Maximum Length: 4000
    Path to the option value being stored.
    Example: dueInfo/numberOfDaysBeforeDue
  • validValue
  • Maximum Length: 254
    Value of the option that is set for the customer subscription.
    Example: 3
Nested Schema : validValue
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source

400 Response

Bad Request
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

Internal Server Error
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.
Back to Top