Jump to

• Request
• Response

Add or Update Outage Events

post

/rest/apis/customer/service/outageEventNotifications/

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

• externalSystem: string
  Maximum Length: 30

  The unique identifier of the outage management system reporting the outage information. This should be a valid reference to an External System record.

  Example: CCB-NMS integration
• outageMessages: array outageMessages

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":30,
            "description":"The unique identifier of the outage management system reporting the outage information. This should be a valid reference to an External System record.",
            "example":"CCB-NMS integration"
        },
        "outageMessages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "eventDetails":{
                        "type":"object",
                        "properties":{
                            "externalOutageId":{
                                "type":"string",
                                "maxLength":254,
                                "description":"The unique identifier of the outage event in the outage management system.",
                                "example":"200234"
                            },
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The outage event's start time.",
                                "example":"2025-02-06T02:00:00-08:00"
                            },
                            "estimatedRestorationTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The outage event's estimated restoration time.",
                                "example":"2025-02-07T12:00:00-08:00"
                            },
                            "completionDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The outage event's restoration or cancelation time.",
                                "example":"2025-02-07T12:00:00-08:00"
                            },
                            "outageType":{
                                "type":"string",
                                "enum":[
                                    "C1PL",
                                    "C1UP"
                                ],
                                "description":"Specifies whether the outage was planned or not.\n* `C1PL` - Planned,\n* `C1UP` - Unplanned",
                                "example":"C1PL"
                            },
                            "messageReference":{
                                "type":"string",
                                "maxLength":254,
                                "description":"An optional value that is assumed to be an increasing when outage event details are updated within the outage management system. It is used to reject stale updates when the incoming message value is lower than the value on the existing record for the event.",
                                "example":"12"
                            },
                            "discarded":{
                                "type":"boolean",
                                "description":"Indicates that the outage event is discarded.",
                                "example":"false"
                            },
                            "impactedCustomers":{
                                "type":"number",
                                "maximum":999999999,
                                "minimum":0,
                                "description":"The number of impacted customers.",
                                "example":"259"
                            },
                            "additionalDetails":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "name":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Name of event",
                                            "example":"power outage"
                                        },
                                        "value":{
                                            "type":"string",
                                            "maxLength":100,
                                            "description":"Value of outage"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "customerInformation":{
                        "type":"object",
                        "properties":{
                            "customers":{
                                "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":"1589809032"
                                        },
                                        "spId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Service Point ID is a system assigned random number that stays with a service point record.",
                                            "example":"2486945183"
                                        }
                                    }
                                }
                            },
                            "incrementalUpdate":{
                                "type":"boolean",
                                "description":"Indicates whether the list of impacted customers is the full list or an incremental addition to the existing list.",
                                "example":"true"
                            }
                        }
                    },
                    "characteristics":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Sequence number of Characteristic",
                                    "example":"10"
                                },
                                "characteristicType":{
                                    "type":"string",
                                    "maxLength":8,
                                    "description":"Type of characteristic that is configured for keeping additional data for the record."
                                },
                                "typeOfCharacteristicValue":{
                                    "type":"string",
                                    "enum":[
                                        "ADV ",
                                        "DFV ",
                                        "FKV ",
                                        "FLV "
                                    ],
                                    "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                                },
                                "characteristicValue":{
                                    "type":"object",
                                    "properties":{
                                        "value":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Adhoc Characteristic Value"
                                        },
                                        "value2":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"Foreign Key Value 2"
                                        },
                                        "value3":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"Foreign Key Value 3"
                                        },
                                        "value4":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"Foreign Key Value 4"
                                        },
                                        "value5":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"Foreign Key Value 5"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1OutEvtsUpd"
    }
}

Nested Schema : outageMessages

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "eventDetails":{
                "type":"object",
                "properties":{
                    "externalOutageId":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The unique identifier of the outage event in the outage management system.",
                        "example":"200234"
                    },
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The outage event's start time.",
                        "example":"2025-02-06T02:00:00-08:00"
                    },
                    "estimatedRestorationTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The outage event's estimated restoration time.",
                        "example":"2025-02-07T12:00:00-08:00"
                    },
                    "completionDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The outage event's restoration or cancelation time.",
                        "example":"2025-02-07T12:00:00-08:00"
                    },
                    "outageType":{
                        "type":"string",
                        "enum":[
                            "C1PL",
                            "C1UP"
                        ],
                        "description":"Specifies whether the outage was planned or not.\n* `C1PL` - Planned,\n* `C1UP` - Unplanned",
                        "example":"C1PL"
                    },
                    "messageReference":{
                        "type":"string",
                        "maxLength":254,
                        "description":"An optional value that is assumed to be an increasing when outage event details are updated within the outage management system. It is used to reject stale updates when the incoming message value is lower than the value on the existing record for the event.",
                        "example":"12"
                    },
                    "discarded":{
                        "type":"boolean",
                        "description":"Indicates that the outage event is discarded.",
                        "example":"false"
                    },
                    "impactedCustomers":{
                        "type":"number",
                        "maximum":999999999,
                        "minimum":0,
                        "description":"The number of impacted customers.",
                        "example":"259"
                    },
                    "additionalDetails":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "name":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Name of event",
                                    "example":"power outage"
                                },
                                "value":{
                                    "type":"string",
                                    "maxLength":100,
                                    "description":"Value of outage"
                                }
                            }
                        }
                    }
                }
            },
            "customerInformation":{
                "type":"object",
                "properties":{
                    "customers":{
                        "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":"1589809032"
                                },
                                "spId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Service Point ID is a system assigned random number that stays with a service point record.",
                                    "example":"2486945183"
                                }
                            }
                        }
                    },
                    "incrementalUpdate":{
                        "type":"boolean",
                        "description":"Indicates whether the list of impacted customers is the full list or an incremental addition to the existing list.",
                        "example":"true"
                    }
                }
            },
            "characteristics":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "sequence":{
                            "type":"number",
                            "maximum":999,
                            "minimum":-999,
                            "description":"Sequence number of Characteristic",
                            "example":"10"
                        },
                        "characteristicType":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Type of characteristic that is configured for keeping additional data for the record."
                        },
                        "typeOfCharacteristicValue":{
                            "type":"string",
                            "enum":[
                                "ADV ",
                                "DFV ",
                                "FKV ",
                                "FLV "
                            ],
                            "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                        },
                        "characteristicValue":{
                            "type":"object",
                            "properties":{
                                "value":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Adhoc Characteristic Value"
                                },
                                "value2":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"Foreign Key Value 2"
                                },
                                "value3":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"Foreign Key Value 3"
                                },
                                "value4":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"Foreign Key Value 4"
                                },
                                "value5":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"Foreign Key Value 5"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristics: array characteristics
