{ "openapi":"3.0.0", "info":{ "title":"Oracle Utilities REST API for Customer Program Management", "description":"This documentation helps you to get started using the REST APIs for Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Digital Asset Management.", "version":"2026.03.11", "x-summary":"This documentation helps you to get started using the REST APIs for Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Digital Asset Management." }, "tags":[ { "name":"Digital Assets/Controllable Device Status", "description":"A controllable device is a remotely managed device, such as thermostats, smart inverters, batteries, and photovoltaic solar panels, installed at a specific location, capable of participating in utility programs and events such as demand response. Upon successful installation, these devices typically report their communication status, indicating whether they are online or offline." }, { "name":"Digital Assets/DER Device Management", "description":"DER (Distributed Energy Resource) device management enables interconnection and registration of DER assets." }, { "name":"Digital Assets/Program Eligibility and Qualification Questions", "description":"A customer's eligibility for specific programs can be determined through evaluation against a set of eligibility criteria configured for each program and against the answers to a configurable set of qualification questions during enrollment." }, { "name":"Digital Assets/Program Enrollments", "description":"Program Enrollments is the process of linking a customer, a specific program, and where applicable a device location with a controllable device, creating a program subscription that officially records the customer's participation." }, { "name":"Digital Assets/Work Activity Appointment Tasks", "description":"Work Activity Appointment Tasks enable scheduling or rescheduling appointments within available time slots, based on the crew needed for a specific work order activity." }, { "name":"Service/Program Event", "description":"Program Events represent instances where a utility takes control of a set of controllable assets in response to demand. For example, during a heat wave, a utility may wish to adjust the thermostats (controllable assets) during peak usage times to help alleviate demand. Events can be created and maintained from an external system responsible for calling the events based on conditions." }, { "name":"Service/Program Event Participation", "description":"Program Event Participation records capture the participation of a controllable device in a program event. When a program event is planned, an external system sends a list of devices and the date/time information to \"reserve\" the devices for the event, and event participation records are created. Once the event is complete, the external system sends a list of impacted devices and the status of each. These details are captured in event participation records." } ], "paths":{ "/rest/apis/cross/digitalAssets/programEnrollments/enrollDevice":{ "post":{ "summary":"Enroll Additional Device Service", "description":"This operation enrolls an additional device to a customer's existing program enrollment. The device can be customer-owned or shipped from the utility.", "operationId":"enrollDevice", "tags":[ "Digital Assets/Program Enrollments" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ENROLLDEVICE_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ENROLLDEVICE_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ENROLLDEVICE_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ENROLLDEVICE_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-digitalAssets-programEnrollments-enrollDevice-post", "x-filename-id":"rest-apis-cross-digitalassets-programenrollments-enrolldevice-post" } }, "/rest/apis/cross/digitalAssets/programEnrollments/enroll":{ "post":{ "summary":"Create Program Enrollment", "description":"This operation processes a customer's program enrollment request.", "operationId":"enrollProgram", "tags":[ "Digital Assets/Program Enrollments" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ENROLLPROGRAM_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ENROLLPROGRAM_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ENROLLPROGRAM_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ENROLLPROGRAM_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-digitalAssets-programEnrollments-enroll-post", "x-filename-id":"rest-apis-cross-digitalassets-programenrollments-enroll-post" } }, "/rest/apis/cross/digitalAssets/programEnrollments/unenroll":{ "post":{ "summary":"Create Program Unenrollment", "description":"This operation handles a customer's request to unenroll from a program.", "operationId":"unenrollProgram", "tags":[ "Digital Assets/Program Enrollments" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UNENROLLPROGRAM_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UNENROLLPROGRAM_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UNENROLLPROGRAM_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UNENROLLPROGRAM_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-digitalAssets-programEnrollments-unenroll-post", "x-filename-id":"rest-apis-cross-digitalassets-programenrollments-unenroll-post" } }, "/rest/apis/cross/digitalAssets/programEnrollments/unenroll/{Unenrollment Id}":{ "get":{ "summary":"Get Program Unenrollment", "description":"This operation retrieves a customer's program unenrollment request status.", "operationId":"getProgramUnenrollment", "parameters":[ { "in":"path", "name":"Unenrollment Id", "required":true, "schema":{ "type":"string" } } ], "tags":[ "Digital Assets/Program Enrollments" ], "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GETPROGRAMUNENROLLMENT_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GETPROGRAMUNENROLLMENT_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-digitalAssets-programEnrollments-unenroll-{Unenrollment Id}-get", "x-filename-id":"rest-apis-cross-digitalassets-programenrollments-unenroll-unenrollment-id-get" } }, "/rest/apis/cross/digitalAssets/programEnrollments/postAcknowledgement":{ "post":{ "summary":"Post Acknowledgement", "description":"This operation returns the registration status of the controllable device with its head-end system.", "operationId":"postAcknowledgement", "tags":[ "Digital Assets/Program Enrollments" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/POSTACKNOWLEDGEMENT_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/POSTACKNOWLEDGEMENT_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/POSTACKNOWLEDGEMENT_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/POSTACKNOWLEDGEMENT_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-digitalAssets-programEnrollments-postAcknowledgement-post", "x-filename-id":"rest-apis-cross-digitalassets-programenrollments-postacknowledgement-post" } }, "/rest/apis/cross/digitalAssets/programEnrollments/enroll/{Enrollment Id}":{ "get":{ "summary":"Get Program Enrollment", "description":"This operation retrieves the status of a customer's program enrollment request.", "operationId":"getProgramEnrollment", "parameters":[ { "in":"path", "name":"Enrollment Id", "required":true, "schema":{ "type":"string" }, "description":"Enrollment identifier created by the system for each individual enrollment record." } ], "tags":[ "Digital Assets/Program Enrollments" ], "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GETPROGRAMENROLLMENT_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GETPROGRAMENROLLMENT_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-digitalAssets-programEnrollments-enroll-{Enrollment Id}-get", "x-filename-id":"rest-apis-cross-digitalassets-programenrollments-enroll-enrollment-id-get" } }, "/rest/apis/cross/service/programEventParticipation/reserveDevice":{ "post":{ "summary":"Reserve Device", "description":"This operation creates program event participation records to reserve devices enrolled in a program for an upcoming event.", "operationId":"reserveDevice", "tags":[ "Service/Program Event Participation" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RESERVEDEVICE_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/RESERVEDEVICE_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RESERVEDEVICE_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/RESERVEDEVICE_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-service-programEventParticipation-reserveDevice-post", "x-filename-id":"rest-apis-cross-service-programeventparticipation-reservedevice-post" } }, "/rest/apis/cross/service/programEventParticipation/postEventOutcome":{ "post":{ "summary":"Post Event Outcome", "description":"This operation posts the outcome of a concluded program event participation.", "operationId":"postEventOutcome", "tags":[ "Service/Program Event Participation" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/POSTEVENTOUTCOME_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/POSTEVENTOUTCOME_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/POSTEVENTOUTCOME_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/POSTEVENTOUTCOME_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-service-programEventParticipation-postEventOutcome-post", "x-filename-id":"rest-apis-cross-service-programeventparticipation-posteventoutcome-post" } }, "/rest/apis/cross/digitalAssets/controllableDeviceStatus/response":{ "post":{ "summary":"Post Controllable Device Status Check", "description":"This operation asynchronously provides the controllable device's communication status in response to a device status check request. It is the asynchronous counterpart to the Controllable Device - Device Status Check request.", "operationId":"postControllableDeviceStatus", "tags":[ "Digital Assets/Controllable Device Status" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/POSTCONTROLLABLEDEVICESTATUS_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/POSTCONTROLLABLEDEVICESTATUS_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/POSTCONTROLLABLEDEVICESTATUS_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/POSTCONTROLLABLEDEVICESTATUS_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-digitalAssets-controllableDeviceStatus-response-post", "x-filename-id":"rest-apis-cross-digitalassets-controllabledevicestatus-response-post" } }, "/rest/apis/cross/service/programEvent/":{ "post":{ "summary":"Create Program Event", "description":"This operation creates a program event.", "operationId":"createProgramEvent", "tags":[ "Service/Program Event" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CREATEPROGRAMEVENT_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CREATEPROGRAMEVENT_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CREATEPROGRAMEVENT_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CREATEPROGRAMEVENT_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-service-programEvent--post", "x-filename-id":"rest-apis-cross-service-programevent-post" } }, "/rest/apis/cross/service/programEvent/lifecycle":{ "post":{ "summary":"Action Program Event", "description":"This operation transitions the status of a program event.", "operationId":"actionProgramEvent", "tags":[ "Service/Program Event" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ACTIONPROGRAMEVENT_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ACTIONPROGRAMEVENT_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ACTIONPROGRAMEVENT_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ACTIONPROGRAMEVENT_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-service-programEvent-lifecycle-post", "x-filename-id":"rest-apis-cross-service-programevent-lifecycle-post" } }, "/rest/apis/cross/digitalAssets/derDeviceManagement/register":{ "post":{ "summary":"Register DER Device", "description":"This operation registers a Distributed Energy Resources (DER) device along with its IEEE 2030.5 nameplate ratings.", "operationId":"registerDERDevice", "tags":[ "Digital Assets/DER Device Management" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/REGISTERDERDEVICE_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/REGISTERDERDEVICE_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/REGISTERDERDEVICE_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/REGISTERDERDEVICE_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-digitalAssets-derDeviceManagement-register-post", "x-filename-id":"rest-apis-cross-digitalassets-derdevicemanagement-register-post" } }, "/rest/apis/cross/digitalAssets/derDeviceManagement/interconnect":{ "post":{ "summary":"DER Interconnection", "description":"This operation records the interconnection details of a Distributed Energy Resources (DER) device.", "operationId":"interconnectDER", "tags":[ "Digital Assets/DER Device Management" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/INTERCONNECTDER_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/INTERCONNECTDER_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/INTERCONNECTDER_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/INTERCONNECTDER_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-digitalAssets-derDeviceManagement-interconnect-post", "x-filename-id":"rest-apis-cross-digitalassets-derdevicemanagement-interconnect-post" } }, "/rest/apis/cross/digitalAssets/appointmentSlots/availableSlots":{ "post":{ "summary":"Get Work Activity Appointment Slots", "description":"This operation returns available appointment slots over a date range for the type of crew required for a specified work order activity.", "operationId":"getAppointmentSlots", "tags":[ "Digital Assets/Work Activity Appointment Tasks" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GETAPPOINTMENTSLOTS_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GETAPPOINTMENTSLOTS_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GETAPPOINTMENTSLOTS_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GETAPPOINTMENTSLOTS_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-digitalAssets-appointmentSlots-availableSlots-post", "x-filename-id":"rest-apis-cross-digitalassets-appointmentslots-availableslots-post" } }, "/rest/apis/cross/digitalAssets/appointmentSlots/schedule":{ "post":{ "summary":"Schedule Activity", "description":"This operation enables scheduling or rescheduling of work activities based on configured crew-shifts and available time slots.", "operationId":"scheduleAppointment", "tags":[ "Digital Assets/Work Activity Appointment Tasks" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SCHEDULEAPPOINTMENT_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SCHEDULEAPPOINTMENT_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SCHEDULEAPPOINTMENT_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SCHEDULEAPPOINTMENT_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-digitalAssets-appointmentSlots-schedule-post", "x-filename-id":"rest-apis-cross-digitalassets-appointmentslots-schedule-post" } }, "/rest/apis/cross/digitalAssets/programEligibilityAndQualification/":{ "post":{ "summary":"Get Eligible Programs", "description":"This operation returns the eligible programs for a customer.", "operationId":"getEligiblePrograms", "tags":[ "Digital Assets/Program Eligibility and Qualification Questions" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GETELIGIBLEPROGRAMS_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GETELIGIBLEPROGRAMS_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GETELIGIBLEPROGRAMS_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GETELIGIBLEPROGRAMS_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-digitalAssets-programEligibilityAndQualification--post", "x-filename-id":"rest-apis-cross-digitalassets-programeligibilityandqualification-post" } }, "/rest/apis/cross/digitalAssets/programEligibilityAndQualification/{Program Code}/qualificationQuestions":{ "get":{ "summary":"Get Qualification Questions", "description":"This operation returns the qualification questions to be asked during a program enrollment, along with the expected answers required for the customer to qualify.", "operationId":"getQualifyingQuestions", "parameters":[ { "in":"path", "name":"Program Code", "required":true, "schema":{ "type":"string" } } ], "tags":[ "Digital Assets/Program Eligibility and Qualification Questions" ], "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GETQUALIFYINGQUESTIONS_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GETQUALIFYINGQUESTIONS_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-digitalAssets-programEligibilityAndQualification-{Program Code}-qualificationQuestions-get", "x-filename-id":"rest-apis-cross-digitalassets-programeligibilityandqualification-program-code-qualificationquestions-get" } }, "/rest/apis/cross/digitalAssets/programEligibilityAndQualification/{Program Code}/informationalQuestions":{ "get":{ "summary":"Get Informational Questions", "description":"This operation returns the informational questions to be asked during a customer program enrollment.", "operationId":"getInformationalQuestions", "parameters":[ { "in":"path", "name":"Program Code", "required":true, "schema":{ "type":"string" } } ], "tags":[ "Digital Assets/Program Eligibility and Qualification Questions" ], "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GETINFORMATIONALQUESTIONS_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GETINFORMATIONALQUESTIONS_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"rest-apis-cross-digitalAssets-programEligibilityAndQualification-{Program Code}-informationalQuestions-get", "x-filename-id":"rest-apis-cross-digitalassets-programeligibilityandqualification-program-code-informationalquestions-get" } } }, "components":{ "securitySchemes":{ "BasicAuth":{ "type":"http", "scheme":"basic" } }, "schemas":{ "ENROLLDEVICE_response":{ "type":"object", "properties":{ "serviceTaskId":{ "type":"string", "maxLength":14, "description":"Service Task ID" }, "status":{ "type":"string", "maxLength":12, "description":"Status of the program enrollment based on business object lifecycle." }, "exception":{ "type":"object", "properties":{ "messageCategory":{ "type":"string", "maxLength":5, "description":"Message Category" }, "messageNumber":{ "type":"string", "maxLength":5, "description":"Message Number" }, "expandedMessage":{ "type":"string", "maxLength":60, "description":"Expanded message parameter" } } } }, "xml":{ "name":"X1DAAdEnroll" } }, "GETPROGRAMUNENROLLMENT_response":{ "type":"object", "properties":{ "unenrollmentId":{ "type":"string", "maxLength":4, "description":"Unenrollment ID" }, "transactionId":{ "type":"string", "maxLength":120, "description":"Unique external transaction identifier created by an external source application such as the Oracle Utilities Grid Edge Distributed Energy Resource Management System." }, "status":{ "type":"string", "maxLength":12, "description":"Status of the program enrollment based on business object lifecycle." }, "relatedObjects":{ "type":"object", "properties":{ "contactId":{ "type":"string", "maxLength":12, "description":"A unique identifier associated to the customer contact within the system." }, "subscriptionId":{ "type":"string", "maxLength":12, "description":"A unique identifier associated to a program subscription within the system." }, "locationId":{ "type":"string", "maxLength":12, "description":"A unique identifier associated to a device location within the system." } } }, "unenrollReason":{ "type":"string", "enum":[ "ZZ Customer move out", "ZZ_UNENROLLTEST" ], "description":"Unenroll Reason: * `LSSL` - Life Support / Sensitive Load, * `CUSTOMEROPTOUT` - Customer Initiated Opt-Out, * `INACTIVESERVICE` - Inactive Service, * `INELIGIBLERATE` - Ineligible Rate\n* `ZZ Customer move out` - ZZ Customer move out (Appr Req),\n* `ZZ_UNENROLLTEST` - ZZ UNENROLL TEST REASON (appr not req)" }, "customerInfo":{ "type":"object", "properties":{ "cisPersonId":{ "type":"string", "maxLength":30, "description":"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." }, "cisAccountId":{ "type":"string", "maxLength":30, "description":"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." }, "name":{ "type":"string", "maxLength":254, "description":"The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment." }, "homePhone":{ "type":"string", "maxLength":24, "description":"The home phone of the customer. Used to derive the existing customer and metered service record associated to the enrollment." }, "businessPhone":{ "type":"string", "maxLength":24, "description":"The business phone of the customer. Used to derive the existing customer and metered service record associated to the enrollment." }, "email":{ "type":"string", "maxLength":254, "description":"The email address of the customer. Used to derive the existing customer and metered service record associated to the enrollment." } } }, "programInfo":{ "type":"object", "properties":{ "programId":{ "type":"string", "maxLength":12, "description":"Program" }, "endDate":{ "type":"string", "format":"date", "description":"The desired application date of unenrollment." } } }, "locationInfo":{ "type":"object", "properties":{ "cisPremiseId":{ "type":"string", "maxLength":60, "description":"The CIS Premise Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided." }, "cisServicePointID":{ "type":"string", "maxLength":60, "description":"The CIS Service Point Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided." }, "division":{ "type":"string", "maxLength":30, "description":"Division is used to define the jurisdiction in which the customer is located." }, "timeZone":{ "type":"string", "maxLength":10, "description":"Time Zone" }, "country":{ "type":"string", "maxLength":3, "description":"The country of the address. Used to derive the metered service point associated to the enrollment." }, "address1":{ "type":"string", "maxLength":254, "description":"The first line of the address. Used to derive the metered service point associated to the enrollment." }, "address2":{ "type":"string", "maxLength":254, "description":"The second line of the address. Used to derive the metered service point associated to the enrollment." }, "address3":{ "type":"string", "maxLength":254, "description":"The third line of the address. Used to derive the metered service point associated to the enrollment." }, "address4":{ "type":"string", "maxLength":254, "description":"The fourth line of the address. Used to derive the metered service point associated to the enrollment." }, "city":{ "type":"string", "maxLength":90, "description":"The city of the address. Used to derive the metered service point associated to the enrollment." }, "county":{ "type":"string", "maxLength":90, "description":"The county of the address. Used to derive the metered service point associated to the enrollment." }, "state":{ "type":"string", "maxLength":6, "description":"The state of the address. Used to derive the metered service point associated to the enrollment." }, "postal":{ "type":"string", "maxLength":12, "description":"The postal code of the address. Used to derive the metered service point associated to the enrollment." } } }, "assetInfo":{ "type":"object", "properties":{ "removalMethod":{ "type":"string", "enum":[ "X1KP", "X1SD", "X1UR" ], "description":"Removal Method:\n* `X1KP` - Keep,\n* `X1SD` - Ship Device,\n* `X1UR` - Utility Removal" }, "assetOwnership":{ "type":"string", "enum":[ "W1CO", "W1OW" ], "description":"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.\n* `W1CO` - Customer Owned,\n* `W1OW` - Utility Owned" } } }, "deviceSetup":{ "type":"object", "properties":{ "deviceSetupActionsList":{ "type":"array", "items":{ "type":"object", "properties":{ "sequence":{ "type":"number", "maximum":999, "minimum":0, "description":"Sequence" }, "setupAction":{ "type":"string", "enum":[ "X1AC", "X1DC", "X1NA", "X1TD", "X1WO" ], "description":"Setup Action:\n* `X1AC` - Create Activity,\n* `X1DC` - Initiate Controllable Device Command,\n* `X1NA` - No Action Needed,\n* `X1TD` - Create To Do,\n* `X1WO` - Create Work Order" }, "toDoType":{ "type":"string", "maxLength":8, "description":"To Do Type refers to the categorization of certain events that occur within the system and trigger messages describing work that requires attention." }, "toDoRole":{ "type":"string", "maxLength":10, "description":"To Do Roles are assigned to users and are referenced by a to do entry created by the system." }, "toDoId":{ "type":"string", "maxLength":14, "description":"To do entry refers to certain events that occur within the system and trigger messages describing work that requires attention." }, "activityType":{ "type":"string", "maxLength":30, "description":"Activity Type defines the main attributes for activities of a certain type and acts as a model and template for activity records." }, "fieldTaskType":{ "type":"string", "enum":[ "ZZ_TEST_METERINSPECT", "ZZ-Meter Inspection", "ZZ_Appnt_Field_Typ", "D1-DisconnectItemSPAtSource", "D1-ConnectSPAtSourceAndTurnOn", "D1-DisconnectSPAtSource", "ZZ-InstallMeter", "D1-ExchangeMeter", "ZZ-OdmAndSomDup", "ZZ-SomAndOdm4", "D1-DisConnSPAtDvcAndRmveDvc", "D1-TurnOffItem", "ZZ-TrimTree", "D1-ConnSPAtSrceAndInstMtr", "D1-TurnOnMeter", "D1-DisConnSPAtSrceAndRmveMtr", "D1-ReconnectItemforPayment", "D1-TurnOffMeter", "ZZ-SomAndOdm5", "ZZ-SomAndOdm6", "D1-DisconnectSPAtDevice", "ZZ-MeterInspection", "D1-InstallDevice", "ZZSSFTT4", "D1-ConnSPAtDvcAndInstDvc", "ZZPO_TestSOMEI", "ZZSSFTT3", "ZZSSFTT2", "D1-ConnectSPAtSource", "D1-DisconnectSPAtMeter", "ZZ-OdmAndSom15", "D1-ServiceInvestigation", "D1-DisConnSPAtMtrAndRmveMtr", "ZZ-MnlDemo1", "ZZ-ODMandSOM", "ZZ-MnlDemo4", "ZZ-MnlDemo3", "X1-InvestigateControllableDevice", "ZZ-MnlDemo7", "D1-ConnectSPAtSourceAndInstallMeter", "D1-RemoveDevice", "D1-ExchangeDevice", "X1-InstallControllableDevice", "ZZ-Meter Inspection-2", "D1-DisconnectWarning", "D1-MaintainEquipment", "ZZ-FaTypKK", "ZZSAFTT", "ZZ-TestDevice", "D1-CutForNonPayment", "ZZ-MaintainFireHydrant", "ZZ_Mgmt_FieldTskTyp", "D1-ConnectSPAtMeterAndTurnOn", "ZZ_HC_Field_task_type", "D1-ConnectSPAtDevice", "ZZ-OdmAndSom3", "ZZSAFTT_2", "ZZ-OdmAndSom2", "ZZPO-SOMACTTYP", "D1-ConnSPAtSrceAndTurnOnDvc", "D1-TurnOnPilotLight", "ZZ-ExchangeMeter", "ZZYC_MeterInspection", "D1-ConnSPAtSrceAndInstDvc", "D1-ConnectSPAtMeter", "ZZ-BookAppnt", "ZZAT-TrimTree", "D1-InstallMeter", "D1-ReconnectForPayment", "D1-ConnectSPAtDvcAndTurnOn", "D1-TrimTree", "ZZLJP_TEST", "D1-ConnSPAtMtrAndInstMtr", "ZZ-ReadMeter", "D1-CutItemForNonPayment", "D1-RemoveMeter", "D1-TurnOnItem", "D1-ReadMeter", "ZZ-OdmAndSom8", "ZZ-OdmAndSom7", "ZZ_CPS_FIELD_TASK_TYPE" ], "description":"Field Task Type: * `X1-InvestigateControllableDevice` - Investigate Controllable Device, * `X1-InstallControllableDevice` - Install Controllable Device\n* `ZZ_TEST_METERINSPECT` - 00ZZ_TEST_METERINSPECT,\n* `ZZ-Meter Inspection` - ZZ PO ODM and SOM,\n* `ZZ_Appnt_Field_Typ` - ZZ Field Task Type for Mgmt Appnt 1,\n* `D1-DisconnectItemSPAtSource` - Disconnect SP at Source Item,\n* `D1-ConnectSPAtSourceAndTurnOn` - Connect SP at Source and Turn On,\n* `D1-DisconnectSPAtSource` - Disconnect SP at Source,\n* `ZZ-InstallMeter` - ZZ - Install Meter,\n* `D1-ExchangeMeter` - Exchange Meter,\n* `ZZ-OdmAndSomDup` - ZZ ODM and SOM 3,\n* `ZZ-SomAndOdm4` - ZZ SOM and ODM 4 Test,\n* `D1-DisConnSPAtDvcAndRmveDvc` - Disconnect SP from Item and Remove Item,\n* `D1-TurnOffItem` - Turn Off Item,\n* `ZZ-TrimTree` - Trim Tree,\n* `D1-ConnSPAtSrceAndInstMtr` - Connect SP at Source and Install Meter,\n* `D1-TurnOnMeter` - Turn On Meter,\n* `D1-DisConnSPAtSrceAndRmveMtr` - Disconnect SP at Source and Remove Meter,\n* `D1-ReconnectItemforPayment` - Reconnect Item for Payment,\n* `D1-TurnOffMeter` - Turn Off Meter,\n* `ZZ-SomAndOdm5` - ZZ SOM and ODM 5,\n* `ZZ-SomAndOdm6` - ZZ SOM and ODM 6,\n* `D1-DisconnectSPAtDevice` - Disconnect SP from Item,\n* `ZZ-MeterInspection` - Meter Inspection,\n* `D1-InstallDevice` - Install Item,\n* `ZZSSFTT4` - ZZSSFTT4 - 1,\n* `D1-ConnSPAtDvcAndInstDvc` - Connect SP to Item and Install Item,\n* `ZZPO_TestSOMEI` - ZZPO_TestSOM Export-Import,\n* `ZZSSFTT3` - ZZSSFTT3,\n* `ZZSSFTT2` - ZZSSFTT2 - 5,\n* `D1-ConnectSPAtSource` - Connect SP at Source,\n* `D1-DisconnectSPAtMeter` - Disconnect SP at Meter,\n* `ZZ-OdmAndSom15` - ZZ ODM and SOM 15,\n* `D1-ServiceInvestigation` - Service Investigation,\n* `D1-DisConnSPAtMtrAndRmveMtr` - Disconnect SP at Meter and Remove Meter,\n* `ZZ-MnlDemo1` - ZZ Manila Demo 1,\n* `ZZ-ODMandSOM` - ZZ KPA ODM and SOM,\n* `ZZ-MnlDemo4` - ZZ Manila Demo 4 Edit,\n* `ZZ-MnlDemo3` - ZZ Manila Demo 3,\n* `X1-InvestigateControllableDevice` - Investigate Controllable Device,\n* `ZZ-MnlDemo7` - ZZ Manila Demo 7,\n* `D1-ConnectSPAtSourceAndInstallMeter` - Connect SP at Source and Install Meter,\n* `D1-RemoveDevice` - Remove Item,\n* `D1-ExchangeDevice` - Exchange Item,\n* `X1-InstallControllableDevice` - Install Controllable Device,\n* `ZZ-Meter Inspection-2` - ZZ PO ODM and SOM-2,\n* `D1-DisconnectWarning` - Disconnect Warning,\n* `D1-MaintainEquipment` - Maintain SP and Meter Equipment,\n* `ZZ-FaTypKK` - Test Field Task Type - KK,\n* `ZZSAFTT` - ZZSAFTT-1,\n* `ZZ-TestDevice` - Test Device,\n* `D1-CutForNonPayment` - Cut for Non Payment,\n* `ZZ-MaintainFireHydrant` - Inspect Communication Relay,\n* `ZZ_Mgmt_FieldTskTyp` - ZZ Field Task Type for Mgmt Appnt,\n* `D1-ConnectSPAtMeterAndTurnOn` - Connect SP at Meter and Turn On,\n* `ZZ_HC_Field_task_type` - ZZ_HC Field task type12 123456,\n* `D1-ConnectSPAtDevice` - Connect SP to Item,\n* `ZZ-OdmAndSom3` - ZZ ODM and SOM 3,\n* `ZZSAFTT_2` - ZZSAFTT-2,\n* `ZZ-OdmAndSom2` - ZZ ODM and SOM 2,\n* `ZZPO-SOMACTTYP` - ZZPO-SOMACTTYP,\n* `D1-ConnSPAtSrceAndTurnOnDvc` - Connect SP at Source and Turn On Item,\n* `D1-TurnOnPilotLight` - Turn On Pilot Light,\n* `ZZ-ExchangeMeter` - Exchange Meter ZZ,\n* `ZZYC_MeterInspection` - 00ZZYC_MeterInspection,\n* `D1-ConnSPAtSrceAndInstDvc` - Connect SP at Source and Install Item,\n* `D1-ConnectSPAtMeter` - Connect SP at Meter,\n* `ZZ-BookAppnt` - Test Book Appointment - KK,\n* `ZZAT-TrimTree` - Trim Tree,\n* `D1-InstallMeter` - Install Meter,\n* `D1-ReconnectForPayment` - Reconnect for Payment,\n* `D1-ConnectSPAtDvcAndTurnOn` - Connect SP to Item and Turn On,\n* `D1-TrimTree` - Trim Tree,\n* `ZZLJP_TEST` - ZZLJP_TEST,\n* `D1-ConnSPAtMtrAndInstMtr` - Connect SP at Meter and Install Meter,\n* `ZZ-ReadMeter` - ZZ Read Meter,\n* `D1-CutItemForNonPayment` - Cut Item for Non Payment,\n* `D1-RemoveMeter` - Remove Meter,\n* `D1-TurnOnItem` - Turn On Item,\n* `D1-ReadMeter` - Read Meter,\n* `ZZ-OdmAndSom8` - ZZ ODM and SOM 8,\n* `ZZ-OdmAndSom7` - ZZ ODM and SOM 7,\n* `ZZ_CPS_FIELD_TASK_TYPE` - CPS Field Task Type Test" }, "activityId":{ "type":"string", "maxLength":14, "description":"Activity" }, "templateWorkOrderId":{ "type":"string", "maxLength":12, "description":"A unique identifier of a work order used as template for generating work orders." }, "workOrderId":{ "type":"string", "maxLength":14, "description":"A system generated unique identifier associated to each work order that is created." } } } } } }, "appointmentSlots":{ "type":"object", "properties":{ "crewShiftList":{ "type":"array", "items":{ "type":"object", "properties":{ "activityType":{ "type":"string", "maxLength":30, "description":"Activity Type defines the main attributes for activities of a certain type and acts as a model and template for activity records." }, "crewShiftId":{ "type":"string", "maxLength":14, "description":"Crew Shift ID" }, "startDateTime":{ "type":"string", "format":"date-time", "description":"Appointment start date and time for the scheduled work." }, "endDateTime":{ "type":"string", "format":"date-time", "description":"Appointment end date and time for the scheduled work." }, "crewId":{ "type":"string", "maxLength":12, "description":"Crew identifier for primary and secondary crew members that are assigned a particular work activity." }, "workAvailabilityDuration":{ "type":"number", "maximum":"99999999999.99", "minimum":0, "description":"Work availability expressed in hours for the particular crew." } } } } } }, "exception":{ "type":"object", "properties":{ "messageCategory":{ "type":"string", "maxLength":5, "description":"Message Category" }, "messageNumber":{ "type":"string", "maxLength":5, "description":"Message Number" }, "expandedMessage":{ "type":"string", "maxLength":60, "description":"Expanded message parameter" } } } }, "xml":{ "name":"X1-DAUnenrol" } }, "ENROLLDEVICE_request":{ "type":"object", "properties":{ "customerInfo":{ "type":"object", "properties":{ "cisPersonId":{ "type":"string", "maxLength":30, "description":"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." }, "cisAccountId":{ "type":"string", "maxLength":30, "description":"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." }, "name":{ "type":"string", "maxLength":254, "description":"The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment." }, "homePhone":{ "type":"string", "maxLength":24, "description":"Phone Number" }, "businessPhone":{ "type":"string", "maxLength":24, "description":"Phone Number" }, "contactNumber":{ "type":"string", "maxLength":24, "description":"Phone Number" }, "email":{ "type":"string", "maxLength":254, "description":"The email address of the customer. Used to derive the existing customer and metered service record associated to the enrollment." } } }, "programInfo":{ "type":"object", "properties":{ "cisServiceAgreementId":{ "type":"string", "maxLength":12, "description":"The CIS Service Agreement ID associated to the metered service. Optional." }, "programCode":{ "type":"string", "maxLength":120, "description":"Program Code of the program being enrolled" }, "startDate":{ "type":"string", "format":"date", "description":"The desired application date of the enrollment." } } }, "locationInfo":{ "type":"object", "properties":{ "cisPremiseId":{ "type":"string", "maxLength":60, "description":"The CIS Premise Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided." }, "cisServicePointID":{ "type":"string", "maxLength":60, "description":"The CIS Service Point Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided." }, "division":{ "type":"string", "maxLength":30, "description":"Division is used to define the jurisdiction in which the customer is located." }, "timeZone":{ "type":"string", "maxLength":10, "description":"Time Zone" }, "country":{ "type":"string", "maxLength":3, "description":"The country of the address. Used to derive the metered service point associated to the enrollment." }, "address1":{ "type":"string", "maxLength":254, "description":"The first line of the address. Used to derive the metered service point associated to the enrollment." }, "address2":{ "type":"string", "maxLength":254, "description":"The second line of the address. Used to derive the metered service point associated to the enrollment." }, "address3":{ "type":"string", "maxLength":254, "description":"The third line of the address. Used to derive the metered service point associated to the enrollment." }, "address4":{ "type":"string", "maxLength":254, "description":"The fourth line of the address. Used to derive the metered service point associated to the enrollment." }, "city":{ "type":"string", "maxLength":90, "description":"The city of the address. Used to derive the metered service point associated to the enrollment." }, "county":{ "type":"string", "maxLength":90, "description":"The county of the address. Used to derive the metered service point associated to the enrollment." }, "state":{ "type":"string", "maxLength":6, "description":"The state of the address. Used to derive the metered service point associated to the enrollment." }, "postal":{ "type":"string", "maxLength":12, "description":"The postal code of the address. Used to derive the metered service point associated to the enrollment." } } }, "assetInfo":{ "type":"object", "properties":{ "installationMethod":{ "type":"string", "enum":[ "X1RE", "X1SD", "X1SI", "X1UI" ], "description":"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.\n* `X1RE` - Re-enroll,\n* `X1SD` - Ship Device,\n* `X1SI` - Bring Your Own,\n* `X1UI` - Utility Installation" }, "assetOwnership":{ "type":"string", "enum":[ "W1CO", "W1OW" ], "description":"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.\n* `W1CO` - Customer Owned,\n* `W1OW` - Utility Owned" }, "assetList":{ "type":"array", "items":{ "type":"object", "properties":{ "sequence":{ "type":"number", "maximum":999, "minimum":0, "description":"Sequence" }, "assetId":{ "type":"string", "maxLength":12, "description":"Asset Id, mostly specific to Utility Owned devices, will be derived internally based on the other Asset Details provided in the request. Optional." }, "specification":{ "type":"string", "maxLength":30, "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record." }, "assetType":{ "type":"string", "maxLength":30, "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record." }, "badgeNo":{ "type":"string", "maxLength":60, "description":"Badge number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments." }, "serialNo":{ "type":"string", "maxLength":60, "description":"Serial number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments." }, "nicId":{ "type":"string", "maxLength":100, "description":"Head end system, along with the NIC Id, 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." }, "headEndSystem":{ "type":"string", "maxLength":30, "description":"Head end system, along with the NIC Id, 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." } } } } } } }, "xml":{ "name":"X1DAAdEnroll" } }, "GETPROGRAMENROLLMENT_response":{ "type":"object", "properties":{ "enrollmentId":{ "type":"string", "maxLength":4, "description":"Enrollment identifier created by the system for each individual enrollment record." }, "transactionId":{ "type":"string", "maxLength":120, "description":"Unique external transaction identifier created by an external source application such as the Oracle Utilities Grid Edge Distributed Energy Resource Management System." }, "status":{ "type":"string", "maxLength":12, "description":"Status of the program enrollment based on business object lifecycle." }, "enrollmentSource":{ "type":"string", "enum":[ "X1BY", "X1CC", "X1SS" ], "description":"Program Enrollment Source:\n* `X1BY` - Bring Your Own,\n* `X1CC` - Contact Center,\n* `X1SS` - Self Service" }, "externalGroupingId":{ "type":"string", "maxLength":60, "description":"External ID" }, "relatedObjects":{ "type":"object", "properties":{ "subscriptionId":{ "type":"string", "maxLength":12, "description":"A unique identifier associated to a program subscription within the system." }, "locationId":{ "type":"string", "maxLength":12, "description":"A unique identifier associated to a device location within the system." }, "relatedProgramId":{ "type":"string", "maxLength":1, "description":"The program identifier of a related program configured for another program in the system." } } }, "customerInfo":{ "type":"object", "properties":{ "cisPersonId":{ "type":"string", "maxLength":30, "description":"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." }, "cisAccountId":{ "type":"string", "maxLength":30, "description":"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." }, "name":{ "type":"string", "maxLength":254, "description":"The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment." }, "homePhone":{ "type":"string", "maxLength":24, "description":"The home phone of the customer. Used to derive the existing customer and metered service record associated to the enrollment." }, "businessPhone":{ "type":"string", "maxLength":24, "description":"The business phone of the customer. Used to derive the existing customer and metered service record associated to the enrollment." }, "email":{ "type":"string", "maxLength":254, "description":"The email address of the customer. Used to derive the existing customer and metered service record associated to the enrollment." }, "questions":{ "type":"object", "properties":{ "qualificationQuestions":{ "type":"object", "properties":{ "questionsList":{ "type":"array", "items":{ "type":"object", "properties":{ "question":{ "type":"string", "description":"(question)" }, "answer":{ "type":"string", "description":"(answer)" }, "response":{ "type":"string", "description":"(response)" } } } } } }, "informationalQuestions":{ "type":"object", "properties":{ "questionsList":{ "type":"array", "items":{ "type":"object", "properties":{ "question":{ "type":"string", "description":"(question)" }, "answer":{ "type":"string", "description":"(answer)" }, "response":{ "type":"string", "description":"(response)" } } } } } } } } } }, "programInfo":{ "type":"object", "properties":{ "cisServiceAgreementId":{ "type":"string", "maxLength":12, "description":"The CIS Service Agreement ID associated to the metered service. Optional." }, "programCode":{ "type":"string", "maxLength":120, "description":"Program Code of the program being enrolled" }, "startDate":{ "type":"string", "format":"date", "description":"The desired application date of the enrollment." } } }, "locationInfo":{ "type":"object", "properties":{ "cisPremiseId":{ "type":"string", "maxLength":60, "description":"The CIS Premise Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided." }, "cisServicePointID":{ "type":"string", "maxLength":60, "description":"The CIS Service Point Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided." }, "division":{ "type":"string", "maxLength":30, "description":"Division is used to define the jurisdiction in which the customer is located." }, "timeZone":{ "type":"string", "maxLength":10, "description":"Time Zone" }, "country":{ "type":"string", "maxLength":3, "description":"The country of the address. Used to derive the metered service point associated to the enrollment." }, "address1":{ "type":"string", "maxLength":254, "description":"The first line of the address. Used to derive the metered service point associated to the enrollment." }, "address2":{ "type":"string", "maxLength":254, "description":"The second line of the address. Used to derive the metered service point associated to the enrollment." }, "address3":{ "type":"string", "maxLength":254, "description":"The third line of the address. Used to derive the metered service point associated to the enrollment." }, "address4":{ "type":"string", "maxLength":254, "description":"The fourth line of the address. Used to derive the metered service point associated to the enrollment." }, "city":{ "type":"string", "maxLength":90, "description":"The city of the address. Used to derive the metered service point associated to the enrollment." }, "county":{ "type":"string", "maxLength":90, "description":"The county of the address. Used to derive the metered service point associated to the enrollment." }, "state":{ "type":"string", "maxLength":6, "description":"The state of the address. Used to derive the metered service point associated to the enrollment." }, "postal":{ "type":"string", "maxLength":12, "description":"The postal code of the address. Used to derive the metered service point associated to the enrollment." } } }, "assetInfo":{ "type":"object", "properties":{ "installationMethod":{ "type":"string", "enum":[ "X1RE", "X1SD", "X1SI", "X1UI" ], "description":"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.\n* `X1RE` - Re-enroll,\n* `X1SD` - Ship Device,\n* `X1SI` - Bring Your Own,\n* `X1UI` - Utility Installation" }, "assetOwnership":{ "type":"string", "enum":[ "W1CO", "W1OW" ], "description":"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.\n* `W1CO` - Customer Owned,\n* `W1OW` - Utility Owned" }, "assetList":{ "type":"array", "items":{ "type":"object", "properties":{ "sequence":{ "type":"number", "maximum":999, "minimum":0, "description":"Sequence" }, "assetId":{ "type":"string", "maxLength":12, "description":"Asset Id, mostly specific to Utility Owned devices, will be derived internally based on the other Asset Details provided in the request. Optional." }, "specification":{ "type":"string", "maxLength":30, "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record." }, "assetType":{ "type":"string", "maxLength":30, "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record." }, "badgeNo":{ "type":"string", "maxLength":60, "description":"Badge number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments." }, "serialNo":{ "type":"string", "maxLength":60, "description":"Serial number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments." }, "nicId":{ "type":"string", "maxLength":100, "description":"Head end system, along with the NIC Id, 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." }, "headEndSystem":{ "type":"string", "maxLength":30, "description":"Head end system, along with the NIC Id, 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." } } } } } }, "deviceSetup":{ "type":"object", "properties":{ "deviceSetupActionsList":{ "type":"array", "items":{ "type":"object", "properties":{ "sequence":{ "type":"number", "maximum":999, "minimum":0, "description":"Sequence" }, "setupAction":{ "type":"string", "enum":[ "X1AC", "X1DC", "X1NA", "X1TD", "X1WO" ], "description":"Setup Action:\n* `X1AC` - Create Activity,\n* `X1DC` - Initiate Controllable Device Command,\n* `X1NA` - No Action Needed,\n* `X1TD` - Create To Do,\n* `X1WO` - Create Work Order" }, "toDoType":{ "type":"string", "maxLength":8, "description":"To Do Type refers to the categorization of certain events that occur within the system and trigger messages describing work that requires attention." }, "toDoRole":{ "type":"string", "maxLength":10, "description":"To Do Roles are assigned to users and are referenced by a to do entry created by the system." }, "toDoId":{ "type":"string", "maxLength":14, "description":"To do entry refers to certain events that occur within the system and trigger messages describing work that requires attention." }, "activityType":{ "type":"string", "maxLength":30, "description":"Activity Type defines the main attributes for activities of a certain type and acts as a model and template for activity records." }, "fieldTaskType":{ "type":"string", "enum":[ "ZZ_TEST_METERINSPECT", "ZZ-Meter Inspection", "ZZ_Appnt_Field_Typ", "D1-DisconnectItemSPAtSource", "D1-ConnectSPAtSourceAndTurnOn", "D1-DisconnectSPAtSource", "ZZ-InstallMeter", "D1-ExchangeMeter", "ZZ-OdmAndSomDup", "ZZ-SomAndOdm4", "D1-DisConnSPAtDvcAndRmveDvc", "D1-TurnOffItem", "ZZ-TrimTree", "D1-ConnSPAtSrceAndInstMtr", "D1-TurnOnMeter", "D1-DisConnSPAtSrceAndRmveMtr", "D1-ReconnectItemforPayment", "D1-TurnOffMeter", "ZZ-SomAndOdm5", "ZZ-SomAndOdm6", "D1-DisconnectSPAtDevice", "ZZ-MeterInspection", "D1-InstallDevice", "ZZSSFTT4", "D1-ConnSPAtDvcAndInstDvc", "ZZPO_TestSOMEI", "ZZSSFTT3", "ZZSSFTT2", "D1-ConnectSPAtSource", "D1-DisconnectSPAtMeter", "ZZ-OdmAndSom15", "D1-ServiceInvestigation", "D1-DisConnSPAtMtrAndRmveMtr", "ZZ-MnlDemo1", "ZZ-ODMandSOM", "ZZ-MnlDemo4", "ZZ-MnlDemo3", "X1-InvestigateControllableDevice", "ZZ-MnlDemo7", "D1-ConnectSPAtSourceAndInstallMeter", "D1-RemoveDevice", "D1-ExchangeDevice", "X1-InstallControllableDevice", "ZZ-Meter Inspection-2", "D1-DisconnectWarning", "D1-MaintainEquipment", "ZZ-FaTypKK", "ZZSAFTT", "ZZ-TestDevice", "D1-CutForNonPayment", "ZZ-MaintainFireHydrant", "ZZ_Mgmt_FieldTskTyp", "D1-ConnectSPAtMeterAndTurnOn", "ZZ_HC_Field_task_type", "D1-ConnectSPAtDevice", "ZZ-OdmAndSom3", "ZZSAFTT_2", "ZZ-OdmAndSom2", "ZZPO-SOMACTTYP", "D1-ConnSPAtSrceAndTurnOnDvc", "D1-TurnOnPilotLight", "ZZ-ExchangeMeter", "ZZYC_MeterInspection", "D1-ConnSPAtSrceAndInstDvc", "D1-ConnectSPAtMeter", "ZZ-BookAppnt", "ZZAT-TrimTree", "D1-InstallMeter", "D1-ReconnectForPayment", "D1-ConnectSPAtDvcAndTurnOn", "D1-TrimTree", "ZZLJP_TEST", "D1-ConnSPAtMtrAndInstMtr", "ZZ-ReadMeter", "D1-CutItemForNonPayment", "D1-RemoveMeter", "D1-TurnOnItem", "D1-ReadMeter", "ZZ-OdmAndSom8", "ZZ-OdmAndSom7", "ZZ_CPS_FIELD_TASK_TYPE" ], "description":"Field Task Type: * `X1-InvestigateControllableDevice` - Investigate Controllable Device, * `X1-InstallControllableDevice` - Install Controllable Device\n* `ZZ_TEST_METERINSPECT` - 00ZZ_TEST_METERINSPECT,\n* `ZZ-Meter Inspection` - ZZ PO ODM and SOM,\n* `ZZ_Appnt_Field_Typ` - ZZ Field Task Type for Mgmt Appnt 1,\n* `D1-DisconnectItemSPAtSource` - Disconnect SP at Source Item,\n* `D1-ConnectSPAtSourceAndTurnOn` - Connect SP at Source and Turn On,\n* `D1-DisconnectSPAtSource` - Disconnect SP at Source,\n* `ZZ-InstallMeter` - ZZ - Install Meter,\n* `D1-ExchangeMeter` - Exchange Meter,\n* `ZZ-OdmAndSomDup` - ZZ ODM and SOM 3,\n* `ZZ-SomAndOdm4` - ZZ SOM and ODM 4 Test,\n* `D1-DisConnSPAtDvcAndRmveDvc` - Disconnect SP from Item and Remove Item,\n* `D1-TurnOffItem` - Turn Off Item,\n* `ZZ-TrimTree` - Trim Tree,\n* `D1-ConnSPAtSrceAndInstMtr` - Connect SP at Source and Install Meter,\n* `D1-TurnOnMeter` - Turn On Meter,\n* `D1-DisConnSPAtSrceAndRmveMtr` - Disconnect SP at Source and Remove Meter,\n* `D1-ReconnectItemforPayment` - Reconnect Item for Payment,\n* `D1-TurnOffMeter` - Turn Off Meter,\n* `ZZ-SomAndOdm5` - ZZ SOM and ODM 5,\n* `ZZ-SomAndOdm6` - ZZ SOM and ODM 6,\n* `D1-DisconnectSPAtDevice` - Disconnect SP from Item,\n* `ZZ-MeterInspection` - Meter Inspection,\n* `D1-InstallDevice` - Install Item,\n* `ZZSSFTT4` - ZZSSFTT4 - 1,\n* `D1-ConnSPAtDvcAndInstDvc` - Connect SP to Item and Install Item,\n* `ZZPO_TestSOMEI` - ZZPO_TestSOM Export-Import,\n* `ZZSSFTT3` - ZZSSFTT3,\n* `ZZSSFTT2` - ZZSSFTT2 - 5,\n* `D1-ConnectSPAtSource` - Connect SP at Source,\n* `D1-DisconnectSPAtMeter` - Disconnect SP at Meter,\n* `ZZ-OdmAndSom15` - ZZ ODM and SOM 15,\n* `D1-ServiceInvestigation` - Service Investigation,\n* `D1-DisConnSPAtMtrAndRmveMtr` - Disconnect SP at Meter and Remove Meter,\n* `ZZ-MnlDemo1` - ZZ Manila Demo 1,\n* `ZZ-ODMandSOM` - ZZ KPA ODM and SOM,\n* `ZZ-MnlDemo4` - ZZ Manila Demo 4 Edit,\n* `ZZ-MnlDemo3` - ZZ Manila Demo 3,\n* `X1-InvestigateControllableDevice` - Investigate Controllable Device,\n* `ZZ-MnlDemo7` - ZZ Manila Demo 7,\n* `D1-ConnectSPAtSourceAndInstallMeter` - Connect SP at Source and Install Meter,\n* `D1-RemoveDevice` - Remove Item,\n* `D1-ExchangeDevice` - Exchange Item,\n* `X1-InstallControllableDevice` - Install Controllable Device,\n* `ZZ-Meter Inspection-2` - ZZ PO ODM and SOM-2,\n* `D1-DisconnectWarning` - Disconnect Warning,\n* `D1-MaintainEquipment` - Maintain SP and Meter Equipment,\n* `ZZ-FaTypKK` - Test Field Task Type - KK,\n* `ZZSAFTT` - ZZSAFTT-1,\n* `ZZ-TestDevice` - Test Device,\n* `D1-CutForNonPayment` - Cut for Non Payment,\n* `ZZ-MaintainFireHydrant` - Inspect Communication Relay,\n* `ZZ_Mgmt_FieldTskTyp` - ZZ Field Task Type for Mgmt Appnt,\n* `D1-ConnectSPAtMeterAndTurnOn` - Connect SP at Meter and Turn On,\n* `ZZ_HC_Field_task_type` - ZZ_HC Field task type12 123456,\n* `D1-ConnectSPAtDevice` - Connect SP to Item,\n* `ZZ-OdmAndSom3` - ZZ ODM and SOM 3,\n* `ZZSAFTT_2` - ZZSAFTT-2,\n* `ZZ-OdmAndSom2` - ZZ ODM and SOM 2,\n* `ZZPO-SOMACTTYP` - ZZPO-SOMACTTYP,\n* `D1-ConnSPAtSrceAndTurnOnDvc` - Connect SP at Source and Turn On Item,\n* `D1-TurnOnPilotLight` - Turn On Pilot Light,\n* `ZZ-ExchangeMeter` - Exchange Meter ZZ,\n* `ZZYC_MeterInspection` - 00ZZYC_MeterInspection,\n* `D1-ConnSPAtSrceAndInstDvc` - Connect SP at Source and Install Item,\n* `D1-ConnectSPAtMeter` - Connect SP at Meter,\n* `ZZ-BookAppnt` - Test Book Appointment - KK,\n* `ZZAT-TrimTree` - Trim Tree,\n* `D1-InstallMeter` - Install Meter,\n* `D1-ReconnectForPayment` - Reconnect for Payment,\n* `D1-ConnectSPAtDvcAndTurnOn` - Connect SP to Item and Turn On,\n* `D1-TrimTree` - Trim Tree,\n* `ZZLJP_TEST` - ZZLJP_TEST,\n* `D1-ConnSPAtMtrAndInstMtr` - Connect SP at Meter and Install Meter,\n* `ZZ-ReadMeter` - ZZ Read Meter,\n* `D1-CutItemForNonPayment` - Cut Item for Non Payment,\n* `D1-RemoveMeter` - Remove Meter,\n* `D1-TurnOnItem` - Turn On Item,\n* `D1-ReadMeter` - Read Meter,\n* `ZZ-OdmAndSom8` - ZZ ODM and SOM 8,\n* `ZZ-OdmAndSom7` - ZZ ODM and SOM 7,\n* `ZZ_CPS_FIELD_TASK_TYPE` - CPS Field Task Type Test" }, "activityId":{ "type":"string", "maxLength":14, "description":"Activity" }, "templateWorkOrderId":{ "type":"string", "maxLength":12, "description":"A unique identifier of a work order used as template for generating work orders." }, "workOrderId":{ "type":"string", "maxLength":14, "description":"A system generated unique identifier associated to each work order that is created." } } } } } }, "appointmentSlots":{ "type":"object", "properties":{ "crewShiftList":{ "type":"array", "items":{ "type":"object", "properties":{ "activityType":{ "type":"string", "maxLength":30, "description":"Activity Type defines the main attributes for activities of a certain type and acts as a model and template for activity records." }, "crewShiftId":{ "type":"string", "maxLength":14, "description":"Crew Shift ID" }, "startDateTime":{ "type":"string", "format":"date-time", "description":"Appointment start date and time for the scheduled work." }, "endDateTime":{ "type":"string", "format":"date-time", "description":"Appointment end date and time for the scheduled work." }, "crewId":{ "type":"string", "maxLength":12, "description":"Crew identifier for primary and secondary crew members that are assigned a particular work activity." }, "workAvailabilityDuration":{ "type":"number", "maximum":"99999999999.99", "minimum":0, "description":"Work availability expressed in hours for the particular crew." } } } } } }, "exception":{ "type":"object", "properties":{ "messageCategory":{ "type":"string", "maxLength":5, "description":"Message Category" }, "messageNumber":{ "type":"string", "maxLength":5, "description":"Message Number" }, "expandedMessage":{ "type":"string", "maxLength":60, "description":"Expanded message parameter" } } } }, "xml":{ "name":"X1-DAEnroll" } }, "problemDetailDocument":{ "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." } } } } }, "POSTACKNOWLEDGEMENT_response":{ "type":"object", "properties":{ "syncRequestId":{ "type":"string", "maxLength":14, "description":"The system-generated unique identifier for the outbound sync request.", "example":"15449036987849" }, "exceptionInfo":{ "type":"array", "items":{ "type":"object", "properties":{ "sequence":{ "type":"number", "maximum":999, "minimum":-999, "description":"A unique Sequence number is given to each entry after the information is saved.", "example":"1" }, "messageCategory":{ "type":"number", "maximum":99999, "minimum":-99999, "description":"Message Category within Oracle Utilities Application Framework.", "example":"99999" }, "messageNumber":{ "type":"number", "maximum":99999, "minimum":-99999, "description":"Message Number within Oracle Utilities Application Framework.", "example":"99999" }, "comments":{ "type":"string", "maxLength":254, "description":"Information from the customer.", "example":"Device details not found." }, "messageParameters":{ "type":"array", "items":{ "type":"object", "properties":{ "parameterSequence":{ "type":"number", "maximum":999, "minimum":-999, "description":"A unique Sequence number is given to each entry after the information is saved.", "example":"1" }, "messageParameterValue":{ "type":"string", "maxLength":2000, "description":"Message Parameter", "example":"Any string" } } } } } } }, "deviceHeadendStatus":{ "type":"object", "properties":{ "deviceHeadendStatusList":{ "type":"array", "items":{ "type":"object", "properties":{ "deviceId":{ "type":"string", "maxLength":12, "description":"Device ID" }, "headEndRegistration":{ "type":"string", "enum":[ "D1DR", "D1NR", "D1RE" ], "description":"Head End Registration Status of the Device.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered", "example":"D1DR" }, "message":{ "type":"string", "maxLength":2000, "description":"Message Information", "example":"Invalid input." } } } } } }, "hasError":{ "type":"boolean", "description":"Indicates whether incoming message has any error.", "example":"true" } }, "xml":{ "name":"X1DAPostAck" } }, "UNENROLLPROGRAM_response":{ "type":"object", "properties":{ "unenrollmentId":{ "type":"string", "maxLength":4, "description":"Unenrollment ID" }, "transactionId":{ "type":"string", "maxLength":120, "description":"Unique external transaction identifier created by an external source application such as the Oracle Utilities Grid Edge Distributed Energy Resource Management System." }, "status":{ "type":"string", "maxLength":12, "description":"Status of the program enrollment based on business object lifecycle." }, "appointmentSlots":{ "type":"object", "properties":{ "crewShiftList":{ "type":"array", "items":{ "type":"object", "properties":{ "activityType":{ "type":"string", "maxLength":30, "description":"Activity Type defines the main attributes for activities of a certain type and acts as a model and template for activity records." }, "crewShiftId":{ "type":"string", "maxLength":14, "description":"Crew Shift ID" }, "startDateTime":{ "type":"string", "format":"date-time", "description":"Appointment start date and time for the scheduled work." }, "endDateTime":{ "type":"string", "format":"date-time", "description":"Appointment end date and time for the scheduled work." }, "crewId":{ "type":"string", "maxLength":12, "description":"Crew identifier for primary and secondary crew members that are assigned a particular work activity." }, "workAvailabilityDuration":{ "type":"number", "maximum":"99999999999.99", "minimum":0, "description":"Work availability expressed in hours for the particular crew." } } } } } }, "exception":{ "type":"object", "properties":{ "messageCategory":{ "type":"string", "maxLength":5, "description":"Message Category" }, "messageNumber":{ "type":"string", "maxLength":5, "description":"Message Number" }, "expandedMessage":{ "type":"string", "maxLength":60, "description":"Expanded message parameter" } } } }, "xml":{ "name":"X1-DAUnenrol" } }, "POSTACKNOWLEDGEMENT_request":{ "type":"object", "properties":{ "syncRequestId":{ "type":"string", "maxLength":14, "description":"The system-generated unique identifier for the outbound sync request.", "example":"15449036987849" }, "exceptionInfo":{ "type":"array", "items":{ "type":"object", "properties":{ "sequence":{ "type":"number", "maximum":999, "minimum":-999, "description":"A unique Sequence number is given to each entry after the information is saved.", "example":"1" }, "messageCategory":{ "type":"number", "maximum":99999, "minimum":-99999, "description":"Message Category within Oracle Utilities Application Framework.", "example":"99999" }, "messageNumber":{ "type":"number", "maximum":99999, "minimum":-99999, "description":"Message Number within Oracle Utilities Application Framework.", "example":"99999" }, "comments":{ "type":"string", "maxLength":254, "description":"Information from the customer.", "example":"Device details not found." }, "messageParameters":{ "type":"array", "items":{ "type":"object", "properties":{ "parameterSequence":{ "type":"number", "maximum":999, "minimum":-999, "description":"A unique Sequence number is given to each entry after the information is saved.", "example":"1" }, "messageParameterValue":{ "type":"string", "maxLength":2000, "description":"Message Parameter", "example":"Any string" } } } } } } }, "deviceHeadendStatus":{ "type":"object", "properties":{ "deviceHeadendStatusList":{ "type":"array", "items":{ "type":"object", "properties":{ "deviceId":{ "type":"string", "maxLength":12, "description":"Device ID" }, "headEndRegistration":{ "type":"string", "enum":[ "D1DR", "D1NR", "D1RE" ], "description":"Head End Registration Status of the Device.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered", "example":"D1DR" }, "message":{ "type":"string", "maxLength":2000, "description":"Message Information", "example":"Invalid input." } } } } } }, "hasError":{ "type":"boolean", "description":"Indicates whether incoming message has any error.", "example":"true" } }, "xml":{ "name":"X1DAPostAck" } }, "ENROLLPROGRAM_response":{ "type":"object", "properties":{ "enrollmentId":{ "type":"string", "maxLength":4, "description":"Enrollment identifier created by the system for each individual enrollment record." }, "transactionId":{ "type":"string", "maxLength":120, "description":"Unique external transaction identifier created by an external source application such as the Oracle Utilities Grid Edge Distributed Energy Resource Management System." }, "status":{ "type":"string", "maxLength":12, "description":"Status of the program enrollment based on business object lifecycle." }, "appointmentSlots":{ "type":"object", "properties":{ "crewShiftList":{ "type":"array", "items":{ "type":"object", "properties":{ "activityType":{ "type":"string", "maxLength":30, "description":"Activity Type defines the main attributes for activities of a certain type and acts as a model and template for activity records." }, "crewShiftId":{ "type":"string", "maxLength":14, "description":"Crew Shift ID" }, "startDateTime":{ "type":"string", "format":"date-time", "description":"Appointment start date and time for the scheduled work." }, "endDateTime":{ "type":"string", "format":"date-time", "description":"Appointment end date and time for the scheduled work." }, "crewId":{ "type":"string", "maxLength":12, "description":"Crew identifier for primary and secondary crew members that are assigned a particular work activity." }, "workAvailabilityDuration":{ "type":"number", "maximum":"99999999999.99", "minimum":0, "description":"Work availability expressed in hours for the particular crew." } } } } } }, "exception":{ "type":"object", "properties":{ "messageCategory":{ "type":"string", "maxLength":5, "description":"Message Category" }, "messageNumber":{ "type":"string", "maxLength":5, "description":"Message Number" }, "expandedMessage":{ "type":"string", "maxLength":60, "description":"Expanded message parameter" } } } }, "xml":{ "name":"X1-DAEnroll" } }, "ENROLLPROGRAM_request":{ "type":"object", "properties":{ "transactionId":{ "type":"string", "maxLength":120, "description":"Unique external transaction identifier created by an external source application such as the Oracle Utilities Grid Edge Distributed Energy Resource Management System." }, "enrollmentSource":{ "type":"string", "enum":[ "X1BY", "X1CC", "X1SS" ], "description":"Program Enrollment Source:\n* `X1BY` - Bring Your Own,\n* `X1CC` - Contact Center,\n* `X1SS` - Self Service" }, "customerInfo":{ "type":"object", "properties":{ "cisPersonId":{ "type":"string", "maxLength":30, "description":"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." }, "cisAccountId":{ "type":"string", "maxLength":30, "description":"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." }, "name":{ "type":"string", "maxLength":254, "description":"The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment." }, "homePhone":{ "type":"string", "maxLength":24, "description":"The home phone of the customer. Used to derive the existing customer and metered service record associated to the enrollment." }, "businessPhone":{ "type":"string", "maxLength":24, "description":"The business phone of the customer. Used to derive the existing customer and metered service record associated to the enrollment." }, "email":{ "type":"string", "maxLength":254, "description":"The email address of the customer. Used to derive the existing customer and metered service record associated to the enrollment." }, "questions":{ "type":"object", "properties":{ "qualificationQuestions":{ "type":"object", "properties":{ "questionsList":{ "type":"array", "items":{ "type":"object", "properties":{ "question":{ "type":"string", "description":"(question)" }, "answer":{ "type":"string", "description":"(answer)" }, "response":{ "type":"string", "description":"(response)" } } } } } }, "informationalQuestions":{ "type":"object", "properties":{ "questionsList":{ "type":"array", "items":{ "type":"object", "properties":{ "question":{ "type":"string", "description":"(question)" }, "answer":{ "type":"string", "description":"(answer)" }, "response":{ "type":"string", "description":"(response)" } } } } } } } } } }, "programInfo":{ "type":"object", "properties":{ "cisServiceAgreementId":{ "type":"string", "maxLength":12, "description":"The CIS Service Agreement ID associated to the metered service. Optional." }, "programCode":{ "type":"string", "maxLength":120, "description":"Program Code of the program being enrolled" }, "startDate":{ "type":"string", "format":"date", "description":"The desired application date of the enrollment." } } }, "locationInfo":{ "type":"object", "properties":{ "cisPremiseId":{ "type":"string", "maxLength":60, "description":"The CIS Premise Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided." }, "cisServicePointID":{ "type":"string", "maxLength":60, "description":"The CIS Service Point Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided." }, "division":{ "type":"string", "maxLength":30, "description":"Division is used to define the jurisdiction in which the customer is located." }, "timeZone":{ "type":"string", "maxLength":10, "description":"Time Zone" }, "country":{ "type":"string", "maxLength":3, "description":"The country of the address. Used to derive the metered service point associated to the enrollment." }, "address1":{ "type":"string", "maxLength":254, "description":"The first line of the address. Used to derive the metered service point associated to the enrollment." }, "address2":{ "type":"string", "maxLength":254, "description":"The second line of the address. Used to derive the metered service point associated to the enrollment." }, "address3":{ "type":"string", "maxLength":254, "description":"The third line of the address. Used to derive the metered service point associated to the enrollment." }, "address4":{ "type":"string", "maxLength":254, "description":"The fourth line of the address. Used to derive the metered service point associated to the enrollment." }, "city":{ "type":"string", "maxLength":90, "description":"The city of the address. Used to derive the metered service point associated to the enrollment." }, "county":{ "type":"string", "maxLength":90, "description":"The county of the address. Used to derive the metered service point associated to the enrollment." }, "state":{ "type":"string", "maxLength":6, "description":"The state of the address. Used to derive the metered service point associated to the enrollment." }, "postal":{ "type":"string", "maxLength":12, "description":"The postal code of the address. Used to derive the metered service point associated to the enrollment." } } }, "assetInfo":{ "type":"object", "properties":{ "installationMethod":{ "type":"string", "enum":[ "X1RE", "X1SD", "X1SI", "X1UI" ], "description":"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.\n* `X1RE` - Re-enroll,\n* `X1SD` - Ship Device,\n* `X1SI` - Bring Your Own,\n* `X1UI` - Utility Installation" }, "assetOwnership":{ "type":"string", "enum":[ "W1CO", "W1OW" ], "description":"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.\n* `W1CO` - Customer Owned,\n* `W1OW` - Utility Owned" }, "assetList":{ "type":"array", "items":{ "type":"object", "properties":{ "sequence":{ "type":"number", "maximum":999, "minimum":0, "description":"Sequence" }, "assetId":{ "type":"string", "maxLength":12, "description":"Asset Id, mostly specific to Utility Owned devices, will be derived internally based on the other Asset Details provided in the request. Optional." }, "specification":{ "type":"string", "maxLength":30, "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record." }, "assetType":{ "type":"string", "maxLength":30, "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record." }, "badgeNo":{ "type":"string", "maxLength":60, "description":"Badge number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments." }, "serialNo":{ "type":"string", "maxLength":60, "description":"Serial number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments." }, "nicId":{ "type":"string", "maxLength":100, "description":"Head end system, along with the NIC Id, 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." }, "headEndSystem":{ "type":"string", "maxLength":30, "description":"Head end system, along with the NIC Id, 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." } } } } } }, "appointmentSlots":{ "type":"object", "properties":{ "crewShiftList":{ "type":"array", "items":{ "type":"object", "properties":{ "activityType":{ "type":"string", "maxLength":30, "description":"Activity Type defines the main attributes for activities of a certain type and acts as a model and template for activity records." }, "crewShiftId":{ "type":"string", "maxLength":14, "description":"Crew Shift ID" }, "startDateTime":{ "type":"string", "format":"date-time", "description":"Appointment start date and time for the scheduled work." }, "endDateTime":{ "type":"string", "format":"date-time", "description":"Appointment end date and time for the scheduled work." }, "crewId":{ "type":"string", "maxLength":12, "description":"Crew identifier for primary and secondary crew members that are assigned a particular work activity." }, "workAvailabilityDuration":{ "type":"number", "maximum":"99999999999.99", "minimum":0, "description":"Work availability expressed in hours for the particular crew." } } } } } } }, "xml":{ "name":"X1-DAEnroll" } }, "UNENROLLPROGRAM_request":{ "type":"object", "properties":{ "transactionId":{ "type":"string", "maxLength":120, "description":"Unique external transaction identifier created by an external source application such as the Oracle Utilities Grid Edge Distributed Energy Resource Management System." }, "unenrollReason":{ "type":"string", "enum":[ "ZZ Customer move out", "ZZ_UNENROLLTEST" ], "description":"Unenroll Reason: * `LSSL` - Life Support / Sensitive Load, * `CUSTOMEROPTOUT` - Customer Initiated Opt-Out, * `INACTIVESERVICE` - Inactive Service, * `INELIGIBLERATE` - Ineligible Rate\n* `ZZ Customer move out` - ZZ Customer move out (Appr Req),\n* `ZZ_UNENROLLTEST` - ZZ UNENROLL TEST REASON (appr not req)" }, "customerInfo":{ "type":"object", "properties":{ "cisPersonId":{ "type":"string", "maxLength":30, "description":"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." }, "cisAccountId":{ "type":"string", "maxLength":30, "description":"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." }, "name":{ "type":"string", "maxLength":254, "description":"The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment." } } }, "programInfo":{ "type":"object", "properties":{ "programId":{ "type":"string", "maxLength":12, "description":"Program" }, "endDate":{ "type":"string", "format":"date", "description":"The desired application date of unenrollment." } } }, "locationInfo":{ "type":"object", "properties":{ "cisPremiseId":{ "type":"string", "maxLength":60, "description":"The CIS Premise Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided." }, "cisServicePointID":{ "type":"string", "maxLength":60, "description":"The CIS Service Point Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided." }, "division":{ "type":"string", "maxLength":30, "description":"Division is used to define the jurisdiction in which the customer is located." }, "timeZone":{ "type":"string", "maxLength":10, "description":"Time Zone" }, "country":{ "type":"string", "maxLength":3, "description":"The country of the address. Used to derive the metered service point associated to the enrollment." }, "address1":{ "type":"string", "maxLength":254, "description":"The first line of the address. Used to derive the metered service point associated to the enrollment." }, "address2":{ "type":"string", "maxLength":254, "description":"The second line of the address. Used to derive the metered service point associated to the enrollment." }, "address3":{ "type":"string", "maxLength":254, "description":"The third line of the address. Used to derive the metered service point associated to the enrollment." }, "address4":{ "type":"string", "maxLength":254, "description":"The fourth line of the address. Used to derive the metered service point associated to the enrollment." }, "city":{ "type":"string", "maxLength":90, "description":"The city of the address. Used to derive the metered service point associated to the enrollment." }, "county":{ "type":"string", "maxLength":90, "description":"The county of the address. Used to derive the metered service point associated to the enrollment." }, "state":{ "type":"string", "maxLength":6, "description":"The state of the address. Used to derive the metered service point associated to the enrollment." }, "postal":{ "type":"string", "maxLength":12, "description":"The postal code of the address. Used to derive the metered service point associated to the enrollment." } } }, "assetInfo":{ "type":"object", "properties":{ "removalMethod":{ "type":"string", "enum":[ "X1KP", "X1SD", "X1UR" ], "description":"Removal Method:\n* `X1KP` - Keep,\n* `X1SD` - Ship Device,\n* `X1UR` - Utility Removal" }, "assetOwnership":{ "type":"string", "enum":[ "W1CO", "W1OW" ], "description":"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.\n* `W1CO` - Customer Owned,\n* `W1OW` - Utility Owned" } } }, "appointmentSlots":{ "type":"object", "properties":{ "crewShiftList":{ "type":"array", "items":{ "type":"object", "properties":{ "activityType":{ "type":"string", "maxLength":30, "description":"Activity Type defines the main attributes for activities of a certain type and acts as a model and template for activity records." }, "crewShiftId":{ "type":"string", "maxLength":14, "description":"Crew Shift ID" }, "startDateTime":{ "type":"string", "format":"date-time", "description":"Appointment start date and time for the scheduled work." }, "endDateTime":{ "type":"string", "format":"date-time", "description":"Appointment end date and time for the scheduled work." }, "crewId":{ "type":"string", "maxLength":12, "description":"Crew identifier for primary and secondary crew members that are assigned a particular work activity." }, "workAvailabilityDuration":{ "type":"number", "maximum":"99999999999.99", "minimum":0, "description":"Work availability expressed in hours for the particular crew." } } } } } } }, "xml":{ "name":"X1-DAUnenrol" } }, "POSTEVENTOUTCOME_response":{ "type":"object", "properties":{ }, "xml":{ "name":"X1_PstEvtOut" } }, "RESERVEDEVICE_response":{ "type":"object", "properties":{ }, "xml":{ "name":"X1_ReserDvc" } }, "POSTEVENTOUTCOME_request":{ "type":"object", "properties":{ "postOutcomeList":{ "type":"array", "items":{ "type":"object", "properties":{ "eventExternalIdentifier":{ "type":"string", "maxLength":120, "description":"Unique identifier of the event from the external application." }, "nicId":{ "type":"string", "maxLength":100, "description":"Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome." }, "headEndSystem":{ "type":"string", "maxLength":50, "description":"Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome." }, "participationStartDateTime":{ "type":"string", "format":"date-time", "description":"Participation start/end date/time will be the device's actual participation period for the event." }, "participationEndDateTime":{ "type":"string", "format":"date-time", "description":"Participation start/end date/time will be the device's actual participation period for the event." }, "outcome":{ "type":"string", "enum":[ "D1CN", "D1ER", "D1IO", "D1ND", "D1SP" ], "description":"Device's participation outcome for the event. * `D1CN` - Cancelled, * `D1ER` - Error, * `D1IO` - In-flight override, * `D1ND` - Non-responsive device, * `D1SP` - Successful participation\n* `D1CN` - Cancelled,\n* `D1ER` - Error,\n* `D1IO` - In-flight override,\n* `D1ND` - Non-responsive device,\n* `D1SP` - Successful participation", "example":"D1SP" }, "errorMessage":{ "type":"string", "maxLength":100, "description":"Optional error message sent when posting an error outcome." } } } } }, "xml":{ "name":"X1_PstEvtOut" } }, "RESERVEDEVICE_request":{ "type":"object", "properties":{ "eventStartDateTime":{ "type":"string", "format":"date-time", "description":"Event start date time indicates the scheduled start time for the event received from the external source application.", "example":"10-15-2022 01:00:00PM" }, "eventEndDateTime":{ "type":"string", "format":"date-time", "description":"Event end date time indicates the scheduled end time for the event received from the external source application.", "example":"10-15-2022 05:00:00PM" }, "eventExternalIdentifier":{ "type":"string", "maxLength":120, "description":"Unique identifier of the event from the external application." }, "deviceList":{ "type":"array", "items":{ "type":"object", "properties":{ "nicId":{ "type":"string", "maxLength":100, "description":"Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome." }, "headEndSystem":{ "type":"string", "maxLength":50, "description":"Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome." }, "reservationStartDateTime":{ "type":"string", "format":"date-time", "description":"Reservation start date time indicates each device's reservation start time for the upcoming event. If not provided, the event start date time is applied as the reservation start date time." }, "reservationEndDateTime":{ "type":"string", "format":"date-time", "description":"Reservation end date time indicates each device's reservation end time for the upcoming event. If not provided, the event end date time is applied as the reservation end date time.", "example":"2022-04-14T01:23:11-07:00" } } } } }, "xml":{ "name":"X1_ReserDvc" } }, "POSTCONTROLLABLEDEVICESTATUS_request":{ "type":"object", "properties":{ "responseDetail":{ "type":"object", "properties":{ "transactionID":{ "type":"string", "maxLength":30, "description":"Transaction Id is the identifier used to determine the initiating controllable device status check request transaction." }, "result":{ "type":"object", "properties":{ "status":{ "type":"string", "enum":[ "ZZFailureReponse", "SUCCESS", "ZZSuccessReponse", "FAILURE" ], "description":"The status code of the controllable device status check result.\n* `ZZFailureReponse` - ZZFailureReponse,\n* `SUCCESS` - Success,\n* `ZZSuccessReponse` - ZZSuccessReponse,\n* `FAILURE` - Failure", "example":"SUCCESS" } } } } } }, "xml":{ "name":"X1-CDStsChkR" } }, "POSTCONTROLLABLEDEVICESTATUS_response":{ "type":"object", "properties":{ "communicationId":{ "type":"string", "maxLength":14, "description":"Communication identifier created by the system for each individual communication response received for a controllable device communication check request" }, "boStatus":{ "type":"string", "maxLength":12, "description":"Status of the controllable device communication request based on business object lifecycle. The controllable device communication status check transitions through different statuses in its lifecycle. On creation, the status uses a default of PENDING and then transitions to VALIDATE. On successful validation, it enters awaiting response status monitoring status AWAITRESP. If no response is received within the configured limit it goes to response error (RESPERROR) and then to RETRY. If a response is not received after a configurable number of retries it transitions to a terminal status of DISCARDED. If a response is received it moves to a terminal status of COMPLETED." } }, "xml":{ "name":"X1-CDStsChkR" } }, "CREATEPROGRAMEVENT_request":{ "type":"object", "properties":{ "eventExternalIdentifier":{ "type":"string", "maxLength":120, "description":"External Id" }, "programExternalIdentifier":{ "type":"string", "maxLength":120, "description":"External Id" }, "externalIdentifier":{ "type":"string", "maxLength":120, "description":"Unique identifier of the event stage from the external source application.", "example":"1315" }, "startDateTime":{ "type":"string", "format":"date-time", "description":"Event start date time indicates the scheduled start time for the event received from the external source application.", "example":"10-15-2022 01:00:00PM" }, "endDateTime":{ "type":"string", "format":"date-time", "description":"Event end date time indicates the scheduled end time for the event received from the external source application.", "example":"10-15-2022 05:00:00PM" }, "programEventCategory":{ "type":"string", "enum":[ "X1DT", "X1EC", "X1EM", "X1RE" ], "description":"Program Event category is defined in the external source application. * `X1DT` - Device Test, * `X1EC` - Economic, * `X1EM` - Emergency, * `X1RE` - Reliability\n* `X1DT` - Device Test,\n* `X1EC` - Economic,\n* `X1EM` - Emergency,\n* `X1RE` - Reliability", "example":"X1EC" } }, "xml":{ "name":"X1CrtPrgEvt" } }, "CREATEPROGRAMEVENT_response":{ "type":"object", "properties":{ }, "xml":{ "name":"X1CrtPrgEvt" } }, "ACTIONPROGRAMEVENT_response":{ "type":"object", "properties":{ "eventExternalIdentifier":{ "type":"string", "maxLength":120, "description":"External Id" }, "action":{ "type":"string", "enum":[ "F1CN", "F1CO", "X1IP", "X1SD" ], "description":"Program event statuses defined and managed in the external source application. * `F1CN` - cancel, * `F1CO` - complete, * `X1IP` - in progress, * `X1SD` - schedule\n* `F1CN` - cancel,\n* `F1CO` - complete,\n* `X1IP` - in progress,\n* `X1SD` - schedule", "example":"F1CO" }, "cancelReason":{ "type":"string", "maxLength":254, "description":"Optional message sent when posting an event cancel action.", "example":"Testing DACS" }, "status":{ "type":"string", "maxLength":12, "description":"Status of the event", "example":"F1CN" }, "nextActions":{ "type":"array", "items":{ "type":"object", "properties":{ "action":{ "type":"string", "enum":[ "F1CN", "F1CO", "X1IP", "X1SD" ], "description":"Program event statuses defined and managed in the external source application. * `F1CN` - cancel, * `F1CO` - complete, * `X1IP` - in progress, * `X1SD` - schedule\n* `F1CN` - cancel,\n* `F1CO` - complete,\n* `X1IP` - in progress,\n* `X1SD` - schedule", "example":"F1CO" } } } } }, "xml":{ "name":"X1ActPrgEvt" } }, "ACTIONPROGRAMEVENT_request":{ "type":"object", "properties":{ "eventExternalIdentifier":{ "type":"string", "maxLength":120, "description":"External Id" }, "action":{ "type":"string", "enum":[ "F1CN", "F1CO", "X1IP", "X1SD" ], "description":"Program event statuses defined and managed in the external source application. * `F1CN` - cancel, * `F1CO` - complete, * `X1IP` - in progress, * `X1SD` - schedule\n* `F1CN` - cancel,\n* `F1CO` - complete,\n* `X1IP` - in progress,\n* `X1SD` - schedule", "example":"F1CO" }, "cancelReason":{ "type":"string", "maxLength":254, "description":"Optional message sent when posting an event cancel action.", "example":"Testing DACS" } }, "xml":{ "name":"X1ActPrgEvt" } }, "REGISTERDERDEVICE_response":{ "type":"object", "properties":{ "enrollmentId":{ "type":"string", "maxLength":4, "description":"Enrollment ID" }, "transactionId":{ "type":"string", "maxLength":120, "description":"External Transaction ID" }, "status":{ "type":"string", "maxLength":12, "description":"Status" }, "exception":{ "type":"object", "properties":{ "messageCategory":{ "type":"string", "maxLength":5, "description":"Message Category" }, "messageNumber":{ "type":"string", "maxLength":5, "description":"Message Number" }, "expandedMessage":{ "type":"string", "maxLength":60, "description":"Expanded message parameter" } } } }, "xml":{ "name":"X1_RegDERDvc" } }, "INTERCONNECTDER_request":{ "type":"object", "properties":{ "transactionId":{ "type":"string", "maxLength":120, "description":"External Transaction ID" }, "customerInfo":{ "type":"object", "properties":{ "cisPersonId":{ "type":"string", "maxLength":30, "description":"The CIS Person Id associated to the metered service point. Used to derive the existing customer and metered service record. Optional, if name is provided." }, "cisAccountId":{ "type":"string", "maxLength":30, "description":"The CIS Account Id associated to the metered service point. Used to derive the existing customer and metered service record. Optional, if name is provided." }, "name":{ "type":"string", "maxLength":254, "description":"The name of the customer. Used to derive the existing customer and metered service record" }, "homePhone":{ "type":"string", "maxLength":24, "description":"The home phone of the customer. Used to derive the existing customer and metered service record" }, "businessPhone":{ "type":"string", "maxLength":24, "description":"The business phone of the customer. Used to derive the existing customer and metered service record" }, "email":{ "type":"string", "maxLength":254, "description":"The email address of the customer. Used to derive the existing customer and metered service record" } } }, "locationInfo":{ "type":"object", "properties":{ "cisPremiseId":{ "type":"string", "maxLength":60, "description":"The CIS Premise Id associated to the metered service point. Used to derive the metered service point. Optional, if address information is provided." }, "cisServicePointID":{ "type":"string", "maxLength":60, "description":"The CIS Service Point Id associated to the metered service point. Used to derive the metered service point. Optional, if address information is provided." }, "division":{ "type":"string", "maxLength":30, "description":"Division is used to define the jurisdiction in which the customer is located." }, "timeZone":{ "type":"string", "maxLength":10, "description":"The time zone of the address" }, "country":{ "type":"string", "maxLength":3, "description":"The country of the address. Used to derive the metered service point" }, "address1":{ "type":"string", "maxLength":254, "description":"The first line of the address. Used to derive the metered service point" }, "address2":{ "type":"string", "maxLength":254, "description":"The second line of the address. Used to derive the metered service point" }, "address3":{ "type":"string", "maxLength":254, "description":"The third line of the address. Used to derive the metered service point" }, "address4":{ "type":"string", "maxLength":254, "description":"The fourth line of the address. Used to derive the metered service point" }, "city":{ "type":"string", "maxLength":90, "description":"The city of the address. Used to derive the metered service point" }, "county":{ "type":"string", "maxLength":90, "description":"The county of the address. Used to derive the metered service point" }, "state":{ "type":"string", "maxLength":6, "description":"The state of the address. Used to derive the metered service point" }, "postal":{ "type":"string", "maxLength":12, "description":"The postal code of the address. Used to derive the metered service point" } } }, "assetInfo":{ "type":"object", "properties":{ "manufacturer":{ "type":"string", "maxLength":30, "description":"Manufacturer" }, "model":{ "type":"string", "maxLength":30, "description":"Model" }, "serialNo":{ "type":"string", "maxLength":60, "description":"Serial number" }, "interconnectionAttributes":{ "type":"object", "properties":{ "interconnectionAttributesList":{ "type":"array", "items":{ "type":"object", "properties":{ "attribute":{ "type":"string", "maxLength":254, "description":"Interconnection attribute name" }, "value":{ "type":"string", "maxLength":254, "description":"Interconnection attribute value" } } } } } } } } }, "xml":{ "name":"X1_DERIntCon" } }, "INTERCONNECTDER_response":{ "type":"object", "properties":{ "enrollmentId":{ "type":"string", "maxLength":4, "description":"Enrollment ID" }, "transactionId":{ "type":"string", "maxLength":120, "description":"External Transaction ID" }, "status":{ "type":"string", "maxLength":12, "description":"Status" }, "exception":{ "type":"object", "properties":{ "messageCategory":{ "type":"string", "maxLength":5, "description":"Message Category" }, "messageNumber":{ "type":"string", "maxLength":5, "description":"Message Number" }, "expandedMessage":{ "type":"string", "maxLength":60, "description":"Expanded message parameter" } } } }, "xml":{ "name":"X1_DERIntCon" } }, "REGISTERDERDEVICE_request":{ "type":"object", "properties":{ "transactionId":{ "type":"string", "maxLength":120, "description":"External Transaction ID" }, "externalGroupingId":{ "type":"string", "maxLength":60, "description":"External identifier for the internal entity grouping code." }, "customerInfo":{ "type":"object", "properties":{ "cisPersonId":{ "type":"string", "maxLength":30, "description":"The CIS Person Id associated to the metered service point. Used to derive the existing customer and metered service record. Optional, if name is provided." }, "cisAccountId":{ "type":"string", "maxLength":30, "description":"The CIS Account Id associated to the metered service point. Used to derive the existing customer and metered service record. Optional, if name is provided." }, "name":{ "type":"string", "maxLength":254, "description":"The name of the customer. Used to derive the existing customer and metered service record" }, "homePhone":{ "type":"string", "maxLength":24, "description":"The home phone of the customer. Used to derive the existing customer and metered service record" }, "businessPhone":{ "type":"string", "maxLength":24, "description":"The business phone of the customer. Used to derive the existing customer and metered service record" }, "email":{ "type":"string", "maxLength":254, "description":"The email address of the customer. Used to derive the existing customer and metered service record" } } }, "locationInfo":{ "type":"object", "properties":{ "cisPremiseId":{ "type":"string", "maxLength":60, "description":"The CIS Premise Id associated to the metered service point. Used to derive the metered service point. Optional, if address information is provided." }, "cisServicePointID":{ "type":"string", "maxLength":60, "description":"The CIS Service Point Id associated to the metered service point. Used to derive the metered service point. Optional, if address information is provided." }, "division":{ "type":"string", "maxLength":30, "description":"Division is used to define the jurisdiction in which the customer is located." }, "timeZone":{ "type":"string", "maxLength":10, "description":"The time zone of the address" }, "country":{ "type":"string", "maxLength":3, "description":"The country of the address. Used to derive the metered service point" }, "address1":{ "type":"string", "maxLength":254, "description":"The first line of the address. Used to derive the metered service point" }, "address2":{ "type":"string", "maxLength":254, "description":"The second line of the address. Used to derive the metered service point" }, "address3":{ "type":"string", "maxLength":254, "description":"The third line of the address. Used to derive the metered service point" }, "address4":{ "type":"string", "maxLength":254, "description":"The fourth line of the address. Used to derive the metered service point" }, "city":{ "type":"string", "maxLength":90, "description":"The city of the address. Used to derive the metered service point" }, "county":{ "type":"string", "maxLength":90, "description":"The county of the address. Used to derive the metered service point" }, "state":{ "type":"string", "maxLength":6, "description":"The state of the address. Used to derive the metered service point" }, "postal":{ "type":"string", "maxLength":12, "description":"The postal code of the address. Used to derive the metered service point" } } }, "programInfo":{ "type":"object", "properties":{ "programCode":{ "type":"string", "maxLength":120, "description":"Program Code of the program being enrolled" } } }, "assetInfo":{ "type":"object", "properties":{ "registrationDate":{ "type":"string", "format":"date", "description":"Start date for the DER registration program" }, "headEndSystem":{ "type":"string", "maxLength":30, "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the registration process to create the controllable device record." }, "attributes":{ "type":"object", "properties":{ "DERCapability":{ "type":"object", "properties":{ "modesSupported":{ "type":"string", "maxLength":254, "description":"Indication of support for each control mode function" }, "rtgAbnormalCategory":{ "type":"string", "maxLength":254, "description":"Indication of voltage and frequency ride-through category I, II, or III" }, "rtgMaxA":{ "type":"string", "maxLength":254, "description":"Maximum continuous ac current capability of the DER, in amperes (rms)" }, "rtgMaxAh":{ "type":"string", "maxLength":254, "description":"Usable energy storage capacity of DER in amp hours" }, "rtgMaxChargeRateVA":{ "type":"string", "maxLength":254, "description":"Maximum apparent power charge rating in voltamperes; may differ from the apparent power maximum rating" }, "rtgMaxChargeRateW":{ "type":"string", "maxLength":254, "description":"Maximum active power charge rating in watts" }, "rtgMaxDischargeRateVA":{ "type":"string", "maxLength":254, "description":"Maximum apparent power discharge rating in voltamperes. May differ from the maximum apparent power rating." }, "rtgMaxDischargeRateW":{ "type":"string", "maxLength":254, "description":"Maximum rate of energy transfer delivered by the storage DER, in watts. Required for combined generation/storage DERs." }, "rtgMaxV":{ "type":"string", "maxLength":254, "description":"Maximum ac voltage rating in rms volts" }, "rtgMaxVA":{ "type":"string", "maxLength":254, "description":"Maximum apparent power charge rating in volt amperes" }, "rtgMaxVar":{ "type":"string", "maxLength":254, "description":"Maximum injected reactive power rating in vars" }, "rtgMaxVarNeg":{ "type":"string", "maxLength":254, "description":"Maximum absorbed reactive power rating in vars" }, "rtgMaxW":{ "type":"string", "maxLength":254, "description":"Active power rating in watts at unity power factor" }, "rtgMaxWh":{ "type":"string", "maxLength":254, "description":"Maximum energy storage capacity of DER in watthours" }, "rtgMinPFOverExcited":{ "type":"string", "maxLength":254, "description":"Minimum power factor displacement capability of the DER when injecting reactive power (over-excited)" }, "rtgMinPFUnderExcited":{ "type":"string", "maxLength":254, "description":"Minimum Power Factor displacement capability of the DER when absorbing reactive power (under-excited)" }, "rtgMinV":{ "type":"string", "maxLength":254, "description":"Minimum ac voltage rating in rms volts" }, "rtgNormalCategory":{ "type":"string", "maxLength":254, "description":"Indication of reactive power and voltage/power control capability" }, "rtgOverExcitedPF":{ "type":"string", "maxLength":254, "description":"Over-excited power factor" }, "rtgOverExcitedW":{ "type":"string", "maxLength":254, "description":"Active power rating in watts at specified over-excited power factor" }, "rtgReactiveSusceptance":{ "type":"string", "maxLength":254, "description":"Reactive susceptance that remains connected to the Area EPS in the cease to energize and trip state" }, "rtgUnderExcitedPF":{ "type":"string", "maxLength":254, "description":"Active power rating in watts at specified under-excited power factor" }, "rtgUnderExcitedW":{ "type":"string", "maxLength":254, "description":"Active power rating in watts at specified under-excited power factor" }, "rtgVNom":{ "type":"string", "maxLength":254, "description":"Nominal ac voltage rating in rms volts" }, "type":{ "type":"string", "maxLength":254, "description":"Type of DER" } } }, "DeviceInformation":{ "type":"object", "properties":{ "mfHwVer":{ "type":"string", "maxLength":254, "description":"Hardware version" }, "mfID":{ "type":"string", "maxLength":254, "description":"Manufacturer" }, "mfModel":{ "type":"string", "maxLength":254, "description":"Model" }, "mfSerNum":{ "type":"string", "maxLength":254, "description":"Serial number" }, "swVer":{ "type":"string", "maxLength":254, "description":"Software version" }, "lFDI":{ "type":"string", "maxLength":254, "description":"Long form of device identifier" }, "aggregatorId":{ "type":"string", "maxLength":254, "description":"Identifier of the entity through which a DER is reached, if not direct" } } }, "additionalAttributes":{ "type":"object", "properties":{ "additionalAttributeList":{ "type":"array", "items":{ "type":"object", "properties":{ "attribute":{ "type":"string", "maxLength":254, "description":"Additional attribute name" }, "value":{ "type":"string", "maxLength":254, "description":"Additional attribute value" } } } } } }, "interconnectionAttributes":{ "type":"object", "properties":{ "interconnectionAttributesList":{ "type":"array", "items":{ "type":"object", "properties":{ "attribute":{ "type":"string", "maxLength":254, "description":"Interconnection attribute name" }, "value":{ "type":"string", "maxLength":254, "description":"Adhoc Characteristic Value" } } } } } } } } } } }, "xml":{ "name":"X1_RegDERDvc" } }, "GETAPPOINTMENTSLOTS_request":{ "type":"object", "properties":{ "appointmentRequest":{ "type":"object", "properties":{ "serviceDate":{ "type":"string", "format":"date", "description":"A beginning date from which the crew's availability should be obtained.", "example":"2024-01-12" }, "serviceDays":{ "type":"number", "maximum":9, "minimum":0, "description":"Number of Days added to the Service Date to form a date range for retrieving Appointment Slots.", "example":"5" }, "serviceArea":{ "type":"string", "maxLength":30, "description":"Service areas defines a logical boundary of an organization's territory. Every crew shift is populated with a list of service areas that the crew shift is allowed to work." }, "crewId":{ "type":"string", "maxLength":12, "description":"Crew" }, "crewShiftType":{ "type":"string", "maxLength":30, "description":"Crew Shift Type" }, "tempWorkOrderIdentifier":{ "type":"string", "maxLength":60, "description":"Unique external identifier to fetch Template Work Order." }, "tempWorkActivitySeqNum":{ "type":"number", "maximum":99999, "minimum":0, "description":"Template Activity Number.", "example":"1" }, "activityType":{ "type":"string", "maxLength":30, "description":"Activity types define the main attributes for activities of a certain type and act as a model and template for Activity records." } } } }, "xml":{ "name":"X1WAppSlots" } }, "SCHEDULEAPPOINTMENT_response":{ "type":"object", "properties":{ }, "xml":{ "name":"X1WActSched" } }, "SCHEDULEAPPOINTMENT_request":{ "type":"object", "properties":{ "appointmentScheduleRequest":{ "type":"object", "properties":{ "workOrderActivity":{ "type":"string", "maxLength":14, "description":"Unique identifier for Work Activity" }, "crewShiftId":{ "type":"string", "maxLength":14, "description":"Unique identifier for crew shift." }, "rescheduleReason":{ "type":"string", "maxLength":256, "description":"Activity re-schedule reason", "example":"Customer will not be available at the premise." } } } }, "xml":{ "name":"X1WActSched" } }, "GETAPPOINTMENTSLOTS_response":{ "type":"object", "properties":{ "appointmentSlots":{ "type":"object", "properties":{ "crewShiftList":{ "type":"array", "items":{ "type":"object", "properties":{ "crewShiftId":{ "type":"string", "maxLength":14, "description":"Unique identifier for crew shift." }, "startDateTime":{ "type":"string", "format":"date-time", "description":"Crew Shift Start Date Time.", "example":"2024-01-12-06.00.00" }, "endDateTime":{ "type":"string", "format":"date-time", "description":"Crew Shift End Date Time", "example":"2024-01-12-08.00.00" }, "crewName":{ "type":"string", "maxLength":254, "description":"Name of the crew.", "example":"SMITH" }, "crewId":{ "type":"string", "maxLength":12, "description":"Crew" }, "workAvailabilityDuration":{ "type":"number", "maximum":"99999999999.99", "minimum":0, "description":"Duration of Crew availability.", "example":"4" } } } } } } }, "xml":{ "name":"X1WAppSlots" } }, "GETINFORMATIONALQUESTIONS_response":{ "type":"object", "properties":{ "informationalQuestions":{ "type":"object", "properties":{ "informationalQuestionsList":{ "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", "description":"(answerStyle)" }, "description":{ "type":"string", "description":"(description)" } } } } } } } } } } } }, "xml":{ "name":"X1-DAInfQues" } }, "GETELIGIBLEPROGRAMS_response":{ "type":"object", "properties":{ "eligiblePrograms":{ "type":"object", "properties":{ "eligibleProgramsList":{ "type":"array", "items":{ "type":"object", "properties":{ "programId":{ "type":"string", "description":"(programId)" }, "programCode":{ "type":"string", "description":"(programCode)" }, "programDescription":{ "type":"string", "description":"(programDescription)" } } } } } }, "exception":{ "type":"object", "properties":{ "messageCategory":{ "type":"string", "maxLength":5, "description":"Message Category" }, "messageNumber":{ "type":"string", "maxLength":5, "description":"Message Number" }, "expandedMessage":{ "type":"string", "maxLength":60, "description":"Expanded message parameter" } } } }, "xml":{ "name":"X1-DAPrgElig" } }, "GETQUALIFYINGQUESTIONS_response":{ "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" } }, "GETELIGIBLEPROGRAMS_request":{ "type":"object", "properties":{ "cisAccountId":{ "type":"string", "description":"(cisAccountId)" }, "division":{ "type":"string", "description":"(division)" } }, "xml":{ "name":"X1-DAPrgElig" } } } }, "security":[ { "BasicAuth":[ ] } ] }