Oracle Utilities REST API for Metering and Customer Information

Validate Stop Service Agreement Selection

post

https://server:port/spl/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: object

Show Source

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

{
    "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"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "showMeterIds":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"Show Meter IDs indicates whether or not meter information is displayed in the self-service application.\n* `N   ` - No,\n* `Y   ` - Yes"
        },
        "premisesToStop":{
            "type":"object",
            "properties":{
                "premiseToStop":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "premiseId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Premise ID"
                            },
                            "sasToStop":{
                                "type":"object",
                                "properties":{
                                    "saToStop":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "serviceAgreementId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Service Agreement"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1SSVStopSAS"
    }
}

Nested Schema : premisesToStop

Type: object

Show Source

premiseToStop: array premiseToStop

{
    "type":"object",
    "properties":{
        "premiseToStop":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID"
                    },
                    "sasToStop":{
                        "type":"object",
                        "properties":{
                            "saToStop":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "serviceAgreementId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Service Agreement"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : premiseToStop

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "premiseId":{
                "type":"string",
                "maxLength":10,
                "description":"Premise ID"
            },
            "sasToStop":{
                "type":"object",
                "properties":{
                    "saToStop":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "serviceAgreementId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Service Agreement"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

premiseId: string

Maximum Length: 10

Premise ID
sasToStop: object sasToStop

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID"
        },
        "sasToStop":{
            "type":"object",
            "properties":{
                "saToStop":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "serviceAgreementId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Agreement"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : sasToStop

Type: object

Show Source

saToStop: array saToStop

{
    "type":"object",
    "properties":{
        "saToStop":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceAgreementId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Agreement"
                    }
                }
            }
        }
    }
}

Nested Schema : saToStop

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceAgreementId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Agreement"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

serviceAgreementId: string

Maximum Length: 10

Service Agreement

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        }
    }
}

Root Schema : schema

Type: object

Show Source

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

{
    "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"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "showMeterIds":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"Show Meter IDs indicates whether or not meter information is displayed in the self-service application.\n* `N   ` - No,\n* `Y   ` - Yes"
        },
        "premisesToStop":{
            "type":"object",
            "properties":{
                "premiseToStop":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "premiseId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Premise ID"
                            },
                            "sasToStop":{
                                "type":"object",
                                "properties":{
                                    "saToStop":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "serviceAgreementId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Service Agreement"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1SSVStopSAS"
    }
}

Nested Schema : premisesToStop

Type: object

Show Source

premiseToStop: array premiseToStop

{
    "type":"object",
    "properties":{
        "premiseToStop":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID"
                    },
                    "sasToStop":{
                        "type":"object",
                        "properties":{
                            "saToStop":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "serviceAgreementId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Service Agreement"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : premiseToStop

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "premiseId":{
                "type":"string",
                "maxLength":10,
                "description":"Premise ID"
            },
            "sasToStop":{
                "type":"object",
                "properties":{
                    "saToStop":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "serviceAgreementId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Service Agreement"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

premiseId: string

Maximum Length: 10

Premise ID
sasToStop: object sasToStop

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID"
        },
        "sasToStop":{
            "type":"object",
            "properties":{
                "saToStop":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "serviceAgreementId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Agreement"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : sasToStop

Type: object

Show Source

saToStop: array saToStop

{
    "type":"object",
    "properties":{
        "saToStop":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceAgreementId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Agreement"
                    }
                }
            }
        }
    }
}

Nested Schema : saToStop

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceAgreementId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Agreement"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

serviceAgreementId: string

Maximum Length: 10

Service Agreement

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        }
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1SSVStopSAS

Type: object

Show Source

messages: object messages
validServicesToStop: boolean

Valid SAs To Stop switch indicates whether or not the selected services to stop is valid.

Example: true

{
    "type":"object",
    "properties":{
        "validServicesToStop":{
            "type":"boolean",
            "description":"Valid SAs To Stop switch indicates whether or not the selected services to stop is valid.",
            "example":"true"
        },
        "messages":{
            "type":"object",
            "properties":{
                "message":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "serviceToStopMessage":{
                                "type":"string",
                                "maxLength":254,
                                "description":"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."
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1SSVStopSAS"
    }
}

Nested Schema : messages

Type: object

Show Source

message: array message

{
    "type":"object",
    "properties":{
        "message":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceToStopMessage":{
                        "type":"string",
                        "maxLength":254,
                        "description":"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."
                    }
                }
            }
        }
    }
}

Nested Schema : message

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceToStopMessage":{
                "type":"string",
                "maxLength":254,
                "description":"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."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "serviceToStopMessage":{
            "type":"string",
            "maxLength":254,
            "description":"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: 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."
        }
    }
}