Jump to

• Request
• Response

Get Service Point Summary

get

/rest/apis/customer/v-model/servicePointsCommon/{servicePointId}/summary

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 : C1SPSummary

Type: object

Show Source

• _self: string
  _self
• abolishedDate: string (date)
  This is the date of the abolishment of the service point at the premise.
• c2mFields: object c2mFields
• cycleRouteSequence: number
  Minimum Value: -99999

  Maximum Value: 99999

  Route Description

  Example: 210
• deviceLocationDescription: string
  Maximum Length: 100

  Description of the location of the service point at the premise.

  Example: Left side of house
• disconnectLocationDescription: string
  Maximum Length: 100

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

  Example: Transformer - Electric
• 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. The default value is based on the Country and the Postal Code, but can be overridden.

  Example: Ohio
• hasEquipment: boolean
  Has Equipment indicates if any equipment is linked to the service point. A value of true indicates that there is equipment linked to the service point.

  Example: false
• hasMultiItems: boolean
  Has Multi Items indicates a service point with multiple non-badged items. A value of true indicates that there are multiple non-badged items for the service point.

  Example: false
• installationDate: string (date)
  This is the date of the installation of the service point at the premise.

  Example: 2018-08-24
• instructionDescription: string
  Maximum Length: 100

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

  Example: Verify serial number
• isActive: boolean
  Is Active indicates if the service point is In Service or Abolished. A value of true defines the service point as active.

  Example: true
• isConnected: boolean
  Is Connected defines if the service point is connected to the source of service or not. A value of true defines the service point as connected.

  Example: true
• keyAtPremise: boolean
  Define Key at Premise as true 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: true
• keyId: string
  Maximum Length: 10

  Key Id defines the key identifier if Key at Premise field is enabled.

  Example: 12345
• locationDetails: string
  Maximum Length: 4000

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

  Example: Location Details added in SP Live Data
• measurementCycleDescription: string
  Maximum Length: 150

  Description for the service point's measurement cycle.

  Example: ZZT Monthly meter rd cycle - day 1 (M-D1)
• meterReadInstructionDetails: string
  Maximum Length: 250

  MR Instruction defines specific instructions that are provided to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.

  Example: CON
• okToEnter: boolean
  Define OK to Enter as true if the meter is located in the interior of the premise and your company has permission to enter.

  Example: true
• premise: object premise
• routeDescription: string
  Maximum Length: 150

  Description for the Measurement Cycle Route.

  Example: MV90 Route 1
• servicePointId: string
  Maximum Length: 10

  Service Point ID
• servicePointType: object servicePointType
  The Service Point Type defines the types of service points that are available. For example, G-COM is configured as "Gas Commercial" and controls the types of devices that can be installed.
• timeZoneName: string
  Maximum Length: 50

  The description for the time zone that is displayed to customers.

  Example: US/Pacific
