Jump to

• Request
• Response

Get Premise

get

https://server:port/spl/rest/apis/customer/v-model/premises/{premiseId}

This Operation handles the Integration Suite API to Get Premise .

Request

Path Parameters

• premiseId(required): string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1-Premise

Type: object

Show Source

• _self: string
  _self
• address: object address
• alternateAddresses: object alternateAddresses
• characteristics: object characteristics
• division: object division
  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.
• geographicLocations: object geographicLocations
• isOKToEnter: boolean
  OK to Enter is turned on if the meter is located in the interior of the premise and your company has permission to enter.

  Example: false
• key: string
  Maximum Length: 10

  Key ID may also be specified if Key at premise field is turned on.
• keyAtPremise: boolean
  Turn on Key at Premise if the meter is secured in a locked area and your company has the key. If this field is turned on, you may also specify the Key ID.

  Example: false
• landlordAgreement: object landlordAgreement
• lifeSupportSensitiveLoad: string
  Allowed Values: [ "N ", "Y " ]

  Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment. Valid values are: LS/SL (i.e., the person has life support / sensitive load equipment) or None. If the customer has LS/SL equipment, make a note of the type of equipment in the description. * `N ` - None, * `Y ` - LS/SL

  Example: Y
• lifeSupportSensitiveLoadDescription: string
  Maximum Length: 1000

  A premise can also have life support / sensitive load information. If the equipment is physically linked to the premise (e.g., a hospital has life support equipment), you should NOT specify the life support information on the person. Rather, specify life support information on the premise.

  Example: sensitive load
• meterReadInstruction: object meterReadInstruction
  Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.
• meterReadInstructionDetails: string
  Maximum Length: 250

  Use Instruction Details to provide more detailed instructions to the individual who reads meters at this premise.

  Example: verify constant
• meterReadWarning: object meterReadWarning
  Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.
• parentPremiseId: object parentPremiseId
  Parent Premise is used to include this premise in a premise hierarchy.
• premiseId: string
  Maximum Length: 10

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

  Example: 2242620736
• premiseType: object premiseType
  Premise Type indicates the type of premise.
• timeZone: object timeZone
  Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.
