Jump to

• Request
• Response

Bill Segment Search

post

/rest/apis/customer/financials/billSegments/search

This operation retrieves all bill Segments information for the provided Bill Id.

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

• filters: object filters
• hasMore: boolean
  Has More

  Example: false
• limit: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Limit
• offset: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Offset

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"object",
            "properties":{
                "billSearch":{
                    "type":"object",
                    "properties":{
                        "billId":{
                            "type":"string",
                            "maxLength":"12",
                            "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
                            "example":"211122345678"
                        },
                        "status":{
                            "type":"string",
                            "enum":[
                                "10  ",
                                "20  ",
                                "30  ",
                                "40  ",
                                "50  ",
                                "60  ",
                                "70  "
                            ],
                            "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
                        },
                        "serviceType":{
                            "type":"string",
                            "maxLength":"30",
                            "description":"Service Type defines the type of service associated with the SA type.",
                            "example":"E"
                        }
                    }
                },
                "billTextSearch":{
                    "type":"object",
                    "properties":{
                        "billId":{
                            "type":"string",
                            "maxLength":"12",
                            "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
                            "example":"211122345678"
                        },
                        "textSearch":{
                            "type":"string",
                            "maxLength":"200",
                            "description":"Search text"
                        },
                        "serviceType":{
                            "type":"string",
                            "maxLength":"30",
                            "description":"Service Type defines the type of service associated with the SA type.",
                            "example":"E"
                        }
                    }
                },
                "queryOption":{
                    "type":"string",
                    "enum":[
                        "C1BI",
                        "C1BT"
                    ],
                    "description":"Bill Segment Query Option:\n* `C1BI` - Bill Search,\n* `C1BT` - Bill Text Search"
                }
            }
        },
        "offset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":"0",
            "description":"Page Offset"
        },
        "limit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":"0",
            "description":"Page Limit"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Has More",
            "example":"false"
        }
    },
    "xml":{
        "name":"C1BilSegSrch"
    }
}

Nested Schema : filters

Type: object

Show Source

• billSearch: object billSearch
• billTextSearch: object billTextSearch
• queryOption: string
  Allowed Values: [ "C1BI", "C1BT" ]

  Bill Segment Query Option: * `C1BI` - Bill Search, * `C1BT` - Bill Text Search

{
    "type":"object",
    "properties":{
        "billSearch":{
            "type":"object",
            "properties":{
                "billId":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
                    "example":"211122345678"
                },
                "status":{
                    "type":"string",
                    "enum":[
                        "10  ",
                        "20  ",
                        "30  ",
                        "40  ",
                        "50  ",
                        "60  ",
                        "70  "
                    ],
                    "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
                },
                "serviceType":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Service Type defines the type of service associated with the SA type.",
                    "example":"E"
                }
            }
        },
        "billTextSearch":{
            "type":"object",
            "properties":{
                "billId":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
                    "example":"211122345678"
                },
                "textSearch":{
                    "type":"string",
                    "maxLength":"200",
                    "description":"Search text"
                },
                "serviceType":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Service Type defines the type of service associated with the SA type.",
                    "example":"E"
                }
            }
        },
        "queryOption":{
            "type":"string",
            "enum":[
                "C1BI",
                "C1BT"
            ],
            "description":"Bill Segment Query Option:\n* `C1BI` - Bill Search,\n* `C1BT` - Bill Text Search"
        }
    }
}

Nested Schema : billSearch

Type: object

Show Source

• billId: string
  Maximum Length: 12

  Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.

  Example: 211122345678
• serviceType: string
  Maximum Length: 30

  Service Type defines the type of service associated with the SA type.

  Example: E
• status: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]

  Bill Segment Status: * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `40 ` - Pending Cancel, * `50 ` - Frozen, * `60 ` - Canceled, * `70 ` - OK

{
    "type":"object",
    "properties":{
        "billId":{
            "type":"string",
            "maxLength":"12",
            "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
            "example":"211122345678"
        },
        "status":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  "
            ],
            "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
        },
        "serviceType":{
            "type":"string",
            "maxLength":"30",
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        }
    }
}

Nested Schema : billTextSearch

Type: object

Show Source

• billId: string
  Maximum Length: 12

  Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.

  Example: 211122345678
