Search Account Premises
post
/spl/rest/apis/customer/v-model/billingContext/premises
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID identifies the customer who is responsible for the bill.Example:0119532152
-
filters: object
filters
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
LimitExample:25
-
offset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
OffsetExample:0
-
personId: string
Maximum Length:
10
Person ID is the system-assigned number for other persons related to the account.
Root Schema : schema
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID identifies the customer who is responsible for the bill.Example:0119532152
-
filters: object
filters
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
LimitExample:25
-
offset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
OffsetExample:0
-
personId: string
Maximum Length:
10
Person ID is the system-assigned number for other persons related to the account.
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1GetPremAcc
Type:
Show Source
object
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
LimitExample:25
-
offset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
OffsetExample:0
-
premiseList: array
premiseList
-
totalNumberOfRecords: number
Minimum Value:
0
Maximum Value:99999
Total Number Of RecordsExample:2
Nested Schema : items
Type:
Show Source
object
-
address: object
address
-
cisDivision: string
Maximum Length:
5
CIS Division -
formattedAddress: string
Maximum Length:
254
Premise InformationExample:129 Sutter St, San Francisco, CA, 94104
-
lifeSupportSensitiveLoadIndicator: boolean
Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment.Example:
true
-
lifeSupportSensitiveLoadNote: string
Maximum Length:
1000
Life Support / Sensitive Load Description defines the type of equipment applicable to the life support or sensitive load distinction. -
premiseId: string
Maximum Length:
10
Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.Example:3836403369
-
premiseType: string
Maximum Length:
8
Premise Type indicates the type of premise.Example:HOME (Single family home)
-
premiseTypeDescription: string
Maximum Length:
60
Description for Premise Type -
servicePointSummary: array
servicePointSummary
Nested Schema : address
Type:
Show Source
object
-
address1: string
Maximum Length:
254
Address -
address2: string
Maximum Length:
254
The second line of the address. -
address3: string
Maximum Length:
254
The third line of the address. -
address4: string
Maximum Length:
254
The fourth line of the address. -
city: string
Maximum Length:
90
The city of the address.Example:Morristown
-
country: string
Maximum Length:
3
Country defaults from the installation options. The address constituents may differ depending on the Country.Example:USA
-
county: string
Maximum Length:
90
The county of the address.Example:San Francisco
-
geographic: string
Maximum Length:
11
Geographic code used to apply proper taxation rules to the physical address location. -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
inCityLimit: boolean
In City Limit is defined as true if the address is considered within the physical city limits.Example:
false
-
postal: string
Maximum Length:
12
The postal code of the address.Example:07960
-
state: string
Maximum Length:
6
The state of the address.Example:CA
Nested Schema : items
Type:
Show Source
object
-
disconnectedServiceIndicator: boolean
Indicator to show if count of metered SP's is same as count of connected metered SP's not not.Example:
true
-
numberOfMeteredServicePoints: number
Minimum Value:
0
Maximum Value:9.999999999E9
Number Of metered service points at a premiseExample:1
-
numberOfServicePoints: number
Minimum Value:
0
Maximum Value:9.999999999E9
Number Of active service points at a premiseExample:1
-
serviceType: string
Maximum Length:
80
Service Type defines the type of service associated with the service agreement. For example, G defines the service type as Gas service.Example:G
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.