Jump to

• Request
• Response

Search Service Agreement

post

/rest/apis/customer/v-model/serviceAgreements/search

The operation retrieves service agreements with premise information based on search criteria.

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

• filters: object filters
• limit: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Limit

  Example: 2
• offset: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Offset

  Example: 2

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement (and its debt) to the new account.",
                    "example":"1589809012"
                },
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                    "example":"7735910061"
                },
                "servicePointId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Point ID The identity of the service point. The type and location of the service point is displayed adjacent."
                },
                "serviceType":{
                    "type":"string",
                    "maxLength":80,
                    "description":"Service Type defines the type of service associated with the SA type.",
                    "example":"E"
                },
                "timeframeDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Date filter field which is used only with active flag values of N & C. This date represents the earliest date of interest for inactive contracts."
                },
                "active":{
                    "type":"string",
                    "enum":[
                        "C   ",
                        "N   ",
                        "Y   "
                    ],
                    "description":"Status of Service Agreement with values as\n\n    C - Closed Only\n    N - All\n    Y - Active\n* `C   ` - Closed Only,\n* `N   ` - All,\n* `Y   ` - Active"
                },
                "includeLatLong":{
                    "type":"string",
                    "enum":[
                        "N   ",
                        "Y   "
                    ],
                    "description":"Flag for Premise LatLong Geo Type\n* `N   ` - No,\n* `Y   ` - Yes",
                    "example":"Y"
                }
            }
        },
        "limit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Page Limit",
            "example":"2"
        },
        "offset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Page Offset",
            "example":"2"
        }
    },
    "xml":{
        "name":"C1SASearhSer"
    }
}

Nested Schema : filters

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement (and its debt) to the new account.

  Example: 1589809012
• active: string
  Allowed Values: [ "C ", "N ", "Y " ]

  Status of Service Agreement with values as C - Closed Only N - All Y - Active * `C ` - Closed Only, * `N ` - All, * `Y ` - Active
• includeLatLong: string
  Allowed Values: [ "N ", "Y " ]

  Flag for Premise LatLong Geo Type * `N ` - No, * `Y ` - Yes

  Example: Y
• premiseId: string
  Maximum Length: 10

  Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.

  Example: 7735910061
• servicePointId: string
  Maximum Length: 10

  Service Point ID The identity of the service point. The type and location of the service point is displayed adjacent.
• serviceType: string
  Maximum Length: 80

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

  Example: E
• timeframeDate: string (date)
  Date filter field which is used only with active flag values of N & C. This date represents the earliest date of interest for inactive contracts.

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement (and its debt) to the new account.",
            "example":"1589809012"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
            "example":"7735910061"
        },
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID The identity of the service point. The type and location of the service point is displayed adjacent."
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        },
        "timeframeDate":{
            "type":"string",
            "format":"date",
            "description":"Date filter field which is used only with active flag values of N & C. This date represents the earliest date of interest for inactive contracts."
        },
        "active":{
            "type":"string",
            "enum":[
                "C   ",
                "N   ",
                "Y   "
            ],
            "description":"Status of Service Agreement with values as\n\n    C - Closed Only\n    N - All\n    Y - Active\n* `C   ` - Closed Only,\n* `N   ` - All,\n* `Y   ` - Active"
        },
        "includeLatLong":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"Flag for Premise LatLong Geo Type\n* `N   ` - No,\n* `Y   ` - Yes",
            "example":"Y"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• filters: object filters
• limit: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Limit

  Example: 2
• offset: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Offset

  Example: 2

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement (and its debt) to the new account.",
                    "example":"1589809012"
                },
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                    "example":"7735910061"
                },
                "servicePointId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Point ID The identity of the service point. The type and location of the service point is displayed adjacent."
                },
                "serviceType":{
                    "type":"string",
                    "maxLength":80,
                    "description":"Service Type defines the type of service associated with the SA type.",
                    "example":"E"
                },
                "timeframeDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Date filter field which is used only with active flag values of N & C. This date represents the earliest date of interest for inactive contracts."
                },
                "active":{
                    "type":"string",
                    "enum":[
                        "C   ",
                        "N   ",
                        "Y   "
                    ],
                    "description":"Status of Service Agreement with values as\n\n    C - Closed Only\n    N - All\n    Y - Active\n* `C   ` - Closed Only,\n* `N   ` - All,\n* `Y   ` - Active"
                },
                "includeLatLong":{
                    "type":"string",
                    "enum":[
                        "N   ",
                        "Y   "
                    ],
                    "description":"Flag for Premise LatLong Geo Type\n* `N   ` - No,\n* `Y   ` - Yes",
                    "example":"Y"
                }
            }
        },
        "limit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Page Limit",
            "example":"2"
        },
        "offset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Page Offset",
            "example":"2"
        }
    },
    "xml":{
        "name":"C1SASearhSer"
    }
}

