Scada Web Service

Scada

Click here for a complete list of operations.

LoadContractsJson

BS_R_CONTRACT

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 /Scada.asmx HTTP/1.1
Host: novoapi.witechusa.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Scada/LoadContractsJson"

<?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>
    <ClsSeguridad xmlns="Scada">
      <User>string</User>
      <Password>string</Password>
      <Token>string</Token>
      <DataBaseEngine>ORACLE or MYSQL or SQLSERVER or POSTGRES</DataBaseEngine>
    </ClsSeguridad>
  </soap:Header>
  <soap:Body>
    <LoadContractsJson xmlns="Scada">
      <Operation>string</Operation>
      <Args>string</Args>
      <Read_Security_Level>int</Read_Security_Level>
    </LoadContractsJson>
  </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:Body>
    <LoadContractsJsonResponse xmlns="Scada">
      <LoadContractsJsonResult>
        <Data>
          <Contract>
            <ContractId>int</ContractId>
            <ContractName>string</ContractName>
            <TypeId>int</TypeId>
            <TypeName>string</TypeName>
            <ProviderId>int</ProviderId>
            <ProviderName>string</ProviderName>
            <ClientId>int</ClientId>
            <ClientName>string</ClientName>
            <ScopeId>int</ScopeId>
            <ScopeName>string</ScopeName>
            <NodeId>int</NodeId>
            <NodeName>string</NodeName>
            <ReferencePointId>int</ReferencePointId>
            <ReferencePointName>string</ReferencePointName>
            <SuperNodeId>int</SuperNodeId>
            <SuperNodeName>string</SuperNodeName>
            <VigencyStartDate>dateTime</VigencyStartDate>
            <VigencyEndDate>dateTime</VigencyEndDate>
            <TemporaryVigencyStartDate>dateTime</TemporaryVigencyStartDate>
            <TemporaryVigencyEndDate>dateTime</TemporaryVigencyEndDate>
            <ContractIdentification>long</ContractIdentification>
            <ClientAddress>string</ClientAddress>
            <LastBalanceDate>dateTime</LastBalanceDate>
            <LastBalanceValue>decimal</LastBalanceValue>
            <IsTemporary>boolean</IsTemporary>
            <UniqueAmount>boolean</UniqueAmount>
            <Expired>boolean</Expired>
            <ChangeRequestId>int</ChangeRequestId>
            <ContractBillingDetail xsi:nil="true" />
            <Capacities xsi:nil="true" />
            <Templates xsi:nil="true" />
            <HourlyTemplates xsi:nil="true" />
            <SettlementDateRange xsi:nil="true" />
          </Contract>
          <Contract>
            <ContractId>int</ContractId>
            <ContractName>string</ContractName>
            <TypeId>int</TypeId>
            <TypeName>string</TypeName>
            <ProviderId>int</ProviderId>
            <ProviderName>string</ProviderName>
            <ClientId>int</ClientId>
            <ClientName>string</ClientName>
            <ScopeId>int</ScopeId>
            <ScopeName>string</ScopeName>
            <NodeId>int</NodeId>
            <NodeName>string</NodeName>
            <ReferencePointId>int</ReferencePointId>
            <ReferencePointName>string</ReferencePointName>
            <SuperNodeId>int</SuperNodeId>
            <SuperNodeName>string</SuperNodeName>
            <VigencyStartDate>dateTime</VigencyStartDate>
            <VigencyEndDate>dateTime</VigencyEndDate>
            <TemporaryVigencyStartDate>dateTime</TemporaryVigencyStartDate>
            <TemporaryVigencyEndDate>dateTime</TemporaryVigencyEndDate>
            <ContractIdentification>long</ContractIdentification>
            <ClientAddress>string</ClientAddress>
            <LastBalanceDate>dateTime</LastBalanceDate>
            <LastBalanceValue>decimal</LastBalanceValue>
            <IsTemporary>boolean</IsTemporary>
            <UniqueAmount>boolean</UniqueAmount>
            <Expired>boolean</Expired>
            <ChangeRequestId>int</ChangeRequestId>
            <ContractBillingDetail xsi:nil="true" />
            <Capacities xsi:nil="true" />
            <Templates xsi:nil="true" />
            <HourlyTemplates xsi:nil="true" />
            <SettlementDateRange xsi:nil="true" />
          </Contract>
        </Data>
      </LoadContractsJsonResult>
    </LoadContractsJsonResponse>
  </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 /Scada.asmx HTTP/1.1
