Jump to

• Request
• Response

Search Premises

post

/rest/apis/customer/v-model/premises/search

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

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"object",
            "properties":{
                "searchText":{
                    "type":"string",
                    "maxLength":"200",
                    "description":"Search Text"
                }
            }
        }
    },
    "xml":{
        "name":"C1PremSrcCap"
    }
}

Nested Schema : filters

Type: object

Show Source

• searchText: string
  Maximum Length: 200

  Search Text

{
    "type":"object",
    "properties":{
        "searchText":{
            "type":"string",
            "maxLength":"200",
            "description":"Search Text"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• filters: object filters

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"object",
            "properties":{
                "searchText":{
                    "type":"string",
                    "maxLength":"200",
                    "description":"Search Text"
                }
            }
        }
    },
    "xml":{
        "name":"C1PremSrcCap"
    }
}

Nested Schema : filters

Type: object

Show Source

• searchText: string
  Maximum Length: 200

  Search Text

{
    "type":"object",
    "properties":{
        "searchText":{
            "type":"string",
            "maxLength":"200",
            "description":"Search Text"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1PremSrcCap

Type: object

Show Source

• hasMore: boolean
  Has More
• premiseList: array premiseList
• totalNumberOfRecords: number
  Minimum Value: 0

  Maximum Value: 99999

  Total Number Of Records

{
    "type":"object",
    "properties":{
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":"99999",
            "minimum":"0",
            "description":"Total Number Of Records"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Has More"
        },
        "premiseList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "premiseId":{
                        "type":"string",
                        "maxLength":"10",
                        "description":"The Premise ID is a system assigned random number that stays with a premise for life.",
                        "example":"2242620736"
                    },
                    "premiseType":{
                        "type":"string",
                        "maxLength":"8",
                        "description":"Premise Type indicates the type of premise.",
                        "example":"HOME (Single family home)"
                    },
                    "premiseTypeDescription":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Descriptive explanation for the type of premise. For example, a single family home.",
                        "example":"Single family home"
                    },
                    "cisDivision":{
                        "type":"string",
                        "maxLength":"5",
                        "description":"CIS Division is used to define the jurisdiction in which the premise is located if the premise type allows CIS Division. This defaults based on the Country and the Postal Code, but can be overridden.",
                        "example":"CA"
                    },
                    "cisDivisionDescription":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Service type",
                        "example":"Electric Service"
                    },
                    "formattedAddress":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"The premise address in a formatted presentation that can be displayed to customers.",
                        "example":"129 Sutter St, San Francisco, CA, 94104"
                    },
                    "address":{
                        "type":"object",
                        "properties":{
                            "country":{
                                "type":"string",
                                "maxLength":"3",
                                "description":"The Country of the address. Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
                                "example":"USA"
                            },
                            "postal":{
                                "type":"string",
                                "maxLength":"12",
                                "description":"The postal code of the address.",
                                "example":"90210"
                            },
                            "address1":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"The first line of the address."
                            },
                            "address2":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"The Second line of the address."
                            },
                            "address3":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"The Third line of the address."
                            },
                            "address4":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"The Fourth line of the address."
                            },
                            "city":{
                                "type":"string",
                                "maxLength":"90",
                                "description":"The city of the address."
                            },
                            "county":{
                                "type":"string",
                                "maxLength":"90",
                                "description":"The county of the address."
                            },
                            "houseType":{
                                "type":"string",
                                "enum":[
                                    "AB  ",
                                    "WW  "
                                ],
                                "description":"Indicates the type of house if applicable.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                            },
                            "geographic":{
                                "type":"string",
                                "maxLength":"11",
                                "description":"Geographic code is used to apply proper taxation rules to the physical address location."
                            },
                            "inCityLimit":{
                                "type":"boolean",
                                "description":"Define In City Limit as true if the address is considered within the physical city limits.",
                                "example":"true"
                            },
                            "state":{
                                "type":"string",
                                "maxLength":"6",
                                "description":"The state of the address.",
                                "example":"CA"
                            }
                        }
                    },
                    "servicePointSummary":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "serviceType":{
                                    "type":"string",
                                    "maxLength":"80",
                                    "description":"Service Type defines the type of service associated with the SA type",
                                    "example":"E"
                                },
                                "numberOfServicePoints":{
                                    "type":"number",
                                    "maximum":"9999999999",
                                    "minimum":"0",
                                    "description":"Number of service points at a premise",
                                    "example":"1"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1PremSrcCap"
    }
}

