Oracle Utilities REST API for Metering and Customer Information

Business Person Summary

post

/rest/apis/customer/v-model/businessPersonQueries/

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

persons: array persons

{
    "type":"object",
    "properties":{
        "persons":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                        "example":"7713248626"
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External Party ID in a CX/CRM application",
                        "example":"CDRM_952287"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1PersonSumm"
    }
}

Nested Schema : persons

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                "example":"7713248626"
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External Party ID in a CX/CRM application",
                "example":"CDRM_952287"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

externalId: string

Maximum Length: 60

External Party ID in a CX/CRM application

Example: CDRM_952287
personId: string

Maximum Length: 10

Person ID is a system-assigned random number that stays with a person for the life of the system.

Example: 7713248626

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
            "example":"7713248626"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External Party ID in a CX/CRM application",
            "example":"CDRM_952287"
        }
    }
}

Root Schema : schema

Type: object

Show Source

persons: array persons

{
    "type":"object",
    "properties":{
        "persons":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                        "example":"7713248626"
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External Party ID in a CX/CRM application",
                        "example":"CDRM_952287"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1PersonSumm"
    }
}

Nested Schema : persons

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "personId":{
                "type":"string",
                "maxLength":10,
                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                "example":"7713248626"
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External Party ID in a CX/CRM application",
                "example":"CDRM_952287"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

externalId: string

Maximum Length: 60

External Party ID in a CX/CRM application

Example: CDRM_952287
personId: string

Maximum Length: 10

Person ID is a system-assigned random number that stays with a person for the life of the system.

Example: 7713248626

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
            "example":"7713248626"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External Party ID in a CX/CRM application",
            "example":"CDRM_952287"
        }
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1PersonSumm

Type: object

Show Source

personSummary: array personSummary

