Oracle Utilities REST API for Metering and Customer Information

Determine Services To Stop

post

/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: object

Show Source

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 Date

Example: 2023-12-31
webUserId: string

Maximum Length: 30

Web User ID

{
    "type":"object",
    "properties":{
        "requestMode":{
            "type":"string",
            "enum":[
                "C1SP",
                "C1ST",
                "C1TR"
            ],
            "description":"Request Mode indicates the type of start/stop/transfer transaction.\n* `C1SP` - Stop Service,\n* `C1ST` - Start Service,\n* `C1TR` - Transfer Service"
        },
        "accountId":{
            "type":"string",
            "maxLength":"10",
            "description":"Account ID"
        },
        "stopDate":{
            "type":"string",
            "format":"date",
            "description":"Service Stop Date",
            "example":"2023-12-31"
        },
        "readOnly":{
            "type":"boolean",
            "description":"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"
        },
        "webUserId":{
            "type":"string",
            "maxLength":"30",
            "description":"Web User ID"
        },
        "cssUser":{
            "type":"string",
            "maxLength":"30",
            "description":"Self-Service User ID"
        },
        "emailAddress":{
            "type":"string",
            "maxLength":"254",
            "description":"Email Address.",
            "example":"mark.brazil@email.com"
        },
        "ipAddress":{
            "type":"string",
            "maxLength":"15",
            "description":"IP Address"
        },
        "serviceTaskId":{
            "type":"string",
            "maxLength":"14",
            "description":"Self-Service Task ID is the system-assigned unique identifier of the self-service task.",
            "example":"69216126491457"
        }
    },
    "xml":{
        "name":"C1SSSvcsStop"
    }
}

Root Schema : schema

Type: object

Show Source

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 Date

Example: 2023-12-31
webUserId: string

Maximum Length: 30

Web User ID

{
    "type":"object",
    "properties":{
        "requestMode":{
            "type":"string",
            "enum":[
                "C1SP",
                "C1ST",
                "C1TR"
            ],
            "description":"Request Mode indicates the type of start/stop/transfer transaction.\n* `C1SP` - Stop Service,\n* `C1ST` - Start Service,\n* `C1TR` - Transfer Service"
        },
        "accountId":{
            "type":"string",
            "maxLength":"10",
            "description":"Account ID"
        },
        "stopDate":{
            "type":"string",
            "format":"date",
            "description":"Service Stop Date",
            "example":"2023-12-31"
        },
        "readOnly":{
            "type":"boolean",
            "description":"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"
        },
        "webUserId":{
            "type":"string",
            "maxLength":"30",
            "description":"Web User ID"
        },
        "cssUser":{
            "type":"string",
            "maxLength":"30",
            "description":"Self-Service User ID"
        },
        "emailAddress":{
            "type":"string",
            "maxLength":"254",
            "description":"Email Address.",
            "example":"mark.brazil@email.com"
        },
        "ipAddress":{
            "type":"string",
            "maxLength":"15",
            "description":"IP Address"
        },
        "serviceTaskId":{
            "type":"string",
            "maxLength":"14",
            "description":"Self-Service Task ID is the system-assigned unique identifier of the self-service task.",
            "example":"69216126491457"
        }
    },
    "xml":{
        "name":"C1SSSvcsStop"
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1SSSvcsStop

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "serviceTaskId":{
            "type":"string",
            "maxLength":"14",
            "description":"Self-Service Task ID is the system-assigned unique identifier of the self-service task.",
            "example":"69216126491457"
        },
        "nbrOfStoppablePremises":{
            "type":"number",
            "maximum":"99999",
            "minimum":"0",
            "description":"Number Of Stoppable Premises"
        }
    },
    "xml":{
        "name":"C1SSSvcsStop"
    }
}

400 Response

Bad Request

Root Schema : problemDetailDocument

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":"60",
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":"9999",
            "minimum":"0",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":"60",
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":"60",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":"0",
                    "minimum":"0",
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":"99999",
                    "minimum":"-99999",
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":"0",
            "minimum":"0",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":"60",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":"60",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Root Schema : problemDetailDocument

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":"60",
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":"9999",
            "minimum":"0",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":"60",
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":"60",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":"0",
                    "minimum":"0",
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":"99999",
                    "minimum":"-99999",
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":"0",
            "minimum":"0",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":"60",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":"60",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}