Create Program Enrollment
post
https://server:port/rest/apis/cross/digitalAssets/programEnrollments/enroll
This REST web service processes a customer's enrollment request to 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
-
assetInfo: object
ENROLLPROGRAM_request_assetInfo
-
customerInfo: object
ENROLLPROGRAM_request_customerInfo
-
locationInfo: object
ENROLLPROGRAM_request_locationInfo
-
programInfo: object
ENROLLPROGRAM_request_programInfo
-
transactionId: string
Maximum Length:
120
Unique external transaction identifier created by an external source application such as the Oracle Utilities Grid Edge Distributed Energy Resource Management System.
Nested Schema : ENROLLPROGRAM_request_assetInfo
Type:
Show Source
object
-
assetList: array
assetList
-
assetOwnership: string
Allowed Values:
[ "W1CO", "W1OW" ]
Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC ID, head end system) must be provided for the enrollment process to create the device record and attach it to the device location. * `W1CO` - Customer Owned, * `W1OW` - Utility Owned -
installationMethod: string
Allowed Values:
[ "X1SD", "X1SI", "X1UI" ]
Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location. * `X1SD` - Ship Device, * `X1SI` - Bring Your Own, * `X1UI` - Utility Installation
Nested Schema : ENROLLPROGRAM_request_customerInfo
Type:
Show Source
object
-
businessPhone: string
Maximum Length:
24
The business phone of the customer. This value is used to derive the existing customer and metered service record associated to the enrollment. -
cisAccountId: string
Maximum Length:
30
The CIS Account Id associated to the metered service point. This unique identifier is used to derive the existing customer and metered service record associated to the enrollment. This value is optional if name is provided. -
cisPersonId: string
Maximum Length:
30
The CIS Person Id associated to the metered service point. This unique identifier is used to derive the existing customer and metered service record associated to the enrollment. This value is optional if name is provided. -
email: string
Maximum Length:
254
The email address of the customer. Data validation is not performed and must be done prior to entry using this resource if required. -
homePhone: string
Maximum Length:
24
The home phone of the customer. This value is used to derive the existing customer and metered service record associated to the enrollment. -
name: string
Maximum Length:
254
The name of the customer which is commonly in Last Name, First Name syntax. Refer to your CIS to confirm the required syntax. This value is used to derive the existing customer and metered service record associated to the enrollment. -
qualificationQuestions: object
ENROLLPROGRAM_request_customerInfo_qualificationQuestions
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
Nested Schema : ENROLLPROGRAM_request_programInfo
Type:
Show Source
object
-
cisServiceAgreementId: string
Maximum Length:
10
The CIS Service Agreement Identifer associated to the metered service. This unique identifier is used to derive the metered service associated to the enrollment. This value is optional if address information is provided. -
programCode: string
Maximum Length:
120
Program code of the program being enrolled. Refer to your applicable program codes for allowable values. -
startDate: string
(date)
The desired start date of the enrollment.
Nested Schema : ENROLLPROGRAM_request_assetInfo_assetList
Type:
Show Source
object
-
assetId: string
Maximum Length:
12
Asset identifier created by Oracle Utilities Digital Asset Cloud Service for each individual asset record. For customer owned devices, this value is not applicable and the specification values are required for the enrollment process to create the controllable device record. -
assetType: string
Maximum Length:
30
Asset Type, along with the specification, is used to define the type of controllable device. Asset type defines the kind of asset in context of its specification, such as Smart Thermostat, Battery, or Smart Inverter. For customer owned devices, these values are required for the enrollment process to create the controllable device record. -
badgeNo: string
Maximum Length:
60
Badge number of the controllable device. This value is optional. When provided, badge number is recorded on the controllable device record for bring your own device enrollments. -
headEndSystem: string
Maximum Length:
30
Head end system, along with the Network Interface Card Identifier, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record. -
nicId: string
Maximum Length:
60
Head end system, along with the Network Interface Card Identifier, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record. -
sequence: number
Minimum Value:
0
Maximum Value:999
The list enables the capturing of the details for each individual asset. -
serialNo: string
Maximum Length:
60
Serial number of the controllable device. This value is optional. When provided, serial number is recorded on the controllable device record for bring your own device enrollments. -
specification: string
Maximum Length:
30
Specification, along with the asset type, is used to define the type of controllable device. Specification characterizes a group of device specific attributes such as Manufacturer, Model, and Head End System. For customer owned devices, these values are required for the enrollment process to create the controllable device record.
Nested Schema : ENROLLPROGRAM_request_customerInfo_qualificationQuestions_qualificationQuestionsList
Type:
Show Source
object
-
answer: string
(answer)
-
question: string
(question)
-
response: string
(response)
Root Schema : schema
Type:
Show Source
object
-
assetInfo: object
ENROLLPROGRAM_request_assetInfo
-
customerInfo: object
ENROLLPROGRAM_request_customerInfo
-
locationInfo: object
ENROLLPROGRAM_request_locationInfo
-
programInfo: object
ENROLLPROGRAM_request_programInfo
-
transactionId: string
Maximum Length:
120
Unique external transaction identifier created by an external source application such as the Oracle Utilities Grid Edge Distributed Energy Resource Management System.
Nested Schema : ENROLLPROGRAM_request_assetInfo
Type:
Show Source
object
-
assetList: array
assetList
-
assetOwnership: string
Allowed Values:
[ "W1CO", "W1OW" ]
Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC ID, head end system) must be provided for the enrollment process to create the device record and attach it to the device location. * `W1CO` - Customer Owned, * `W1OW` - Utility Owned -
installationMethod: string
Allowed Values:
[ "X1SD", "X1SI", "X1UI" ]
Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location. * `X1SD` - Ship Device, * `X1SI` - Bring Your Own, * `X1UI` - Utility Installation
Nested Schema : ENROLLPROGRAM_request_customerInfo
Type:
Show Source
object
-
businessPhone: string
Maximum Length:
24
The business phone of the customer. This value is used to derive the existing customer and metered service record associated to the enrollment. -
cisAccountId: string
Maximum Length:
30
The CIS Account Id associated to the metered service point. This unique identifier is used to derive the existing customer and metered service record associated to the enrollment. This value is optional if name is provided. -
cisPersonId: string
Maximum Length:
30
The CIS Person Id associated to the metered service point. This unique identifier is used to derive the existing customer and metered service record associated to the enrollment. This value is optional if name is provided. -
email: string
Maximum Length:
254
The email address of the customer. Data validation is not performed and must be done prior to entry using this resource if required. -
homePhone: string
Maximum Length:
24
The home phone of the customer. This value is used to derive the existing customer and metered service record associated to the enrollment. -
name: string
Maximum Length:
254
The name of the customer which is commonly in Last Name, First Name syntax. Refer to your CIS to confirm the required syntax. This value is used to derive the existing customer and metered service record associated to the enrollment. -
qualificationQuestions: object
ENROLLPROGRAM_request_customerInfo_qualificationQuestions
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
Nested Schema : ENROLLPROGRAM_request_programInfo
Type:
Show Source
object
-
cisServiceAgreementId: string
Maximum Length:
10
The CIS Service Agreement Identifer associated to the metered service. This unique identifier is used to derive the metered service associated to the enrollment. This value is optional if address information is provided. -
programCode: string
Maximum Length:
120
Program code of the program being enrolled. Refer to your applicable program codes for allowable values. -
startDate: string
(date)
The desired start date of the enrollment.
Nested Schema : ENROLLPROGRAM_request_assetInfo_assetList
Type:
Show Source
object
-
assetId: string
Maximum Length:
12
Asset identifier created by Oracle Utilities Digital Asset Cloud Service for each individual asset record. For customer owned devices, this value is not applicable and the specification values are required for the enrollment process to create the controllable device record. -
assetType: string
Maximum Length:
30
Asset Type, along with the specification, is used to define the type of controllable device. Asset type defines the kind of asset in context of its specification, such as Smart Thermostat, Battery, or Smart Inverter. For customer owned devices, these values are required for the enrollment process to create the controllable device record. -
badgeNo: string
Maximum Length:
60
Badge number of the controllable device. This value is optional. When provided, badge number is recorded on the controllable device record for bring your own device enrollments. -
headEndSystem: string
Maximum Length:
30
Head end system, along with the Network Interface Card Identifier, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record. -
nicId: string
Maximum Length:
60
Head end system, along with the Network Interface Card Identifier, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record. -
sequence: number
Minimum Value:
0
Maximum Value:999
The list enables the capturing of the details for each individual asset. -
serialNo: string
Maximum Length:
60
Serial number of the controllable device. This value is optional. When provided, serial number is recorded on the controllable device record for bring your own device enrollments. -
specification: string
Maximum Length:
30
Specification, along with the asset type, is used to define the type of controllable device. Specification characterizes a group of device specific attributes such as Manufacturer, Model, and Head End System. For customer owned devices, these values are required for the enrollment process to create the controllable device record.
Nested Schema : ENROLLPROGRAM_request_customerInfo_qualificationQuestions_qualificationQuestionsList
Type:
Show Source
object
-
answer: string
(answer)
-
question: string
(question)
-
response: string
(response)
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : X1-DAEnroll
Type:
Show Source
object
-
enrollmentId: string
Maximum Length:
4
Enrollment identifier created by Oracle Utilities Digital Asset Cloud Service for each individual enrollment record -
exception: object
ENROLLPROGRAM_response_exception
-
status: string
Maximum Length:
12
Status of the program enrollment based on business object lifecycle. -
transactionId: string
Maximum Length:
120
External transaction identifier created initially by the external source application, such as the Grid Edge Distributed Energy Resource Management System
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
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.