• warningDescription: string
  Maximum Length: 100

  MR Warning Description defines a specific warning that is provided to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.

  Example: Mean dog at premise

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID"
        },
        "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."
                },
                "formattedAddress":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The Premise ID is a system assigned random number that stays with a premise for life."
                },
                "lifeSupportSensitiveLoad":{
                    "type":"boolean",
                    "description":"The Premise ID is a system assigned random number that stays with a premise for life."
                },
                "lifeSupportSensitiveLoadDescription":{
                    "type":"string",
                    "maxLength":1000,
                    "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 the types of service points that are available.  For example, G-COM is configured as \"Gas Commercial\" and controls the types of devices that can be installed.",
            "properties":{
                "servicePointType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The Service Point Type defines the types of service points that are available.  For example, G-COM is configured as \"Gas Commercial\" and controls the types of devices that can be installed.",
                    "example":"G-COM"
                },
                "servicePointTypeDescription":{
                    "type":"string",
                    "maxLength":150,
                    "description":"The Service Point Type defines the types of service points that are available.  For example, G-COM is configured as \"Gas Commercial\" and controls the types of devices that can be installed.",
                    "example":"G-COM"
                },
                "category":{
                    "type":"string",
                    "maxLength":4,
                    "description":"The Service Point Type defines the types of service points that are available.  For example, G-COM is configured as \"Gas Commercial\" and controls the types of devices that can be installed.",
                    "example":"G-COM"
                },
                "serviceType":{
                    "type":"string",
                    "maxLength":80,
                    "description":"The Service Point Type defines the types of service points that are available.  For example, G-COM is configured as \"Gas Commercial\" and controls the types of devices that can be installed.",
                    "example":"G-COM"
                },
                "_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. The default value is based on the Country and the Postal Code, but can be overridden.",
            "example":"Ohio"
        },
        "timeZoneName":{
            "type":"string",
            "maxLength":50,
            "description":"The description for the time zone that is displayed to customers.",
            "example":"US/Pacific"
        },
        "installationDate":{
            "type":"string",
            "format":"date",
            "description":"This is the date of the installation of the service point at the premise.",
            "example":"2018-08-24"
        },
        "abolishedDate":{
            "type":"string",
            "format":"date",
            "description":"This is the date of the abolishment of the service point at the premise."
        },
        "isActive":{
            "type":"boolean",
            "description":"Is Active indicates if the service point is In Service or Abolished. A value of true defines the service point as active.",
            "example":"true"
        },
        "isConnected":{
            "type":"boolean",
            "description":"Is Connected defines if the service point is connected to the source of service or not.  A value of true defines the service point as connected.",
            "example":"true"
        },
        "disconnectLocationDescription":{
            "type":"string",
            "maxLength":100,
            "description":"If the service point source status is disconnected, use Disconnect Location to specify where service was severed.",
            "example":"Transformer - Electric"
        },
        "deviceLocationDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Description of the location of the service point at the premise.",
            "example":"Left side of house"
        },
        "locationDetails":{
            "type":"string",
            "maxLength":4000,
            "description":"Meter Location is used to define where the service point is located on the premise.",
            "example":"Location Details added in SP Live Data"
        },
        "measurementCycleDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Description for the service point's measurement cycle.",
            "example":"ZZT Monthly meter rd cycle - day 1 (M-D1)"
        },
        "routeDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Description for the Measurement Cycle Route.",
            "example":"MV90 Route 1"
        },
        "cycleRouteSequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Route Description",
            "example":"210"
        },
        "okToEnter":{
            "type":"boolean",
            "description":"Define OK to Enter as true if the meter is located in the interior of the premise and your company has permission to enter.",
            "example":"true"
        },
        "warningDescription":{
            "type":"string",
            "maxLength":100,
            "description":"MR Warning Description defines a specific warning that is provided to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.",
            "example":"Mean dog at premise"
        },
        "instructionDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Instruction Details provides more detailed instructions to the individual who reads meters at this premise.",
            "example":"Verify serial number"
        },
        "meterReadInstructionDetails":{
            "type":"string",
            "maxLength":250,
            "description":"MR Instruction defines specific instructions that are provided to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.",
            "example":"CON"
        },
        "keyAtPremise":{
            "type":"boolean",
            "description":"Define Key at Premise as true 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":"true"
        },
        "keyId":{
            "type":"string",
            "maxLength":10,
            "description":"Key Id defines the key identifier if Key at Premise field is enabled.",
            "example":"12345"
        },
        "hasEquipment":{
            "type":"boolean",
            "description":"Has Equipment indicates if any equipment is linked to the service point. A value of true indicates that there is equipment linked to the service point.",
            "example":"false"
        },
        "hasMultiItems":{
            "type":"boolean",
            "description":"Has Multi Items indicates a service point with multiple non-badged items. A value of true indicates that there are multiple non-badged items for the service point.",
            "example":"false"
        },
        "c2mFields":{
            "type":"object",
            "properties":{
                "mdmServicePointId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Service Point ID is a system assigned random number that stays with a service point record in Meter Data Management system.",
                    "example":"848918749582"
                },
                "estimationEligibilityDescription":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Description for Estimation Eligibility"
                },
                "mainContact":{
                    "type":"object",
                    "properties":{
                        "contactId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Person Contact"
                        },
                        "name":{
                            "type":"string",
                            "maxLength":1,
                            "description":"Person Contact"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "marketDescription":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Description for service point market.",
                    "example":"ERCOT"
                }
            }
        }
    },
    "xml":{
        "name":"C1SPSummary"
    }
}

Nested Schema : c2mFields

Type: object

Show Source

• estimationEligibilityDescription: string
  Maximum Length: 100

  Description for Estimation Eligibility