• serviceType: string
  Maximum Length: 30

  Service Type defines the type of service associated with the SA type.

  Example: E
• textSearch: string
  Maximum Length: 200

  Search text

{
    "type":"object",
    "properties":{
        "billId":{
            "type":"string",
            "maxLength":"12",
            "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
            "example":"211122345678"
        },
        "textSearch":{
            "type":"string",
            "maxLength":"200",
            "description":"Search text"
        },
        "serviceType":{
            "type":"string",
            "maxLength":"30",
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• filters: object filters
• hasMore: boolean
  Has More

  Example: false
• limit: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Limit
• offset: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Offset

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"object",
            "properties":{
                "billSearch":{
                    "type":"object",
                    "properties":{
                        "billId":{
                            "type":"string",
                            "maxLength":"12",
                            "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
                            "example":"211122345678"
                        },
                        "status":{
                            "type":"string",
                            "enum":[
                                "10  ",
                                "20  ",
                                "30  ",
                                "40  ",
                                "50  ",
                                "60  ",
                                "70  "
                            ],
                            "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
                        },
                        "serviceType":{
                            "type":"string",
                            "maxLength":"30",
                            "description":"Service Type defines the type of service associated with the SA type.",
                            "example":"E"
                        }
                    }
                },
                "billTextSearch":{
                    "type":"object",
                    "properties":{
                        "billId":{
                            "type":"string",
                            "maxLength":"12",
                            "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
                            "example":"211122345678"
                        },
                        "textSearch":{
                            "type":"string",
                            "maxLength":"200",
                            "description":"Search text"
                        },
                        "serviceType":{
                            "type":"string",
                            "maxLength":"30",
                            "description":"Service Type defines the type of service associated with the SA type.",
                            "example":"E"
                        }
                    }
                },
                "queryOption":{
                    "type":"string",
                    "enum":[
                        "C1BI",
                        "C1BT"
                    ],
                    "description":"Bill Segment Query Option:\n* `C1BI` - Bill Search,\n* `C1BT` - Bill Text Search"
                }
            }
        },
        "offset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":"0",
            "description":"Page Offset"
        },
        "limit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":"0",
            "description":"Page Limit"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Has More",
            "example":"false"
        }
    },
    "xml":{
        "name":"C1BilSegSrch"
    }
}

Nested Schema : filters

Type: object

Show Source

• billSearch: object billSearch
• billTextSearch: object billTextSearch
• queryOption: string
  Allowed Values: [ "C1BI", "C1BT" ]

  Bill Segment Query Option: * `C1BI` - Bill Search, * `C1BT` - Bill Text Search

{
    "type":"object",
    "properties":{
        "billSearch":{
            "type":"object",
            "properties":{
                "billId":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
                    "example":"211122345678"
                },
                "status":{
                    "type":"string",
                    "enum":[
                        "10  ",
                        "20  ",
                        "30  ",
                        "40  ",
                        "50  ",
                        "60  ",
                        "70  "
                    ],
                    "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
                },
                "serviceType":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Service Type defines the type of service associated with the SA type.",
                    "example":"E"
                }
            }
        },
        "billTextSearch":{
            "type":"object",
            "properties":{
                "billId":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
                    "example":"211122345678"
                },
                "textSearch":{
                    "type":"string",
                    "maxLength":"200",
                    "description":"Search text"
                },
                "serviceType":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Service Type defines the type of service associated with the SA type.",
                    "example":"E"
                }
            }
        },
        "queryOption":{
            "type":"string",
            "enum":[
                "C1BI",
                "C1BT"
            ],
            "description":"Bill Segment Query Option:\n* `C1BI` - Bill Search,\n* `C1BT` - Bill Text Search"
        }
    }
}

Nested Schema : billSearch

Type: object

Show Source

• billId: string
  Maximum Length: 12

  Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.

  Example: 211122345678
• serviceType: string
  Maximum Length: 30

  Service Type defines the type of service associated with the SA type.

  Example: E
• status: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]

  Bill Segment Status: * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `40 ` - Pending Cancel, * `50 ` - Frozen, * `60 ` - Canceled, * `70 ` - OK