Nested Schema : filters

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement (and its debt) to the new account.

  Example: 1589809012
• active: string
  Allowed Values: [ "C ", "N ", "Y " ]

  Status of Service Agreement with values as C - Closed Only N - All Y - Active * `C ` - Closed Only, * `N ` - All, * `Y ` - Active
• includeLatLong: string
  Allowed Values: [ "N ", "Y " ]

  Flag for Premise LatLong Geo Type * `N ` - No, * `Y ` - Yes

  Example: Y
• premiseId: string
  Maximum Length: 10

  Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.

  Example: 7735910061
• servicePointId: string
  Maximum Length: 10

  Service Point ID The identity of the service point. The type and location of the service point is displayed adjacent.
• serviceType: string
  Maximum Length: 80

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

  Example: E
• timeframeDate: string (date)
  Date filter field which is used only with active flag values of N & C. This date represents the earliest date of interest for inactive contracts.

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement (and its debt) to the new account.",
            "example":"1589809012"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
            "example":"7735910061"
        },
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID The identity of the service point. The type and location of the service point is displayed adjacent."
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        },
        "timeframeDate":{
            "type":"string",
            "format":"date",
            "description":"Date filter field which is used only with active flag values of N & C. This date represents the earliest date of interest for inactive contracts."
        },
        "active":{
            "type":"string",
            "enum":[
                "C   ",
                "N   ",
                "Y   "
            ],
            "description":"Status of Service Agreement with values as\n\n    C - Closed Only\n    N - All\n    Y - Active\n* `C   ` - Closed Only,\n* `N   ` - All,\n* `Y   ` - Active"
        },
        "includeLatLong":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"Flag for Premise LatLong Geo Type\n* `N   ` - No,\n* `Y   ` - Yes",
            "example":"Y"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1SASearhSer

Type: object

Show Source

• limit: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Limit

  Example: 2
• offset: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Offset

  Example: 2
• serviceAgreements: array serviceAgreements
• totalNumberOfRecords: number
  Minimum Value: 0

  Maximum Value: 99999

  Total number of records

  Example: 4