• customerInformation: object customerInformation
• eventDetails: object eventDetails

{
    "type":"object",
    "properties":{
        "eventDetails":{
            "type":"object",
            "properties":{
                "externalOutageId":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The unique identifier of the outage event in the outage management system.",
                    "example":"200234"
                },
                "startDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The outage event's start time.",
                    "example":"2025-02-06T02:00:00-08:00"
                },
                "estimatedRestorationTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The outage event's estimated restoration time.",
                    "example":"2025-02-07T12:00:00-08:00"
                },
                "completionDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The outage event's restoration or cancelation time.",
                    "example":"2025-02-07T12:00:00-08:00"
                },
                "outageType":{
                    "type":"string",
                    "enum":[
                        "C1PL",
                        "C1UP"
                    ],
                    "description":"Specifies whether the outage was planned or not.\n* `C1PL` - Planned,\n* `C1UP` - Unplanned",
                    "example":"C1PL"
                },
                "messageReference":{
                    "type":"string",
                    "maxLength":254,
                    "description":"An optional value that is assumed to be an increasing when outage event details are updated within the outage management system. It is used to reject stale updates when the incoming message value is lower than the value on the existing record for the event.",
                    "example":"12"
                },
                "discarded":{
                    "type":"boolean",
                    "description":"Indicates that the outage event is discarded.",
                    "example":"false"
                },
                "impactedCustomers":{
                    "type":"number",
                    "maximum":999999999,
                    "minimum":0,
                    "description":"The number of impacted customers.",
                    "example":"259"
                },
                "additionalDetails":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Name of event",
                                "example":"power outage"
                            },
                            "value":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Value of outage"
                            }
                        }
                    }
                }
            }
        },
        "customerInformation":{
            "type":"object",
            "properties":{
                "customers":{
                    "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":"1589809032"
                            },
                            "spId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Point ID is a system assigned random number that stays with a service point record.",
                                "example":"2486945183"
                            }
                        }
                    }
                },
                "incrementalUpdate":{
                    "type":"boolean",
                    "description":"Indicates whether the list of impacted customers is the full list or an incremental addition to the existing list.",
                    "example":"true"
                }
            }
        },
        "characteristics":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence number of Characteristic",
                        "example":"10"
                    },
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Type of characteristic that is configured for keeping additional data for the record."
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "enum":[
                            "ADV ",
                            "DFV ",
                            "FKV ",
                            "FLV "
                        ],
                        "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Adhoc Characteristic Value"
                            },
                            "value2":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 2"
                            },
                            "value3":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 3"
                            },
                            "value4":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 4"
                            },
                            "value5":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 5"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : characteristics

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence number of Characteristic",
                "example":"10"
            },
            "characteristicType":{
                "type":"string",
                "maxLength":8,
                "description":"Type of characteristic that is configured for keeping additional data for the record."
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "enum":[
                    "ADV ",
                    "DFV ",
                    "FKV ",
                    "FLV "
                ],
                "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Adhoc Characteristic Value"
                    },
                    "value2":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 2"
                    },
                    "value3":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 3"
                    },
                    "value4":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 4"
                    },
                    "value5":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 5"
                    }
                }
            }
        }
    }
}

Nested Schema : customerInformation

Type: object

Show Source

• customers: array customers
• incrementalUpdate: boolean
  Indicates whether the list of impacted customers is the full list or an incremental addition to the existing list.

  Example: true

{
    "type":"object",
    "properties":{
        "customers":{
            "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":"1589809032"
                    },
                    "spId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID is a system assigned random number that stays with a service point record.",
                        "example":"2486945183"
                    }
                }
            }
        },
        "incrementalUpdate":{
            "type":"boolean",
            "description":"Indicates whether the list of impacted customers is the full list or an incremental addition to the existing list.",
            "example":"true"
        }
    }
}

Nested Schema : eventDetails

Type: object

Show Source

• additionalDetails: array additionalDetails
• completionDateTime: string (date-time)
  The outage event's restoration or cancelation time.

  Example: 2025-02-07T12:00:00-08:00
• discarded: boolean
  Indicates that the outage event is discarded.

  Example: false
• estimatedRestorationTime: string (date-time)
  The outage event's estimated restoration time.

  Example: 2025-02-07T12:00:00-08:00
• externalOutageId: string
  Maximum Length: 254

  The unique identifier of the outage event in the outage management system.

  Example: 200234
• impactedCustomers: number
  Minimum Value: 0

  Maximum Value: 999999999

  The number of impacted customers.

  Example: 259
• messageReference: string
  Maximum Length: 254

  An optional value that is assumed to be an increasing when outage event details are updated within the outage management system. It is used to reject stale updates when the incoming message value is lower than the value on the existing record for the event.

  Example: 12
• outageType: string
  Allowed Values: [ "C1PL", "C1UP" ]

  Specifies whether the outage was planned or not. * `C1PL` - Planned, * `C1UP` - Unplanned

  Example: C1PL
• startDateTime: string (date-time)
  The outage event's start time.

  Example: 2025-02-06T02:00:00-08:00