• mainContact: object mainContact
• marketDescription: string
  Maximum Length: 100

  Description for service point market.

  Example: ERCOT
• mdmServicePointId: string
  Maximum Length: 12

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

  Example: 848918749582

{
    "type":"object",
    "properties":{
        "mdmServicePointId":{
            "type":"string",
            "maxLength":12,
            "description":"Service Point ID is a system assigned random number that stays with a service point record in Meter Data Management system.",
            "example":"848918749582"
        },
        "estimationEligibilityDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Description for Estimation Eligibility"
        },
        "mainContact":{
            "type":"object",
            "properties":{
                "contactId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person Contact"
                },
                "name":{
                    "type":"string",
                    "maxLength":1,
                    "description":"Person Contact"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "marketDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Description for service point market.",
            "example":"ERCOT"
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• _link: string
  _link
• formattedAddress: string
  Maximum Length: 254

  The Premise ID is a system assigned random number that stays with a premise for life.
• lifeSupportSensitiveLoad: boolean
  The Premise ID is a system assigned random number that stays with a premise for life.
• lifeSupportSensitiveLoadDescription: string
  Maximum Length: 1000

  The Premise ID is a system assigned random number that stays with a premise for life.
• 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."
        },
        "formattedAddress":{
            "type":"string",
            "maxLength":254,
            "description":"The Premise ID is a system assigned random number that stays with a premise for life."
        },
        "lifeSupportSensitiveLoad":{
            "type":"boolean",
            "description":"The Premise ID is a system assigned random number that stays with a premise for life."
        },
        "lifeSupportSensitiveLoadDescription":{
            "type":"string",
            "maxLength":1000,
            "description":"The Premise ID is a system assigned random number that stays with a premise for life."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : servicePointType

Type: object

The Service Point Type defines the types of service points that are available. For example, G-COM is configured as "Gas Commercial" and controls the types of devices that can be installed.

Show Source

• _link: string
  _link
• category: string
  Maximum Length: 4

  The Service Point Type defines the types of service points that are available. For example, G-COM is configured as "Gas Commercial" and controls the types of devices that can be installed.

  Example: G-COM
• servicePointType: string
  Maximum Length: 30

  The Service Point Type defines the types of service points that are available. For example, G-COM is configured as "Gas Commercial" and controls the types of devices that can be installed.

  Example: G-COM
• servicePointTypeDescription: string
  Maximum Length: 150

  The Service Point Type defines the types of service points that are available. For example, G-COM is configured as "Gas Commercial" and controls the types of devices that can be installed.

  Example: G-COM
• serviceType: string
  Maximum Length: 80

  The Service Point Type defines the types of service points that are available. For example, G-COM is configured as "Gas Commercial" and controls the types of devices that can be installed.

  Example: G-COM

{
    "type":"object",
    "description":"The Service Point Type defines the types of service points that are available.  For example, G-COM is configured as \"Gas Commercial\" and controls the types of devices that can be installed.",
    "properties":{
        "servicePointType":{
            "type":"string",
            "maxLength":30,
            "description":"The Service Point Type defines the types of service points that are available.  For example, G-COM is configured as \"Gas Commercial\" and controls the types of devices that can be installed.",
            "example":"G-COM"
        },
        "servicePointTypeDescription":{
            "type":"string",
            "maxLength":150,
            "description":"The Service Point Type defines the types of service points that are available.  For example, G-COM is configured as \"Gas Commercial\" and controls the types of devices that can be installed.",
            "example":"G-COM"
        },
        "category":{
            "type":"string",
            "maxLength":4,
            "description":"The Service Point Type defines the types of service points that are available.  For example, G-COM is configured as \"Gas Commercial\" and controls the types of devices that can be installed.",
            "example":"G-COM"
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"The Service Point Type defines the types of service points that are available.  For example, G-COM is configured as \"Gas Commercial\" and controls the types of devices that can be installed.",
            "example":"G-COM"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : mainContact

Type: object

Show Source

• _link: string
  _link
• contactId: string
  Maximum Length: 10

  Person Contact
• name: string
  Maximum Length: 1

  Person Contact

{
    "type":"object",
    "properties":{
        "contactId":{
            "type":"string",
            "maxLength":10,
            "description":"Person Contact"
        },
        "name":{
            "type":"string",
            "maxLength":1,
            "description":"Person Contact"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

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