{
    "type":"object",
    "properties":{
        "limit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Page Limit",
            "example":"2"
        },
        "offset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Page Offset",
            "example":"2"
        },
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Total number of records",
            "example":"4"
        },
        "serviceAgreements":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceAgreementDetails":{
                        "type":"object",
                        "properties":{
                            "serviceAgreement":{
                                "type":"object",
                                "properties":{
                                    "serviceAgreementId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"The Service Agreement ID is a system assigned random number that stays with a service agreement for life."
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "account":{
                                "type":"object",
                                "properties":{
                                    "accountId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Account ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "startDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The Start Date defines when the financial relationship begins."
                            },
                            "endDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The End Date defines when the financial relationship terminates.",
                                "example":"2018-02-25"
                            },
                            "cisDivision":{
                                "type":"string",
                                "maxLength":5,
                                "description":"The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.",
                                "example":"Ohio"
                            },
                            "cisDivisionDescription":{
                                "type":"string",
                                "maxLength":1,
                                "description":"Description for CIS Division. CIS Division defines the jurisdiction that governs the account.",
                                "example":"California"
                            },
                            "saType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"SATYPE is Service Agreement Type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                                "example":"CHARITY (Ohio / Charitable contribution)"
                            },
                            "saTypeDescription":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Description for  Service Agreement Type",
                                "example":"Electric commercial"
                            },
                            "serviceType":{
                                "type":"string",
                                "maxLength":80,
                                "description":"Service Type defines the type of service associated with the SA type.",
                                "example":"E"
                            },
                            "saStatus":{
                                "type":"string",
                                "enum":[
                                    "05  ",
                                    "10  ",
                                    "20  ",
                                    "30  ",
                                    "40  ",
                                    "50  ",
                                    "60  ",
                                    "70  "
                                ],
                                "description":"SA Status defines the state of the service agreement.\n* `05  ` - Incomplete,\n* `10  ` - Pending Start,\n* `20  ` - Active,\n* `30  ` - Pending Stop,\n* `40  ` - Stopped,\n* `50  ` - Reactivated,\n* `60  ` - Closed,\n* `70  ` - Canceled",
                                "example":"20"
                            },
                            "saStatusDescription":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Description for SA Status",
                                "example":"Canceled"
                            },
                            "isActive":{
                                "type":"boolean",
                                "description":"IsActive flag to show active SAs for account",
                                "example":"false"
                            }
                        }
                    },
                    "premiseDetails":{
                        "type":"object",
                        "properties":{
                            "premise":{
                                "type":"object",
                                "properties":{
                                    "premiseId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                                        "example":"7735910061"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "address1":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Premise Address",
                                "example":"22 Northwood Road"
                            },
                            "premiseAddress":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Premise Info",
                                "example":"22 Northwood Road, San Francisco, CA, 94105"
                            },
                            "premiseLatitude":{
                                "type":"number",
                                "maximum":"999999999.999999",
                                "minimum":0,
                                "description":"Premise Latitude",
                                "example":"72"
                            },
                            "premiseLongitude":{
                                "type":"number",
                                "maximum":"999999999.999999",
                                "minimum":0,
                                "description":"Premise Longitude",
                                "example":"141"
                            }
                        }
                    },
                    "effectiveRateSchedule":{
                        "type":"object",
                        "properties":{
                            "rateSchedule":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Rate Schedule defines the rate used to calculate the service agreement's bill segments. Note, you can only choose rates defined as permissible on the service agreement's SA type."
                            },
                            "rateScheduleDescription":{
                                "type":"string",
                                "maxLength":60,
                                "description":"A short description for the rate schedule.",
                                "example":"Electric Residential Plan 1"
                            },
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.",
                                "example":"2018-02-25"
                            }
                        }
                    },
                    "servicePoints":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "servicePoint":{
                                    "type":"object",
                                    "properties":{
                                        "servicePointId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Service Point ID The identity of the service point. The type and location of the service point is displayed adjacent."
                                        },
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        }
                                    }
                                },
                                "howToUseDescription":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Short description for values on how billing uses the consumption associated with the service point. Valid values are: Add, Check, Subtract.  This is not applicable for item-type service points.",
                                    "example":"Add"
                                },
                                "premise":{
                                    "type":"object",
                                    "properties":{
                                        "premiseId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                                            "example":"7735910061"
                                        },
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1SASearhSer"
    }
}