{
    "type":"object",
    "properties":{
        "personSummary":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "person":{
                        "type":"object",
                        "properties":{
                            "personId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                                "example":"7713248626"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External Party ID in a CX/CRM application",
                        "example":"CDRM_952287"
                    },
                    "currency":{
                        "type":"object",
                        "properties":{
                            "currency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Currency Code"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "annualBilledAmount":{
                        "type":"number",
                        "description":"Total Annual Revenue",
                        "example":"19222.88"
                    },
                    "annualBilledDetails":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "serviceType":{
                                    "type":"string",
                                    "maxLength":80,
                                    "description":"Service Type"
                                },
                                "annualBilledAmount":{
                                    "type":"number",
                                    "description":"Annual Revenue for service type",
                                    "example":"187741.99"
                                }
                            }
                        }
                    },
                    "yearToDateBilledAmount":{
                        "type":"number",
                        "description":"Year To Date Billed Amount",
                        "example":"52641.14"
                    },
                    "currentBalance":{
                        "type":"number",
                        "description":"Current Balance",
                        "example":"7874.02"
                    },
                    "totalBalance":{
                        "type":"number",
                        "description":"Total Balance",
                        "example":"7874.02"
                    },
                    "disputedBalance":{
                        "type":"number",
                        "description":"Disputed Balance",
                        "example":"0.0"
                    },
                    "numberOfAccounts":{
                        "type":"number",
                        "maximum":9.999999999E9,
                        "minimum":0,
                        "description":"Number Of Accounts",
                        "example":"5"
                    },
                    "numberOfSAs":{
                        "type":"number",
                        "maximum":9.999999999E9,
                        "minimum":0,
                        "description":"Number Of Service Agreements",
                        "example":"81"
                    },
                    "numberOfPremises":{
                        "type":"number",
                        "maximum":9.999999999E9,
                        "minimum":0,
                        "description":"Number Of Premises",
                        "example":"77"
                    },
                    "numberOfSPs":{
                        "type":"number",
                        "maximum":9.999999999E9,
                        "minimum":0,
                        "description":"Number Of Service Points",
                        "example":"154"
                    },
                    "numberOfOpenServiceOrders":{
                        "type":"number",
                        "maximum":9.999999999E9,
                        "minimum":0,
                        "description":"Number Of Open Service Orders",
                        "example":"3"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1PersonSumm"
    }
}

Nested Schema : personSummary

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "person":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                        "example":"7713248626"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External Party ID in a CX/CRM application",
                "example":"CDRM_952287"
            },
            "currency":{
                "type":"object",
                "properties":{
                    "currency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "annualBilledAmount":{
                "type":"number",
                "description":"Total Annual Revenue",
                "example":"19222.88"
            },
            "annualBilledDetails":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "serviceType":{
                            "type":"string",
                            "maxLength":80,
                            "description":"Service Type"
                        },
                        "annualBilledAmount":{
                            "type":"number",
                            "description":"Annual Revenue for service type",
                            "example":"187741.99"
                        }
                    }
                }
            },
            "yearToDateBilledAmount":{
                "type":"number",
                "description":"Year To Date Billed Amount",
                "example":"52641.14"
            },
            "currentBalance":{
                "type":"number",
                "description":"Current Balance",
                "example":"7874.02"
            },
            "totalBalance":{
                "type":"number",
                "description":"Total Balance",
                "example":"7874.02"
            },
            "disputedBalance":{
                "type":"number",
                "description":"Disputed Balance",
                "example":"0.0"
            },
            "numberOfAccounts":{
                "type":"number",
                "maximum":9.999999999E9,
                "minimum":0,
                "description":"Number Of Accounts",
                "example":"5"
            },
            "numberOfSAs":{
                "type":"number",
                "maximum":9.999999999E9,
                "minimum":0,
                "description":"Number Of Service Agreements",
                "example":"81"
            },
            "numberOfPremises":{
                "type":"number",
                "maximum":9.999999999E9,
                "minimum":0,
                "description":"Number Of Premises",
                "example":"77"
            },
            "numberOfSPs":{
                "type":"number",
                "maximum":9.999999999E9,
                "minimum":0,
                "description":"Number Of Service Points",
                "example":"154"
            },
            "numberOfOpenServiceOrders":{
                "type":"number",
                "maximum":9.999999999E9,
                "minimum":0,
                "description":"Number Of Open Service Orders",
                "example":"3"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

annualBilledAmount: number

Total Annual Revenue

Example: 19222.88
annualBilledDetails: array annualBilledDetails
currency: object currency
currentBalance: number

Current Balance

Example: 7874.02
disputedBalance: number

Disputed Balance

Example: 0.0
externalId: string

Maximum Length: 60

External Party ID in a CX/CRM application

Example: CDRM_952287
numberOfAccounts: number

Minimum Value: 0

Maximum Value: 9.999999999E9

Number Of Accounts

Example: 5
numberOfOpenServiceOrders: number

Minimum Value: 0

Maximum Value: 9.999999999E9

Number Of Open Service Orders

Example: 3
numberOfPremises: number

Minimum Value: 0

Maximum Value: 9.999999999E9

Number Of Premises

Example: 77
numberOfSAs: number

Minimum Value: 0

Maximum Value: 9.999999999E9

Number Of Service Agreements

Example: 81
numberOfSPs: number

Minimum Value: 0

Maximum Value: 9.999999999E9

Number Of Service Points

Example: 154
person: object person
totalBalance: number

Total Balance

Example: 7874.02
yearToDateBilledAmount: number

Year To Date Billed Amount

Example: 52641.14

{
    "type":"object",
    "properties":{
        "person":{
            "type":"object",
            "properties":{
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
                    "example":"7713248626"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External Party ID in a CX/CRM application",
            "example":"CDRM_952287"
        },
        "currency":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "annualBilledAmount":{
            "type":"number",
            "description":"Total Annual Revenue",
            "example":"19222.88"
        },
        "annualBilledDetails":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type"
                    },
                    "annualBilledAmount":{
                        "type":"number",
                        "description":"Annual Revenue for service type",
                        "example":"187741.99"
                    }
                }
            }
        },
        "yearToDateBilledAmount":{
            "type":"number",
            "description":"Year To Date Billed Amount",
            "example":"52641.14"
        },
        "currentBalance":{
            "type":"number",
            "description":"Current Balance",
            "example":"7874.02"
        },
        "totalBalance":{
            "type":"number",
            "description":"Total Balance",
            "example":"7874.02"
        },
        "disputedBalance":{
            "type":"number",
            "description":"Disputed Balance",
            "example":"0.0"
        },
        "numberOfAccounts":{
            "type":"number",
            "maximum":9.999999999E9,
            "minimum":0,
            "description":"Number Of Accounts",
            "example":"5"
        },
        "numberOfSAs":{
            "type":"number",
            "maximum":9.999999999E9,
            "minimum":0,
            "description":"Number Of Service Agreements",
            "example":"81"
        },
        "numberOfPremises":{
            "type":"number",
            "maximum":9.999999999E9,
            "minimum":0,
            "description":"Number Of Premises",
            "example":"77"
        },
        "numberOfSPs":{
            "type":"number",
            "maximum":9.999999999E9,
            "minimum":0,
            "description":"Number Of Service Points",
            "example":"154"
        },
        "numberOfOpenServiceOrders":{
            "type":"number",
            "maximum":9.999999999E9,
            "minimum":0,
            "description":"Number Of Open Service Orders",
            "example":"3"
        }
    }
}

Nested Schema : annualBilledDetails

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceType":{
                "type":"string",
                "maxLength":80,
                "description":"Service Type"
            },
            "annualBilledAmount":{
                "type":"number",
                "description":"Annual Revenue for service type",
                "example":"187741.99"
            }
        }
    }
}

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

Type: object

Show Source

_link: string

_link
personId: string

Maximum Length: 10

Person ID is a system-assigned random number that stays with a person for the life of the system.

Example: 7713248626

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is a system-assigned random number that stays with a person for the life of the system.",
            "example":"7713248626"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : items

Type: object

Show Source

annualBilledAmount: number

Annual Revenue for service type

Example: 187741.99
serviceType: string

Maximum Length: 80

Service Type

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type"
        },
        "annualBilledAmount":{
            "type":"number",
            "description":"Annual Revenue for service type",
            "example":"187741.99"
        }
    }
}

400 Response

Bad Request

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

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."
        }
    }
}