Jump to

• Request
• Response

Retrieve Services To Stop

post

/rest/apis/customer/service/startStopTransferTasks/stoppableServiceDetails

This operation retrieves the premises with stoppable service that were previously determined and persisted on the self-service start/stop/transfer task.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• pageLimit: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Maximum number of premises displayed at a time in the self-service application.

  Example: 10
• pageOffset: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Offset from the first set of premises returned.

  Example: 2
• serviceTaskId: string
  Maximum Length: 14

  Self-Service Task ID is the system-assigned unique identifier of the self-service task.

  Example: 69216126491457

{
    "type":"object",
    "properties":{
        "serviceTaskId":{
            "type":"string",
            "maxLength":14,
            "description":"Self-Service Task ID is the system-assigned unique identifier of the self-service task.",
            "example":"69216126491457"
        },
        "pageOffset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Offset from the first set of premises returned.",
            "example":"2"
        },
        "pageLimit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Maximum number of premises displayed at a time in the self-service application.",
            "example":"10"
        }
    },
    "xml":{
        "name":"C1SSStpSvcsD"
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• pageLimit: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Maximum number of premises displayed at a time in the self-service application.

  Example: 10
• pageOffset: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Offset from the first set of premises returned.

  Example: 2
• serviceTaskId: string
  Maximum Length: 14

  Self-Service Task ID is the system-assigned unique identifier of the self-service task.

  Example: 69216126491457

{
    "type":"object",
    "properties":{
        "serviceTaskId":{
            "type":"string",
            "maxLength":14,
            "description":"Self-Service Task ID is the system-assigned unique identifier of the self-service task.",
            "example":"69216126491457"
        },
        "pageOffset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Offset from the first set of premises returned.",
            "example":"2"
        },
        "pageLimit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Maximum number of premises displayed at a time in the self-service application.",
            "example":"10"
        }
    },
    "xml":{
        "name":"C1SSStpSvcsD"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1SSStpSvcsD

Type: object

Show Source

• premisesToStop: object premisesToStop

{
    "type":"object",
    "properties":{
        "premisesToStop":{
            "type":"object",
            "properties":{
                "premiseToStop":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "premiseId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Premise ID"
                            },
                            "country":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Country"
                            },
                            "addressLine1":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address"
                            },
                            "addressLine2":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address 2"
                            },
                            "addressLine3":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address 3"
                            },
                            "addressLine4":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address 4"
                            },
                            "houseType":{
                                "type":"string",
                                "enum":[
                                    "AB  ",
                                    "WW  "
                                ],
                                "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                            },
                            "number1":{
                                "type":"string",
                                "maxLength":6,
                                "description":"Number 1"
                            },
                            "number2":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Number 2"
                            },
                            "inCityLimit":{
                                "type":"boolean",
                                "description":"In City Limit"
                            },
                            "city":{
                                "type":"string",
                                "maxLength":90,
                                "description":"City"
                            },
                            "geographic":{
                                "type":"string",
                                "maxLength":11,
                                "description":"Geographical Code"
                            },
                            "county":{
                                "type":"string",
                                "maxLength":90,
                                "description":"County"
                            },
                            "state":{
                                "type":"string",
                                "maxLength":6,
                                "description":"State"
                            },
                            "postal":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Postal"
                            },
                            "sasToStop":{
                                "type":"object",
                                "properties":{
                                    "saToStop":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "serviceAgreementId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Service Agreement"
                                                },
                                                "serviceType":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Service Type defines the type of service associated with the SA type.",
                                                    "example":"E"
                                                },
                                                "serviceTypeDescription":{
                                                    "type":"string",
                                                    "maxLength":60,
                                                    "description":"Description"
                                                },
                                                "meters":{
                                                    "type":"object",
                                                    "properties":{
                                                        "meter":{
                                                            "type":"array",
                                                            "items":{
                                                                "type":"object",
                                                                "properties":{
                                                                    "badgeNumber":{
                                                                        "type":"string",
                                                                        "maxLength":30,
                                                                        "description":"Badge Number is the identifier stamped on the meter.",
                                                                        "example":"ER-SM-1360"
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1SSStpSvcsD"
    }
}

Nested Schema : premisesToStop

Type: object

Show Source

• premiseToStop: array premiseToStop

{
    "type":"object",
    "properties":{
        "premiseToStop":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID"
                    },
                    "country":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Country"
                    },
                    "addressLine1":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address"
                    },
                    "addressLine2":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address 2"
                    },
                    "addressLine3":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address 3"
                    },
                    "addressLine4":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address 4"
                    },
                    "houseType":{
                        "type":"string",
                        "enum":[
                            "AB  ",
                            "WW  "
                        ],
                        "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                    },
                    "number1":{
                        "type":"string",
                        "maxLength":6,
                        "description":"Number 1"
                    },
                    "number2":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Number 2"
                    },
                    "inCityLimit":{
                        "type":"boolean",
                        "description":"In City Limit"
                    },
                    "city":{
                        "type":"string",
                        "maxLength":90,
                        "description":"City"
                    },
                    "geographic":{
                        "type":"string",
                        "maxLength":11,
                        "description":"Geographical Code"
                    },
                    "county":{
                        "type":"string",
                        "maxLength":90,
                        "description":"County"
                    },
                    "state":{
                        "type":"string",
                        "maxLength":6,
                        "description":"State"
                    },
                    "postal":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Postal"
                    },
                    "sasToStop":{
                        "type":"object",
                        "properties":{
                            "saToStop":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "serviceAgreementId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Service Agreement"
                                        },
                                        "serviceType":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Service Type defines the type of service associated with the SA type.",
                                            "example":"E"
                                        },
                                        "serviceTypeDescription":{
                                            "type":"string",
                                            "maxLength":60,
                                            "description":"Description"
                                        },
                                        "meters":{
                                            "type":"object",
                                            "properties":{
                                                "meter":{
                                                    "type":"array",
                                                    "items":{
                                                        "type":"object",
                                                        "properties":{
                                                            "badgeNumber":{
                                                                "type":"string",
                                                                "maxLength":30,
                                                                "description":"Badge Number is the identifier stamped on the meter.",
                                                                "example":"ER-SM-1360"
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : premiseToStop

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "premiseId":{
                "type":"string",
                "maxLength":10,
                "description":"Premise ID"
            },
            "country":{
                "type":"string",
                "maxLength":3,
                "description":"Country"
            },
            "addressLine1":{
                "type":"string",
                "maxLength":254,
                "description":"Address"
            },
            "addressLine2":{
                "type":"string",
                "maxLength":254,
                "description":"Address 2"
            },
            "addressLine3":{
                "type":"string",
                "maxLength":254,
                "description":"Address 3"
            },
            "addressLine4":{
                "type":"string",
                "maxLength":254,
                "description":"Address 4"
            },
            "houseType":{
                "type":"string",
                "enum":[
                    "AB  ",
                    "WW  "
                ],
                "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
            },
            "number1":{
                "type":"string",
                "maxLength":6,
                "description":"Number 1"
            },
            "number2":{
                "type":"string",
                "maxLength":4,
                "description":"Number 2"
            },
            "inCityLimit":{
                "type":"boolean",
                "description":"In City Limit"
            },
            "city":{
                "type":"string",
                "maxLength":90,
                "description":"City"
            },
            "geographic":{
                "type":"string",
                "maxLength":11,
                "description":"Geographical Code"
            },
            "county":{
                "type":"string",
                "maxLength":90,
                "description":"County"
            },
            "state":{
                "type":"string",
                "maxLength":6,
                "description":"State"
            },
            "postal":{
                "type":"string",
                "maxLength":12,
                "description":"Postal"
            },
            "sasToStop":{
                "type":"object",
                "properties":{
                    "saToStop":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "serviceAgreementId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Service Agreement"
                                },
                                "serviceType":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Service Type defines the type of service associated with the SA type.",
                                    "example":"E"
                                },
                                "serviceTypeDescription":{
                                    "type":"string",
                                    "maxLength":60,
                                    "description":"Description"
                                },
                                "meters":{
                                    "type":"object",
                                    "properties":{
                                        "meter":{
                                            "type":"array",
                                            "items":{
                                                "type":"object",
                                                "properties":{
                                                    "badgeNumber":{
                                                        "type":"string",
                                                        "maxLength":30,
                                                        "description":"Badge Number is the identifier stamped on the meter.",
                                                        "example":"ER-SM-1360"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• addressLine1: string
  Maximum Length: 254

  Address
• addressLine2: string
  Maximum Length: 254

  Address 2
• addressLine3: string
  Maximum Length: 254

  Address 3
• addressLine4: string
  Maximum Length: 254

  Address 4
• city: string
  Maximum Length: 90

  City
• country: string
  Maximum Length: 3

  Country
• county: string
  Maximum Length: 90

  County
• geographic: string
  Maximum Length: 11

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

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

  Number 1
• number2: string
  Maximum Length: 4

  Number 2
• postal: string
  Maximum Length: 12

  Postal
• premiseId: string
  Maximum Length: 10

  Premise ID
• sasToStop: object sasToStop
• state: string
  Maximum Length: 6

  State

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID"
        },
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"Country"
        },
        "addressLine1":{
            "type":"string",
            "maxLength":254,
            "description":"Address"
        },
        "addressLine2":{
            "type":"string",
            "maxLength":254,
            "description":"Address 2"
        },
        "addressLine3":{
            "type":"string",
            "maxLength":254,
            "description":"Address 3"
        },
        "addressLine4":{
            "type":"string",
            "maxLength":254,
            "description":"Address 4"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "number1":{
            "type":"string",
            "maxLength":6,
            "description":"Number 1"
        },
        "number2":{
            "type":"string",
            "maxLength":4,
            "description":"Number 2"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"City"
        },
        "geographic":{
            "type":"string",
            "maxLength":11,
            "description":"Geographical Code"
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"County"
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"State"
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"Postal"
        },
        "sasToStop":{
            "type":"object",
            "properties":{
                "saToStop":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "serviceAgreementId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Agreement"
                            },
                            "serviceType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Service Type defines the type of service associated with the SA type.",
                                "example":"E"
                            },
                            "serviceTypeDescription":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Description"
                            },
                            "meters":{
                                "type":"object",
                                "properties":{
                                    "meter":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "badgeNumber":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Badge Number is the identifier stamped on the meter.",
                                                    "example":"ER-SM-1360"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : sasToStop

Type: object

Show Source

• saToStop: array saToStop

{
    "type":"object",
    "properties":{
        "saToStop":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceAgreementId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Agreement"
                    },
                    "serviceType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Service Type defines the type of service associated with the SA type.",
                        "example":"E"
                    },
                    "serviceTypeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    },
                    "meters":{
                        "type":"object",
                        "properties":{
                            "meter":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "badgeNumber":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Badge Number is the identifier stamped on the meter.",
                                            "example":"ER-SM-1360"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : saToStop

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceAgreementId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Agreement"
            },
            "serviceType":{
                "type":"string",
                "maxLength":30,
                "description":"Service Type defines the type of service associated with the SA type.",
                "example":"E"
            },
            "serviceTypeDescription":{
                "type":"string",
                "maxLength":60,
                "description":"Description"
            },
            "meters":{
                "type":"object",
                "properties":{
                    "meter":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "badgeNumber":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Badge Number is the identifier stamped on the meter.",
                                    "example":"ER-SM-1360"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• meters: object meters
• serviceAgreementId: string
  Maximum Length: 10

  Service Agreement
• serviceType: string
  Maximum Length: 30

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

  Example: E
• serviceTypeDescription: string
  Maximum Length: 60

  Description

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        },
        "serviceType":{
            "type":"string",
            "maxLength":30,
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        },
        "serviceTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "meters":{
            "type":"object",
            "properties":{
                "meter":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "badgeNumber":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Badge Number is the identifier stamped on the meter.",
                                "example":"ER-SM-1360"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : meters

Type: object

Show Source

• meter: array meter

{
    "type":"object",
    "properties":{
        "meter":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "badgeNumber":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Badge Number is the identifier stamped on the meter.",
                        "example":"ER-SM-1360"
                    }
                }
            }
        }
    }
}

Nested Schema : meter

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "badgeNumber":{
                "type":"string",
                "maxLength":30,
                "description":"Badge Number is the identifier stamped on the meter.",
                "example":"ER-SM-1360"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• badgeNumber: string
  Maximum Length: 30

  Badge Number is the identifier stamped on the meter.

  Example: ER-SM-1360

{
    "type":"object",
    "properties":{
        "badgeNumber":{
            "type":"string",
            "maxLength":30,
            "description":"Badge Number is the identifier stamped on the meter.",
            "example":"ER-SM-1360"
        }
    }
}

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