Oracle Utilities REST API for Digital Asset

Get Qualification Questions

get

https://server:port/rest/apis/cross/digitalAssets/programEligibilityAndQualification/{Program Code}/qualificationQuestions

This REST web service returns the Qualification questions that will be asked to the customer during program enrollment and the expected answers from a customer in order to qualify in the program.

Request

Path Parameters

Program Code(required): string
The implementation defined code of the program definition to be shared with external systems to allow enrollments and event creation.
Example:
```
LOADSHIFT, MANAGEDCHARGING
```

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : X1-DAPrgQues

Type: object

Show Source

qualificationQuestions: object qualificationQuestions

{
    "type":"object",
    "properties":{
        "qualificationQuestions":{
            "type":"object",
            "properties":{
                "qualificationQuestionsList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"string",
                                "description":"(sequence)"
                            },
                            "question":{
                                "type":"string",
                                "description":"(question)"
                            },
                            "responseRequired":{
                                "type":"string",
                                "description":"(responseRequired)"
                            },
                            "description":{
                                "type":"string",
                                "description":"(description)"
                            },
                            "questionAnswers":{
                                "type":"object",
                                "properties":{
                                    "questionAnswer":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "sequence":{
                                                    "type":"string",
                                                    "description":"(sequence)"
                                                },
                                                "answer":{
                                                    "type":"string",
                                                    "description":"(answer)"
                                                },
                                                "answerStyle":{
                                                    "type":"string",
                                                    "enum":[
                                                        "CHBX",
                                                        "CHTY",
                                                        "DATE",
                                                        "DTTM",
                                                        "RBTN",
                                                        "TEXT"
                                                    ],
                                                    "description":"(answerStyle):\n* `CHBX` - Checkbox,\n* `CHTY` - Predefined Characteristic Type,\n* `DATE` - Date,\n* `DTTM` - Date/Time,\n* `RBTN` - Radio Button,\n* `TEXT` - Text Input"
                                                },
                                                "description":{
                                                    "type":"string",
                                                    "description":"(description)"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1-DAPrgQues"
    }
}

Nested Schema : qualificationQuestions

Type: object

Show Source

qualificationQuestionsList: array qualificationQuestionsList

{
    "type":"object",
    "properties":{
        "qualificationQuestionsList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"string",
                        "description":"(sequence)"
                    },
                    "question":{
                        "type":"string",
                        "description":"(question)"
                    },
                    "responseRequired":{
                        "type":"string",
                        "description":"(responseRequired)"
                    },
                    "description":{
                        "type":"string",
                        "description":"(description)"
                    },
                    "questionAnswers":{
                        "type":"object",
                        "properties":{
                            "questionAnswer":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "sequence":{
                                            "type":"string",
                                            "description":"(sequence)"
                                        },
                                        "answer":{
                                            "type":"string",
                                            "description":"(answer)"
                                        },
                                        "answerStyle":{
                                            "type":"string",
                                            "enum":[
                                                "CHBX",
                                                "CHTY",
                                                "DATE",
                                                "DTTM",
                                                "RBTN",
                                                "TEXT"
                                            ],
                                            "description":"(answerStyle):\n* `CHBX` - Checkbox,\n* `CHTY` - Predefined Characteristic Type,\n* `DATE` - Date,\n* `DTTM` - Date/Time,\n* `RBTN` - Radio Button,\n* `TEXT` - Text Input"
                                        },
                                        "description":{
                                            "type":"string",
                                            "description":"(description)"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : qualificationQuestionsList

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"string",
                "description":"(sequence)"
            },
            "question":{
                "type":"string",
                "description":"(question)"
            },
            "responseRequired":{
                "type":"string",
                "description":"(responseRequired)"
            },
            "description":{
                "type":"string",
                "description":"(description)"
            },
            "questionAnswers":{
                "type":"object",
                "properties":{
                    "questionAnswer":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"string",
                                    "description":"(sequence)"
                                },
                                "answer":{
                                    "type":"string",
                                    "description":"(answer)"
                                },
                                "answerStyle":{
                                    "type":"string",
                                    "enum":[
                                        "CHBX",
                                        "CHTY",
                                        "DATE",
                                        "DTTM",
                                        "RBTN",
                                        "TEXT"
                                    ],
                                    "description":"(answerStyle):\n* `CHBX` - Checkbox,\n* `CHTY` - Predefined Characteristic Type,\n* `DATE` - Date,\n* `DTTM` - Date/Time,\n* `RBTN` - Radio Button,\n* `TEXT` - Text Input"
                                },
                                "description":{
                                    "type":"string",
                                    "description":"(description)"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

description: string

(description)
question: string

(question)
questionAnswers: object questionAnswers
responseRequired: string

(responseRequired)
sequence: string

(sequence)

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"string",
            "description":"(sequence)"
        },
        "question":{
            "type":"string",
            "description":"(question)"
        },
        "responseRequired":{
            "type":"string",
            "description":"(responseRequired)"
        },
        "description":{
            "type":"string",
            "description":"(description)"
        },
        "questionAnswers":{
            "type":"object",
            "properties":{
                "questionAnswer":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"string",
                                "description":"(sequence)"
                            },
                            "answer":{
                                "type":"string",
                                "description":"(answer)"
                            },
                            "answerStyle":{
                                "type":"string",
                                "enum":[
                                    "CHBX",
                                    "CHTY",
                                    "DATE",
                                    "DTTM",
                                    "RBTN",
                                    "TEXT"
                                ],
                                "description":"(answerStyle):\n* `CHBX` - Checkbox,\n* `CHTY` - Predefined Characteristic Type,\n* `DATE` - Date,\n* `DTTM` - Date/Time,\n* `RBTN` - Radio Button,\n* `TEXT` - Text Input"
                            },
                            "description":{
                                "type":"string",
                                "description":"(description)"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : questionAnswers

Type: object

Show Source

questionAnswer: array questionAnswer

{
    "type":"object",
    "properties":{
        "questionAnswer":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"string",
                        "description":"(sequence)"
                    },
                    "answer":{
                        "type":"string",
                        "description":"(answer)"
                    },
                    "answerStyle":{
                        "type":"string",
                        "enum":[
                            "CHBX",
                            "CHTY",
                            "DATE",
                            "DTTM",
                            "RBTN",
                            "TEXT"
                        ],
                        "description":"(answerStyle):\n* `CHBX` - Checkbox,\n* `CHTY` - Predefined Characteristic Type,\n* `DATE` - Date,\n* `DTTM` - Date/Time,\n* `RBTN` - Radio Button,\n* `TEXT` - Text Input"
                    },
                    "description":{
                        "type":"string",
                        "description":"(description)"
                    }
                }
            }
        }
    }
}

Nested Schema : questionAnswer

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"string",
                "description":"(sequence)"
            },
            "answer":{
                "type":"string",
                "description":"(answer)"
            },
            "answerStyle":{
                "type":"string",
                "enum":[
                    "CHBX",
                    "CHTY",
                    "DATE",
                    "DTTM",
                    "RBTN",
                    "TEXT"
                ],
                "description":"(answerStyle):\n* `CHBX` - Checkbox,\n* `CHTY` - Predefined Characteristic Type,\n* `DATE` - Date,\n* `DTTM` - Date/Time,\n* `RBTN` - Radio Button,\n* `TEXT` - Text Input"
            },
            "description":{
                "type":"string",
                "description":"(description)"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

answer: string

(answer)
answerStyle: string

Allowed Values: [ "CHBX", "CHTY", "DATE", "DTTM", "RBTN", "TEXT" ]

(answerStyle): * `CHBX` - Checkbox, * `CHTY` - Predefined Characteristic Type, * `DATE` - Date, * `DTTM` - Date/Time, * `RBTN` - Radio Button, * `TEXT` - Text Input
description: string

(description)
sequence: string

(sequence)

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"string",
            "description":"(sequence)"
        },
        "answer":{
            "type":"string",
            "description":"(answer)"
        },
        "answerStyle":{
            "type":"string",
            "enum":[
                "CHBX",
                "CHTY",
                "DATE",
                "DTTM",
                "RBTN",
                "TEXT"
            ],
            "description":"(answerStyle):\n* `CHBX` - Checkbox,\n* `CHTY` - Predefined Characteristic Type,\n* `DATE` - Date,\n* `DTTM` - Date/Time,\n* `RBTN` - Radio Button,\n* `TEXT` - Text Input"
        },
        "description":{
            "type":"string",
            "description":"(description)"
        }
    }
}

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."
        }
    }
}