SA Search
post
/rest/apis/customer/v-model/serviceAgreements/search
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
filters: object
filters
-
limit: number
Minimum Value:
0
Maximum Value:999999999.999999
Page LimitExample:2
-
offset: number
Minimum Value:
0
Maximum Value:999999999.999999
Page OffsetExample:2
Nested Schema : filters
Type:
Show Source
object
-
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 ` - YesExample: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.
Root Schema : schema
Type:
Show Source
object
-
filters: object
filters
-
limit: number
Minimum Value:
0
Maximum Value:999999999.999999
Page LimitExample:2
-
offset: number
Minimum Value:
0
Maximum Value:999999999.999999
Page OffsetExample:2
Nested Schema : filters
Type:
Show Source
object
-
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 ` - YesExample: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.
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1SASearhSer
Type:
Show Source
object
-
limit: number
Minimum Value:
0
Maximum Value:999999999.999999
Page LimitExample:2
-
offset: number
Minimum Value:
0
Maximum Value:999999999.999999
Page OffsetExample:2
-
serviceAgreements: array
serviceAgreements
-
totalNumberOfRecords: number
Minimum Value:
0
Maximum Value:99999
Total number of recordsExample:4
Nested Schema : effectiveRateSchedule
Type:
Show Source
object
-
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
Nested Schema : premiseDetails
Type:
Show Source
object
-
address1: string
Maximum Length:
254
Premise AddressExample:22 Northwood Road
-
premise: object
premise
-
premiseAddress: string
Maximum Length:
254
Premise InfoExample:22 Northwood Road, San Francisco, CA, 94105
-
premiseLatitude: number
Minimum Value:
0
Maximum Value:999999999.999999
Premise LatitudeExample:72
-
premiseLongitude: number
Minimum Value:
0
Maximum Value:999999999.999999
Premise LongitudeExample:141
Nested Schema : serviceAgreementDetails
Type:
Show Source
object
-
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 accountExample:
false
-
saStatusDescription: string
Maximum Length:
60
Description for SA StatusExample: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 TypeExample: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.
Nested Schema : premise
Type:
Show Source
object
-
_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
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID
Nested Schema : serviceAgreement
Type:
Show Source
object
-
_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.
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : premise
Type:
Show Source
object
-
_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
Nested Schema : servicePoint
Type:
Show Source
object
-
_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.
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.