Jump to

• Request
• Response

Business Person Summary

post

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

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

• persons: array persons

{
    "type":"object",
    "properties":{
        "persons":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Person ID"
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External ID"
                    }
                }
            }
        }
    },
    "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"
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External ID"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalId: string
  Maximum Length: 60

  External ID
• personId: string
  Maximum Length: 10

  Person ID

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External ID"
        }
    }
}

Request Body - 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"
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External ID"
                    }
                }
            }
        }
    },
    "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"
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External ID"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalId: string
  Maximum Length: 60

  External ID
• personId: string
  Maximum Length: 10

  Person ID

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External ID"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

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"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "externalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"External ID"
                    },
                    "currency":{
                        "type":"object",
                        "properties":{
                            "currency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Currency Code"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "annualBilledAmount":{
                        "type":"number",
                        "description":"Total Annual Revenue"
                    },
                    "annualBilledDetails":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "serviceType":{
                                    "type":"string",
                                    "maxLength":80,
                                    "description":"Service Type"
                                },
                                "annualBilledAmount":{
                                    "type":"number",
                                    "description":"Annual Revenue"
                                }
                            }
                        }
                    },
                    "yearToDateBilledAmount":{
                        "type":"number",
                        "description":"Year To Date Revenue"
                    },
                    "currentBalance":{
                        "type":"number",
                        "description":"Current Balance"
                    },
                    "totalBalance":{
                        "type":"number",
                        "description":"Total Balance"
                    },
                    "disputedBalance":{
                        "type":"number",
                        "description":"Disputed Balance"
                    },
                    "numberOfAccounts":{
                        "type":"number",
                        "maximum":9.999999999E9,
                        "minimum":0,
                        "description":"Number Of Accounts"
                    },
                    "numberOfSAs":{
                        "type":"number",
                        "maximum":9.999999999E9,
                        "minimum":0,
                        "description":"Number Of Service Agreements"
                    },
                    "numberOfPremises":{
                        "type":"number",
                        "maximum":9.999999999E9,
                        "minimum":0,
                        "description":"Number Of Premises"
                    },
                    "numberOfSPs":{
                        "type":"number",
                        "maximum":9.999999999E9,
                        "minimum":0,
                        "description":"Number Of Service Points"
                    },
                    "numberOfOpenServiceOrders":{
                        "type":"number",
                        "maximum":9.999999999E9,
                        "minimum":0,
                        "description":"Number Of Open Service Orders"
                    }
                }
            }
        }
    },
    "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"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "externalId":{
                "type":"string",
                "maxLength":60,
                "description":"External ID"
            },
            "currency":{
                "type":"object",
                "properties":{
                    "currency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "annualBilledAmount":{
                "type":"number",
                "description":"Total Annual Revenue"
            },
            "annualBilledDetails":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "serviceType":{
                            "type":"string",
                            "maxLength":80,
                            "description":"Service Type"
                        },
                        "annualBilledAmount":{
                            "type":"number",
                            "description":"Annual Revenue"
                        }
                    }
                }
            },
            "yearToDateBilledAmount":{
                "type":"number",
                "description":"Year To Date Revenue"
            },
            "currentBalance":{
                "type":"number",
                "description":"Current Balance"
            },
            "totalBalance":{
                "type":"number",
                "description":"Total Balance"
            },
            "disputedBalance":{
                "type":"number",
                "description":"Disputed Balance"
            },
            "numberOfAccounts":{
                "type":"number",
                "maximum":9.999999999E9,
                "minimum":0,
                "description":"Number Of Accounts"
            },
            "numberOfSAs":{
                "type":"number",
                "maximum":9.999999999E9,
                "minimum":0,
                "description":"Number Of Service Agreements"
            },
            "numberOfPremises":{
                "type":"number",
                "maximum":9.999999999E9,
                "minimum":0,
                "description":"Number Of Premises"
            },
            "numberOfSPs":{
                "type":"number",
                "maximum":9.999999999E9,
                "minimum":0,
                "description":"Number Of Service Points"
            },
            "numberOfOpenServiceOrders":{
                "type":"number",
                "maximum":9.999999999E9,
                "minimum":0,
                "description":"Number Of Open Service Orders"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• annualBilledAmount: number
  Total Annual Revenue
• annualBilledDetails: array annualBilledDetails
• currency: object currency
• currentBalance: number
  Current Balance
• disputedBalance: number
  Disputed Balance
• externalId: string
  Maximum Length: 60

  External ID
• numberOfAccounts: number
  Minimum Value: 0

  Maximum Value: 9.999999999E9

  Number Of Accounts
• numberOfOpenServiceOrders: number
  Minimum Value: 0

  Maximum Value: 9.999999999E9

  Number Of Open Service Orders
• numberOfPremises: number
  Minimum Value: 0

  Maximum Value: 9.999999999E9

  Number Of Premises
• numberOfSAs: number
  Minimum Value: 0

  Maximum Value: 9.999999999E9

  Number Of Service Agreements
• numberOfSPs: number
  Minimum Value: 0

  Maximum Value: 9.999999999E9

  Number Of Service Points
• person: object person
• totalBalance: number
  Total Balance
• yearToDateBilledAmount: number
  Year To Date Revenue

{
    "type":"object",
    "properties":{
        "person":{
            "type":"object",
            "properties":{
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External ID"
        },
        "currency":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "annualBilledAmount":{
            "type":"number",
            "description":"Total Annual Revenue"
        },
        "annualBilledDetails":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type"
                    },
                    "annualBilledAmount":{
                        "type":"number",
                        "description":"Annual Revenue"
                    }
                }
            }
        },
        "yearToDateBilledAmount":{
            "type":"number",
            "description":"Year To Date Revenue"
        },
        "currentBalance":{
            "type":"number",
            "description":"Current Balance"
        },
        "totalBalance":{
            "type":"number",
            "description":"Total Balance"
        },
        "disputedBalance":{
            "type":"number",
            "description":"Disputed Balance"
        },
        "numberOfAccounts":{
            "type":"number",
            "maximum":9.999999999E9,
            "minimum":0,
            "description":"Number Of Accounts"
        },
        "numberOfSAs":{
            "type":"number",
            "maximum":9.999999999E9,
            "minimum":0,
            "description":"Number Of Service Agreements"
        },
        "numberOfPremises":{
            "type":"number",
            "maximum":9.999999999E9,
            "minimum":0,
            "description":"Number Of Premises"
        },
        "numberOfSPs":{
            "type":"number",
            "maximum":9.999999999E9,
            "minimum":0,
            "description":"Number Of Service Points"
        },
        "numberOfOpenServiceOrders":{
            "type":"number",
            "maximum":9.999999999E9,
            "minimum":0,
            "description":"Number Of Open Service Orders"
        }
    }
}

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

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

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• annualBilledAmount: number
  Annual Revenue
• serviceType: string
  Maximum Length: 80

  Service Type

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

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