Jump to

• Request
• Response

Record Customer Engagement

post

/rest/apis/customer/v-model/customerengagements/

This operation creates a Customer Engagement customer contact for each communication. If an error occurs, the communication information is stored in a Customer Engagement Error BO instance for later remediation and reprocessing. The Communication Product Event Type Mapping extendable lookup defines the mapping between a communication product/event type value combination and a notification event type lookup value. Notification event types must be configured for these lookup values. The customer contact type used for each communication is derived from the notification type defined for the notification event type. The communication is skipped if the customer contact type cannot be determined or if the customer contact BO is not defined on the customer contact 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

• communications: array communications

{
    "type":"object",
    "properties":{
        "communications":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                        "example":"833559999"
                    },
                    "externalCCId":{
                        "type":"string",
                        "maxLength":120,
                        "description":"The unique identifier of the communication in the  external system."
                    },
                    "originatingSystem":{
                        "type":"string",
                        "enum":[
                            "C1CB",
                            "NMS ",
                            "OPW "
                        ],
                        "description":"System that initiated the communication\n* `C1CB` - Customer Care and Billing,\n* `NMS ` - Network Management System,\n* `OPW ` - Opower",
                        "example":"OPW"
                    },
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                        "example":"3903069999"
                    },
                    "eventCapturedDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Date and time of the communication event."
                    },
                    "deliveryChannel":{
                        "type":"string",
                        "enum":[
                            "EMAI",
                            "FAX ",
                            "IVR ",
                            "SMS "
                        ],
                        "description":"The type of delivery by which the communication is 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 communication is sent.",
                        "example":"[e-mail]"
                    },
                    "status":{
                        "type":"string",
                        "enum":[
                            "C1AP",
                            "C1BN",
                            "C1CK",
                            "C1DV",
                            "C1ES",
                            "C1FL",
                            "C1NS",
                            "C1OP",
                            "C1PN",
                            "C1SK",
                            "C1ST"
                        ],
                        "description":"Status of the communication in the external system.\n* `C1AP` - Auto Opened,\n* `C1BN` - Bounced,\n* `C1CK` - Clicked,\n* `C1DV` - Delivered,\n* `C1ES` - Error Sending,\n* `C1FL` - Failed,\n* `C1NS` - Not Sent,\n* `C1OP` - Opened,\n* `C1PN` - Pending,\n* `C1SK` - Skipped,\n* `C1ST` - Sent",
                        "example":"C1ST"
                    },
                    "commProduct":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Communication Product",
                        "example":"BDR"
                    },
                    "commEventType":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Communication Event Type",
                        "example":"POST_SEASON_EVENT"
                    },
                    "commContentPath":{
                        "type":"string",
                        "maxLength":256,
                        "description":"Communication Content Path in the communication repository",
                        "example":"content-storage-v2://VMDL/BDR/POST_SEASON_EVENT/EMAIL/html_report/abc123def456"
                    },
                    "notificationPreferenceId":{
                        "type":"string",
                        "maxLength":14,
                        "description":"The Notification Preference ID is the unique system generated primary key for the Notification Preference record.",
                        "example":"95058374991172"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1CustEngage"
    }
}