• trendArea: object trendArea
  Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "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":"object",
            "description":"Premise Type indicates the type of premise.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "premiseType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Premise Type indicates the type of premise.",
                    "example":"HOME"
                }
            }
        },
        "division":{
            "type":"object",
            "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.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "division":{
                    "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"
                }
            }
        },
        "landlordAgreement":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "landlordAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Landlord Agreement ID"
                }
            }
        },
        "keyAtPremise":{
            "type":"boolean",
            "description":"Turn on Key at Premise if the meter is secured in a locked area and your company has the key. If this field is turned on, you may also specify the Key ID.",
            "example":"false"
        },
        "key":{
            "type":"string",
            "maxLength":10,
            "description":"Key ID may also be specified if Key at premise field is turned on."
        },
        "isOKToEnter":{
            "type":"boolean",
            "description":"OK to Enter is turned on if the meter is located in the interior of the premise and your company has permission to enter.",
            "example":"false"
        },
        "meterReadInstruction":{
            "type":"object",
            "description":"Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "meterReadInstruction":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.",
                    "example":"CON"
                }
            }
        },
        "meterReadInstructionDetails":{
            "type":"string",
            "maxLength":250,
            "description":"Use Instruction Details to provide more detailed instructions to the individual who reads meters at this premise.",
            "example":"verify constant"
        },
        "meterReadWarning":{
            "type":"object",
            "description":"Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "meterReadWarning":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.",
                    "example":"DANG"
                }
            }
        },
        "trendArea":{
            "type":"object",
            "description":"Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "trendArea":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.",
                    "example":"SF"
                }
            }
        },
        "address":{
            "type":"object",
            "properties":{
                "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."
                },
                "number1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The first street number line of the address."
                },
                "number2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"The Second street number line of the address."
                },
                "county":{
                    "type":"object",
                    "description":"The county of the address.",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "county":{
                            "type":"string",
                            "maxLength":90,
                            "description":"The county of the address."
                        }
                    }
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The postal code of the address."
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The state of the address."
                },
                "country":{
                    "type":"object",
                    "description":"The Country of the address.",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "country":{
                            "type":"string",
                            "maxLength":3,
                            "description":"The Country of the address.",
                            "example":"USA"
                        }
                    }
                },
                "mailingAddress":{
                    "type":"boolean",
                    "description":"Indicates whether the address is a valid Mailing Address that can be used for the Account mailing.",
                    "example":"true"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "geographicCode":{
                    "type":"string",
                    "maxLength":11,
                    "description":"Geographic code used to apply proper taxation rules to the physical address location."
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"City Limit switch is on if the address is considered within the physical city limits.",
                    "example":"true"
                }
            }
        },
        "timeZone":{
            "type":"object",
            "description":"Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "timeZone":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.",
                    "example":"USPACIFIC"
                }
            }
        },
        "lifeSupportSensitiveLoad":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment. Valid values are: LS/SL (i.e., the person has life support / sensitive load equipment) or None. If the customer has LS/SL equipment, make a note of the type of equipment in the description.\n* `N   ` - None,\n* `Y   ` - LS/SL",
            "example":"Y"
        },
        "lifeSupportSensitiveLoadDescription":{
            "type":"string",
            "maxLength":1000,
            "description":"A premise can also have life support / sensitive load information. If the equipment is physically linked to the premise (e.g., a hospital has life support equipment), you should NOT specify the life support information on the person. Rather, specify life support information on the premise.",
            "example":"sensitive load"
        },
        "parentPremiseId":{
            "type":"object",
            "description":"Parent Premise is used to include this premise in a premise hierarchy.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "parentPremiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Parent Premise is used to include this premise in a premise hierarchy.",
                    "example":"5150218089"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date defines the date on which the characteristic becomes effective.",
                                "example":"2018-08-06"
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    }
                                }
                            },
                            "typeOfCharacteristicValue":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location."
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    },
                                    "value":{
                                        "type":"string",
                                        "description":"(value)"
                                    },
                                    "value2":{
                                        "type":"string",
                                        "description":"(value2)"
                                    },
                                    "value3":{
                                        "type":"string",
                                        "description":"(value3)"
                                    },
                                    "value4":{
                                        "type":"string",
                                        "description":"(value4)"
                                    },
                                    "value5":{
                                        "type":"string",
                                        "description":"(value5)"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        },
        "geographicLocations":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "geographicType":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "geographicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Geographic Type"
                                    }
                                }
                            },
                            "geographicValue":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Specifies the geographic value such as a coordinate.",
                                "example":"123"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        },
        "alternateAddresses":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "premiseAlternateAddressId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"System assigned key if an alternate address record is entered.  This is only possible if alternate addresses are enabled on the installation record.",
                                "example":"6808137793"
                            },
                            "alternateAddress":{
                                "type":"object",
                                "properties":{
                                    "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."
                                    },
                                    "number1":{
                                        "type":"string",
                                        "maxLength":6,
                                        "description":"Number 1"
                                    },
                                    "number2":{
                                        "type":"string",
                                        "maxLength":4,
                                        "description":"Number 2"
                                    },
                                    "city":{
                                        "type":"string",
                                        "maxLength":90,
                                        "description":"The city of the address."
                                    },
                                    "county":{
                                        "type":"string",
                                        "maxLength":90,
                                        "description":"The county of the address."
                                    },
                                    "country":{
                                        "type":"object",
                                        "properties":{
                                            "_link":{
                                                "type":"string",
                                                "description":"_link"
                                            },
                                            "country":{
                                                "type":"string",
                                                "maxLength":3,
                                                "description":"Country"
                                            }
                                        }
                                    },
                                    "postal":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"The postal code of the address."
                                    },
                                    "state":{
                                        "type":"string",
                                        "maxLength":6,
                                        "description":"The state of the address."
                                    },
                                    "houseType":{
                                        "type":"string",
                                        "enum":[
                                            "AB  ",
                                            "WW  "
                                        ],
                                        "description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                                    },
                                    "inCityLimit":{
                                        "type":"boolean",
                                        "description":"In City Limit"
                                    },
                                    "geographicCode":{
                                        "type":"string",
                                        "maxLength":11,
                                        "description":"Geographical Code"
                                    },
                                    "version":{
                                        "type":"number",
                                        "maximum":99999,
                                        "minimum":-99999,
                                        "description":"The Version number is used for internal concurrency checks.",
                                        "example":"1"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1-Premise"
    }
}

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: object country
  The Country of the address.
• county: object county
  The county of the address.
• geographicCode: string
  Maximum Length: 11

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

  House Type indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer Reference
• inCityLimit: boolean
  City Limit switch is on if the address is considered within the physical city limits.

  Example: true
• mailingAddress: boolean
  Indicates whether the address is a valid Mailing Address that can be used for the Account mailing.

  Example: true
