Jump to

• Request
• Response

Get Pay Segments

get

https://server:port/spl/rest/apis/customer/financials/payments/{paymentId}/paySegments

Request

Path Parameters

• paymentId(required): string
  Payment ID is the system-assigned unique identifier of the payment.

  Example:

  317896608844

Query Parameters

• limit: number
• offset: number

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

Type: object

Show Source

• _self: string
  _self
• account: object account
• hasMore: boolean
  Has More
• httpMethod: string
  Allowed Values: [ "DELT", "GET ", "POST", "PTCH", "PUT " ]

  HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put

  Example: GET
• limit: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Limit
• offset: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Offset
• payment: object payment
• paySegments: object paySegments
• totalNumberOfRecords: number
  Minimum Value: 0

  Maximum Value: 99999

  Total Number Of Records

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "httpMethod":{
            "type":"string",
            "enum":[
                "DELT",
                "GET ",
                "POST",
                "PTCH",
                "PUT "
            ],
            "description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put",
            "example":"GET"
        },
        "payment":{
            "type":"object",
            "properties":{
                "paymentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Payment ID is the system-assigned unique identifier of the payment.",
                    "example":"317896608844"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "hasMore":{
            "type":"boolean",
            "description":"Has More"
        },
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Limit"
        },
        "offset":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Offset"
        },
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Total Number Of Records"
        },
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID identifies the customer who is responsible for the bill.",
                    "example":"1112345900"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "paySegments":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "paySegment":{
                                "type":"object",
                                "properties":{
                                    "paySegmentId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Pay Segment ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "premise":{
                                "type":"object",
                                "properties":{
                                    "premiseId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Premise ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "currency":{
                                "type":"object",
                                "properties":{
                                    "currency":{
                                        "type":"string",
                                        "maxLength":3,
                                        "description":"Currency Code"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "adjustment":{
                                "type":"object",
                                "properties":{
                                    "adjustmentId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Adjustment ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "matchEvent":{
                                "type":"object",
                                "properties":{
                                    "matchEventId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Match Event ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "financialTransaction":{
                                "type":"object",
                                "properties":{
                                    "financialTransactionId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Financial Transaction ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "paySegmentAmount":{
                                "type":"number",
                                "description":"Distributed Amount is the amount of the service agreement's debt relieved by the payment.",
                                "example":"25.08"
                            },
                            "serviceAgreement":{
                                "type":"object",
                                "properties":{
                                    "serviceAgreementId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Service Agreement"
                                    },
                                    "serviceType":{
                                        "type":"string",
                                        "maxLength":80,
                                        "description":"Service Type"
                                    },
                                    "serviceAgreementTypeDescription":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"SA Type Description"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1GetPaySegm"
    }
}

Nested Schema : account

Type: object

Show Source

• _link: string
  _link
• accountId: string
  Maximum Length: 10

  Account ID identifies the customer who is responsible for the bill.

  Example: 1112345900

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID identifies the customer who is responsible for the bill.",
            "example":"1112345900"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : payment

Type: object

Show Source

• _link: string
  _link
• paymentId: string
  Maximum Length: 12

  Payment ID is the system-assigned unique identifier of the payment.

  Example: 317896608844

{
    "type":"object",
    "properties":{
        "paymentId":{
            "type":"string",
            "maxLength":12,
            "description":"Payment ID is the system-assigned unique identifier of the payment.",
            "example":"317896608844"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : paySegments

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "paySegment":{
                        "type":"object",
                        "properties":{
                            "paySegmentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Pay Segment ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "premise":{
                        "type":"object",
                        "properties":{
                            "premiseId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Premise ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "currency":{
                        "type":"object",
                        "properties":{
                            "currency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Currency Code"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "adjustment":{
                        "type":"object",
                        "properties":{
                            "adjustmentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Adjustment ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "matchEvent":{
                        "type":"object",
                        "properties":{
                            "matchEventId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Match Event ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "financialTransaction":{
                        "type":"object",
                        "properties":{
                            "financialTransactionId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Financial Transaction ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "paySegmentAmount":{
                        "type":"number",
                        "description":"Distributed Amount is the amount of the service agreement's debt relieved by the payment.",
                        "example":"25.08"
                    },
                    "serviceAgreement":{
                        "type":"object",
                        "properties":{
                            "serviceAgreementId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Agreement"
                            },
                            "serviceType":{
                                "type":"string",
                                "maxLength":80,
                                "description":"Service Type"
                            },
                            "serviceAgreementTypeDescription":{
                                "type":"string",
                                "maxLength":30,
                                "description":"SA Type Description"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "paySegment":{
                "type":"object",
                "properties":{
                    "paySegmentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Pay Segment ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "premise":{
                "type":"object",
                "properties":{
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "currency":{
                "type":"object",
                "properties":{
                    "currency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "adjustment":{
                "type":"object",
                "properties":{
                    "adjustmentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Adjustment ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "matchEvent":{
                "type":"object",
                "properties":{
                    "matchEventId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Match Event ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "financialTransaction":{
                "type":"object",
                "properties":{
                    "financialTransactionId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Financial Transaction ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "paySegmentAmount":{
                "type":"number",
                "description":"Distributed Amount is the amount of the service agreement's debt relieved by the payment.",
                "example":"25.08"
            },
            "serviceAgreement":{
                "type":"object",
                "properties":{
                    "serviceAgreementId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Agreement"
                    },
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type"
                    },
                    "serviceAgreementTypeDescription":{
                        "type":"string",
                        "maxLength":30,
                        "description":"SA Type Description"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• adjustment: object adjustment
• currency: object currency
• financialTransaction: object financialTransaction
• matchEvent: object matchEvent
• paySegment: object paySegment
• paySegmentAmount: number
  Distributed Amount is the amount of the service agreement's debt relieved by the payment.

  Example: 25.08
• premise: object premise
• serviceAgreement: object serviceAgreement

{
    "type":"object",
    "properties":{
        "paySegment":{
            "type":"object",
            "properties":{
                "paySegmentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Pay Segment ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "currency":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "adjustment":{
            "type":"object",
            "properties":{
                "adjustmentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Adjustment ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "matchEvent":{
            "type":"object",
            "properties":{
                "matchEventId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Match Event ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "financialTransaction":{
            "type":"object",
            "properties":{
                "financialTransactionId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Financial Transaction ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "paySegmentAmount":{
            "type":"number",
            "description":"Distributed Amount is the amount of the service agreement's debt relieved by the payment.",
            "example":"25.08"
        },
        "serviceAgreement":{
            "type":"object",
            "properties":{
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                },
                "serviceType":{
                    "type":"string",
                    "maxLength":80,
                    "description":"Service Type"
                },
                "serviceAgreementTypeDescription":{
                    "type":"string",
                    "maxLength":30,
                    "description":"SA Type Description"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        }
    }
}

Nested Schema : adjustment

Type: object

Show Source

• _link: string
  _link
• adjustmentId: string
  Maximum Length: 12

  Adjustment ID

{
    "type":"object",
    "properties":{
        "adjustmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Adjustment ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : currency

Type: object

Show Source

• _link: string
  _link
• currency: string
  Maximum Length: 3

  Currency Code

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : financialTransaction

Type: object

Show Source

• _link: string
  _link
• financialTransactionId: string
  Maximum Length: 12

  Financial Transaction ID

{
    "type":"object",
    "properties":{
        "financialTransactionId":{
            "type":"string",
            "maxLength":12,
            "description":"Financial Transaction ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : matchEvent

Type: object

Show Source

• _link: string
  _link
• matchEventId: string
  Maximum Length: 12

  Match Event ID

{
    "type":"object",
    "properties":{
        "matchEventId":{
            "type":"string",
            "maxLength":12,
            "description":"Match Event ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : paySegment

Type: object

Show Source

• _link: string
  _link
• paySegmentId: string
  Maximum Length: 12

  Pay Segment ID

{
    "type":"object",
    "properties":{
        "paySegmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Pay Segment ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : premise

Type: object

Show Source

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

  Premise ID

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Show Source

• _link: string
  _link
• serviceAgreementId: string
  Maximum Length: 10

  Service Agreement
• serviceAgreementTypeDescription: string
  Maximum Length: 30

  SA Type Description
• serviceType: string
  Maximum Length: 80

  Service Type

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type"
        },
        "serviceAgreementTypeDescription":{
            "type":"string",
            "maxLength":30,
            "description":"SA Type Description"
        },
        "_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