All REST Endpoints

Sort by

Task Path Method

Group by API

Digital Assets/Controllable Device Status

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.

Post Controllable Device Status Check

Method: post

Path: /rest/apis/cross/digitalAssets/controllableDeviceStatus/response

Digital Assets/DER Device Management

DER (Distributed Energy Resource) device management enables interconnection and registration of DER assets.

DER Interconnection

Method: post

Path: /rest/apis/cross/digitalAssets/derDeviceManagement/interconnect

Register DER Device

Method: post

Path: /rest/apis/cross/digitalAssets/derDeviceManagement/register

Digital Assets/Program Eligibility and Qualification Questions

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.

Get Eligible Programs

Method: post

Path: /rest/apis/cross/digitalAssets/programEligibilityAndQualification/

Get Informational Questions

Method: get

Path: /rest/apis/cross/digitalAssets/programEligibilityAndQualification/{Program Code}/informationalQuestions

Get Qualification Questions

Method: get

Path: /rest/apis/cross/digitalAssets/programEligibilityAndQualification/{Program Code}/qualificationQuestions

Digital Assets/Program Enrollments

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.

Create Program Enrollment

Method: post

Path: /rest/apis/cross/digitalAssets/programEnrollments/enroll

Create Program Unenrollment

Method: post

Path: /rest/apis/cross/digitalAssets/programEnrollments/unenroll

Enroll Additional Device Service

Method: post

Path: /rest/apis/cross/digitalAssets/programEnrollments/enrollDevice

Get Program Enrollment

Method: get

Path: /rest/apis/cross/digitalAssets/programEnrollments/enroll/{Enrollment Id}

Get Program Unenrollment

Method: get

Path: /rest/apis/cross/digitalAssets/programEnrollments/unenroll/{Unenrollment Id}

Post Acknowledgement

Method: post

Path: /rest/apis/cross/digitalAssets/programEnrollments/postAcknowledgement

Digital Assets/Work Activity Appointment Tasks

Work Activity Appointment Tasks enable scheduling or rescheduling appointments within available time slots, based on the crew needed for a specific work order activity.

Get Work Activity Appointment Slots

Method: post

Path: /rest/apis/cross/digitalAssets/appointmentSlots/availableSlots

Schedule Activity

Method: post

Path: /rest/apis/cross/digitalAssets/appointmentSlots/schedule

Service/Program Event

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.

Action Program Event

Method: post

Path: /rest/apis/cross/service/programEvent/lifecycle

Create Program Event

Method: post

Path: /rest/apis/cross/service/programEvent/

Service/Program Event Participation

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.

Post Event Outcome

Method: post

Path: /rest/apis/cross/service/programEventParticipation/postEventOutcome

Reserve Device

Method: post

Path: /rest/apis/cross/service/programEventParticipation/reserveDevice