Oracle Utilities REST API for Metering and Customer Information

Unsubscribe Notifications

post

/rest/apis/customer/v-model/C1UnsubscribeNotifications/

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

accountId: string

Maximum Length: 10

The system generated unique identifier for the Account.

Example: 1575649032
contactId: string

Maximum Length: 10

The system generated unique identifier for the Person Contact.

Example: 1461171925
deliveryChannel: string

Allowed Values: [ "EMAI", "FAX ", "IVR ", "SMS " ]

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
deliveryValue: string

Maximum Length: 254

The information of the Person Contact where the notification will be sent.

Example: john.doe@gmail.com
notificationPreferenceId: string

Maximum Length: 14

The system generated unique identifier for the Notification Preference.

Example: 95058374991172
notificationType: string

Maximum Length: 30

The type of Notification used as Notification Preference.

Example: CM-OUTAGENOTIF

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The system generated unique identifier for the Account.",
            "example":"1575649032"
        },
        "contactId":{
            "type":"string",
            "maxLength":10,
            "description":"The system generated unique identifier for the Person Contact.",
            "example":"1461171925"
        },
        "notificationType":{
            "type":"string",
            "maxLength":30,
            "description":"The type of Notification used as Notification Preference.",
            "example":"CM-OUTAGENOTIF"
        },
        "notificationPreferenceId":{
            "type":"string",
            "maxLength":14,
            "description":"The system generated unique identifier for the Notification Preference.",
            "example":"95058374991172"
        },
        "deliveryChannel":{
            "type":"string",
            "enum":[
                "EMAI",
                "FAX ",
                "IVR ",
                "SMS "
            ],
            "description":"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"
        },
        "deliveryValue":{
            "type":"string",
            "maxLength":254,
            "description":"The information of the Person Contact where the notification will be sent.",
            "example":"john.doe@gmail.com"
        }
    },
    "xml":{
        "name":"C1UnsubNtf"
    }
}

Root Schema : schema

Type: object

Show Source

accountId: string

Maximum Length: 10

The system generated unique identifier for the Account.

Example: 1575649032
contactId: string

Maximum Length: 10

The system generated unique identifier for the Person Contact.

Example: 1461171925
deliveryChannel: string

Allowed Values: [ "EMAI", "FAX ", "IVR ", "SMS " ]

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
deliveryValue: string

Maximum Length: 254

The information of the Person Contact where the notification will be sent.

Example: john.doe@gmail.com
notificationPreferenceId: string

Maximum Length: 14

The system generated unique identifier for the Notification Preference.

Example: 95058374991172
notificationType: string

Maximum Length: 30

The type of Notification used as Notification Preference.

Example: CM-OUTAGENOTIF

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The system generated unique identifier for the Account.",
            "example":"1575649032"
        },
        "contactId":{
            "type":"string",
            "maxLength":10,
            "description":"The system generated unique identifier for the Person Contact.",
            "example":"1461171925"
        },
        "notificationType":{
            "type":"string",
            "maxLength":30,
            "description":"The type of Notification used as Notification Preference.",
            "example":"CM-OUTAGENOTIF"
        },
        "notificationPreferenceId":{
            "type":"string",
            "maxLength":14,
            "description":"The system generated unique identifier for the Notification Preference.",
            "example":"95058374991172"
        },
        "deliveryChannel":{
            "type":"string",
            "enum":[
                "EMAI",
                "FAX ",
                "IVR ",
                "SMS "
            ],
            "description":"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"
        },
        "deliveryValue":{
            "type":"string",
            "maxLength":254,
            "description":"The information of the Person Contact where the notification will be sent.",
            "example":"john.doe@gmail.com"
        }
    },
    "xml":{
        "name":"C1UnsubNtf"
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1UnsubNtf

Type: object

Show Source

informationMessage: object informationMessage

{
    "type":"object",
    "properties":{
        "informationMessage":{
            "type":"object",
            "properties":{
                "messageReference":{
                    "type":"object",
                    "properties":{
                        "category":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Message Category of the error."
                        },
                        "number":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Message Number of the error."
                        }
                    }
                },
                "message":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Message text containing the details of the error encountered."
                }
            }
        }
    },
    "xml":{
        "name":"C1UnsubNtf"
    }
}

Nested Schema : informationMessage

Type: object

Show Source

message: string

Maximum Length: 254

Message text containing the details of the error encountered.
messageReference: object messageReference

{
    "type":"object",
    "properties":{
        "messageReference":{
            "type":"object",
            "properties":{
                "category":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Category of the error."
                },
                "number":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number of the error."
                }
            }
        },
        "message":{
            "type":"string",
            "maxLength":254,
            "description":"Message text containing the details of the error encountered."
        }
    }
}

Nested Schema : messageReference

Type: object

Show Source

category: number

Minimum Value: -99999

Maximum Value: 99999

Message Category of the error.
number: number

Minimum Value: -99999

Maximum Value: 99999

Message Number of the error.

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

400 Response

Bad Request

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

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