• number1: string
  Maximum Length: 6

  The first street number line of the address.
• number2: string
  Maximum Length: 4

  The Second street number line of the address.
• postal: string
  Maximum Length: 12

  The postal code of the address.
• state: string
  Maximum Length: 6

  The state of the address.

{
    "type":"object",
    "properties":{
        "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."
        },
        "number1":{
            "type":"string",
            "maxLength":6,
            "description":"The first street number line of the address."
        },
        "number2":{
            "type":"string",
            "maxLength":4,
            "description":"The Second street number line of the address."
        },
        "county":{
            "type":"object",
            "description":"The county of the address.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The county of the address."
                }
            }
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"The postal code of the address."
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"The state of the address."
        },
        "country":{
            "type":"object",
            "description":"The Country of the address.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"The Country of the address.",
                    "example":"USA"
                }
            }
        },
        "mailingAddress":{
            "type":"boolean",
            "description":"Indicates whether the address is a valid Mailing Address that can be used for the Account mailing.",
            "example":"true"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "geographicCode":{
            "type":"string",
            "maxLength":11,
            "description":"Geographic code used to apply proper taxation rules to the physical address location."
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"City Limit switch is on if the address is considered within the physical city limits.",
            "example":"true"
        }
    }
}

Nested Schema : alternateAddresses

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "premiseAlternateAddressId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"System assigned key if an alternate address record is entered.  This is only possible if alternate addresses are enabled on the installation record.",
                        "example":"6808137793"
                    },
                    "alternateAddress":{
                        "type":"object",
                        "properties":{
                            "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."
                            },
                            "number1":{
                                "type":"string",
                                "maxLength":6,
                                "description":"Number 1"
                            },
                            "number2":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Number 2"
                            },
                            "city":{
                                "type":"string",
                                "maxLength":90,
                                "description":"The city of the address."
                            },
                            "county":{
                                "type":"string",
                                "maxLength":90,
                                "description":"The county of the address."
                            },
                            "country":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "country":{
                                        "type":"string",
                                        "maxLength":3,
                                        "description":"Country"
                                    }
                                }
                            },
                            "postal":{
                                "type":"string",
                                "maxLength":12,
                                "description":"The postal code of the address."
                            },
                            "state":{
                                "type":"string",
                                "maxLength":6,
                                "description":"The state of the address."
                            },
                            "houseType":{
                                "type":"string",
                                "enum":[
                                    "AB  ",
                                    "WW  "
                                ],
                                "description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                            },
                            "inCityLimit":{
                                "type":"boolean",
                                "description":"In City Limit"
                            },
                            "geographicCode":{
                                "type":"string",
                                "maxLength":11,
                                "description":"Geographical Code"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : characteristics

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date defines the date on which the characteristic becomes effective.",
                        "example":"2018-08-06"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            }
                        }
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location."
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            },
                            "value":{
                                "type":"string",
                                "description":"(value)"
                            },
                            "value2":{
                                "type":"string",
                                "description":"(value2)"
                            },
                            "value3":{
                                "type":"string",
                                "description":"(value3)"
                            },
                            "value4":{
                                "type":"string",
                                "description":"(value4)"
                            },
                            "value5":{
                                "type":"string",
                                "description":"(value5)"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : division

Type: object

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.

Show Source

• _link: string
  _link
• division: 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

{
    "type":"object",
    "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.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "division":{
            "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"
        }
    }
}

Nested Schema : geographicLocations

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "geographicType":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "geographicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Geographic Type"
                            }
                        }
                    },
                    "geographicValue":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Specifies the geographic value such as a coordinate.",
                        "example":"123"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : landlordAgreement

Type: object

Show Source

• _link: string
  _link
• landlordAgreementId: string
  Maximum Length: 10

  Landlord Agreement ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "landlordAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"Landlord Agreement ID"
        }
    }
}

Nested Schema : meterReadInstruction

Type: object

Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.

Show Source

• _link: string
  _link
• meterReadInstruction: string
  Maximum Length: 4

  Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.

  Example: CON

{
    "type":"object",
    "description":"Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "meterReadInstruction":{
            "type":"string",
            "maxLength":4,
            "description":"Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.",
            "example":"CON"
        }
    }
}

Nested Schema : meterReadWarning

Type: object

Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.

Show Source

• _link: string
  _link
• meterReadWarning: string
  Maximum Length: 4

  Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.

  Example: DANG

