SCADA_Server Web Service

SCADA_Server

Click here for a complete list of operations.

GetDRProgramsByStatus

Requests a list of DR programs for a particular value of DRProgramStatus. The permissible values of DRProgramStatus are: 'Active', 'Suspended', 'Rescinded', 'Other' and 'Unknown'. Active status means that the DRProgram has an ending date in the future and customer enrollment is possible, even if control is not currently active. A status of Suspended implies that a customer can still be enrolled in the program but no load control or pricing signals will be sent. A status of Rescinded means that a customer cannot be enrolled in the DRProgram. The Other and Unknown statuses are included for extensibility, but their use is discouraged. If the DRProgramStatus is set to be Other, the DR Program Owner should populate the OtherDRProgramStatus element with the non-standard status value.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /MultispeakService/SCADA_Server_v416.asmx HTTP/1.1
Host: multispeak.utilismartcorp.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.multispeak.org/Version_4.1_Release/GetDRProgramsByStatus"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <MultiSpeakMsgHeader MajorVersion="integer" MinorVersion="integer" Build="integer" Branch="integer" BuildString="PR or RC or Branch or Release or Other or Unknown" UserID="string" Pwd="string" AppName="string" AppVersion="string" Company="string" DefaultCurrencyCode="USD or EUR or AED or AFN or ALL or AMD or ANG or AOA or ARS or AUD or AWG or AZN or BAM or BBD or BDT or BGN or BHD or BIF or BMD or BND or BOB or BOV or BRL or BSD or BTN or BWP or BYR or BZD or CAD or CDF or CHE or CHF or CHW or CLF or CLP or CNY or COP or COU or CRC or CUP or CVE or CZK or DJF or DKK or DOP or DZD or EEK or EGP or ERN or ETB or FJD or FKP or GBP or GEL or GHS or GIP or GMD or GNF or GTQ or GYD or HKD or HNL or HRK or HTG or HUF or IDR or ILS or INR or IQD or IRR or ISK or JMD or JOD or JPY or KES or KGS or KHR or KMF or KPW or KRW or KWD or KYD or KZT or LAK or LBP or LKR or LRD or LSL or LTL or LVL or LYD or MAD or MDL or MGA or MKD or MMK or MNT or MOP or MRO or MUR or MVR or MWK or MXN or MXV or MYR or MZN or NAD or NGN or NIO or NOK or NPR or NZD or OMR or PAB or PEN or PGK or PHP or PKR or PLN or PYG or QAR or RON or RSD or RUB or RWF or SAR or SBD or SCR or SDG or SEK or SGD or SHP or SKK or SLL or SOS or SRD or STD or SYP or SZL or THB or TJS or TMM or TND or TOP or TRY or TTD or TWD or TZS or UAH or UGX or USN or USS or UYU or UZS or VEF or VND or VUV or WST or XAF or XAG or XAU or XBA or XBB or XBC or XBD or XCD or XDR or XFU or XOF or XPD or XPF or XPT or XTS or XXX or YER or ZAR or ZMK or ZWD or ADF or ADP or ATS or BEF or CYP or DEM or ESP or FIM or FRF or GRD or IEP or ITL or LUF or MCF or MTL or NLG or PTE or SIT or SML or VAL or XEU or Other" CSUnits="feet or meters or USSurveyFeet or other" CoordinateSystemName="string" CoordinateSystemAuthority="string" CoordinateSystemAuthorityCode="string" Datum="string" SessionID="string" PreviousSessionID="string" ObjectsRemaining="integer" LastSent="string" RegistrationID="string" MessageID="string" TimeStamp="dateTime" Context="Production or Testing or Development or Study or Training or Other" AuditID="string" AuditPassword="string" xmlns="http://www.multispeak.org/Version_4.1_Release" />
  </soap:Header>
  <soap:Body>
    <GetDRProgramsByStatus xmlns="http://www.multispeak.org/Version_4.1_Release">
      <DRProgramStatus>string</DRProgramStatus>
    </GetDRProgramsByStatus>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <MultiSpeakMsgHeader MajorVersion="integer" MinorVersion="integer" Build="integer" Branch="integer" BuildString="PR or RC or Branch or Release or Other or Unknown" UserID="string" Pwd="string" AppName="string" AppVersion="string" Company="string" DefaultCurrencyCode="USD or EUR or AED or AFN or ALL or AMD or ANG or AOA or ARS or AUD or AWG or AZN or BAM or BBD or BDT or BGN or BHD or BIF or BMD or BND or BOB or BOV or BRL or BSD or BTN or BWP or BYR or BZD or CAD or CDF or CHE or CHF or CHW or CLF or CLP or CNY or COP or COU or CRC or CUP or CVE or CZK or DJF or DKK or DOP or DZD or EEK or EGP or ERN or ETB or FJD or FKP or GBP or GEL or GHS or GIP or GMD or GNF or GTQ or GYD or HKD or HNL or HRK or HTG or HUF or IDR or ILS or INR or IQD or IRR or ISK or JMD or JOD or JPY or KES or KGS or KHR or KMF or KPW or KRW or KWD or KYD or KZT or LAK or LBP or LKR or LRD or LSL or LTL or LVL or LYD or MAD or MDL or MGA or MKD or MMK or MNT or MOP or MRO or MUR or MVR or MWK or MXN or MXV or MYR or MZN or NAD or NGN or NIO or NOK or NPR or NZD or OMR or PAB or PEN or PGK or PHP or PKR or PLN or PYG or QAR or RON or RSD or RUB or RWF or SAR or SBD or SCR or SDG or SEK or SGD or SHP or SKK or SLL or SOS or SRD or STD or SYP or SZL or THB or TJS or TMM or TND or TOP or TRY or TTD or TWD or TZS or UAH or UGX or USN or USS or UYU or UZS or VEF or VND or VUV or WST or XAF or XAG or XAU or XBA or XBB or XBC or XBD or XCD or XDR or XFU or XOF or XPD or XPF or XPT or XTS or XXX or YER or ZAR or ZMK or ZWD or ADF or ADP or ATS or BEF or CYP or DEM or ESP or FIM or FRF or GRD or IEP or ITL or LUF or MCF or MTL or NLG or PTE or SIT or SML or VAL or XEU or Other" CSUnits="feet or meters or USSurveyFeet or other" CoordinateSystemName="string" CoordinateSystemAuthority="string" CoordinateSystemAuthorityCode="string" Datum="string" SessionID="string" PreviousSessionID="string" ObjectsRemaining="integer" LastSent="string" RegistrationID="string" MessageID="string" TimeStamp="dateTime" Context="Production or Testing or Development or Study or Training or Other" AuditID="string" AuditPassword="string" xmlns="http://www.multispeak.org/Version_4.1_Release" />
  </soap:Header>
  <soap:Body>
    <GetDRProgramsByStatusResponse xmlns="http://www.multispeak.org/Version_4.1_Release">
      <GetDRProgramsByStatusResult>
        <DRProgram>
          <DRProgramName>string</DRProgramName>
          <DRProgramOwner>string</DRProgramOwner>
          <DRProgramDescription>string</DRProgramDescription>
          <DRProgramStartDate>dateTime</DRProgramStartDate>
          <DRProgramEndDate>dateTime</DRProgramEndDate>
          <isDRDeviceRequired>boolean</isDRDeviceRequired>
          <HANDeviceType>string</HANDeviceType>
          <DRProgramStatus>Other or Active or Suspended or Rescinded or Unknown</DRProgramStatus>
          <otherDRProgramStatus>string</otherDRProgramStatus>
          <DRProgramType>string</DRProgramType>
        </DRProgram>
        <DRProgram>
          <DRProgramName>string</DRProgramName>
          <DRProgramOwner>string</DRProgramOwner>
          <DRProgramDescription>string</DRProgramDescription>
          <DRProgramStartDate>dateTime</DRProgramStartDate>
          <DRProgramEndDate>dateTime</DRProgramEndDate>
          <isDRDeviceRequired>boolean</isDRDeviceRequired>
          <HANDeviceType>string</HANDeviceType>
          <DRProgramStatus>Other or Active or Suspended or Rescinded or Unknown</DRProgramStatus>
          <otherDRProgramStatus>string</otherDRProgramStatus>
          <DRProgramType>string</DRProgramType>
        </DRProgram>
      </GetDRProgramsByStatusResult>
    </GetDRProgramsByStatusResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /MultispeakService/SCADA_Server_v416.asmx HTTP/1.1
