Determine Services To Stop
post
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/servicesToStop
This operation uses the Determine Services To Stop Algorithm control to determine the SP-based services to stop for an account at a given stop date when stopping service or transferring service. It returns number of premises that have stoppable services.
This operation can be called read-only mode. This mode is used by the self-service application to determine if stop service is available as an option to the user. When not in read-only mode, a self-service start/stop/transfer task containing the determined SP-based services is created if one doesn't exist (initial call when stopping service).
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 -
cssUser: string
Maximum Length:
30
Self-Service User ID -
emailAddress: string
Maximum Length:
254
Email Address.Example:mark.brazil@email.com
-
ipAddress: string
Maximum Length:
15
IP Address -
readOnly: boolean
Read Only switch indicates whether or not the request is in read-only mode. This mode is used by the self-service application to determine if stop service is available as an option to the user. No self-service task is created in this mode.Example:
true
-
requestMode: string
Allowed Values:
[ "C1SP", "C1ST", "C1TR" ]
Request Mode indicates the type of start/stop/transfer transaction. * `C1SP` - Stop Service, * `C1ST` - Start Service, * `C1TR` - Transfer Service -
serviceTaskId: string
Maximum Length:
14
Self-Service Task ID is the system-assigned unique identifier of the self-service task.Example:69216126491457
-
stopDate: string
(date)
Service Stop DateExample:
2023-12-31
-
webUserId: string
Maximum Length:
30
Web User ID
Root Schema : schema
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID -
cssUser: string
Maximum Length:
30
Self-Service User ID -
emailAddress: string
Maximum Length:
254
Email Address.Example:mark.brazil@email.com
-
ipAddress: string
Maximum Length:
15
IP Address -
readOnly: boolean
Read Only switch indicates whether or not the request is in read-only mode. This mode is used by the self-service application to determine if stop service is available as an option to the user. No self-service task is created in this mode.Example:
true
-
requestMode: string
Allowed Values:
[ "C1SP", "C1ST", "C1TR" ]
Request Mode indicates the type of start/stop/transfer transaction. * `C1SP` - Stop Service, * `C1ST` - Start Service, * `C1TR` - Transfer Service -
serviceTaskId: string
Maximum Length:
14
Self-Service Task ID is the system-assigned unique identifier of the self-service task.Example:69216126491457
-
stopDate: string
(date)
Service Stop DateExample:
2023-12-31
-
webUserId: string
Maximum Length:
30
Web User ID
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1SSSvcsStop
Type:
Show Source
object
-
nbrOfStoppablePremises: number
Minimum Value:
0
Maximum Value:99999
Number Of Stoppable Premises -
serviceTaskId: string
Maximum Length:
14
Self-Service Task ID is the system-assigned unique identifier of the self-service task.Example:69216126491457
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.