{
    "type":"object",
    "properties":{
        "billId":{
            "type":"string",
            "maxLength":"12",
            "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
            "example":"211122345678"
        },
        "status":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  "
            ],
            "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
        },
        "serviceType":{
            "type":"string",
            "maxLength":"30",
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        }
    }
}

Nested Schema : billTextSearch

Type: object

Show Source

• billId: string
  Maximum Length: 12

  Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.

  Example: 211122345678
• serviceType: string
  Maximum Length: 30

  Service Type defines the type of service associated with the SA type.

  Example: E
• textSearch: string
  Maximum Length: 200

  Search text

{
    "type":"object",
    "properties":{
        "billId":{
            "type":"string",
            "maxLength":"12",
            "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
            "example":"211122345678"
        },
        "textSearch":{
            "type":"string",
            "maxLength":"200",
            "description":"Search text"
        },
        "serviceType":{
            "type":"string",
            "maxLength":"30",
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1BilSegSrch

Type: object

Show Source

• bill: object bill
• billSegments: array billSegments
• count: number
  Minimum Value: 0

  Maximum Value: 99999

  Number of Bill Segments for serviceType in bill segment status.

  Example: 8
• hasMore: boolean
  Has More

  Example: false
• limit: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Limit
• offset: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Offset
• totalNumberOfRecords: number
  Minimum Value: 0

  Maximum Value: 99999

  Total Number Of Records

  Example: 8

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":"0",
            "description":"Page Offset"
        },
        "limit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":"0",
            "description":"Page Limit"
        },
        "count":{
            "type":"number",
            "maximum":"99999",
            "minimum":"0",
            "description":"Number of Bill Segments for serviceType in bill segment status.",
            "example":"8"
        },
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":"99999",
            "minimum":"0",
            "description":"Total Number Of Records",
            "example":"8"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Has More",
            "example":"false"
        },
        "bill":{
            "type":"object",
            "properties":{
                "billId":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
                    "example":"211122345678"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "billSegments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "billSegment":{
                        "type":"object",
                        "properties":{
                            "billSegmentId":{
                                "type":"string",
                                "maxLength":"12",
                                "description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.",
                                "example":"211366855400"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "billSegmentStatus":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  ",
                            "30  ",
                            "40  ",
                            "50  ",
                            "60  ",
                            "70  "
                        ],
                        "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
                    },
                    "billSegmentStatusDescription":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Description for Bill Segment Status",
                        "example":"Pending Cancel"
                    },
                    "periodStartDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Start Date"
                    },
                    "periodEndDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Maximum of the Bill Segment bill period end dates",
                        "example":"2010-07-01"
                    },
                    "premise":{
                        "type":"object",
                        "properties":{
                            "premiseId":{
                                "type":"string",
                                "maxLength":"10",
                                "description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "premiseInfo":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Premise Info"
                    },
                    "serviceAgreement":{
                        "type":"object",
                        "properties":{
                            "serviceAgreementId":{
                                "type":"string",
                                "maxLength":"10",
                                "description":"SA ID contains information about the bill segment's service agreement.",
                                "example":"0340281111"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "serviceType":{
                        "type":"object",
                        "description":"Service Type defines the type of service associated with the SA type.",
                        "properties":{
                            "serviceType":{
                                "type":"string",
                                "maxLength":"80",
                                "description":"Service Type defines the type of service associated with the SA type.",
                                "example":"E"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "serviceAgreementType":{
                        "type":"object",
                        "properties":{
                            "cisDivision":{
                                "type":"string",
                                "maxLength":"1",
                                "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                                "example":"OH"
                            },
                            "cisDivisionDescription":{
                                "type":"string",
                                "maxLength":"1",
                                "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                                "example":"OH"
                            },
                            "saType":{
                                "type":"string",
                                "maxLength":"8",
                                "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                                "example":"OH"
                            },
                            "serviceAgreementTypeDescription":{
                                "type":"string",
                                "maxLength":"30",
                                "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                                "example":"OH"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "endingRatePlan":{
                        "type":"string",
                        "maxLength":"8",
                        "description":"Rate Schedule"
                    },
                    "currency":{
                        "type":"string",
                        "maxLength":"3",
                        "description":"Currency Code"
                    },
                    "currentAmount":{
                        "type":"number",
                        "description":"Current Amount"
                    },
                    "isEstimate":{
                        "type":"boolean",
                        "description":"If the Estimate switch is on, consumption on this bill segment has been estimated by the system.",
                        "example":"true"
                    },
                    "isClosingBillSegment":{
                        "type":"boolean",
                        "description":"If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).",
                        "example":"true"
                    },
                    "isServiceQuantityOverridden":{
                        "type":"boolean",
                        "description":"SQ Override"
                    },
                    "isItemOverridden":{
                        "type":"boolean",
                        "description":"Item Override"
                    },
                    "totalQuantity":{
                        "type":"object",
                        "properties":{
                            "totalFoundIndicator":{
                                "type":"boolean",
                                "description":"Total Found Indicator flag is true when SA's SA Type UOM matches UOM from the Bill Segment's Service Quantity collection.",
                                "example":"true"
                            },
                            "totalServiceQuantity":{
                                "type":"number",
                                "maximum":"1000000000000",
                                "minimum":"-1000000000000",
                                "description":"Billable Service Quantity"
                            },
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":"30",
                                "description":"Unit of Measure"
                            }
                        }
                    },
                    "hasMultipleLineGroup":{
                        "type":"boolean",
                        "description":"Has Multiple Line Group",
                        "example":"true"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1BilSegSrch"
    }
}

Nested Schema : bill

Type: object

Show Source

• _link: string
  _link
• billId: string
  Maximum Length: 12

  Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.

  Example: 211122345678

{
    "type":"object",
    "properties":{
        "billId":{
            "type":"string",
            "maxLength":"12",
            "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
            "example":"211122345678"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : billSegments

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "billSegment":{
                "type":"object",
                "properties":{
                    "billSegmentId":{
                        "type":"string",
                        "maxLength":"12",
                        "description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.",
                        "example":"211366855400"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "billSegmentStatus":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  ",
                    "30  ",
                    "40  ",
                    "50  ",
                    "60  ",
                    "70  "
                ],
                "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
            },
            "billSegmentStatusDescription":{
                "type":"string",
                "maxLength":"60",
                "description":"Description for Bill Segment Status",
                "example":"Pending Cancel"
            },
            "periodStartDate":{
                "type":"string",
                "format":"date",
                "description":"Start Date"
            },
            "periodEndDate":{
                "type":"string",
                "format":"date",
                "description":"Maximum of the Bill Segment bill period end dates",
                "example":"2010-07-01"
            },
            "premise":{
                "type":"object",
                "properties":{
                    "premiseId":{
                        "type":"string",
                        "maxLength":"10",
                        "description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "premiseInfo":{
                "type":"string",
                "maxLength":"254",
                "description":"Premise Info"
            },
            "serviceAgreement":{
                "type":"object",
                "properties":{
                    "serviceAgreementId":{
                        "type":"string",
                        "maxLength":"10",
                        "description":"SA ID contains information about the bill segment's service agreement.",
                        "example":"0340281111"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "serviceType":{
                "type":"object",
                "description":"Service Type defines the type of service associated with the SA type.",
                "properties":{
                    "serviceType":{
                        "type":"string",
                        "maxLength":"80",
                        "description":"Service Type defines the type of service associated with the SA type.",
                        "example":"E"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "serviceAgreementType":{
                "type":"object",
                "properties":{
                    "cisDivision":{
                        "type":"string",
                        "maxLength":"1",
                        "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                        "example":"OH"
                    },
                    "cisDivisionDescription":{
                        "type":"string",
                        "maxLength":"1",
                        "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                        "example":"OH"
                    },
                    "saType":{
                        "type":"string",
                        "maxLength":"8",
                        "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                        "example":"OH"
                    },
                    "serviceAgreementTypeDescription":{
                        "type":"string",
                        "maxLength":"30",
                        "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                        "example":"OH"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "endingRatePlan":{
                "type":"string",
                "maxLength":"8",
                "description":"Rate Schedule"
            },
            "currency":{
                "type":"string",
                "maxLength":"3",
                "description":"Currency Code"
            },
            "currentAmount":{
                "type":"number",
                "description":"Current Amount"
            },
            "isEstimate":{
                "type":"boolean",
                "description":"If the Estimate switch is on, consumption on this bill segment has been estimated by the system.",
                "example":"true"
            },
            "isClosingBillSegment":{
                "type":"boolean",
                "description":"If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).",
                "example":"true"
            },
            "isServiceQuantityOverridden":{
                "type":"boolean",
                "description":"SQ Override"
            },
            "isItemOverridden":{
                "type":"boolean",
                "description":"Item Override"
            },
            "totalQuantity":{
                "type":"object",
                "properties":{
                    "totalFoundIndicator":{
                        "type":"boolean",
                        "description":"Total Found Indicator flag is true when SA's SA Type UOM matches UOM from the Bill Segment's Service Quantity collection.",
                        "example":"true"
                    },
                    "totalServiceQuantity":{
                        "type":"number",
                        "maximum":"1000000000000",
                        "minimum":"-1000000000000",
                        "description":"Billable Service Quantity"
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":"30",
                        "description":"Unit of Measure"
                    }
                }
            },
            "hasMultipleLineGroup":{
                "type":"boolean",
                "description":"Has Multiple Line Group",
                "example":"true"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billSegment: object billSegment
• billSegmentStatus: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]

  Bill Segment Status: * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `40 ` - Pending Cancel, * `50 ` - Frozen, * `60 ` - Canceled, * `70 ` - OK
• billSegmentStatusDescription: string
  Maximum Length: 60

  Description for Bill Segment Status

  Example: Pending Cancel
• currency: string
  Maximum Length: 3

  Currency Code
• currentAmount: number
  Current Amount
• endingRatePlan: string
  Maximum Length: 8

  Rate Schedule
• hasMultipleLineGroup: boolean
  Has Multiple Line Group

  Example: true
• isClosingBillSegment: boolean
  If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).

  Example: true
• isEstimate: boolean
  If the Estimate switch is on, consumption on this bill segment has been estimated by the system.

  Example: true
• isItemOverridden: boolean
  Item Override
• isServiceQuantityOverridden: boolean
  SQ Override
• periodEndDate: string (date)
  Maximum of the Bill Segment bill period end dates

  Example: 2010-07-01
• periodStartDate: string (date)
  Start Date
• premise: object premise
• premiseInfo: string
  Maximum Length: 254

  Premise Info
• serviceAgreement: object serviceAgreement
• serviceAgreementType: object serviceAgreementType
• serviceType: object serviceType
  Service Type defines the type of service associated with the SA type.
• totalQuantity: object totalQuantity

{
    "type":"object",
    "properties":{
        "billSegment":{
            "type":"object",
            "properties":{
                "billSegmentId":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.",
                    "example":"211366855400"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "billSegmentStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  "
            ],
            "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
        },
        "billSegmentStatusDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"Description for Bill Segment Status",
            "example":"Pending Cancel"
        },
        "periodStartDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date"
        },
        "periodEndDate":{
            "type":"string",
            "format":"date",
            "description":"Maximum of the Bill Segment bill period end dates",
            "example":"2010-07-01"
        },
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":"10",
                    "description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "premiseInfo":{
            "type":"string",
            "maxLength":"254",
            "description":"Premise Info"
        },
        "serviceAgreement":{
            "type":"object",
            "properties":{
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":"10",
                    "description":"SA ID contains information about the bill segment's service agreement.",
                    "example":"0340281111"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "serviceType":{
            "type":"object",
            "description":"Service Type defines the type of service associated with the SA type.",
            "properties":{
                "serviceType":{
                    "type":"string",
                    "maxLength":"80",
                    "description":"Service Type defines the type of service associated with the SA type.",
                    "example":"E"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "serviceAgreementType":{
            "type":"object",
            "properties":{
                "cisDivision":{
                    "type":"string",
                    "maxLength":"1",
                    "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                    "example":"OH"
                },
                "cisDivisionDescription":{
                    "type":"string",
                    "maxLength":"1",
                    "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                    "example":"OH"
                },
                "saType":{
                    "type":"string",
                    "maxLength":"8",
                    "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                    "example":"OH"
                },
                "serviceAgreementTypeDescription":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                    "example":"OH"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "endingRatePlan":{
            "type":"string",
            "maxLength":"8",
            "description":"Rate Schedule"
        },
        "currency":{
            "type":"string",
            "maxLength":"3",
            "description":"Currency Code"
        },
        "currentAmount":{
            "type":"number",
            "description":"Current Amount"
        },
        "isEstimate":{
            "type":"boolean",
            "description":"If the Estimate switch is on, consumption on this bill segment has been estimated by the system.",
            "example":"true"
        },
        "isClosingBillSegment":{
            "type":"boolean",
            "description":"If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).",
            "example":"true"
        },
        "isServiceQuantityOverridden":{
            "type":"boolean",
            "description":"SQ Override"
        },
        "isItemOverridden":{
            "type":"boolean",
            "description":"Item Override"
        },
        "totalQuantity":{
            "type":"object",
            "properties":{
                "totalFoundIndicator":{
                    "type":"boolean",
                    "description":"Total Found Indicator flag is true when SA's SA Type UOM matches UOM from the Bill Segment's Service Quantity collection.",
                    "example":"true"
                },
                "totalServiceQuantity":{
                    "type":"number",
                    "maximum":"1000000000000",
                    "minimum":"-1000000000000",
                    "description":"Billable Service Quantity"
                },
                "unitOfMeasure":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Unit of Measure"
                }
            }
        },
        "hasMultipleLineGroup":{
            "type":"boolean",
            "description":"Has Multiple Line Group",
            "example":"true"
        }
    }
}

Nested Schema : billSegment

Type: object

Show Source

• _link: string
  _link
• billSegmentId: string
  Maximum Length: 12

  Bill Segment ID is the system-assigned unique identifier of the bill segment.

  Example: 211366855400

{
    "type":"object",
    "properties":{
        "billSegmentId":{
            "type":"string",
            "maxLength":"12",
            "description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.",
            "example":"211366855400"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• _link: string
  _link
• premiseId: string
  Maximum Length: 10

  Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise.

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":"10",
            "description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Show Source

• _link: string
  _link
• serviceAgreementId: string
  Maximum Length: 10

  SA ID contains information about the bill segment's service agreement.

  Example: 0340281111

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":"10",
            "description":"SA ID contains information about the bill segment's service agreement.",
            "example":"0340281111"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : serviceAgreementType

Type: object

Show Source

• _link: string
  _link
• cisDivision: string
  Maximum Length: 1

  The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.

  Example: OH
• cisDivisionDescription: string
  Maximum Length: 1

  The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.

  Example: OH
• saType: string
  Maximum Length: 8

  The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.

  Example: OH
• serviceAgreementTypeDescription: string
  Maximum Length: 30

  The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.

  Example: OH

{
    "type":"object",
    "properties":{
        "cisDivision":{
            "type":"string",
            "maxLength":"1",
            "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
            "example":"OH"
        },
        "cisDivisionDescription":{
            "type":"string",
            "maxLength":"1",
            "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
            "example":"OH"
        },
        "saType":{
            "type":"string",
            "maxLength":"8",
            "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
            "example":"OH"
        },
        "serviceAgreementTypeDescription":{
            "type":"string",
            "maxLength":"30",
            "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
            "example":"OH"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : serviceType

Type: object

Service Type defines the type of service associated with the SA type.

Show Source

• _link: string
  _link
• serviceType: string
  Maximum Length: 80

  Service Type defines the type of service associated with the SA type.

  Example: E

{
    "type":"object",
    "description":"Service Type defines the type of service associated with the SA type.",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":"80",
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : totalQuantity

Type: object

Show Source

• totalFoundIndicator: boolean
  Total Found Indicator flag is true when SA's SA Type UOM matches UOM from the Bill Segment's Service Quantity collection.

  Example: true
• totalServiceQuantity: number
  Minimum Value: -1000000000000

  Maximum Value: 1000000000000

  Billable Service Quantity
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure

{
    "type":"object",
    "properties":{
        "totalFoundIndicator":{
            "type":"boolean",
            "description":"Total Found Indicator flag is true when SA's SA Type UOM matches UOM from the Bill Segment's Service Quantity collection.",
            "example":"true"
        },
        "totalServiceQuantity":{
            "type":"number",
            "maximum":"1000000000000",
            "minimum":"-1000000000000",
            "description":"Billable Service Quantity"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":"30",
            "description":"Unit of Measure"
        }
    }
}

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