{
    "type":"object",
    "properties":{
        "externalOutageId":{
            "type":"string",
            "maxLength":254,
            "description":"The unique identifier of the outage event in the outage management system.",
            "example":"200234"
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The outage event's start time.",
            "example":"2025-02-06T02:00:00-08:00"
        },
        "estimatedRestorationTime":{
            "type":"string",
            "format":"date-time",
            "description":"The outage event's estimated restoration time.",
            "example":"2025-02-07T12:00:00-08:00"
        },
        "completionDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The outage event's restoration or cancelation time.",
            "example":"2025-02-07T12:00:00-08:00"
        },
        "outageType":{
            "type":"string",
            "enum":[
                "C1PL",
                "C1UP"
            ],
            "description":"Specifies whether the outage was planned or not.\n* `C1PL` - Planned,\n* `C1UP` - Unplanned",
            "example":"C1PL"
        },
        "messageReference":{
            "type":"string",
            "maxLength":254,
            "description":"An optional value that is assumed to be an increasing when outage event details are updated within the outage management system. It is used to reject stale updates when the incoming message value is lower than the value on the existing record for the event.",
            "example":"12"
        },
        "discarded":{
            "type":"boolean",
            "description":"Indicates that the outage event is discarded.",
            "example":"false"
        },
        "impactedCustomers":{
            "type":"number",
            "maximum":999999999,
            "minimum":0,
            "description":"The number of impacted customers.",
            "example":"259"
        },
        "additionalDetails":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Name of event",
                        "example":"power outage"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Value of outage"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: string
  Maximum Length: 8

  Type of characteristic that is configured for keeping additional data for the record.
• characteristicValue: object characteristicValue
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence number of Characteristic

  Example: 10
• typeOfCharacteristicValue: string
  Allowed Values: [ "ADV ", "DFV ", "FKV ", "FLV " ]

  Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location. * `ADV ` - Adhoc Value, * `DFV ` - Predefined Value, * `FKV ` - Foreign Key Value, * `FLV ` - File Location Value

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence number of Characteristic",
            "example":"10"
        },
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Type of characteristic that is configured for keeping additional data for the record."
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "enum":[
                "ADV ",
                "DFV ",
                "FKV ",
                "FLV "
            ],
            "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Adhoc Characteristic Value"
                },
                "value2":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 2"
                },
                "value3":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 3"
                },
                "value4":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 4"
                },
                "value5":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 5"
                }
            }
        }
    }
}

Nested Schema : characteristicValue

Type: object

Show Source

• value: string
  Maximum Length: 254

  Adhoc Characteristic Value
• value2: string
  Maximum Length: 50

  Foreign Key Value 2
• value3: string
  Maximum Length: 50

  Foreign Key Value 3
• value4: string
  Maximum Length: 50

  Foreign Key Value 4
• value5: string
  Maximum Length: 50

  Foreign Key Value 5

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "maxLength":254,
            "description":"Adhoc Characteristic Value"
        },
        "value2":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 2"
        },
        "value3":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 3"
        },
        "value4":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 4"
        },
        "value5":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 5"
        }
    }
}

Nested Schema : customers

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":"1589809032"
            },
            "spId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Point ID is a system assigned random number that stays with a service point record.",
                "example":"2486945183"
            }
        }
    }
}

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: 1589809032
• spId: string
  Maximum Length: 10

  Service Point ID is a system assigned random number that stays with a service point record.

  Example: 2486945183

{
    "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":"1589809032"
        },
        "spId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID is a system assigned random number that stays with a service point record.",
            "example":"2486945183"
        }
    }
}

Nested Schema : additionalDetails

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "maxLength":254,
                "description":"Name of event",
                "example":"power outage"
            },
            "value":{
                "type":"string",
                "maxLength":100,
                "description":"Value of outage"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
  Maximum Length: 254

  Name of event

  Example: power outage
• value: string
  Maximum Length: 100

  Value of outage

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "maxLength":254,
            "description":"Name of event",
            "example":"power outage"
        },
        "value":{
            "type":"string",
            "maxLength":100,
            "description":"Value of outage"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• externalSystem: string
  Maximum Length: 30

  The unique identifier of the outage management system reporting the outage information. This should be a valid reference to an External System record.

  Example: CCB-NMS integration
• outageMessages: array outageMessages

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":30,
            "description":"The unique identifier of the outage management system reporting the outage information. This should be a valid reference to an External System record.",
            "example":"CCB-NMS integration"
        },
        "outageMessages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "eventDetails":{
                        "type":"object",
                        "properties":{
                            "externalOutageId":{
                                "type":"string",
                                "maxLength":254,
                                "description":"The unique identifier of the outage event in the outage management system.",
                                "example":"200234"
                            },
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The outage event's start time.",
                                "example":"2025-02-06T02:00:00-08:00"
                            },
                            "estimatedRestorationTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The outage event's estimated restoration time.",
                                "example":"2025-02-07T12:00:00-08:00"
                            },
                            "completionDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The outage event's restoration or cancelation time.",
                                "example":"2025-02-07T12:00:00-08:00"
                            },
                            "outageType":{
                                "type":"string",
                                "enum":[
                                    "C1PL",
                                    "C1UP"
                                ],
                                "description":"Specifies whether the outage was planned or not.\n* `C1PL` - Planned,\n* `C1UP` - Unplanned",
                                "example":"C1PL"
                            },
                            "messageReference":{
                                "type":"string",
                                "maxLength":254,
                                "description":"An optional value that is assumed to be an increasing when outage event details are updated within the outage management system. It is used to reject stale updates when the incoming message value is lower than the value on the existing record for the event.",
                                "example":"12"
                            },
                            "discarded":{
                                "type":"boolean",
                                "description":"Indicates that the outage event is discarded.",
                                "example":"false"
                            },
                            "impactedCustomers":{
                                "type":"number",
                                "maximum":999999999,
                                "minimum":0,
                                "description":"The number of impacted customers.",
                                "example":"259"
                            },
                            "additionalDetails":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "name":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Name of event",
                                            "example":"power outage"
                                        },
                                        "value":{
                                            "type":"string",
                                            "maxLength":100,
                                            "description":"Value of outage"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "customerInformation":{
                        "type":"object",
                        "properties":{
                            "customers":{
                                "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":"1589809032"
                                        },
                                        "spId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Service Point ID is a system assigned random number that stays with a service point record.",
                                            "example":"2486945183"
                                        }
                                    }
                                }
                            },
                            "incrementalUpdate":{
                                "type":"boolean",
                                "description":"Indicates whether the list of impacted customers is the full list or an incremental addition to the existing list.",
                                "example":"true"
                            }
                        }
                    },
                    "characteristics":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Sequence number of Characteristic",
                                    "example":"10"
                                },
                                "characteristicType":{
                                    "type":"string",
                                    "maxLength":8,
                                    "description":"Type of characteristic that is configured for keeping additional data for the record."
                                },
                                "typeOfCharacteristicValue":{
                                    "type":"string",
                                    "enum":[
                                        "ADV ",
                                        "DFV ",
                                        "FKV ",
                                        "FLV "
                                    ],
                                    "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                                },
                                "characteristicValue":{
                                    "type":"object",
                                    "properties":{
                                        "value":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Adhoc Characteristic Value"
                                        },
                                        "value2":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"Foreign Key Value 2"
                                        },
                                        "value3":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"Foreign Key Value 3"
                                        },
                                        "value4":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"Foreign Key Value 4"
                                        },
                                        "value5":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"Foreign Key Value 5"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1OutEvtsUpd"
    }
}

