Jump to

• Request
• Response

Get Service Point

get

/rest/apis/meter/v-model/servicePoints/{servicePointId}

Request

Path Parameters

• servicePointId(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-ServicePt

Type: object

Show Source

• _self: string
  _self
• abolishedDate: string (date)
  Abolished Date is the date when service point was abolished.

  Example: 2005-01-01
• characteristics: object characteristics
• disconnectLocation: object disconnectLocation
  If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.
• equipment: object equipment
• facilityLevel1: string
  Maximum Length: 8

  Designate the facility hierarchy that supplies service to the service point using the Facility Levels.

  Example: E (Substation - east)
• facilityLevel2: string
  Maximum Length: 8

  Designate the facility hierarchy that supplies service to the service point using the Facility Levels.

  Example: 2 (Feeder 2 )
• facilityLevel3: string
  Maximum Length: 8

  Designate the facility hierarchy that supplies service to the service point using the Facility Levels.

  Example: A (Node A)
• geographicLocations: object geographicLocations
• installationDate: string (date)
  Date of the installation of the service point connection at the premise.

  Example: 2007-06-1
• 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.
• keyId: string
  Maximum Length: 10

  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.
• location: object location
• locationDetails: string
  Maximum Length: 4000

  Location Details are used to clarify the location at the premise.

  Example: Left side of house
• 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: SER
• meterReadInstructionDetails: string
  Maximum Length: 250

  Provides more detailed instructions to the individual who reads meters at this premise.

  Example: Suspect Dangerous occupants
• 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
• multiItems: object multiItems
• okToEnter: boolean
  If the Override premise field information is set to yes , then Turn on OK to Enter if the meter is located in the interior of the premise and your company has permission to enter.

  Example: false
• operationAreas: object operationAreas
• overridePremiseFieldInfo: string
  Allowed Values: [ "N ", "Y " ]

  To override premise field information on a specific service point, set Override Premise Field Information to Yes. If the value is set to No, the premise information may not be overridden. * `N ` - No, * `Y ` - Yes

  Example: N
• premise: object premise
• serviceCycle: object serviceCycle
  If the SP Type uses a service route, the Service Cycle, Service Route, and Service Cycle / Route Sequence are specified to define the logical position of the service point in the meter reader's route.
• serviceCycleRouteSequence: number
  Minimum Value: -99999999

  Maximum Value: 99999999

  If the SP Type uses a service route, the Service Cycle, Service Route, and Service Cycle / Route Sequence are specified to define the logical position of the service point in the meter reader's route.

  Example: 0
• servicePointId: string
  Maximum Length: 10

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

  Example: 3996166619
• servicePointSourceStatus: string
  Allowed Values: [ "C ", "D " ]

  Service Point Source Status defines whether the service point is connected to the source of power. Valid values are: Connected and Disconnected. * `C ` - Connected, * `D ` - Disconnected

  Example: C
• servicePointStatus: string
  Allowed Values: [ "I ", "R " ]

  Service Point Status controls whether the service point can be linked to new service agreements. SP status indicates if the service point is In Service or Abolished * `I ` - Out of Service, * `R ` - In Service

  Example: R
• servicePointType: object servicePointType
  The Service Point Type defines specific types of points at which service is delivered.
• serviceRoute: string
  Maximum Length: 16

  If the SP Type uses a service route, the Service Cycle, Service Route, and Service Cycle / Route Sequence are specified to define the logical position of the service point in the meter reader's route.

  Example: 1
• 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"
        },
        "servicePointId":{
            "type":"string",
            "maxLength":"10",
            "description":"Service Point ID is a system assigned random number that stays with a service point record.",
            "example":"3996166619"
        },
        "premise":{
            "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."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "servicePointType":{
            "type":"object",
            "description":"The Service Point Type defines specific types of points at which service is delivered.",
            "properties":{
                "servicePointType":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"The Service Point Type defines specific types of points at which service is delivered.",
                    "example":"G-COM"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "servicePointStatus":{
            "type":"string",
            "enum":[
                "I   ",
                "R   "
            ],
            "description":"Service Point Status controls whether the service point can be linked to new service agreements. SP status indicates if the service point is In Service or Abolished\n* `I   ` - Out of Service,\n* `R   ` - In Service",
            "example":"R"
        },
        "abolishedDate":{
            "type":"string",
            "format":"date",
            "description":"Abolished Date is the date when service point was abolished.",
            "example":"2005-01-01"
        },
        "installationDate":{
            "type":"string",
            "format":"date",
            "description":"Date of the installation of the service point connection at the premise.",
            "example":"2007-06-1"
        },
        "servicePointSourceStatus":{
            "type":"string",
            "enum":[
                "C   ",
                "D   "
            ],
            "description":"Service Point Source Status defines whether the service point is connected to the source of power. Valid values are: Connected and Disconnected.\n* `C   ` - Connected,\n* `D   ` - Disconnected",
            "example":"C"
        },
        "disconnectLocation":{
            "type":"object",
            "description":"If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.",
            "properties":{
                "disconnectLocation":{
                    "type":"string",
                    "maxLength":"4",
                    "description":"If the Service point source status is disconnected, use Disconnect Location to specify where service was severed."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "location":{
            "type":"object",
            "properties":{
                "meterLocation":{
                    "type":"string",
                    "maxLength":"4",
                    "description":"Meter Location is used to define where the service point is located on the premise.",
                    "example":"LEFT"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "locationDetails":{
            "type":"string",
            "maxLength":"4000",
            "description":"Location Details are used to clarify the location at the premise.",
            "example":"Left side of house"
        },
        "serviceCycle":{
            "type":"object",
            "description":"If the SP Type uses a service route, the Service Cycle, Service Route, and Service Cycle / Route Sequence are specified to define the logical position of the service point in the meter reader's route.",
            "properties":{
                "serviceCycle":{
                    "type":"string",
                    "maxLength":"16",
                    "description":"If the SP Type uses a service route, the Service Cycle, Service Route, and Service Cycle / Route Sequence are specified to define the logical position of the service point in the meter reader's route.",
                    "example":"M-D1"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "serviceRoute":{
            "type":"string",
            "maxLength":"16",
            "description":"If the SP Type uses a service route, the Service Cycle, Service Route, and Service Cycle / Route Sequence are specified to define the logical position of the service point in the meter reader's route.",
            "example":"1"
        },
        "serviceCycleRouteSequence":{
            "type":"number",
            "maximum":"99999999",
            "minimum":"-99999999",
            "description":"If the SP Type uses a service route, the Service Cycle, Service Route, and Service Cycle / Route Sequence are specified to define the logical position of the service point in the meter reader's route.",
            "example":"0"
        },
        "facilityLevel1":{
            "type":"string",
            "maxLength":"8",
            "description":"Designate the facility hierarchy that supplies service to the service point using the Facility Levels.",
            "example":"E (Substation - east)"
        },
        "facilityLevel2":{
            "type":"string",
            "maxLength":"8",
            "description":"Designate the facility hierarchy that supplies service to the service point using the Facility Levels.",
            "example":"2 (Feeder 2 )"
        },
        "facilityLevel3":{
            "type":"string",
            "maxLength":"8",
            "description":"Designate the facility hierarchy that supplies service to the service point using the Facility Levels.",
            "example":"A (Node A)"
        },
        "overridePremiseFieldInfo":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"To override premise field information on a specific service point, set Override Premise Field Information to Yes. If the value is set to No, the premise information may not be overridden.\n* `N   ` - No,\n* `Y   ` - Yes",
            "example":"N"
        },
        "okToEnter":{
            "type":"boolean",
            "description":"If the Override premise field information is set to yes , then Turn on OK to Enter if the meter is located in the interior of the premise and your company has permission to enter.",
            "example":"false"
        },
        "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"
        },
        "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":"SER"
        },
        "meterReadInstructionDetails":{
            "type":"string",
            "maxLength":"250",
            "description":"Provides more detailed instructions to the individual who reads meters at this premise.",
            "example":"Suspect Dangerous occupants"
        },
        "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."
        },
        "keyId":{
            "type":"string",
            "maxLength":"10",
            "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."
        },
        "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. The effective date defaults from the Installation Record."
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":"8",
                                        "description":"Characteristic Type"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "typeOfCharacteristicValue":{
                                "type":"string",
                                "enum":[
                                    "ADV ",
                                    "DFV ",
                                    "FKV ",
                                    "FLV "
                                ],
                                "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "value":{
                                        "type":"string",
                                        "maxLength":"254",
                                        "description":"Adhoc Characteristic Value"
                                    },
                                    "value2":{
                                        "type":"string",
                                        "maxLength":"50",
                                        "description":"Foreign Key Value 2"
                                    },
                                    "value3":{
                                        "type":"string",
                                        "maxLength":"50",
                                        "description":"Foreign Key Value 3"
                                    },
                                    "value4":{
                                        "type":"string",
                                        "maxLength":"50",
                                        "description":"Foreign Key Value 4"
                                    },
                                    "value5":{
                                        "type":"string",
                                        "maxLength":"50",
                                        "description":"Foreign Key Value 5"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":"99999",
                                "minimum":"-99999",
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        },
        "equipment":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "equipment":{
                                "type":"object",
                                "properties":{
                                    "equipmentId":{
                                        "type":"string",
                                        "maxLength":"10",
                                        "description":"Item ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "installationDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Date of the installation of the service point connection at the premise.",
                                "example":"2007-06-1"
                            },
                            "removalDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Defines the date that the equipment was removed from the service point.",
                                "example":"2007-06-1"
                            },
                            "equipmentCount":{
                                "type":"number",
                                "maximum":"999999999.99",
                                "minimum":"-999999999.99",
                                "description":"Equipment Count field should be 1 except when you are using an item to define a generic piece of equipment. If you use an item to define a generic piece of equipment, you can indicate the number of such generic pieces of equipment that are associated with this service point.",
                                "example":"1.00"
                            },
                            "comment":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"Use comments to explain anything unusual about the piece of equipment."
                            },
                            "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":{
                                    "geographicType":{
                                        "type":"string",
                                        "maxLength":"8",
                                        "description":"Geographic Type"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "geographicValue":{
                                "type":"string",
                                "maxLength":"50",
                                "description":"Specifies the geographic value such as a coordinate.",
                                "example":"1002748"
                            },
                            "version":{
                                "type":"number",
                                "maximum":"99999",
                                "minimum":"-99999",
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        },
        "multiItems":{
            "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. The effective date defaults from the Installation Record."
                            },
                            "version":{
                                "type":"number",
                                "maximum":"99999",
                                "minimum":"-99999",
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"1"
                            },
                            "multiItem":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "itemType":{
                                                    "type":"object",
                                                    "properties":{
                                                        "itemType":{
                                                            "type":"string",
                                                            "maxLength":"30",
                                                            "description":"Item Type"
                                                        },
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        }
                                                    }
                                                },
                                                "itemCount":{
                                                    "type":"number",
                                                    "maximum":"999999999.99",
                                                    "minimum":"-999999999.99",
                                                    "description":"Indicates how many of the given type of item exist at the service point."
                                                },
                                                "effectiveDate":{
                                                    "type":"string",
                                                    "format":"date",
                                                    "description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record."
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":"99999",
                                                    "minimum":"-99999",
                                                    "description":"The Version number is used for internal concurrency checks.",
                                                    "example":"1"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "operationAreas":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "fieldServiceClass":{
                                "type":"string",
                                "maxLength":"5",
                                "description":"Indicates the field service classification.",
                                "example":"METER"
                            },
                            "operationsArea":{
                                "type":"string",
                                "maxLength":"8",
                                "description":"Specifies the operation area that manages field activities associated with the field service classification.",
                                "example":"NORTH"
                            },
                            "version":{
                                "type":"number",
                                "maximum":"99999",
                                "minimum":"-99999",
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1-ServicePt"
    }
}

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. The effective date defaults from the Installation Record."
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"string",
                                "maxLength":"8",
                                "description":"Characteristic Type"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "enum":[
                            "ADV ",
                            "DFV ",
                            "FKV ",
                            "FLV "
                        ],
                        "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Adhoc Characteristic Value"
                            },
                            "value2":{
                                "type":"string",
                                "maxLength":"50",
                                "description":"Foreign Key Value 2"
                            },
                            "value3":{
                                "type":"string",
                                "maxLength":"50",
                                "description":"Foreign Key Value 3"
                            },
                            "value4":{
                                "type":"string",
                                "maxLength":"50",
                                "description":"Foreign Key Value 4"
                            },
                            "value5":{
                                "type":"string",
                                "maxLength":"50",
                                "description":"Foreign Key Value 5"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":"99999",
                        "minimum":"-99999",
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : disconnectLocation

Type: object

If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.

Show Source

• _link: string
  _link
• disconnectLocation: string
  Maximum Length: 4

  If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.

{
    "type":"object",
    "description":"If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.",
    "properties":{
        "disconnectLocation":{
            "type":"string",
            "maxLength":"4",
            "description":"If the Service point source status is disconnected, use Disconnect Location to specify where service was severed."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : equipment

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "equipment":{
                        "type":"object",
                        "properties":{
                            "equipmentId":{
                                "type":"string",
                                "maxLength":"10",
                                "description":"Item ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "installationDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Date of the installation of the service point connection at the premise.",
                        "example":"2007-06-1"
                    },
                    "removalDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Defines the date that the equipment was removed from the service point.",
                        "example":"2007-06-1"
                    },
                    "equipmentCount":{
                        "type":"number",
                        "maximum":"999999999.99",
                        "minimum":"-999999999.99",
                        "description":"Equipment Count field should be 1 except when you are using an item to define a generic piece of equipment. If you use an item to define a generic piece of equipment, you can indicate the number of such generic pieces of equipment that are associated with this service point.",
                        "example":"1.00"
                    },
                    "comment":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Use comments to explain anything unusual about the piece of equipment."
                    },
                    "version":{
                        "type":"number",
                        "maximum":"99999",
                        "minimum":"-99999",
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : geographicLocations

Type: object

Show Source

• _data: array _data

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

Nested Schema : location

Type: object

Show Source

• _link: string
  _link
• meterLocation: string
  Maximum Length: 4

  Meter Location is used to define where the service point is located on the premise.

  Example: LEFT

{
    "type":"object",
    "properties":{
        "meterLocation":{
            "type":"string",
            "maxLength":"4",
            "description":"Meter Location is used to define where the service point is located on the premise.",
            "example":"LEFT"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : multiItems

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. The effective date defaults from the Installation Record."
                    },
                    "version":{
                        "type":"number",
                        "maximum":"99999",
                        "minimum":"-99999",
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"1"
                    },
                    "multiItem":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "itemType":{
                                            "type":"object",
                                            "properties":{
                                                "itemType":{
                                                    "type":"string",
                                                    "maxLength":"30",
                                                    "description":"Item Type"
                                                },
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                }
                                            }
                                        },
                                        "itemCount":{
                                            "type":"number",
                                            "maximum":"999999999.99",
                                            "minimum":"-999999999.99",
                                            "description":"Indicates how many of the given type of item exist at the service point."
                                        },
                                        "effectiveDate":{
                                            "type":"string",
                                            "format":"date",
                                            "description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record."
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":"99999",
                                            "minimum":"-99999",
                                            "description":"The Version number is used for internal concurrency checks.",
                                            "example":"1"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : operationAreas

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fieldServiceClass":{
                        "type":"string",
                        "maxLength":"5",
                        "description":"Indicates the field service classification.",
                        "example":"METER"
                    },
                    "operationsArea":{
                        "type":"string",
                        "maxLength":"8",
                        "description":"Specifies the operation area that manages field activities associated with the field service classification.",
                        "example":"NORTH"
                    },
                    "version":{
                        "type":"number",
                        "maximum":"99999",
                        "minimum":"-99999",
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : premise

Type: object

Show Source

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

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

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

Nested Schema : serviceCycle

Type: object

If the SP Type uses a service route, the Service Cycle, Service Route, and Service Cycle / Route Sequence are specified to define the logical position of the service point in the meter reader's route.

Show Source

• _link: string
  _link
• serviceCycle: string
  Maximum Length: 16

  If the SP Type uses a service route, the Service Cycle, Service Route, and Service Cycle / Route Sequence are specified to define the logical position of the service point in the meter reader's route.

  Example: M-D1

{
    "type":"object",
    "description":"If the SP Type uses a service route, the Service Cycle, Service Route, and Service Cycle / Route Sequence are specified to define the logical position of the service point in the meter reader's route.",
    "properties":{
        "serviceCycle":{
            "type":"string",
            "maxLength":"16",
            "description":"If the SP Type uses a service route, the Service Cycle, Service Route, and Service Cycle / Route Sequence are specified to define the logical position of the service point in the meter reader's route.",
            "example":"M-D1"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : servicePointType

Type: object

The Service Point Type defines specific types of points at which service is delivered.

Show Source

• _link: string
  _link
• servicePointType: string
  Maximum Length: 30

  The Service Point Type defines specific types of points at which service is delivered.

  Example: G-COM

{
    "type":"object",
    "description":"The Service Point Type defines specific types of points at which service is delivered.",
    "properties":{
        "servicePointType":{
            "type":"string",
            "maxLength":"30",
            "description":"The Service Point Type defines specific types of points at which service is delivered.",
            "example":"G-COM"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

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. The effective date defaults from the Installation Record."
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"string",
                        "maxLength":"8",
                        "description":"Characteristic Type"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "enum":[
                    "ADV ",
                    "DFV ",
                    "FKV ",
                    "FLV "
                ],
                "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Adhoc Characteristic Value"
                    },
                    "value2":{
                        "type":"string",
                        "maxLength":"50",
                        "description":"Foreign Key Value 2"
                    },
                    "value3":{
                        "type":"string",
                        "maxLength":"50",
                        "description":"Foreign Key Value 3"
                    },
                    "value4":{
                        "type":"string",
                        "maxLength":"50",
                        "description":"Foreign Key Value 4"
                    },
                    "value5":{
                        "type":"string",
                        "maxLength":"50",
                        "description":"Foreign Key Value 5"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            },
            "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. The effective date defaults from the Installation Record.
• typeOfCharacteristicValue: string
  Allowed Values: [ "ADV ", "DFV ", "FKV ", "FLV " ]

  Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location. * `ADV ` - Adhoc Value, * `DFV ` - Predefined Value, * `FKV ` - Foreign Key Value, * `FLV ` - File Location Value
• 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. The effective date defaults from the Installation Record."
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":"8",
                    "description":"Characteristic Type"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "enum":[
                "ADV ",
                "DFV ",
                "FKV ",
                "FLV "
            ],
            "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Adhoc Characteristic Value"
                },
                "value2":{
                    "type":"string",
                    "maxLength":"50",
                    "description":"Foreign Key Value 2"
                },
                "value3":{
                    "type":"string",
                    "maxLength":"50",
                    "description":"Foreign Key Value 3"
                },
                "value4":{
                    "type":"string",
                    "maxLength":"50",
                    "description":"Foreign Key Value 4"
                },
                "value5":{
                    "type":"string",
                    "maxLength":"50",
                    "description":"Foreign Key Value 5"
                },
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                }
            }
        },
        "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":{
        "characteristicType":{
            "type":"string",
            "maxLength":"8",
            "description":"Characteristic Type"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : characteristicValue

Type: object

Show Source

• _link: string
  (_link)
• value: string
  Maximum Length: 254

  Adhoc Characteristic Value
• value2: string
  Maximum Length: 50

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

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

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

  Foreign Key Value 5

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

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "equipment":{
                "type":"object",
                "properties":{
                    "equipmentId":{
                        "type":"string",
                        "maxLength":"10",
                        "description":"Item ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "installationDate":{
                "type":"string",
                "format":"date",
                "description":"Date of the installation of the service point connection at the premise.",
                "example":"2007-06-1"
            },
            "removalDate":{
                "type":"string",
                "format":"date",
                "description":"Defines the date that the equipment was removed from the service point.",
                "example":"2007-06-1"
            },
            "equipmentCount":{
                "type":"number",
                "maximum":"999999999.99",
                "minimum":"-999999999.99",
                "description":"Equipment Count field should be 1 except when you are using an item to define a generic piece of equipment. If you use an item to define a generic piece of equipment, you can indicate the number of such generic pieces of equipment that are associated with this service point.",
                "example":"1.00"
            },
            "comment":{
                "type":"string",
                "maxLength":"60",
                "description":"Use comments to explain anything unusual about the piece of equipment."
            },
            "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

• comment: string
  Maximum Length: 60

  Use comments to explain anything unusual about the piece of equipment.
• equipment: object equipment
• equipmentCount: number
  Minimum Value: -999999999.99

  Maximum Value: 999999999.99

  Equipment Count field should be 1 except when you are using an item to define a generic piece of equipment. If you use an item to define a generic piece of equipment, you can indicate the number of such generic pieces of equipment that are associated with this service point.

  Example: 1.00
• installationDate: string (date)
  Date of the installation of the service point connection at the premise.

  Example: 2007-06-1
• removalDate: string (date)
  Defines the date that the equipment was removed from the service point.

  Example: 2007-06-1
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "equipment":{
            "type":"object",
            "properties":{
                "equipmentId":{
                    "type":"string",
                    "maxLength":"10",
                    "description":"Item ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "installationDate":{
            "type":"string",
            "format":"date",
            "description":"Date of the installation of the service point connection at the premise.",
            "example":"2007-06-1"
        },
        "removalDate":{
            "type":"string",
            "format":"date",
            "description":"Defines the date that the equipment was removed from the service point.",
            "example":"2007-06-1"
        },
        "equipmentCount":{
            "type":"number",
            "maximum":"999999999.99",
            "minimum":"-999999999.99",
            "description":"Equipment Count field should be 1 except when you are using an item to define a generic piece of equipment. If you use an item to define a generic piece of equipment, you can indicate the number of such generic pieces of equipment that are associated with this service point.",
            "example":"1.00"
        },
        "comment":{
            "type":"string",
            "maxLength":"60",
            "description":"Use comments to explain anything unusual about the piece of equipment."
        },
        "version":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        }
    }
}

Nested Schema : equipment

Type: object

Show Source

• _link: string
  _link
• equipmentId: string
  Maximum Length: 10

  Item ID

{
    "type":"object",
    "properties":{
        "equipmentId":{
            "type":"string",
            "maxLength":"10",
            "description":"Item ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "geographicType":{
                "type":"object",
                "properties":{
                    "geographicType":{
                        "type":"string",
                        "maxLength":"8",
                        "description":"Geographic Type"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "geographicValue":{
                "type":"string",
                "maxLength":"50",
                "description":"Specifies the geographic value such as a coordinate.",
                "example":"1002748"
            },
            "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: 1002748
• 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":{
                "geographicType":{
                    "type":"string",
                    "maxLength":"8",
                    "description":"Geographic Type"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "geographicValue":{
            "type":"string",
            "maxLength":"50",
            "description":"Specifies the geographic value such as a coordinate.",
            "example":"1002748"
        },
        "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":{
        "geographicType":{
            "type":"string",
            "maxLength":"8",
            "description":"Geographic Type"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

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. The effective date defaults from the Installation Record."
            },
            "version":{
                "type":"number",
                "maximum":"99999",
                "minimum":"-99999",
                "description":"The Version number is used for internal concurrency checks.",
                "example":"1"
            },
            "multiItem":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "itemType":{
                                    "type":"object",
                                    "properties":{
                                        "itemType":{
                                            "type":"string",
                                            "maxLength":"30",
                                            "description":"Item Type"
                                        },
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        }
                                    }
                                },
                                "itemCount":{
                                    "type":"number",
                                    "maximum":"999999999.99",
                                    "minimum":"-999999999.99",
                                    "description":"Indicates how many of the given type of item exist at the service point."
                                },
                                "effectiveDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record."
                                },
                                "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

• effectiveDate: string (date)
  Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.
• multiItem: object multiItem
• 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. The effective date defaults from the Installation Record."
        },
        "version":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        },
        "multiItem":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "itemType":{
                                "type":"object",
                                "properties":{
                                    "itemType":{
                                        "type":"string",
                                        "maxLength":"30",
                                        "description":"Item Type"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "itemCount":{
                                "type":"number",
                                "maximum":"999999999.99",
                                "minimum":"-999999999.99",
                                "description":"Indicates how many of the given type of item exist at the service point."
                            },
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record."
                            },
                            "version":{
                                "type":"number",
                                "maximum":"99999",
                                "minimum":"-99999",
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : multiItem

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "itemType":{
                        "type":"object",
                        "properties":{
                            "itemType":{
                                "type":"string",
                                "maxLength":"30",
                                "description":"Item Type"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "itemCount":{
                        "type":"number",
                        "maximum":"999999999.99",
                        "minimum":"-999999999.99",
                        "description":"Indicates how many of the given type of item exist at the service point."
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record."
                    },
                    "version":{
                        "type":"number",
                        "maximum":"99999",
                        "minimum":"-99999",
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "itemType":{
                "type":"object",
                "properties":{
                    "itemType":{
                        "type":"string",
                        "maxLength":"30",
                        "description":"Item Type"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "itemCount":{
                "type":"number",
                "maximum":"999999999.99",
                "minimum":"-999999999.99",
                "description":"Indicates how many of the given type of item exist at the service point."
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record."
            },
            "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

• effectiveDate: string (date)
  Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.
• itemCount: number
  Minimum Value: -999999999.99

  Maximum Value: 999999999.99

  Indicates how many of the given type of item exist at the service point.
• itemType: object itemType
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "itemType":{
            "type":"object",
            "properties":{
                "itemType":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Item Type"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "itemCount":{
            "type":"number",
            "maximum":"999999999.99",
            "minimum":"-999999999.99",
            "description":"Indicates how many of the given type of item exist at the service point."
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record."
        },
        "version":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        }
    }
}

Nested Schema : itemType

Type: object

Show Source

• _link: string
  _link
• itemType: string
  Maximum Length: 30

  Item Type

{
    "type":"object",
    "properties":{
        "itemType":{
            "type":"string",
            "maxLength":"30",
            "description":"Item Type"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fieldServiceClass":{
                "type":"string",
                "maxLength":"5",
                "description":"Indicates the field service classification.",
                "example":"METER"
            },
            "operationsArea":{
                "type":"string",
                "maxLength":"8",
                "description":"Specifies the operation area that manages field activities associated with the field service classification.",
                "example":"NORTH"
            },
            "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

• fieldServiceClass: string
  Maximum Length: 5

  Indicates the field service classification.

  Example: METER
• operationsArea: string
  Maximum Length: 8

  Specifies the operation area that manages field activities associated with the field service classification.

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

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "fieldServiceClass":{
            "type":"string",
            "maxLength":"5",
            "description":"Indicates the field service classification.",
            "example":"METER"
        },
        "operationsArea":{
            "type":"string",
            "maxLength":"8",
            "description":"Specifies the operation area that manages field activities associated with the field service classification.",
            "example":"NORTH"
        },
        "version":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"The Version number is used for internal concurrency checks.",
            "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