Nested Schema : communications

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "accountId":{
                "type":"string",
                "maxLength":10,
                "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                "example":"833559999"
            },
            "externalCCId":{
                "type":"string",
                "maxLength":120,
                "description":"The unique identifier of the communication in the  external system."
            },
            "originatingSystem":{
                "type":"string",
                "enum":[
                    "C1CB",
                    "NMS ",
                    "OPW "
                ],
                "description":"System that initiated the communication\n* `C1CB` - Customer Care and Billing,\n* `NMS ` - Network Management System,\n* `OPW ` - Opower",
                "example":"OPW"
            },
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                "example":"3903069999"
            },
            "eventCapturedDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Date and time of the communication event."
            },
            "deliveryChannel":{
                "type":"string",
                "enum":[
                    "EMAI",
                    "FAX ",
                    "IVR ",
                    "SMS "
                ],
                "description":"The type of delivery by which the communication is 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 communication is sent.",
                "example":"[e-mail]"
            },
            "status":{
                "type":"string",
                "enum":[
                    "C1AP",
                    "C1BN",
                    "C1CK",
                    "C1DV",
                    "C1ES",
                    "C1FL",
                    "C1NS",
                    "C1OP",
                    "C1PN",
                    "C1SK",
                    "C1ST"
                ],
                "description":"Status of the communication in the external system.\n* `C1AP` - Auto Opened,\n* `C1BN` - Bounced,\n* `C1CK` - Clicked,\n* `C1DV` - Delivered,\n* `C1ES` - Error Sending,\n* `C1FL` - Failed,\n* `C1NS` - Not Sent,\n* `C1OP` - Opened,\n* `C1PN` - Pending,\n* `C1SK` - Skipped,\n* `C1ST` - Sent",
                "example":"C1ST"
            },
            "commProduct":{
                "type":"string",
                "maxLength":254,
                "description":"Communication Product",
                "example":"BDR"
            },
            "commEventType":{
                "type":"string",
                "maxLength":254,
                "description":"Communication Event Type",
                "example":"POST_SEASON_EVENT"
            },
            "commContentPath":{
                "type":"string",
                "maxLength":256,
                "description":"Communication Content Path in the communication repository",
                "example":"content-storage-v2://VMDL/BDR/POST_SEASON_EVENT/EMAIL/html_report/abc123def456"
            },
            "notificationPreferenceId":{
                "type":"string",
                "maxLength":14,
                "description":"The Notification Preference ID is the unique system generated primary key for the Notification Preference record.",
                "example":"95058374991172"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  The Account ID is a system-assigned random number that stays with an account for life.

  Example: 833559999
• commContentPath: string
  Maximum Length: 256

  Communication Content Path in the communication repository

  Example: content-storage-v2://VMDL/BDR/POST_SEASON_EVENT/EMAIL/html_report/abc123def456
• commEventType: string
  Maximum Length: 254

  Communication Event Type

  Example: POST_SEASON_EVENT
• commProduct: string
  Maximum Length: 254

  Communication Product

  Example: BDR
• deliveryChannel: string
  Allowed Values: [ "EMAI", "FAX ", "IVR ", "SMS " ]

  The type of delivery by which the communication is 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 communication is sent.

  Example: [e-mail]
• eventCapturedDateTime: string (date-time)
  Date and time of the communication event.
• externalCCId: string
  Maximum Length: 120

  The unique identifier of the communication in the external system.
• notificationPreferenceId: string
  Maximum Length: 14

  The Notification Preference ID is the unique system generated primary key for the Notification Preference record.

  Example: 95058374991172
• originatingSystem: string
  Allowed Values: [ "C1CB", "NMS ", "OPW " ]

  System that initiated the communication * `C1CB` - Customer Care and Billing, * `NMS ` - Network Management System, * `OPW ` - Opower

  Example: OPW
• personId: string
  Maximum Length: 10

  Person ID is a system-assigned random number that stays with a person for the life of the system.

  Example: 3903069999
• status: string
  Allowed Values: [ "C1AP", "C1BN", "C1CK", "C1DV", "C1ES", "C1FL", "C1NS", "C1OP", "C1PN", "C1SK", "C1ST" ]

  Status of the communication in the external system. * `C1AP` - Auto Opened, * `C1BN` - Bounced, * `C1CK` - Clicked, * `C1DV` - Delivered, * `C1ES` - Error Sending, * `C1FL` - Failed, * `C1NS` - Not Sent, * `C1OP` - Opened, * `C1PN` - Pending, * `C1SK` - Skipped, * `C1ST` - Sent

  Example: C1ST

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "example":"833559999"
        },
        "externalCCId":{
            "type":"string",
            "maxLength":120,
            "description":"The unique identifier of the communication in the  external system."
        },
        "originatingSystem":{
            "type":"string",
            "enum":[
                "C1CB",
                "NMS ",
                "OPW "
            ],
            "description":"System that initiated the communication\n* `C1CB` - Customer Care and Billing,\n* `NMS ` - Network Management System,\n* `OPW ` - Opower",
            "example":"OPW"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
            "example":"3903069999"
        },
        "eventCapturedDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the communication event."
        },
        "deliveryChannel":{
            "type":"string",
            "enum":[
                "EMAI",
                "FAX ",
                "IVR ",
                "SMS "
            ],
            "description":"The type of delivery by which the communication is 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 communication is sent.",
            "example":"[e-mail]"
        },
        "status":{
            "type":"string",
            "enum":[
                "C1AP",
                "C1BN",
                "C1CK",
                "C1DV",
                "C1ES",
                "C1FL",
                "C1NS",
                "C1OP",
                "C1PN",
                "C1SK",
                "C1ST"
            ],
            "description":"Status of the communication in the external system.\n* `C1AP` - Auto Opened,\n* `C1BN` - Bounced,\n* `C1CK` - Clicked,\n* `C1DV` - Delivered,\n* `C1ES` - Error Sending,\n* `C1FL` - Failed,\n* `C1NS` - Not Sent,\n* `C1OP` - Opened,\n* `C1PN` - Pending,\n* `C1SK` - Skipped,\n* `C1ST` - Sent",
            "example":"C1ST"
        },
        "commProduct":{
            "type":"string",
            "maxLength":254,
            "description":"Communication Product",
            "example":"BDR"
        },
        "commEventType":{
            "type":"string",
            "maxLength":254,
            "description":"Communication Event Type",
            "example":"POST_SEASON_EVENT"
        },
        "commContentPath":{
            "type":"string",
            "maxLength":256,
            "description":"Communication Content Path in the communication repository",
            "example":"content-storage-v2://VMDL/BDR/POST_SEASON_EVENT/EMAIL/html_report/abc123def456"
        },
        "notificationPreferenceId":{
            "type":"string",
            "maxLength":14,
            "description":"The Notification Preference ID is the unique system generated primary key for the Notification Preference record.",
            "example":"95058374991172"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• communications: array communications

{
    "type":"object",
    "properties":{
        "communications":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                        "example":"833559999"
                    },
                    "externalCCId":{
                        "type":"string",
                        "maxLength":120,
                        "description":"The unique identifier of the communication in the  external system."
                    },
                    "originatingSystem":{
                        "type":"string",
                        "enum":[
                            "C1CB",
                            "NMS ",
                            "OPW "
                        ],
                        "description":"System that initiated the communication\n* `C1CB` - Customer Care and Billing,\n* `NMS ` - Network Management System,\n* `OPW ` - Opower",
                        "example":"OPW"
                    },
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                        "example":"3903069999"
                    },
                    "eventCapturedDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Date and time of the communication event."
                    },
                    "deliveryChannel":{
                        "type":"string",
                        "enum":[
                            "EMAI",
                            "FAX ",
                            "IVR ",
                            "SMS "
                        ],
                        "description":"The type of delivery by which the communication is 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 communication is sent.",
                        "example":"[e-mail]"
                    },
                    "status":{
                        "type":"string",
                        "enum":[
                            "C1AP",
                            "C1BN",
                            "C1CK",
                            "C1DV",
                            "C1ES",
                            "C1FL",
                            "C1NS",
                            "C1OP",
                            "C1PN",
                            "C1SK",
                            "C1ST"
                        ],
                        "description":"Status of the communication in the external system.\n* `C1AP` - Auto Opened,\n* `C1BN` - Bounced,\n* `C1CK` - Clicked,\n* `C1DV` - Delivered,\n* `C1ES` - Error Sending,\n* `C1FL` - Failed,\n* `C1NS` - Not Sent,\n* `C1OP` - Opened,\n* `C1PN` - Pending,\n* `C1SK` - Skipped,\n* `C1ST` - Sent",
                        "example":"C1ST"
                    },
                    "commProduct":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Communication Product",
                        "example":"BDR"
                    },
                    "commEventType":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Communication Event Type",
                        "example":"POST_SEASON_EVENT"
                    },
                    "commContentPath":{
                        "type":"string",
                        "maxLength":256,
                        "description":"Communication Content Path in the communication repository",
                        "example":"content-storage-v2://VMDL/BDR/POST_SEASON_EVENT/EMAIL/html_report/abc123def456"
                    },
                    "notificationPreferenceId":{
                        "type":"string",
                        "maxLength":14,
                        "description":"The Notification Preference ID is the unique system generated primary key for the Notification Preference record.",
                        "example":"95058374991172"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1CustEngage"
    }
}