Nested Schema : outageMessages

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "eventDetails":{
                "type":"object",
                "properties":{
                    "externalOutageId":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The unique identifier of the outage event in the outage management system.",
                        "example":"200234"
                    },
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The outage event's start time.",
                        "example":"2025-02-06T02:00:00-08:00"
                    },
                    "estimatedRestorationTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The outage event's estimated restoration time.",
                        "example":"2025-02-07T12:00:00-08:00"
                    },
                    "completionDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The outage event's restoration or cancelation time.",
                        "example":"2025-02-07T12:00:00-08:00"
                    },
                    "outageType":{
                        "type":"string",
                        "enum":[
                            "C1PL",
                            "C1UP"
                        ],
                        "description":"Specifies whether the outage was planned or not.\n* `C1PL` - Planned,\n* `C1UP` - Unplanned",
                        "example":"C1PL"
                    },
                    "messageReference":{
                        "type":"string",
                        "maxLength":254,
                        "description":"An optional value that is assumed to be an increasing when outage event details are updated within the outage management system. It is used to reject stale updates when the incoming message value is lower than the value on the existing record for the event.",
                        "example":"12"
                    },
                    "discarded":{
                        "type":"boolean",
                        "description":"Indicates that the outage event is discarded.",
                        "example":"false"
                    },
                    "impactedCustomers":{
                        "type":"number",
                        "maximum":999999999,
                        "minimum":0,
                        "description":"The number of impacted customers.",
                        "example":"259"
                    },
                    "additionalDetails":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "name":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Name of event",
                                    "example":"power outage"
                                },
                                "value":{
                                    "type":"string",
                                    "maxLength":100,
                                    "description":"Value of outage"
                                }
                            }
                        }
                    }
                }
            },
            "customerInformation":{
                "type":"object",
                "properties":{
                    "customers":{
                        "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":"1589809032"
                                },
                                "spId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Service Point ID is a system assigned random number that stays with a service point record.",
                                    "example":"2486945183"
                                }
                            }
                        }
                    },
                    "incrementalUpdate":{
                        "type":"boolean",
                        "description":"Indicates whether the list of impacted customers is the full list or an incremental addition to the existing list.",
                        "example":"true"
                    }
                }
            },
            "characteristics":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "sequence":{
                            "type":"number",
                            "maximum":999,
                            "minimum":-999,
                            "description":"Sequence number of Characteristic",
                            "example":"10"
                        },
                        "characteristicType":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Type of characteristic that is configured for keeping additional data for the record."
                        },
                        "typeOfCharacteristicValue":{
                            "type":"string",
                            "enum":[
                                "ADV ",
                                "DFV ",
                                "FKV ",
                                "FLV "
                            ],
                            "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                        },
                        "characteristicValue":{
                            "type":"object",
                            "properties":{
                                "value":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Adhoc Characteristic Value"
                                },
                                "value2":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"Foreign Key Value 2"
                                },
                                "value3":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"Foreign Key Value 3"
                                },
                                "value4":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"Foreign Key Value 4"
                                },
                                "value5":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"Foreign Key Value 5"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristics: array characteristics
• customerInformation: object customerInformation
• eventDetails: object eventDetails

