Validate Stop Service Agreement Selection
post
/rest/apis/customer/service/startStopTransferTasks/stopSASelectionValidation
This operation uses the Stop Level, Require SAs At Same SP To Behave Together, and Validate Services To Stop Algorithm controls to validate the selected SP-based services to stop. It is used when stopping service or transferring service. The SP-based services to stop for the account should be determined before this operation can be used.
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 -
premisesToStop: object
premisesToStop
-
serviceTaskId: string
Maximum Length:
14
Self-Service Task ID is the system-assigned unique identifier of the self-service task.Example:69216126491457
-
showMeterIds: string
Allowed Values:
[ "N ", "Y " ]
Show Meter IDs indicates whether or not meter information is displayed in the self-service application. * `N ` - No, * `Y ` - Yes
Nested Schema : items
Type:
Show Source
object
-
premiseId: string
Maximum Length:
10
Premise ID -
sasToStop: object
sasToStop
Nested Schema : items
Type:
Show Source
object
-
serviceAgreementId: string
Maximum Length:
10
Service Agreement
Root Schema : schema
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID -
premisesToStop: object
premisesToStop
-
serviceTaskId: string
Maximum Length:
14
Self-Service Task ID is the system-assigned unique identifier of the self-service task.Example:69216126491457
-
showMeterIds: string
Allowed Values:
[ "N ", "Y " ]
Show Meter IDs indicates whether or not meter information is displayed in the self-service application. * `N ` - No, * `Y ` - Yes
Nested Schema : items
Type:
Show Source
object
-
premiseId: string
Maximum Length:
10
Premise ID -
sasToStop: object
sasToStop
Nested Schema : items
Type:
Show Source
object
-
serviceAgreementId: string
Maximum Length:
10
Service Agreement
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1SSVStopSAS
Type:
Show Source
object
-
messages: object
messages
-
validServicesToStop: boolean
Valid SAs To Stop switch indicates whether or not the selected services to stop is valid.Example:
true
Nested Schema : items
Type:
Show Source
object
-
serviceToStopMessage: string
Maximum Length:
254
Service To Stop Message is any message returned when validating the selected services to stop.Example:Electric and Gas at premise 5785517281 should be stopped together.
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.