Each interface has an associated payload that refers to the information that needs to be sent or received by a component in the DELTA environment. The SHACL shapes are used to verify that a payload is consistent with the OpenADR ontology restrictions. The JSON-LD payloads examples are guidelines to produce payloads that follow the OpenADR ontology.
Interface name | Exchanged data | SHACL shapes | JSON-LD examples | Service |
---|---|---|---|---|
oadrCanceledOpt | Data related to provide information about the schedule that is cancelled. | oadrCanceledOpt Shape | oadrCanceledOpt Example | Opt |
oadrCancelOpt Opt | Data related to a schedule that must be cancelled. | oadrCancelOpt Shape | oadrCancelOpt Example | Opt |
oadrCancelPartyRegistration | Data related to a device that is removed from the environment. | oadrCancelPartyRegistration Shape | oadrCancelPartyRegistration Example | Register |
oadrCreatedEvent | Data related to an event that is sent from the VEN to the VTN. | oadrCreatedEvent Shape | oadrCreatedEvent Example | Event |
oadrCreatedOpt | Data related to the schedule that is created associated to an asset. | oadrCreatedOpt Shape | oadrCreatedOpt Example | Opt |
oadrCreatedPartyRegistration | Data related to the registered VEN, which also includes the supported profiles and transports, the service specific information or extensions required to insure interoperability over the profile and transport being utilized. | oadrCreatedPartyRegistration Shape | oadrCreatedPartyRegistration Example | Register |
oadrCreatedPartyRegistration with ID | Data related to the registered VEN, which also includes the VEN ID, the supported profiles and transports, the service specific information or extensions required to insure interoperability over the profile and transport being utilized. | oadrCreatedPartyRegistration with ID Shape | oadrCreatedPartyRegistration with ID Example | Register |
oadrCreatedReport | Data related to a created report and the list of pending reports that are scheduled for future delivery. | oadrCreatedReport Shape | oadrCreatedReport Example | Report |
oadrCreateOpt | Data related to the period of temporary availability or unavailability for a target. | oadrCreateOpt Shape | oadrCreateOpt Example | Opt |
oadrCreatePartyRegistration | Data related to the VEN that is going to be registered. | oadrCreatePartyRegistration Shape | oadrCreatePartyRegistration Example | Register |
oadrCreateReport | Data related to a report that is requested from the target party. That payload contains a set of reportSpecifierID's that correspond to reports in the METADATA report that was previously sent by the target party as part of the previously described oadrRegisterReport interaction. | oadrCreateReport Shape | oadrCreateReport Example | Report |
oadrDistributeEvent | Data related to a new event and that is sent from the VTN to the VEN. | oadrDistributeEvent Shape | oadrDistributeEvent Example | Event |
oadrPoll | Data to request pending service operations from the VTN. | oadrPoll Shape | oadrPoll Example | Poll |
oadrQueryRegistration | Data related to the profiles, transports, and extensions a VTN may support. | oadrQueryRegistration Shape | oadrQueryRegistration Example | Register |
oadrRegisteredReport | Data related to the report that is registered. | oadrRegisteredReport Shape | oadrRegisteredReport Example | Report |
oadrRegisterReport | Data related to the reporting capabilities of a source party. | oadrRegisterReport Shape | oadrRegisterReport Example | Report |
oadrCancelReport | Data related to a cancelled report for avoiding any future reports. | oadrCancelReport Shape | oadrCancelReport Example | Report |
oadrUpdateReport | Data related to a report that is updated. | oadrUpdateReport Shape | oadrUpdateReport Example | Report |
oadrRequestReregistration | Data related to a VTN that has changed its registration information. | RequestReregistration Shape | RequestReregistration Example | Register |