{
    "type":"object",
    "properties":{
        "eventDetails":{
            "type":"object",
            "properties":{
                "externalOutageId":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The unique identifier of the outage event in the outage management system.",
                    "example":"200234"
                },
                "startDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The outage event's start time.",
                    "example":"2025-02-06T02:00:00-08:00"
                },
                "estimatedRestorationTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The outage event's estimated restoration time.",
                    "example":"2025-02-07T12:00:00-08:00"
                },
                "completionDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The outage event's restoration or cancelation time.",
                    "example":"2025-02-07T12:00:00-08:00"
                },
                "outageType":{
                    "type":"string",
                    "enum":[
                        "C1PL",
                        "C1UP"
                    ],
                    "description":"Specifies whether the outage was planned or not.\n* `C1PL` - Planned,\n* `C1UP` - Unplanned",
                    "example":"C1PL"
                },
                "messageReference":{
                    "type":"string",
                    "maxLength":254,
                    "description":"An optional value that is assumed to be an increasing when outage event details are updated within the outage management system. It is used to reject stale updates when the incoming message value is lower than the value on the existing record for the event.",
                    "example":"12"
                },
                "discarded":{
                    "type":"boolean",
                    "description":"Indicates that the outage event is discarded.",
                    "example":"false"
                },
                "impactedCustomers":{
                    "type":"number",
                    "maximum":999999999,
                    "minimum":0,
                    "description":"The number of impacted customers.",
                    "example":"259"
                },
                "additionalDetails":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Name of event",
                                "example":"power outage"
                            },
                            "value":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Value of outage"
                            }
                        }
                    }
                }
            }
        },
        "customerInformation":{
            "type":"object",
            "properties":{
                "customers":{
                    "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":"1589809032"
                            },
                            "spId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Point ID is a system assigned random number that stays with a service point record.",
                                "example":"2486945183"
                            }
                        }
                    }
                },
                "incrementalUpdate":{
                    "type":"boolean",
                    "description":"Indicates whether the list of impacted customers is the full list or an incremental addition to the existing list.",
                    "example":"true"
                }
            }
        },
        "characteristics":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence number of Characteristic",
                        "example":"10"
                    },
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Type of characteristic that is configured for keeping additional data for the record."
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "enum":[
                            "ADV ",
                            "DFV ",
                            "FKV ",
                            "FLV "
                        ],
                        "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Adhoc Characteristic Value"
                            },
                            "value2":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 2"
                            },
                            "value3":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 3"
                            },
                            "value4":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 4"
                            },
                            "value5":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 5"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : characteristics

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence number of Characteristic",
                "example":"10"
            },
            "characteristicType":{
                "type":"string",
                "maxLength":8,
                "description":"Type of characteristic that is configured for keeping additional data for the record."
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "enum":[
                    "ADV ",
                    "DFV ",
                    "FKV ",
                    "FLV "
                ],
                "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Adhoc Characteristic Value"
                    },
                    "value2":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 2"
                    },
                    "value3":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 3"
                    },
                    "value4":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 4"
                    },
                    "value5":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 5"
                    }
                }
            }
        }
    }
}

Nested Schema : customerInformation

Type: object

Show Source

• customers: array customers
• incrementalUpdate: boolean
  Indicates whether the list of impacted customers is the full list or an incremental addition to the existing list.

  Example: true

{
    "type":"object",
    "properties":{
        "customers":{
            "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":"1589809032"
                    },
                    "spId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID is a system assigned random number that stays with a service point record.",
                        "example":"2486945183"
                    }
                }
            }
        },
        "incrementalUpdate":{
            "type":"boolean",
            "description":"Indicates whether the list of impacted customers is the full list or an incremental addition to the existing list.",
            "example":"true"
        }
    }
}

Nested Schema : eventDetails

Type: object

Show Source

• additionalDetails: array additionalDetails
• completionDateTime: string (date-time)
  The outage event's restoration or cancelation time.

  Example: 2025-02-07T12:00:00-08:00
• discarded: boolean
  Indicates that the outage event is discarded.

  Example: false
• estimatedRestorationTime: string (date-time)
  The outage event's estimated restoration time.

  Example: 2025-02-07T12:00:00-08:00
• externalOutageId: string
  Maximum Length: 254

  The unique identifier of the outage event in the outage management system.

  Example: 200234
• impactedCustomers: number
  Minimum Value: 0

  Maximum Value: 999999999

  The number of impacted customers.

  Example: 259
• messageReference: string
  Maximum Length: 254

  An optional value that is assumed to be an increasing when outage event details are updated within the outage management system. It is used to reject stale updates when the incoming message value is lower than the value on the existing record for the event.

  Example: 12
• outageType: string
  Allowed Values: [ "C1PL", "C1UP" ]

  Specifies whether the outage was planned or not. * `C1PL` - Planned, * `C1UP` - Unplanned

  Example: C1PL
• startDateTime: string (date-time)
  The outage event's start time.

  Example: 2025-02-06T02:00:00-08:00

{
    "type":"object",
    "properties":{
        "externalOutageId":{
            "type":"string",
            "maxLength":254,
            "description":"The unique identifier of the outage event in the outage management system.",
            "example":"200234"
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The outage event's start time.",
            "example":"2025-02-06T02:00:00-08:00"
        },
        "estimatedRestorationTime":{
            "type":"string",
            "format":"date-time",
            "description":"The outage event's estimated restoration time.",
            "example":"2025-02-07T12:00:00-08:00"
        },
        "completionDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The outage event's restoration or cancelation time.",
            "example":"2025-02-07T12:00:00-08:00"
        },
        "outageType":{
            "type":"string",
            "enum":[
                "C1PL",
                "C1UP"
            ],
            "description":"Specifies whether the outage was planned or not.\n* `C1PL` - Planned,\n* `C1UP` - Unplanned",
            "example":"C1PL"
        },
        "messageReference":{
            "type":"string",
            "maxLength":254,
            "description":"An optional value that is assumed to be an increasing when outage event details are updated within the outage management system. It is used to reject stale updates when the incoming message value is lower than the value on the existing record for the event.",
            "example":"12"
        },
        "discarded":{
            "type":"boolean",
            "description":"Indicates that the outage event is discarded.",
            "example":"false"
        },
        "impactedCustomers":{
            "type":"number",
            "maximum":999999999,
            "minimum":0,
            "description":"The number of impacted customers.",
            "example":"259"
        },
        "additionalDetails":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Name of event",
                        "example":"power outage"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Value of outage"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: string
  Maximum Length: 8

  Type of characteristic that is configured for keeping additional data for the record.
• characteristicValue: object characteristicValue
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence number of Characteristic

  Example: 10
• typeOfCharacteristicValue: string
  Allowed Values: [ "ADV ", "DFV ", "FKV ", "FLV " ]

  Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location. * `ADV ` - Adhoc Value, * `DFV ` - Predefined Value, * `FKV ` - Foreign Key Value, * `FLV ` - File Location Value

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence number of Characteristic",
            "example":"10"
        },
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Type of characteristic that is configured for keeping additional data for the record."
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "enum":[
                "ADV ",
                "DFV ",
                "FKV ",
                "FLV "
            ],
            "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Adhoc Characteristic Value"
                },
                "value2":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 2"
                },
                "value3":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 3"
                },
                "value4":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 4"
                },
                "value5":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 5"
                }
            }
        }
    }
}

