Retrieve Services To Stop
post
/rest/apis/customer/service/startStopTransferTasks/stoppableServiceDetails
This operation retrieves the premises with stoppable service that were previously determined and persisted on the self-service start/stop/transfer task.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
pageLimit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Maximum number of premises displayed at a time in the self-service application.Example:10
-
pageOffset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Offset from the first set of premises returned.Example:2
-
serviceTaskId: string
Maximum Length:
14
Self-Service Task ID is the system-assigned unique identifier of the self-service task.Example:69216126491457
Root Schema : schema
Type:
Show Source
object
-
pageLimit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Maximum number of premises displayed at a time in the self-service application.Example:10
-
pageOffset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Offset from the first set of premises returned.Example:2
-
serviceTaskId: string
Maximum Length:
14
Self-Service Task ID is the system-assigned unique identifier of the self-service task.Example:69216126491457
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : items
Type:
Show Source
object
-
addressLine1: string
Maximum Length:
254
Address -
addressLine2: string
Maximum Length:
254
Address 2 -
addressLine3: string
Maximum Length:
254
Address 3 -
addressLine4: string
Maximum Length:
254
Address 4 -
city: string
Maximum Length:
90
City -
country: string
Maximum Length:
3
Country -
county: string
Maximum Length:
90
County -
geographic: string
Maximum Length:
11
Geographical Code -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type: * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
inCityLimit: boolean
In City Limit
-
number1: string
Maximum Length:
6
Number 1 -
number2: string
Maximum Length:
4
Number 2 -
postal: string
Maximum Length:
12
Postal -
premiseId: string
Maximum Length:
10
Premise ID -
sasToStop: object
sasToStop
-
state: string
Maximum Length:
6
State
Nested Schema : items
Type:
Show Source
object
-
meters: object
meters
-
serviceAgreementId: string
Maximum Length:
10
Service Agreement -
serviceType: string
Maximum Length:
30
Service Type defines the type of service associated with the SA type.Example:E
-
serviceTypeDescription: string
Maximum Length:
60
Description
Nested Schema : items
Type:
Show Source
object
-
badgeNumber: string
Maximum Length:
30
Badge Number is the identifier stamped on the meter.Example:ER-SM-1360
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.