{
    "type":"object",
    "description":"Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "meterReadWarning":{
            "type":"string",
            "maxLength":4,
            "description":"Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.",
            "example":"DANG"
        }
    }
}

Nested Schema : parentPremiseId

Type: object

Parent Premise is used to include this premise in a premise hierarchy.

Show Source

• _link: string
  _link
• parentPremiseId: string
  Maximum Length: 10

  Parent Premise is used to include this premise in a premise hierarchy.

  Example: 5150218089

{
    "type":"object",
    "description":"Parent Premise is used to include this premise in a premise hierarchy.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "parentPremiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Parent Premise is used to include this premise in a premise hierarchy.",
            "example":"5150218089"
        }
    }
}

Nested Schema : premiseType

Type: object

Premise Type indicates the type of premise.

Show Source

• _link: string
  _link
• premiseType: string
  Maximum Length: 8

  Premise Type indicates the type of premise.

  Example: HOME

{
    "type":"object",
    "description":"Premise Type indicates the type of premise.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "premiseType":{
            "type":"string",
            "maxLength":8,
            "description":"Premise Type indicates the type of premise.",
            "example":"HOME"
        }
    }
}

Nested Schema : timeZone

Type: object

Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.

Show Source

• _link: string
  _link
• timeZone: string
  Maximum Length: 10

  Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.

  Example: USPACIFIC

{
    "type":"object",
    "description":"Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.",
            "example":"USPACIFIC"
        }
    }
}

Nested Schema : trendArea

Type: object

Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.

Show Source

• _link: string
  _link
• trendArea: string
  Maximum Length: 8

  Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.

  Example: SF

{
    "type":"object",
    "description":"Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "trendArea":{
            "type":"string",
            "maxLength":8,
            "description":"Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.",
            "example":"SF"
        }
    }
}

Nested Schema : country

Type: object

The Country of the address.

Show Source

• _link: string
  _link
• country: string
  Maximum Length: 3

  The Country of the address.

  Example: USA

{
    "type":"object",
    "description":"The Country of the address.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"The Country of the address.",
            "example":"USA"
        }
    }
}

Nested Schema : county

Type: object

The county of the address.

Show Source

• _link: string
  _link
• county: string
  Maximum Length: 90

  The county of the address.

{
    "type":"object",
    "description":"The county of the address.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"The county of the address."
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "premiseAlternateAddressId":{
                "type":"string",
                "maxLength":10,
                "description":"System assigned key if an alternate address record is entered.  This is only possible if alternate addresses are enabled on the installation record.",
                "example":"6808137793"
            },
            "alternateAddress":{
                "type":"object",
                "properties":{
                    "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."
                    },
                    "number1":{
                        "type":"string",
                        "maxLength":6,
                        "description":"Number 1"
                    },
                    "number2":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Number 2"
                    },
                    "city":{
                        "type":"string",
                        "maxLength":90,
                        "description":"The city of the address."
                    },
                    "county":{
                        "type":"string",
                        "maxLength":90,
                        "description":"The county of the address."
                    },
                    "country":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "country":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Country"
                            }
                        }
                    },
                    "postal":{
                        "type":"string",
                        "maxLength":12,
                        "description":"The postal code of the address."
                    },
                    "state":{
                        "type":"string",
                        "maxLength":6,
                        "description":"The state of the address."
                    },
                    "houseType":{
                        "type":"string",
                        "enum":[
                            "AB  ",
                            "WW  "
                        ],
                        "description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                    },
                    "inCityLimit":{
                        "type":"boolean",
                        "description":"In City Limit"
                    },
                    "geographicCode":{
                        "type":"string",
                        "maxLength":11,
                        "description":"Geographical Code"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• alternateAddress: object alternateAddress
• premiseAlternateAddressId: string
  Maximum Length: 10

  System assigned key if an alternate address record is entered. This is only possible if alternate addresses are enabled on the installation record.

  Example: 6808137793

{
    "type":"object",
    "properties":{
        "premiseAlternateAddressId":{
            "type":"string",
            "maxLength":10,
            "description":"System assigned key if an alternate address record is entered.  This is only possible if alternate addresses are enabled on the installation record.",
            "example":"6808137793"
        },
        "alternateAddress":{
            "type":"object",
            "properties":{
                "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."
                },
                "number1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"Number 1"
                },
                "number2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Number 2"
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The city of the address."
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The county of the address."
                },
                "country":{
                    "type":"object",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "country":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Country"
                        }
                    }
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The postal code of the address."
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The state of the address."
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit"
                },
                "geographicCode":{
                    "type":"string",
                    "maxLength":11,
                    "description":"Geographical Code"
                },
                "version":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"The Version number is used for internal concurrency checks.",
                    "example":"1"
                }
            }
        }
    }
}