Nested Schema : characteristicValue

Type: object

Show Source

• value: string
  Maximum Length: 254

  Adhoc Characteristic Value
• value2: string
  Maximum Length: 50

  Foreign Key Value 2
• value3: string
  Maximum Length: 50

  Foreign Key Value 3
• value4: string
  Maximum Length: 50

  Foreign Key Value 4
• value5: string
  Maximum Length: 50

  Foreign Key Value 5

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "maxLength":254,
            "description":"Adhoc Characteristic Value"
        },
        "value2":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 2"
        },
        "value3":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 3"
        },
        "value4":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 4"
        },
        "value5":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 5"
        }
    }
}

Nested Schema : customers

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":"1589809032"
            },
            "spId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Point ID is a system assigned random number that stays with a service point record.",
                "example":"2486945183"
            }
        }
    }
}

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: 1589809032
• spId: string
  Maximum Length: 10

  Service Point ID is a system assigned random number that stays with a service point record.

  Example: 2486945183

{
    "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":"1589809032"
        },
        "spId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID is a system assigned random number that stays with a service point record.",
            "example":"2486945183"
        }
    }
}

Nested Schema : additionalDetails

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "maxLength":254,
                "description":"Name of event",
                "example":"power outage"
            },
            "value":{
                "type":"string",
                "maxLength":100,
                "description":"Value of outage"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
  Maximum Length: 254

  Name of event

  Example: power outage
• value: string
  Maximum Length: 100

  Value of outage

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "maxLength":254,
            "description":"Name of event",
            "example":"power outage"
        },
        "value":{
            "type":"string",
            "maxLength":100,
            "description":"Value of outage"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1OutEvtsUpd

Type: object

Show Source

• externalSystem: string
  Maximum Length: 30

  The unique identifier of the outage management system reporting the outage information. This should be a valid reference to an External System record.

  Example: CCB-NMS integration
• outageMessages: array outageMessages

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":30,
            "description":"The unique identifier of the outage management system reporting the outage information. This should be a valid reference to an External System record.",
            "example":"CCB-NMS integration"
        },
        "outageMessages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "eventDetails":{
                        "type":"object",
                        "properties":{
                            "externalOutageId":{
                                "type":"string",
                                "maxLength":254,
                                "description":"The unique identifier of the outage event in the outage management system.",
                                "example":"200234"
                            },
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The outage event's start time.",
                                "example":"2025-02-06T02:00:00-08:00"
                            },
                            "estimatedRestorationTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The outage event's estimated restoration time.",
                                "example":"2025-02-07T12:00:00-08:00"
                            },
                            "completionDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The outage event's restoration or cancelation time.",
                                "example":"2025-02-07T12:00:00-08:00"
                            },
                            "outageType":{
                                "type":"string",
                                "enum":[
                                    "C1PL",
                                    "C1UP"
                                ],
                                "description":"Specifies whether the outage was planned or not.\n* `C1PL` - Planned,\n* `C1UP` - Unplanned",
                                "example":"C1PL"
                            },
                            "messageReference":{
                                "type":"string",
                                "maxLength":254,
                                "description":"An optional value that is assumed to be an increasing when outage event details are updated within the outage management system. It is used to reject stale updates when the incoming message value is lower than the value on the existing record for the event.",
                                "example":"12"
                            },
                            "discarded":{
                                "type":"boolean",
                                "description":"Indicates that the outage event is discarded.",
                                "example":"false"
                            },
                            "impactedCustomers":{
                                "type":"number",
                                "maximum":999999999,
                                "minimum":0,
                                "description":"The number of impacted customers.",
                                "example":"259"
                            },
                            "additionalDetails":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "name":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Name of event",
                                            "example":"power outage"
                                        },
                                        "value":{
                                            "type":"string",
                                            "maxLength":100,
                                            "description":"Value of outage"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "customerInformation":{
                        "type":"object",
                        "properties":{
                            "customers":{
                                "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":"1589809032"
                                        },
                                        "spId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Service Point ID is a system assigned random number that stays with a service point record.",
                                            "example":"2486945183"
                                        }
                                    }
                                }
                            },
                            "incrementalUpdate":{
                                "type":"boolean",
                                "description":"Indicates whether the list of impacted customers is the full list or an incremental addition to the existing list.",
                                "example":"true"
                            }
                        }
                    },
                    "characteristics":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Sequence number of Characteristic",
                                    "example":"10"
                                },
                                "characteristicType":{
                                    "type":"string",
                                    "maxLength":8,
                                    "description":"Type of characteristic that is configured for keeping additional data for the record."
                                },
                                "typeOfCharacteristicValue":{
                                    "type":"string",
                                    "enum":[
                                        "ADV ",
                                        "DFV ",
                                        "FKV ",
                                        "FLV "
                                    ],
                                    "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                                },
                                "characteristicValue":{
                                    "type":"object",
                                    "properties":{
                                        "value":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Adhoc Characteristic Value"
                                        },
                                        "value2":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"Foreign Key Value 2"
                                        },
                                        "value3":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"Foreign Key Value 3"
                                        },
                                        "value4":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"Foreign Key Value 4"
                                        },
                                        "value5":{
                                            "type":"string",
                                            "maxLength":50,
                                            "description":"Foreign Key Value 5"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1OutEvtsUpd"
    }
}