Nested Schema : communications

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "accountId":{
                "type":"string",
                "maxLength":10,
                "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                "example":"833559999"
            },
            "externalCCId":{
                "type":"string",
                "maxLength":120,
                "description":"The unique identifier of the communication in the  external system."
            },
            "originatingSystem":{
                "type":"string",
                "enum":[
                    "C1CB",
                    "NMS ",
                    "OPW "
                ],
                "description":"System that initiated the communication\n* `C1CB` - Customer Care and Billing,\n* `NMS ` - Network Management System,\n* `OPW ` - Opower",
                "example":"OPW"
            },
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                "example":"3903069999"
            },
            "eventCapturedDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Date and time of the communication event."
            },
            "deliveryChannel":{
                "type":"string",
                "enum":[
                    "EMAI",
                    "FAX ",
                    "IVR ",
                    "SMS "
                ],
                "description":"The type of delivery by which the communication is 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 communication is sent.",
                "example":"[e-mail]"
            },
            "status":{
                "type":"string",
                "enum":[
                    "C1AP",
                    "C1BN",
                    "C1CK",
                    "C1DV",
                    "C1ES",
                    "C1FL",
                    "C1NS",
                    "C1OP",
                    "C1PN",
                    "C1SK",
                    "C1ST"
                ],
                "description":"Status of the communication in the external system.\n* `C1AP` - Auto Opened,\n* `C1BN` - Bounced,\n* `C1CK` - Clicked,\n* `C1DV` - Delivered,\n* `C1ES` - Error Sending,\n* `C1FL` - Failed,\n* `C1NS` - Not Sent,\n* `C1OP` - Opened,\n* `C1PN` - Pending,\n* `C1SK` - Skipped,\n* `C1ST` - Sent",
                "example":"C1ST"
            },
            "commProduct":{
                "type":"string",
                "maxLength":254,
                "description":"Communication Product",
                "example":"BDR"
            },
            "commEventType":{
                "type":"string",
                "maxLength":254,
                "description":"Communication Event Type",
                "example":"POST_SEASON_EVENT"
            },
            "commContentPath":{
                "type":"string",
                "maxLength":256,
                "description":"Communication Content Path in the communication repository",
                "example":"content-storage-v2://VMDL/BDR/POST_SEASON_EVENT/EMAIL/html_report/abc123def456"
            },
            "notificationPreferenceId":{
                "type":"string",
                "maxLength":14,
                "description":"The Notification Preference ID is the unique system generated primary key for the Notification Preference record.",
                "example":"95058374991172"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  The Account ID is a system-assigned random number that stays with an account for life.

  Example: 833559999
• commContentPath: string
  Maximum Length: 256

  Communication Content Path in the communication repository

  Example: content-storage-v2://VMDL/BDR/POST_SEASON_EVENT/EMAIL/html_report/abc123def456
• commEventType: string
  Maximum Length: 254

  Communication Event Type

  Example: POST_SEASON_EVENT
• commProduct: string
  Maximum Length: 254

  Communication Product

  Example: BDR
• deliveryChannel: string
  Allowed Values: [ "EMAI", "FAX ", "IVR ", "SMS " ]

  The type of delivery by which the communication is 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 communication is sent.

  Example: [e-mail]
• eventCapturedDateTime: string (date-time)
  Date and time of the communication event.
• externalCCId: string
  Maximum Length: 120

  The unique identifier of the communication in the external system.
• notificationPreferenceId: string
  Maximum Length: 14

  The Notification Preference ID is the unique system generated primary key for the Notification Preference record.

  Example: 95058374991172
• originatingSystem: string
  Allowed Values: [ "C1CB", "NMS ", "OPW " ]

  System that initiated the communication * `C1CB` - Customer Care and Billing, * `NMS ` - Network Management System, * `OPW ` - Opower

  Example: OPW
• personId: string
  Maximum Length: 10

  Person ID is a system-assigned random number that stays with a person for the life of the system.

  Example: 3903069999
• status: string
  Allowed Values: [ "C1AP", "C1BN", "C1CK", "C1DV", "C1ES", "C1FL", "C1NS", "C1OP", "C1PN", "C1SK", "C1ST" ]

  Status of the communication in the external system. * `C1AP` - Auto Opened, * `C1BN` - Bounced, * `C1CK` - Clicked, * `C1DV` - Delivered, * `C1ES` - Error Sending, * `C1FL` - Failed, * `C1NS` - Not Sent, * `C1OP` - Opened, * `C1PN` - Pending, * `C1SK` - Skipped, * `C1ST` - Sent

  Example: C1ST

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "example":"833559999"
        },
        "externalCCId":{
            "type":"string",
            "maxLength":120,
            "description":"The unique identifier of the communication in the  external system."
        },
        "originatingSystem":{
            "type":"string",
            "enum":[
                "C1CB",
                "NMS ",
                "OPW "
            ],
            "description":"System that initiated the communication\n* `C1CB` - Customer Care and Billing,\n* `NMS ` - Network Management System,\n* `OPW ` - Opower",
            "example":"OPW"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
            "example":"3903069999"
        },
        "eventCapturedDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the communication event."
        },
        "deliveryChannel":{
            "type":"string",
            "enum":[
                "EMAI",
                "FAX ",
                "IVR ",
                "SMS "
            ],
            "description":"The type of delivery by which the communication is 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 communication is sent.",
            "example":"[e-mail]"
        },
        "status":{
            "type":"string",
            "enum":[
                "C1AP",
                "C1BN",
                "C1CK",
                "C1DV",
                "C1ES",
                "C1FL",
                "C1NS",
                "C1OP",
                "C1PN",
                "C1SK",
                "C1ST"
            ],
            "description":"Status of the communication in the external system.\n* `C1AP` - Auto Opened,\n* `C1BN` - Bounced,\n* `C1CK` - Clicked,\n* `C1DV` - Delivered,\n* `C1ES` - Error Sending,\n* `C1FL` - Failed,\n* `C1NS` - Not Sent,\n* `C1OP` - Opened,\n* `C1PN` - Pending,\n* `C1SK` - Skipped,\n* `C1ST` - Sent",
            "example":"C1ST"
        },
        "commProduct":{
            "type":"string",
            "maxLength":254,
            "description":"Communication Product",
            "example":"BDR"
        },
        "commEventType":{
            "type":"string",
            "maxLength":254,
            "description":"Communication Event Type",
            "example":"POST_SEASON_EVENT"
        },
        "commContentPath":{
            "type":"string",
            "maxLength":256,
            "description":"Communication Content Path in the communication repository",
            "example":"content-storage-v2://VMDL/BDR/POST_SEASON_EVENT/EMAIL/html_report/abc123def456"
        },
        "notificationPreferenceId":{
            "type":"string",
            "maxLength":14,
            "description":"The Notification Preference ID is the unique system generated primary key for the Notification Preference record.",
            "example":"95058374991172"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1CustEngage

Type: object

Show Source

{
    "type":"object",
    "properties":{
    },
    "xml":{
        "name":"C1CustEngage"
    }
}

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