Search Account Premises

post

https://server:port/spl/rest/apis/customer/v-model/billingContext/premises

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
  • Maximum Length: 10
    The Account ID is a system-assigned random number that stays with an account for life.
    Example: 0279948222
  • filters
  • Minimum Value: 0
    Maximum Value: 9.99999999999999E8
    Limit
    Example: 25
  • Minimum Value: 0
    Maximum Value: 9.99999999999999E8
    Offset
    Example: 0
  • Maximum Length: 10
    Person ID is the system-assigned number for other persons related to the account.
    Example: 4429925678
Nested Schema : filters
Type: object
Show Source
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Maximum Length: 10
    The Account ID is a system-assigned random number that stays with an account for life.
    Example: 0279948222
  • filters
  • Minimum Value: 0
    Maximum Value: 9.99999999999999E8
    Limit
    Example: 25
  • Minimum Value: 0
    Maximum Value: 9.99999999999999E8
    Offset
    Example: 0
  • Maximum Length: 10
    Person ID is the system-assigned number for other persons related to the account.
    Example: 4429925678
Nested Schema : filters
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : C1GetPremAcc
Type: object
Show Source
Nested Schema : premiseList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : address
Type: object
Show Source
  • Maximum Length: 254
    Address
  • Maximum Length: 254
    The second line of the address.
  • Maximum Length: 254
    The third line of the address.
  • Maximum Length: 254
    The fourth line of the address.
  • Maximum Length: 90
    The city of the address.
    Example: Morristown
  • Maximum Length: 3
    Country defaults from the installation options. The address constituents may differ depending on the Country.
    Example: USA
  • Maximum Length: 90
    The county of the address.
    Example: San Francisco
  • Maximum Length: 11
    Geographic code used to apply proper taxation rules to the physical address location.
  • Allowed Values: [ "AB ", "WW " ]
    House Type indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer Reference
  • In City Limit is defined as true if the address is considered within the physical city limits.
    Example: false
  • Maximum Length: 12
    The postal code of the address.
    Example: 07960
  • Maximum Length: 6
    The state of the address.
    Example: CA

400 Response

Bad Request
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

Internal Server Error
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.
Back to Top