Nested Schema : outageMessages

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "eventDetails":{
                "type":"object",
                "properties":{
                    "externalOutageId":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The unique identifier of the outage event in the outage management system.",
                        "example":"200234"
                    },
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The outage event's start time.",
                        "example":"2025-02-06T02:00:00-08:00"
                    },
                    "estimatedRestorationTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The outage event's estimated restoration time.",
                        "example":"2025-02-07T12:00:00-08:00"
                    },
                    "completionDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The outage event's restoration or cancelation time.",
                        "example":"2025-02-07T12:00:00-08:00"
                    },
                    "outageType":{
                        "type":"string",
                        "enum":[
                            "C1PL",
                            "C1UP"
                        ],
                        "description":"Specifies whether the outage was planned or not.\n* `C1PL` - Planned,\n* `C1UP` - Unplanned",
                        "example":"C1PL"
                    },
                    "messageReference":{
                        "type":"string",
                        "maxLength":254,
                        "description":"An optional value that is assumed to be an increasing when outage event details are updated within the outage management system. It is used to reject stale updates when the incoming message value is lower than the value on the existing record for the event.",
                        "example":"12"
                    },
                    "discarded":{
                        "type":"boolean",
                        "description":"Indicates that the outage event is discarded.",
                        "example":"false"
                    },
                    "impactedCustomers":{
                        "type":"number",
                        "maximum":999999999,
                        "minimum":0,
                        "description":"The number of impacted customers.",
                        "example":"259"
                    },
                    "additionalDetails":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "name":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Name of event",
                                    "example":"power outage"
                                },
                                "value":{
                                    "type":"string",
                                    "maxLength":100,
                                    "description":"Value of outage"
                                }
                            }
                        }
                    }
                }
            },
            "customerInformation":{
                "type":"object",
                "properties":{
                    "customers":{
                        "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":"1589809032"
                                },
                                "spId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Service Point ID is a system assigned random number that stays with a service point record.",
                                    "example":"2486945183"
                                }
                            }
                        }
                    },
                    "incrementalUpdate":{
                        "type":"boolean",
                        "description":"Indicates whether the list of impacted customers is the full list or an incremental addition to the existing list.",
                        "example":"true"
                    }
                }
            },
            "characteristics":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "sequence":{
                            "type":"number",
                            "maximum":999,
                            "minimum":-999,
                            "description":"Sequence number of Characteristic",
                            "example":"10"
                        },
                        "characteristicType":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Type of characteristic that is configured for keeping additional data for the record."
                        },
                        "typeOfCharacteristicValue":{
                            "type":"string",
                            "enum":[
                                "ADV ",
                                "DFV ",
                                "FKV ",
                                "FLV "
                            ],
                            "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                        },
                        "characteristicValue":{
                            "type":"object",
                            "properties":{
                                "value":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Adhoc Characteristic Value"
                                },
                                "value2":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"Foreign Key Value 2"
                                },
                                "value3":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"Foreign Key Value 3"
                                },
                                "value4":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"Foreign Key Value 4"
                                },
                                "value5":{
                                    "type":"string",
                                    "maxLength":50,
                                    "description":"Foreign Key Value 5"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristics: array characteristics
• customerInformation: object customerInformation
• eventDetails: object eventDetails

{
    "type":"object",
    "properties":{
        "eventDetails":{
            "type":"object",
            "properties":{
                "externalOutageId":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The unique identifier of the outage event in the outage management system.",
                    "example":"200234"
                },
                "startDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The outage event's start time.",
                    "example":"2025-02-06T02:00:00-08:00"
                },
                "estimatedRestorationTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The outage event's estimated restoration time.",
                    "example":"2025-02-07T12:00:00-08:00"
                },
                "completionDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The outage event's restoration or cancelation time.",
                    "example":"2025-02-07T12:00:00-08:00"
                },
                "outageType":{
                    "type":"string",
                    "enum":[
                        "C1PL",
                        "C1UP"
                    ],
                    "description":"Specifies whether the outage was planned or not.\n* `C1PL` - Planned,\n* `C1UP` - Unplanned",
                    "example":"C1PL"
                },
                "messageReference":{
                    "type":"string",
                    "maxLength":254,
                    "description":"An optional value that is assumed to be an increasing when outage event details are updated within the outage management system. It is used to reject stale updates when the incoming message value is lower than the value on the existing record for the event.",
                    "example":"12"
                },
                "discarded":{
                    "type":"boolean",
                    "description":"Indicates that the outage event is discarded.",
                    "example":"false"
                },
                "impactedCustomers":{
                    "type":"number",
                    "maximum":999999999,
                    "minimum":0,
                    "description":"The number of impacted customers.",
                    "example":"259"
                },
                "additionalDetails":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Name of event",
                                "example":"power outage"
                            },
                            "value":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Value of outage"
                            }
                        }
                    }
                }
            }
        },
        "customerInformation":{
            "type":"object",
            "properties":{
                "customers":{
                    "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":"1589809032"
                            },
                            "spId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Point ID is a system assigned random number that stays with a service point record.",
                                "example":"2486945183"
                            }
                        }
                    }
                },
                "incrementalUpdate":{
                    "type":"boolean",
                    "description":"Indicates whether the list of impacted customers is the full list or an incremental addition to the existing list.",
                    "example":"true"
                }
            }
        },
        "characteristics":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence number of Characteristic",
                        "example":"10"
                    },
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Type of characteristic that is configured for keeping additional data for the record."
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "enum":[
                            "ADV ",
                            "DFV ",
                            "FKV ",
                            "FLV "
                        ],
                        "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Adhoc Characteristic Value"
                            },
                            "value2":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 2"
                            },
                            "value3":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 3"
                            },
                            "value4":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 4"
                            },
                            "value5":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 5"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : characteristics

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence number of Characteristic",
                "example":"10"
            },
            "characteristicType":{
                "type":"string",
                "maxLength":8,
                "description":"Type of characteristic that is configured for keeping additional data for the record."
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "enum":[
                    "ADV ",
                    "DFV ",
                    "FKV ",
                    "FLV "
                ],
                "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Adhoc Characteristic Value"
                    },
                    "value2":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 2"
                    },
                    "value3":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 3"
                    },
                    "value4":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 4"
                    },
                    "value5":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 5"
                    }
                }
            }
        }
    }
}

Nested Schema : customerInformation