Nested Schema : serviceAgreements

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceAgreementDetails":{
                "type":"object",
                "properties":{
                    "serviceAgreement":{
                        "type":"object",
                        "properties":{
                            "serviceAgreementId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"The Service Agreement ID is a system assigned random number that stays with a service agreement for life."
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "account":{
                        "type":"object",
                        "properties":{
                            "accountId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Account ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "startDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The Start Date defines when the financial relationship begins."
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The End Date defines when the financial relationship terminates.",
                        "example":"2018-02-25"
                    },
                    "cisDivision":{
                        "type":"string",
                        "maxLength":5,
                        "description":"The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.",
                        "example":"Ohio"
                    },
                    "cisDivisionDescription":{
                        "type":"string",
                        "maxLength":1,
                        "description":"Description for CIS Division. CIS Division defines the jurisdiction that governs the account.",
                        "example":"California"
                    },
                    "saType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"SATYPE is Service Agreement Type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                        "example":"CHARITY (Ohio / Charitable contribution)"
                    },
                    "saTypeDescription":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Description for  Service Agreement Type",
                        "example":"Electric commercial"
                    },
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type defines the type of service associated with the SA type.",
                        "example":"E"
                    },
                    "saStatus":{
                        "type":"string",
                        "enum":[
                            "05  ",
                            "10  ",
                            "20  ",
                            "30  ",
                            "40  ",
                            "50  ",
                            "60  ",
                            "70  "
                        ],
                        "description":"SA Status defines the state of the service agreement.\n* `05  ` - Incomplete,\n* `10  ` - Pending Start,\n* `20  ` - Active,\n* `30  ` - Pending Stop,\n* `40  ` - Stopped,\n* `50  ` - Reactivated,\n* `60  ` - Closed,\n* `70  ` - Canceled",
                        "example":"20"
                    },
                    "saStatusDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description for SA Status",
                        "example":"Canceled"
                    },
                    "isActive":{
                        "type":"boolean",
                        "description":"IsActive flag to show active SAs for account",
                        "example":"false"
                    }
                }
            },
            "premiseDetails":{
                "type":"object",
                "properties":{
                    "premise":{
                        "type":"object",
                        "properties":{
                            "premiseId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                                "example":"7735910061"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "address1":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Premise Address",
                        "example":"22 Northwood Road"
                    },
                    "premiseAddress":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Premise Info",
                        "example":"22 Northwood Road, San Francisco, CA, 94105"
                    },
                    "premiseLatitude":{
                        "type":"number",
                        "maximum":"999999999.999999",
                        "minimum":0,
                        "description":"Premise Latitude",
                        "example":"72"
                    },
                    "premiseLongitude":{
                        "type":"number",
                        "maximum":"999999999.999999",
                        "minimum":0,
                        "description":"Premise Longitude",
                        "example":"141"
                    }
                }
            },
            "effectiveRateSchedule":{
                "type":"object",
                "properties":{
                    "rateSchedule":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Rate Schedule defines the rate used to calculate the service agreement's bill segments. Note, you can only choose rates defined as permissible on the service agreement's SA type."
                    },
                    "rateScheduleDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"A short description for the rate schedule.",
                        "example":"Electric Residential Plan 1"
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.",
                        "example":"2018-02-25"
                    }
                }
            },
            "servicePoints":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "servicePoint":{
                            "type":"object",
                            "properties":{
                                "servicePointId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Service Point ID The identity of the service point. The type and location of the service point is displayed adjacent."
                                },
                                "_link":{
                                    "type":"string",
                                    "description":"_link"
                                }
                            }
                        },
                        "howToUseDescription":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Short description for values on how billing uses the consumption associated with the service point. Valid values are: Add, Check, Subtract.  This is not applicable for item-type service points.",
                            "example":"Add"
                        },
                        "premise":{
                            "type":"object",
                            "properties":{
                                "premiseId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                                    "example":"7735910061"
                                },
                                "_link":{
                                    "type":"string",
                                    "description":"_link"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• effectiveRateSchedule: object effectiveRateSchedule
• premiseDetails: object premiseDetails
• serviceAgreementDetails: object serviceAgreementDetails
• servicePoints: array servicePoints

{
    "type":"object",
    "properties":{
        "serviceAgreementDetails":{
            "type":"object",
            "properties":{
                "serviceAgreement":{
                    "type":"object",
                    "properties":{
                        "serviceAgreementId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"The Service Agreement ID is a system assigned random number that stays with a service agreement for life."
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "account":{
                    "type":"object",
                    "properties":{
                        "accountId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Account ID"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "startDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The Start Date defines when the financial relationship begins."
                },
                "endDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The End Date defines when the financial relationship terminates.",
                    "example":"2018-02-25"
                },
                "cisDivision":{
                    "type":"string",
                    "maxLength":5,
                    "description":"The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.",
                    "example":"Ohio"
                },
                "cisDivisionDescription":{
                    "type":"string",
                    "maxLength":1,
                    "description":"Description for CIS Division. CIS Division defines the jurisdiction that governs the account.",
                    "example":"California"
                },
                "saType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"SATYPE is Service Agreement Type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                    "example":"CHARITY (Ohio / Charitable contribution)"
                },
                "saTypeDescription":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Description for  Service Agreement Type",
                    "example":"Electric commercial"
                },
                "serviceType":{
                    "type":"string",
                    "maxLength":80,
                    "description":"Service Type defines the type of service associated with the SA type.",
                    "example":"E"
                },
                "saStatus":{
                    "type":"string",
                    "enum":[
                        "05  ",
                        "10  ",
                        "20  ",
                        "30  ",
                        "40  ",
                        "50  ",
                        "60  ",
                        "70  "
                    ],
                    "description":"SA Status defines the state of the service agreement.\n* `05  ` - Incomplete,\n* `10  ` - Pending Start,\n* `20  ` - Active,\n* `30  ` - Pending Stop,\n* `40  ` - Stopped,\n* `50  ` - Reactivated,\n* `60  ` - Closed,\n* `70  ` - Canceled",
                    "example":"20"
                },
                "saStatusDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description for SA Status",
                    "example":"Canceled"
                },
                "isActive":{
                    "type":"boolean",
                    "description":"IsActive flag to show active SAs for account",
                    "example":"false"
                }
            }
        },
        "premiseDetails":{
            "type":"object",
            "properties":{
                "premise":{
                    "type":"object",
                    "properties":{
                        "premiseId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                            "example":"7735910061"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Premise Address",
                    "example":"22 Northwood Road"
                },
                "premiseAddress":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Premise Info",
                    "example":"22 Northwood Road, San Francisco, CA, 94105"
                },
                "premiseLatitude":{
                    "type":"number",
                    "maximum":"999999999.999999",
                    "minimum":0,
                    "description":"Premise Latitude",
                    "example":"72"
                },
                "premiseLongitude":{
                    "type":"number",
                    "maximum":"999999999.999999",
                    "minimum":0,
                    "description":"Premise Longitude",
                    "example":"141"
                }
            }
        },
        "effectiveRateSchedule":{
            "type":"object",
            "properties":{
                "rateSchedule":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Rate Schedule defines the rate used to calculate the service agreement's bill segments. Note, you can only choose rates defined as permissible on the service agreement's SA type."
                },
                "rateScheduleDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"A short description for the rate schedule.",
                    "example":"Electric Residential Plan 1"
                },
                "effectiveDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.",
                    "example":"2018-02-25"
                }
            }
        },
        "servicePoints":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "servicePoint":{
                        "type":"object",
                        "properties":{
                            "servicePointId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Point ID The identity of the service point. The type and location of the service point is displayed adjacent."
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "howToUseDescription":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Short description for values on how billing uses the consumption associated with the service point. Valid values are: Add, Check, Subtract.  This is not applicable for item-type service points.",
                        "example":"Add"
                    },
                    "premise":{
                        "type":"object",
                        "properties":{
                            "premiseId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                                "example":"7735910061"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : effectiveRateSchedule

Type: object

Show Source

• effectiveDate: string (date)
  Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.

  Example: 2018-02-25
• rateSchedule: string
  Maximum Length: 8

  Rate Schedule defines the rate used to calculate the service agreement's bill segments. Note, you can only choose rates defined as permissible on the service agreement's SA type.
• rateScheduleDescription: string
  Maximum Length: 60

  A short description for the rate schedule.

  Example: Electric Residential Plan 1

{
    "type":"object",
    "properties":{
        "rateSchedule":{
            "type":"string",
            "maxLength":8,
            "description":"Rate Schedule defines the rate used to calculate the service agreement's bill segments. Note, you can only choose rates defined as permissible on the service agreement's SA type."
        },
        "rateScheduleDescription":{
            "type":"string",
            "maxLength":60,
            "description":"A short description for the rate schedule.",
            "example":"Electric Residential Plan 1"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.",
            "example":"2018-02-25"
        }
    }
}

Nested Schema : premiseDetails

Type: object

Show Source

• address1: string
  Maximum Length: 254

  Premise Address

  Example: 22 Northwood Road
• premise: object premise
• premiseAddress: string
  Maximum Length: 254

  Premise Info

  Example: 22 Northwood Road, San Francisco, CA, 94105
• premiseLatitude: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Premise Latitude

  Example: 72
• premiseLongitude: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Premise Longitude

  Example: 141

{
    "type":"object",
    "properties":{
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                    "example":"7735910061"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"Premise Address",
            "example":"22 Northwood Road"
        },
        "premiseAddress":{
            "type":"string",
            "maxLength":254,
            "description":"Premise Info",
            "example":"22 Northwood Road, San Francisco, CA, 94105"
        },
        "premiseLatitude":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Premise Latitude",
            "example":"72"
        },
        "premiseLongitude":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Premise Longitude",
            "example":"141"
        }
    }
}