Host: multispeak.utilismartcorp.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <MultiSpeakMsgHeader MajorVersion="integer" MinorVersion="integer" Build="integer" Branch="integer" BuildString="PR or RC or Branch or Release or Other or Unknown" UserID="string" Pwd="string" AppName="string" AppVersion="string" Company="string" DefaultCurrencyCode="USD or EUR or AED or AFN or ALL or AMD or ANG or AOA or ARS or AUD or AWG or AZN or BAM or BBD or BDT or BGN or BHD or BIF or BMD or BND or BOB or BOV or BRL or BSD or BTN or BWP or BYR or BZD or CAD or CDF or CHE or CHF or CHW or CLF or CLP or CNY or COP or COU or CRC or CUP or CVE or CZK or DJF or DKK or DOP or DZD or EEK or EGP or ERN or ETB or FJD or FKP or GBP or GEL or GHS or GIP or GMD or GNF or GTQ or GYD or HKD or HNL or HRK or HTG or HUF or IDR or ILS or INR or IQD or IRR or ISK or JMD or JOD or JPY or KES or KGS or KHR or KMF or KPW or KRW or KWD or KYD or KZT or LAK or LBP or LKR or LRD or LSL or LTL or LVL or LYD or MAD or MDL or MGA or MKD or MMK or MNT or MOP or MRO or MUR or MVR or MWK or MXN or MXV or MYR or MZN or NAD or NGN or NIO or NOK or NPR or NZD or OMR or PAB or PEN or PGK or PHP or PKR or PLN or PYG or QAR or RON or RSD or RUB or RWF or SAR or SBD or SCR or SDG or SEK or SGD or SHP or SKK or SLL or SOS or SRD or STD or SYP or SZL or THB or TJS or TMM or TND or TOP or TRY or TTD or TWD or TZS or UAH or UGX or USN or USS or UYU or UZS or VEF or VND or VUV or WST or XAF or XAG or XAU or XBA or XBB or XBC or XBD or XCD or XDR or XFU or XOF or XPD or XPF or XPT or XTS or XXX or YER or ZAR or ZMK or ZWD or ADF or ADP or ATS or BEF or CYP or DEM or ESP or FIM or FRF or GRD or IEP or ITL or LUF or MCF or MTL or NLG or PTE or SIT or SML or VAL or XEU or Other" CSUnits="feet or meters or USSurveyFeet or other" CoordinateSystemName="string" CoordinateSystemAuthority="string" CoordinateSystemAuthorityCode="string" Datum="string" SessionID="string" PreviousSessionID="string" ObjectsRemaining="integer" LastSent="string" RegistrationID="string" MessageID="string" TimeStamp="dateTime" Context="Production or Testing or Development or Study or Training or Other" AuditID="string" AuditPassword="string" xmlns="http://www.multispeak.org/Version_4.1_Release" />
  </soap12:Header>
  <soap12:Body>
    <GetDRProgramsByStatus xmlns="http://www.multispeak.org/Version_4.1_Release">
      <DRProgramStatus>string</DRProgramStatus>
    </GetDRProgramsByStatus>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <MultiSpeakMsgHeader MajorVersion="integer" MinorVersion="integer" Build="integer" Branch="integer" BuildString="PR or RC or Branch or Release or Other or Unknown" UserID="string" Pwd="string" AppName="string" AppVersion="string" Company="string" DefaultCurrencyCode="USD or EUR or AED or AFN or ALL or AMD or ANG or AOA or ARS or AUD or AWG or AZN or BAM or BBD or BDT or BGN or BHD or BIF or BMD or BND or BOB or BOV or BRL or BSD or BTN or BWP or BYR or BZD or CAD or CDF or CHE or CHF or CHW or CLF or CLP or CNY or COP or COU or CRC or CUP or CVE or CZK or DJF or DKK or DOP or DZD or EEK or EGP or ERN or ETB or FJD or FKP or GBP or GEL or GHS or GIP or GMD or GNF or GTQ or GYD or HKD or HNL or HRK or HTG or HUF or IDR or ILS or INR or IQD or IRR or ISK or JMD or JOD or JPY or KES or KGS or KHR or KMF or KPW or KRW or KWD or KYD or KZT or LAK or LBP or LKR or LRD or LSL or LTL or LVL or LYD or MAD or MDL or MGA or MKD or MMK or MNT or MOP or MRO or MUR or MVR or MWK or MXN or MXV or MYR or MZN or NAD or NGN or NIO or NOK or NPR or NZD or OMR or PAB or PEN or PGK or PHP or PKR or PLN or PYG or QAR or RON or RSD or RUB or RWF or SAR or SBD or SCR or SDG or SEK or SGD or SHP or SKK or SLL or SOS or SRD or STD or SYP or SZL or THB or TJS or TMM or TND or TOP or TRY or TTD or TWD or TZS or UAH or UGX or USN or USS or UYU or UZS or VEF or VND or VUV or WST or XAF or XAG or XAU or XBA or XBB or XBC or XBD or XCD or XDR or XFU or XOF or XPD or XPF or XPT or XTS or XXX or YER or ZAR or ZMK or ZWD or ADF or ADP or ATS or BEF or CYP or DEM or ESP or FIM or FRF or GRD or IEP or ITL or LUF or MCF or MTL or NLG or PTE or SIT or SML or VAL or XEU or Other" CSUnits="feet or meters or USSurveyFeet or other" CoordinateSystemName="string" CoordinateSystemAuthority="string" CoordinateSystemAuthorityCode="string" Datum="string" SessionID="string" PreviousSessionID="string" ObjectsRemaining="integer" LastSent="string" RegistrationID="string" MessageID="string" TimeStamp="dateTime" Context="Production or Testing or Development or Study or Training or Other" AuditID="string" AuditPassword="string" xmlns="http://www.multispeak.org/Version_4.1_Release" />
  </soap12:Header>
  <soap12:Body>
    <GetDRProgramsByStatusResponse xmlns="http://www.multispeak.org/Version_4.1_Release">
      <GetDRProgramsByStatusResult>
        <DRProgram>
          <DRProgramName>string</DRProgramName>
          <DRProgramOwner>string</DRProgramOwner>
          <DRProgramDescription>string</DRProgramDescription>
          <DRProgramStartDate>dateTime</DRProgramStartDate>
          <DRProgramEndDate>dateTime</DRProgramEndDate>
          <isDRDeviceRequired>boolean</isDRDeviceRequired>
          <HANDeviceType>string</HANDeviceType>
          <DRProgramStatus>Other or Active or Suspended or Rescinded or Unknown</DRProgramStatus>
          <otherDRProgramStatus>string</otherDRProgramStatus>
          <DRProgramType>string</DRProgramType>
        </DRProgram>
        <DRProgram>
          <DRProgramName>string</DRProgramName>
          <DRProgramOwner>string</DRProgramOwner>
          <DRProgramDescription>string</DRProgramDescription>
          <DRProgramStartDate>dateTime</DRProgramStartDate>
          <DRProgramEndDate>dateTime</DRProgramEndDate>
          <isDRDeviceRequired>boolean</isDRDeviceRequired>
          <HANDeviceType>string</HANDeviceType>
          <DRProgramStatus>Other or Active or Suspended or Rescinded or Unknown</DRProgramStatus>
          <otherDRProgramStatus>string</otherDRProgramStatus>
          <DRProgramType>string</DRProgramType>
        </DRProgram>
      </GetDRProgramsByStatusResult>
    </GetDRProgramsByStatusResponse>
  </soap12:Body>
</soap12:Envelope>