Nested Schema : premiseList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "premiseId":{
                "type":"string",
                "maxLength":"10",
                "description":"The Premise ID is a system assigned random number that stays with a premise for life.",
                "example":"2242620736"
            },
            "premiseType":{
                "type":"string",
                "maxLength":"8",
                "description":"Premise Type indicates the type of premise.",
                "example":"HOME (Single family home)"
            },
            "premiseTypeDescription":{
                "type":"string",
                "maxLength":"60",
                "description":"Descriptive explanation for the type of premise. For example, a single family home.",
                "example":"Single family home"
            },
            "cisDivision":{
                "type":"string",
                "maxLength":"5",
                "description":"CIS Division is used to define the jurisdiction in which the premise is located if the premise type allows CIS Division. This defaults based on the Country and the Postal Code, but can be overridden.",
                "example":"CA"
            },
            "cisDivisionDescription":{
                "type":"string",
                "maxLength":"60",
                "description":"Service type",
                "example":"Electric Service"
            },
            "formattedAddress":{
                "type":"string",
                "maxLength":"254",
                "description":"The premise address in a formatted presentation that can be displayed to customers.",
                "example":"129 Sutter St, San Francisco, CA, 94104"
            },
            "address":{
                "type":"object",
                "properties":{
                    "country":{
                        "type":"string",
                        "maxLength":"3",
                        "description":"The Country of the address. Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
                        "example":"USA"
                    },
                    "postal":{
                        "type":"string",
                        "maxLength":"12",
                        "description":"The postal code of the address.",
                        "example":"90210"
                    },
                    "address1":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"The first line of the address."
                    },
                    "address2":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"The Second line of the address."
                    },
                    "address3":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"The Third line of the address."
                    },
                    "address4":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"The Fourth line of the address."
                    },
                    "city":{
                        "type":"string",
                        "maxLength":"90",
                        "description":"The city of the address."
                    },
                    "county":{
                        "type":"string",
                        "maxLength":"90",
                        "description":"The county of the address."
                    },
                    "houseType":{
                        "type":"string",
                        "enum":[
                            "AB  ",
                            "WW  "
                        ],
                        "description":"Indicates the type of house if applicable.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                    },
                    "geographic":{
                        "type":"string",
                        "maxLength":"11",
                        "description":"Geographic code is used to apply proper taxation rules to the physical address location."
                    },
                    "inCityLimit":{
                        "type":"boolean",
                        "description":"Define In City Limit as true if the address is considered within the physical city limits.",
                        "example":"true"
                    },
                    "state":{
                        "type":"string",
                        "maxLength":"6",
                        "description":"The state of the address.",
                        "example":"CA"
                    }
                }
            },
            "servicePointSummary":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "serviceType":{
                            "type":"string",
                            "maxLength":"80",
                            "description":"Service Type defines the type of service associated with the SA type",
                            "example":"E"
                        },
                        "numberOfServicePoints":{
                            "type":"number",
                            "maximum":"9999999999",
                            "minimum":"0",
                            "description":"Number of service points at a premise",
                            "example":"1"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• address: object address
• cisDivision: string
  Maximum Length: 5

  CIS Division is used to define the jurisdiction in which the premise is located if the premise type allows CIS Division. This defaults based on the Country and the Postal Code, but can be overridden.

  Example: CA
• cisDivisionDescription: string
  Maximum Length: 60

  Service type

  Example: Electric Service
• formattedAddress: string
  Maximum Length: 254

  The premise address in a formatted presentation that can be displayed to customers.

  Example: 129 Sutter St, San Francisco, CA, 94104
• premiseId: string
  Maximum Length: 10

  The Premise ID is a system assigned random number that stays with a premise for life.

  Example: 2242620736
• premiseType: string
  Maximum Length: 8

  Premise Type indicates the type of premise.

  Example: HOME (Single family home)
• premiseTypeDescription: string
  Maximum Length: 60

  Descriptive explanation for the type of premise. For example, a single family home.

  Example: Single family home
• servicePointSummary: array servicePointSummary

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":"10",
            "description":"The Premise ID is a system assigned random number that stays with a premise for life.",
            "example":"2242620736"
        },
        "premiseType":{
            "type":"string",
            "maxLength":"8",
            "description":"Premise Type indicates the type of premise.",
            "example":"HOME (Single family home)"
        },
        "premiseTypeDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"Descriptive explanation for the type of premise. For example, a single family home.",
            "example":"Single family home"
        },
        "cisDivision":{
            "type":"string",
            "maxLength":"5",
            "description":"CIS Division is used to define the jurisdiction in which the premise is located if the premise type allows CIS Division. This defaults based on the Country and the Postal Code, but can be overridden.",
            "example":"CA"
        },
        "cisDivisionDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"Service type",
            "example":"Electric Service"
        },
        "formattedAddress":{
            "type":"string",
            "maxLength":"254",
            "description":"The premise address in a formatted presentation that can be displayed to customers.",
            "example":"129 Sutter St, San Francisco, CA, 94104"
        },
        "address":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":"3",
                    "description":"The Country of the address. Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
                    "example":"USA"
                },
                "postal":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"The postal code of the address.",
                    "example":"90210"
                },
                "address1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The first line of the address."
                },
                "address2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The Second line of the address."
                },
                "address3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The Third line of the address."
                },
                "address4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The Fourth line of the address."
                },
                "city":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"The city of the address."
                },
                "county":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"The county of the address."
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"Indicates the type of house if applicable.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "geographic":{
                    "type":"string",
                    "maxLength":"11",
                    "description":"Geographic code is used to apply proper taxation rules to the physical address location."
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"Define In City Limit as true if the address is considered within the physical city limits.",
                    "example":"true"
                },
                "state":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"The state of the address.",
                    "example":"CA"
                }
            }
        },
        "servicePointSummary":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceType":{
                        "type":"string",
                        "maxLength":"80",
                        "description":"Service Type defines the type of service associated with the SA type",
                        "example":"E"
                    },
                    "numberOfServicePoints":{
                        "type":"number",
                        "maximum":"9999999999",
                        "minimum":"0",
                        "description":"Number of service points at a premise",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : address

Type: object

Show Source

• address1: string
  Maximum Length: 254

  The first line of the address.
• address2: string
  Maximum Length: 254

  The Second line of the address.
• address3: string
  Maximum Length: 254

  The Third line of the address.
• address4: string
  Maximum Length: 254

  The Fourth line of the address.
• city: string
  Maximum Length: 90

  The city of the address.
• country: string
  Maximum Length: 3

  The Country of the address. Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.

  Example: USA
• county: string
  Maximum Length: 90

  The county of the address.
• geographic: string
  Maximum Length: 11

  Geographic code is used to apply proper taxation rules to the physical address location.
• houseType: string
  Allowed Values: [ "AB ", "WW " ]

  Indicates the type of house if applicable. * `AB ` - House Boat References, * `WW ` - House Trailer Reference
• inCityLimit: boolean
  Define In City Limit as true if the address is considered within the physical city limits.

  Example: true
• postal: string
  Maximum Length: 12

  The postal code of the address.

  Example: 90210
• state: string
  Maximum Length: 6

  The state of the address.

  Example: CA

{
    "type":"object",
    "properties":{
        "country":{
            "type":"string",
            "maxLength":"3",
            "description":"The Country of the address. Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
            "example":"USA"
        },
        "postal":{
            "type":"string",
            "maxLength":"12",
            "description":"The postal code of the address.",
            "example":"90210"
        },
        "address1":{
            "type":"string",
            "maxLength":"254",
            "description":"The first line of the address."
        },
        "address2":{
            "type":"string",
            "maxLength":"254",
            "description":"The Second line of the address."
        },
        "address3":{
            "type":"string",
            "maxLength":"254",
            "description":"The Third line of the address."
        },
        "address4":{
            "type":"string",
            "maxLength":"254",
            "description":"The Fourth line of the address."
        },
        "city":{
            "type":"string",
            "maxLength":"90",
            "description":"The city of the address."
        },
        "county":{
            "type":"string",
            "maxLength":"90",
            "description":"The county of the address."
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"Indicates the type of house if applicable.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "geographic":{
            "type":"string",
            "maxLength":"11",
            "description":"Geographic code is used to apply proper taxation rules to the physical address location."
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"Define In City Limit as true if the address is considered within the physical city limits.",
            "example":"true"
        },
        "state":{
            "type":"string",
            "maxLength":"6",
            "description":"The state of the address.",
            "example":"CA"
        }
    }
}

Nested Schema : servicePointSummary

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceType":{
                "type":"string",
                "maxLength":"80",
                "description":"Service Type defines the type of service associated with the SA type",
                "example":"E"
            },
            "numberOfServicePoints":{
                "type":"number",
                "maximum":"9999999999",
                "minimum":"0",
                "description":"Number of service points at a premise",
                "example":"1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• numberOfServicePoints: number
  Minimum Value: 0

  Maximum Value: 9999999999

  Number of service points at a premise

  Example: 1
• serviceType: string
  Maximum Length: 80

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

  Example: E

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":"80",
            "description":"Service Type defines the type of service associated with the SA type",
            "example":"E"
        },
        "numberOfServicePoints":{
            "type":"number",
            "maximum":"9999999999",
            "minimum":"0",
            "description":"Number of service points at a premise",
            "example":"1"
        }
    }
}

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