Nested Schema : serviceAgreementDetails

Type: object

Show Source

• account: object account
• cisDivision: string
  Maximum Length: 5

  The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.

  Example: Ohio
• cisDivisionDescription: string
  Maximum Length: 1

  Description for CIS Division. CIS Division defines the jurisdiction that governs the account.

  Example: California
• endDate: string (date)
  The End Date defines when the financial relationship terminates.

  Example: 2018-02-25
• isActive: boolean
  IsActive flag to show active SAs for account

  Example: false
• saStatus: string
  Allowed Values: [ "05 ", "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]

  SA Status defines the state of the service agreement. * `05 ` - Incomplete, * `10 ` - Pending Start, * `20 ` - Active, * `30 ` - Pending Stop, * `40 ` - Stopped, * `50 ` - Reactivated, * `60 ` - Closed, * `70 ` - Canceled

  Example: 20
• saStatusDescription: string
  Maximum Length: 60

  Description for SA Status

  Example: Canceled
• saType: string
  Maximum Length: 8

  SATYPE is Service Agreement Type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.

  Example: CHARITY (Ohio / Charitable contribution)
• saTypeDescription: string
  Maximum Length: 30

  Description for Service Agreement Type

  Example: Electric commercial
• serviceAgreement: object serviceAgreement
• serviceType: string
  Maximum Length: 80

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

  Example: E
• startDate: string (date)
  The Start Date defines when the financial relationship begins.

{
    "type":"object",
    "properties":{
        "serviceAgreement":{
            "type":"object",
            "properties":{
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"The Service Agreement ID is a system assigned random number that stays with a service agreement for life."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"The Start Date defines when the financial relationship begins."
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"The End Date defines when the financial relationship terminates.",
            "example":"2018-02-25"
        },
        "cisDivision":{
            "type":"string",
            "maxLength":5,
            "description":"The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.",
            "example":"Ohio"
        },
        "cisDivisionDescription":{
            "type":"string",
            "maxLength":1,
            "description":"Description for CIS Division. CIS Division defines the jurisdiction that governs the account.",
            "example":"California"
        },
        "saType":{
            "type":"string",
            "maxLength":8,
            "description":"SATYPE is Service Agreement Type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
            "example":"CHARITY (Ohio / Charitable contribution)"
        },
        "saTypeDescription":{
            "type":"string",
            "maxLength":30,
            "description":"Description for  Service Agreement Type",
            "example":"Electric commercial"
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        },
        "saStatus":{
            "type":"string",
            "enum":[
                "05  ",
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  "
            ],
            "description":"SA Status defines the state of the service agreement.\n* `05  ` - Incomplete,\n* `10  ` - Pending Start,\n* `20  ` - Active,\n* `30  ` - Pending Stop,\n* `40  ` - Stopped,\n* `50  ` - Reactivated,\n* `60  ` - Closed,\n* `70  ` - Canceled",
            "example":"20"
        },
        "saStatusDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description for SA Status",
            "example":"Canceled"
        },
        "isActive":{
            "type":"boolean",
            "description":"IsActive flag to show active SAs for account",
            "example":"false"
        }
    }
}

Nested Schema : servicePoints

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "servicePoint":{
                "type":"object",
                "properties":{
                    "servicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID The identity of the service point. The type and location of the service point is displayed adjacent."
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "howToUseDescription":{
                "type":"string",
                "maxLength":30,
                "description":"Short description for values on how billing uses the consumption associated with the service point. Valid values are: Add, Check, Subtract.  This is not applicable for item-type service points.",
                "example":"Add"
            },
            "premise":{
                "type":"object",
                "properties":{
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                        "example":"7735910061"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            }
        }
    }
}

Nested Schema : premise

Type: object

Show Source

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

  Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.

  Example: 7735910061

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
            "example":"7735910061"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : account

Type: object

Show Source

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

  Account ID

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Show Source

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

  The Service Agreement ID is a system assigned random number that stays with a service agreement for life.

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"The Service Agreement ID is a system assigned random number that stays with a service agreement for life."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• howToUseDescription: string
  Maximum Length: 30

  Short description for values on how billing uses the consumption associated with the service point. Valid values are: Add, Check, Subtract. This is not applicable for item-type service points.

  Example: Add
• premise: object premise
• servicePoint: object servicePoint

{
    "type":"object",
    "properties":{
        "servicePoint":{
            "type":"object",
            "properties":{
                "servicePointId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Point ID The identity of the service point. The type and location of the service point is displayed adjacent."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "howToUseDescription":{
            "type":"string",
            "maxLength":30,
            "description":"Short description for values on how billing uses the consumption associated with the service point. Valid values are: Add, Check, Subtract.  This is not applicable for item-type service points.",
            "example":"Add"
        },
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                    "example":"7735910061"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        }
    }
}

Nested Schema : premise

Type: object

Show Source

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

  Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.

  Example: 7735910061

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
            "example":"7735910061"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : servicePoint

Type: object

Show Source

• _link: string
  _link
• servicePointId: string
  Maximum Length: 10

  Service Point ID The identity of the service point. The type and location of the service point is displayed adjacent.

{
    "type":"object",
    "properties":{
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID The identity of the service point. The type and location of the service point is displayed adjacent."
        },
        "_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