Nested Schema : alternateAddress

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: object country
• county: string
  Maximum Length: 90

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

  Geographical Code
• houseType: string
  Allowed Values: [ "AB ", "WW " ]

  House Type indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer Reference
• inCityLimit: boolean
  In City Limit
• number1: string
  Maximum Length: 6

  Number 1
• number2: string
  Maximum Length: 4

  Number 2
• postal: string
  Maximum Length: 12

  The postal code of the address.
• state: string
  Maximum Length: 6

  The state of the address.
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "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."
        },
        "number1":{
            "type":"string",
            "maxLength":6,
            "description":"Number 1"
        },
        "number2":{
            "type":"string",
            "maxLength":4,
            "description":"Number 2"
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"The city of the address."
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"The county of the address."
        },
        "country":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Country"
                }
            }
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"The postal code of the address."
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"The state of the address."
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "geographicCode":{
            "type":"string",
            "maxLength":11,
            "description":"Geographical Code"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        }
    }
}

Nested Schema : country

Type: object

Show Source

• _link: string
  _link
• country: string
  Maximum Length: 3

  Country

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"Country"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date defines the date on which the characteristic becomes effective.",
                "example":"2018-08-06"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    }
                }
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "maxLength":4,
                "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location."
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    },
                    "value":{
                        "type":"string",
                        "description":"(value)"
                    },
                    "value2":{
                        "type":"string",
                        "description":"(value2)"
                    },
                    "value3":{
                        "type":"string",
                        "description":"(value3)"
                    },
                    "value4":{
                        "type":"string",
                        "description":"(value4)"
                    },
                    "value5":{
                        "type":"string",
                        "description":"(value5)"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"The Version number is used for internal concurrency checks.",
                "example":"1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: object characteristicType
• characteristicValue: object characteristicValue
• effectiveDate: string (date)
  Effective Date defines the date on which the characteristic becomes effective.

  Example: 2018-08-06
• typeOfCharacteristicValue: string
  Maximum Length: 4

  Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date defines the date on which the characteristic becomes effective.",
            "example":"2018-08-06"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                }
            }
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "maxLength":4,
            "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location."
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                },
                "value":{
                    "type":"string",
                    "description":"(value)"
                },
                "value2":{
                    "type":"string",
                    "description":"(value2)"
                },
                "value3":{
                    "type":"string",
                    "description":"(value3)"
                },
                "value4":{
                    "type":"string",
                    "description":"(value4)"
                },
                "value5":{
                    "type":"string",
                    "description":"(value5)"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• _link: string
  _link
• characteristicType: string
  Maximum Length: 8

  Characteristic Type

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        }
    }
}

Nested Schema : characteristicValue

Type: object

Show Source

• _link: string
  (_link)
• value: string
  (value)
• value2: string
  (value2)
• value3: string
  (value3)
• value4: string
  (value4)
• value5: string
  (value5)

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"(_link)"
        },
        "value":{
            "type":"string",
            "description":"(value)"
        },
        "value2":{
            "type":"string",
            "description":"(value2)"
        },
        "value3":{
            "type":"string",
            "description":"(value3)"
        },
        "value4":{
            "type":"string",
            "description":"(value4)"
        },
        "value5":{
            "type":"string",
            "description":"(value5)"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "geographicType":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "geographicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Geographic Type"
                    }
                }
            },
            "geographicValue":{
                "type":"string",
                "maxLength":50,
                "description":"Specifies the geographic value such as a coordinate.",
                "example":"123"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"The Version number is used for internal concurrency checks.",
                "example":"1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• geographicType: object geographicType
• geographicValue: string
  Maximum Length: 50

  Specifies the geographic value such as a coordinate.

  Example: 123
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "geographicType":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "geographicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Geographic Type"
                }
            }
        },
        "geographicValue":{
            "type":"string",
            "maxLength":50,
            "description":"Specifies the geographic value such as a coordinate.",
            "example":"123"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        }
    }
}

Nested Schema : geographicType

Type: object

Show Source

• _link: string
  _link
• geographicType: string
  Maximum Length: 8

  Geographic Type

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "geographicType":{
            "type":"string",
            "maxLength":8,
            "description":"Geographic Type"
        }
    }
}

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