Create Program Unenrollment
post
https://server:port/rest/apis/cross/digitalAssets/programEnrollments/unenroll
This REST web service processes a customer's unenrollment request from a program in Oracle Utilities Digital Asset Cloud Service.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
customerInfo: object
UNENROLLPROGRAM_request_customerInfo
-
locationInfo: object
ENROLLPROGRAM_request_locationInfo
-
transactionId: string
Maximum Length:
120
Unique external Transaction identifier created by the external source application (for example, Grid Edge Distributed Energy Resource Management System) -
unenrollReason: string
Allowed Values:
[ "LSSL", "CUSTOMEROPTOUT", "INACTIVESERVICE", "INELIGIBLERATE" ]
Unenroll reason is used for capturing the reason for unenrolling the customer from the program.: * `LSSL` - Life Support / Sensitive Load, * `CUSTOMEROPTOUT` - Customer Initiated Opt-Out, * `INACTIVESERVICE` - Inactive Service, * `INELIGIBLERATE` - Ineligible Rate
Nested Schema : UNENROLLPROGRAM_request_customerInfo
Type:
Show Source
object
-
cisAccountId: string
Maximum Length:
30
The CIS Account Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided. -
cisPersonId: string
Maximum Length:
30
The CIS Person Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided. -
name: string
Maximum Length:
254
The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment.
Nested Schema : ENROLLPROGRAM_request_locationInfo
Type:
Show Source
object
-
address1: string
Maximum Length:
254
TThe first line of the address. Used to derive the metered service point associated to the enrollment. -
address2: string
Maximum Length:
254
The second line of the address. Used to derive the metered service point associated to the enrollment. -
address3: string
Maximum Length:
254
The third line of the address. Used to derive the metered service point associated to the enrollment. -
address4: string
Maximum Length:
254
The fourth line of the address. Used to derive the metered service point associated to the enrollment. -
cisPremiseId: string
Maximum Length:
14
The CIS Premise Id associated to the metered service point. This unique identifier is used to derive the metered service point associated to the enrollment. This value is optional if address information is provided. -
cisServicePointID: string
Maximum Length:
12
The CIS Service Point Id associated to the metered service point. This unique identifier is used to derive the metered service point associated to the enrollment. This value is optional if address information is provided. -
city: string
Maximum Length:
90
The city of the address. Used to derive the metered service point associated to the enrollment. -
country: string
Maximum Length:
3
The country of the address. Used to derive the metered service point associated to the enrollment. This value is optional if address information is provided. -
county: string
Maximum Length:
90
The county of the address. Used to derive the metered service point associated to the enrollment. -
division: string
Maximum Length:
30
Division is used to define the jurisdiction in which the customer is located. A utility name or acronym is commonly used for division, while state information can be used for utilities that operate across multiple regions. -
postal: string
Maximum Length:
12
The postal code of the address. Used to derive the metered service point associated to the enrollment. -
state: string
Maximum Length:
6
The state of the address. Used to derive the metered service point associated to the enrollment. -
timeZone: string
Maximum Length:
10
Time Zone
Root Schema : schema
Type:
Show Source
object
-
customerInfo: object
UNENROLLPROGRAM_request_customerInfo
-
locationInfo: object
ENROLLPROGRAM_request_locationInfo
-
transactionId: string
Maximum Length:
120
Unique external Transaction identifier created by the external source application (for example, Grid Edge Distributed Energy Resource Management System) -
unenrollReason: string
Allowed Values:
[ "LSSL", "CUSTOMEROPTOUT", "INACTIVESERVICE", "INELIGIBLERATE" ]
Unenroll reason is used for capturing the reason for unenrolling the customer from the program.: * `LSSL` - Life Support / Sensitive Load, * `CUSTOMEROPTOUT` - Customer Initiated Opt-Out, * `INACTIVESERVICE` - Inactive Service, * `INELIGIBLERATE` - Ineligible Rate
Nested Schema : UNENROLLPROGRAM_request_customerInfo
Type:
Show Source
object
-
cisAccountId: string
Maximum Length:
30
The CIS Account Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided. -
cisPersonId: string
Maximum Length:
30
The CIS Person Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided. -
name: string
Maximum Length:
254
The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment.
Nested Schema : ENROLLPROGRAM_request_locationInfo
Type:
Show Source
object
-
address1: string
Maximum Length:
254
TThe first line of the address. Used to derive the metered service point associated to the enrollment. -
address2: string
Maximum Length:
254
The second line of the address. Used to derive the metered service point associated to the enrollment. -
address3: string
Maximum Length:
254
The third line of the address. Used to derive the metered service point associated to the enrollment. -
address4: string
Maximum Length:
254
The fourth line of the address. Used to derive the metered service point associated to the enrollment. -
cisPremiseId: string
Maximum Length:
14
The CIS Premise Id associated to the metered service point. This unique identifier is used to derive the metered service point associated to the enrollment. This value is optional if address information is provided. -
cisServicePointID: string
Maximum Length:
12
The CIS Service Point Id associated to the metered service point. This unique identifier is used to derive the metered service point associated to the enrollment. This value is optional if address information is provided. -
city: string
Maximum Length:
90
The city of the address. Used to derive the metered service point associated to the enrollment. -
country: string
Maximum Length:
3
The country of the address. Used to derive the metered service point associated to the enrollment. This value is optional if address information is provided. -
county: string
Maximum Length:
90
The county of the address. Used to derive the metered service point associated to the enrollment. -
division: string
Maximum Length:
30
Division is used to define the jurisdiction in which the customer is located. A utility name or acronym is commonly used for division, while state information can be used for utilities that operate across multiple regions. -
postal: string
Maximum Length:
12
The postal code of the address. Used to derive the metered service point associated to the enrollment. -
state: string
Maximum Length:
6
The state of the address. Used to derive the metered service point associated to the enrollment. -
timeZone: string
Maximum Length:
10
Time Zone
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : X1-DAUnenrol
Type:
Show Source
object
-
exception: object
ENROLLPROGRAM_response_exception
-
status: string
Maximum Length:
12
Status of the Enrollment based on business object lifecycle. -
transactionId: string
Maximum Length:
120
External Transaction identifier created initially by the external source application (for example, Grid Edge Distributed Energy Resource Management System) -
unenrollmentId: string
Maximum Length:
4
Unenrollment identifier created by Oracle Utilities Digital Asset Cloud Service for each individual unenrollment record
Nested Schema : ENROLLPROGRAM_response_exception
Type:
Show Source
object
-
expandedMessage: string
Maximum Length:
60
Expanded message parameter -
messageCategory: string
Maximum Length:
5
Message Category -
messageNumber: string
Maximum Length:
5
Message Number
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
problemDetailDocument_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 : problemDetailDocument_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
problemDetailDocument_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 : problemDetailDocument_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.