Host: novoapi.witechusa.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>
    <ClsSeguridad xmlns="Scada">
      <User>string</User>
      <Password>string</Password>
      <Token>string</Token>
      <DataBaseEngine>ORACLE or MYSQL or SQLSERVER or POSTGRES</DataBaseEngine>
    </ClsSeguridad>
  </soap12:Header>
  <soap12:Body>
    <LoadContractsJson xmlns="Scada">
      <Operation>string</Operation>
      <Args>string</Args>
      <Read_Security_Level>int</Read_Security_Level>
    </LoadContractsJson>
  </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:Body>
    <LoadContractsJsonResponse xmlns="Scada">
      <LoadContractsJsonResult>
        <Data>
          <Contract>
            <ContractId>int</ContractId>
            <ContractName>string</ContractName>
            <TypeId>int</TypeId>
            <TypeName>string</TypeName>
            <ProviderId>int</ProviderId>
            <ProviderName>string</ProviderName>
            <ClientId>int</ClientId>
            <ClientName>string</ClientName>
            <ScopeId>int</ScopeId>
            <ScopeName>string</ScopeName>
            <NodeId>int</NodeId>
            <NodeName>string</NodeName>
            <ReferencePointId>int</ReferencePointId>
            <ReferencePointName>string</ReferencePointName>
            <SuperNodeId>int</SuperNodeId>
            <SuperNodeName>string</SuperNodeName>
            <VigencyStartDate>dateTime</VigencyStartDate>
            <VigencyEndDate>dateTime</VigencyEndDate>
            <TemporaryVigencyStartDate>dateTime</TemporaryVigencyStartDate>
            <TemporaryVigencyEndDate>dateTime</TemporaryVigencyEndDate>
            <ContractIdentification>long</ContractIdentification>
            <ClientAddress>string</ClientAddress>
            <LastBalanceDate>dateTime</LastBalanceDate>
            <LastBalanceValue>decimal</LastBalanceValue>
            <IsTemporary>boolean</IsTemporary>
            <UniqueAmount>boolean</UniqueAmount>
            <Expired>boolean</Expired>
            <ChangeRequestId>int</ChangeRequestId>
            <ContractBillingDetail xsi:nil="true" />
            <Capacities xsi:nil="true" />
            <Templates xsi:nil="true" />
            <HourlyTemplates xsi:nil="true" />
            <SettlementDateRange xsi:nil="true" />
          </Contract>
          <Contract>
            <ContractId>int</ContractId>
            <ContractName>string</ContractName>
            <TypeId>int</TypeId>
            <TypeName>string</TypeName>
            <ProviderId>int</ProviderId>
            <ProviderName>string</ProviderName>
            <ClientId>int</ClientId>
            <ClientName>string</ClientName>
            <ScopeId>int</ScopeId>
            <ScopeName>string</ScopeName>
            <NodeId>int</NodeId>
            <NodeName>string</NodeName>
            <ReferencePointId>int</ReferencePointId>
            <ReferencePointName>string</ReferencePointName>
            <SuperNodeId>int</SuperNodeId>
            <SuperNodeName>string</SuperNodeName>
            <VigencyStartDate>dateTime</VigencyStartDate>
            <VigencyEndDate>dateTime</VigencyEndDate>
            <TemporaryVigencyStartDate>dateTime</TemporaryVigencyStartDate>
            <TemporaryVigencyEndDate>dateTime</TemporaryVigencyEndDate>
            <ContractIdentification>long</ContractIdentification>
            <ClientAddress>string</ClientAddress>
            <LastBalanceDate>dateTime</LastBalanceDate>
            <LastBalanceValue>decimal</LastBalanceValue>
            <IsTemporary>boolean</IsTemporary>
            <UniqueAmount>boolean</UniqueAmount>
            <Expired>boolean</Expired>
            <ChangeRequestId>int</ChangeRequestId>
            <ContractBillingDetail xsi:nil="true" />
            <Capacities xsi:nil="true" />
            <Templates xsi:nil="true" />
            <HourlyTemplates xsi:nil="true" />
            <SettlementDateRange xsi:nil="true" />
          </Contract>
        </Data>
      </LoadContractsJsonResult>
    </LoadContractsJsonResponse>
  </soap12:Body>
</soap12:Envelope>