Type: object

Show Source

• customers: array customers
• incrementalUpdate: boolean
  Indicates whether the list of impacted customers is the full list or an incremental addition to the existing list.

  Example: true

{
    "type":"object",
    "properties":{
        "customers":{
            "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":"1589809032"
                    },
                    "spId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID is a system assigned random number that stays with a service point record.",
                        "example":"2486945183"
                    }
                }
            }
        },
        "incrementalUpdate":{
            "type":"boolean",
            "description":"Indicates whether the list of impacted customers is the full list or an incremental addition to the existing list.",
            "example":"true"
        }
    }
}

Nested Schema : eventDetails

Type: object

Show Source

• additionalDetails: array additionalDetails
• completionDateTime: string (date-time)
  The outage event's restoration or cancelation time.

  Example: 2025-02-07T12:00:00-08:00
• discarded: boolean
  Indicates that the outage event is discarded.

  Example: false
• estimatedRestorationTime: string (date-time)
  The outage event's estimated restoration time.

  Example: 2025-02-07T12:00:00-08:00
• externalOutageId: string
  Maximum Length: 254

  The unique identifier of the outage event in the outage management system.

  Example: 200234
• impactedCustomers: number
  Minimum Value: 0

  Maximum Value: 999999999

  The number of impacted customers.

  Example: 259
• messageReference: string
  Maximum Length: 254

  An optional value that is assumed to be an increasing when outage event details are updated within the outage management system. It is used to reject stale updates when the incoming message value is lower than the value on the existing record for the event.

  Example: 12
• outageType: string
  Allowed Values: [ "C1PL", "C1UP" ]

  Specifies whether the outage was planned or not. * `C1PL` - Planned, * `C1UP` - Unplanned

  Example: C1PL
• startDateTime: string (date-time)
  The outage event's start time.

  Example: 2025-02-06T02:00:00-08:00

{
    "type":"object",
    "properties":{
        "externalOutageId":{
            "type":"string",
            "maxLength":254,
            "description":"The unique identifier of the outage event in the outage management system.",
            "example":"200234"
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The outage event's start time.",
            "example":"2025-02-06T02:00:00-08:00"
        },
        "estimatedRestorationTime":{
            "type":"string",
            "format":"date-time",
            "description":"The outage event's estimated restoration time.",
            "example":"2025-02-07T12:00:00-08:00"
        },
        "completionDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The outage event's restoration or cancelation time.",
            "example":"2025-02-07T12:00:00-08:00"
        },
        "outageType":{
            "type":"string",
            "enum":[
                "C1PL",
                "C1UP"
            ],
            "description":"Specifies whether the outage was planned or not.\n* `C1PL` - Planned,\n* `C1UP` - Unplanned",
            "example":"C1PL"
        },
        "messageReference":{
            "type":"string",
            "maxLength":254,
            "description":"An optional value that is assumed to be an increasing when outage event details are updated within the outage management system. It is used to reject stale updates when the incoming message value is lower than the value on the existing record for the event.",
            "example":"12"
        },
        "discarded":{
            "type":"boolean",
            "description":"Indicates that the outage event is discarded.",
            "example":"false"
        },
        "impactedCustomers":{
            "type":"number",
            "maximum":999999999,
            "minimum":0,
            "description":"The number of impacted customers.",
            "example":"259"
        },
        "additionalDetails":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Name of event",
                        "example":"power outage"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Value of outage"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: string
  Maximum Length: 8

  Type of characteristic that is configured for keeping additional data for the record.
• characteristicValue: object characteristicValue
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence number of Characteristic

  Example: 10
• typeOfCharacteristicValue: string
  Allowed Values: [ "ADV ", "DFV ", "FKV ", "FLV " ]

  Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location. * `ADV ` - Adhoc Value, * `DFV ` - Predefined Value, * `FKV ` - Foreign Key Value, * `FLV ` - File Location Value

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence number of Characteristic",
            "example":"10"
        },
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Type of characteristic that is configured for keeping additional data for the record."
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "enum":[
                "ADV ",
                "DFV ",
                "FKV ",
                "FLV "
            ],
            "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Adhoc Characteristic Value"
                },
                "value2":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 2"
                },
                "value3":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 3"
                },
                "value4":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 4"
                },
                "value5":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 5"
                }
            }
        }
    }
}

Nested Schema : characteristicValue

Type: object

Show Source

• value: string
  Maximum Length: 254

  Adhoc Characteristic Value
• value2: string
  Maximum Length: 50

  Foreign Key Value 2
• value3: string
  Maximum Length: 50

  Foreign Key Value 3
• value4: string
  Maximum Length: 50

  Foreign Key Value 4
• value5: string
  Maximum Length: 50

  Foreign Key Value 5

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "maxLength":254,
            "description":"Adhoc Characteristic Value"
        },
        "value2":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 2"
        },
        "value3":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 3"
        },
        "value4":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 4"
        },
        "value5":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 5"
        }
    }
}

Nested Schema : customers

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":"1589809032"
            },
            "spId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Point ID is a system assigned random number that stays with a service point record.",
                "example":"2486945183"
            }
        }
    }
}

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: 1589809032
• spId: string
  Maximum Length: 10

  Service Point ID is a system assigned random number that stays with a service point record.

  Example: 2486945183

{
    "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":"1589809032"
        },
        "spId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID is a system assigned random number that stays with a service point record.",
            "example":"2486945183"
        }
    }
}

Nested Schema : additionalDetails

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "maxLength":254,
                "description":"Name of event",
                "example":"power outage"
            },
            "value":{
                "type":"string",
                "maxLength":100,
                "description":"Value of outage"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
  Maximum Length: 254

  Name of event

  Example: power outage
• value: string
  Maximum Length: 100

  Value of outage

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "maxLength":254,
            "description":"Name of event",
            "example":"power outage"
        },
        "value":{
            "type":"string",
            "maxLength":100,
            "description":"Value of outage"
        }
    }
}

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