Scada


Click here for a complete list of operations.

LoadBillContract

Load Bill 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/LoadBillContract"

<?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>
    <LoadBillContract xmlns="Scada">
      <Operation>string</Operation>
      <Args>string</Args>
      <Read_Security_Level>int</Read_Security_Level>
    </LoadBillContract>
  </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>
    <LoadBillContractResponse xmlns="Scada">
      <LoadBillContractResult>
        <Data>
          <ClsBillContract>
            <id_contract>int</id_contract>
            <id_contract_type>int</id_contract_type>
            <id_agent>int</id_agent>
            <description>string</description>
            <base_value>double</base_value>
            <top_value>double</top_value>
            <volumetric_value>double</volumetric_value>
            <read_security_level>int</read_security_level>
            <write_security_level>int</write_security_level>
            <agent_name>string</agent_name>
            <contract_type>string</contract_type>
            <id_reference_point>int</id_reference_point>
            <reference_point_name>string</reference_point_name>
            <id_injection_point>int</id_injection_point>
            <injection_point_name>string</injection_point_name>
            <id_extraction_point>int</id_extraction_point>
            <extraction_point_name>string</extraction_point_name>
            <id_zone>int</id_zone>
            <zone_name>string</zone_name>
            <id_node>int</id_node>
            <node_name>string</node_name>
            <subscriber>string</subscriber>
            <unique_amount>boolean</unique_amount>
            <id_contract_detail>int</id_contract_detail>
            <contract_identification>long</contract_identification>
            <client_address>string</client_address>
            <vigency_start_date>dateTime</vigency_start_date>
            <vigency_end_date>dateTime</vigency_end_date>
            <supply_capacity>double</supply_capacity>
            <transport_capacity>double</transport_capacity>
            <standar_connection_length>double</standar_connection_length>
            <not_standar_connection_length>double</not_standar_connection_length>
            <id_billing_cycle>int</id_billing_cycle>
            <billing_cycle>string</billing_cycle>
            <id_trm_type>int</id_trm_type>
            <trm_name>string</trm_name>
            <id_origin_agent>int</id_origin_agent>
            <id_end_agent>int</id_end_agent>
            <end_agent_name>string</end_agent_name>
            <id_payment_method>int</id_payment_method>
            <payment_method>string</payment_method>
            <detail_record_status>boolean</detail_record_status>
            <supply_unit_name>string</supply_unit_name>
            <id_supply_unit>int</id_supply_unit>
            <transport_unit_name>string</transport_unit_name>
            <id_transport_unit>int</id_transport_unit>
            <id_currency>int</id_currency>
            <currency_name>string</currency_name>
            <fixed_base_for_transport>double</fixed_base_for_transport>
            <swing_base_for_transport>double</swing_base_for_transport>
            <volumetric_base_for_transport>double</volumetric_base_for_transport>
            <same_values_for_transport>boolean</same_values_for_transport>
            <is_volumetric_base_available>boolean</is_volumetric_base_available>
            <id_transporter>int</id_transporter>
            <transporter_name>string</transporter_name>
            <id_producer>int</id_producer>
            <producer_name>string</producer_name>
            <settlement_date_range xsi:nil="true" />
            <monthly_min_energy>double</monthly_min_energy>
            <date_apply_min_energy>dateTime</date_apply_min_energy>
            <create_user>string</create_user>
            <temp_base_value>double</temp_base_value>
            <temp_top_value>double</temp_top_value>
            <temp_volumetric_value>double</temp_volumetric_value>
            <temp_fixed_base_for_transport>double</temp_fixed_base_for_transport>
            <temp_swing_base_for_transport>double</temp_swing_base_for_transport>
            <temp_volumetric_base_for_transport>double</temp_volumetric_base_for_transport>
            <temp_vigency_start_date>dateTime</temp_vigency_start_date>
            <temp_vigency_end_date>dateTime</temp_vigency_end_date>
            <applied_temp_contract>boolean</applied_temp_contract>
            <same_temp_values_for_transport>boolean</same_temp_values_for_transport>
            <is_temp_volumetric_base_available>boolean</is_temp_volumetric_base_available>
          </ClsBillContract>
          <ClsBillContract>
            <id_contract>int</id_contract>
            <id_contract_type>int</id_contract_type>
            <id_agent>int</id_agent>
            <description>string</description>
            <base_value>double</base_value>
            <top_value>double</top_value>
            <volumetric_value>double</volumetric_value>
            <read_security_level>int</read_security_level>
            <write_security_level>int</write_security_level>
            <agent_name>string</agent_name>
            <contract_type>string</contract_type>
            <id_reference_point>int</id_reference_point>
            <reference_point_name>string</reference_point_name>
            <id_injection_point>int</id_injection_point>
            <injection_point_name>string</injection_point_name>
            <id_extraction_point>int</id_extraction_point>
            <extraction_point_name>string</extraction_point_name>
            <id_zone>int</id_zone>
            <zone_name>string</zone_name>
            <id_node>int</id_node>
            <node_name>string</node_name>
            <subscriber>string</subscriber>
            <unique_amount>boolean</unique_amount>
            <id_contract_detail>int</id_contract_detail>
            <contract_identification>long</contract_identification>
            <client_address>string</client_address>
            <vigency_start_date>dateTime</vigency_start_date>
            <vigency_end_date>dateTime</vigency_end_date>
            <supply_capacity>double</supply_capacity>
            <transport_capacity>double</transport_capacity>
            <standar_connection_length>double</standar_connection_length>
            <not_standar_connection_length>double</not_standar_connection_length>
            <id_billing_cycle>int</id_billing_cycle>
            <billing_cycle>string</billing_cycle>
            <id_trm_type>int</id_trm_type>
            <trm_name>string</trm_name>
            <id_origin_agent>int</id_origin_agent>
            <id_end_agent>int</id_end_agent>
            <end_agent_name>string</end_agent_name>
            <id_payment_method>int</id_payment_method>
            <payment_method>string</payment_method>
            <detail_record_status>boolean</detail_record_status>
            <supply_unit_name>string</supply_unit_name>
            <id_supply_unit>int</id_supply_unit>
            <transport_unit_name>string</transport_unit_name>
            <id_transport_unit>int</id_transport_unit>
            <id_currency>int</id_currency>
            <currency_name>string</currency_name>
            <fixed_base_for_transport>double</fixed_base_for_transport>
            <swing_base_for_transport>double</swing_base_for_transport>
            <volumetric_base_for_transport>double</volumetric_base_for_transport>
            <same_values_for_transport>boolean</same_values_for_transport>
            <is_volumetric_base_available>boolean</is_volumetric_base_available>
            <id_transporter>int</id_transporter>
            <transporter_name>string</transporter_name>
            <id_producer>int</id_producer>
            <producer_name>string</producer_name>
            <settlement_date_range xsi:nil="true" />
            <monthly_min_energy>double</monthly_min_energy>
            <date_apply_min_energy>dateTime</date_apply_min_energy>
            <create_user>string</create_user>
            <temp_base_value>double</temp_base_value>
            <temp_top_value>double</temp_top_value>
            <temp_volumetric_value>double</temp_volumetric_value>
            <temp_fixed_base_for_transport>double</temp_fixed_base_for_transport>
            <temp_swing_base_for_transport>double</temp_swing_base_for_transport>
            <temp_volumetric_base_for_transport>double</temp_volumetric_base_for_transport>
            <temp_vigency_start_date>dateTime</temp_vigency_start_date>
            <temp_vigency_end_date>dateTime</temp_vigency_end_date>
            <applied_temp_contract>boolean</applied_temp_contract>
            <same_temp_values_for_transport>boolean</same_temp_values_for_transport>
            <is_temp_volumetric_base_available>boolean</is_temp_volumetric_base_available>
          </ClsBillContract>
        </Data>
      </LoadBillContractResult>
    </LoadBillContractResponse>
  </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>
    <LoadBillContract xmlns="Scada">
      <Operation>string</Operation>
      <Args>string</Args>
      <Read_Security_Level>int</Read_Security_Level>
    </LoadBillContract>
  </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>
    <LoadBillContractResponse xmlns="Scada">
      <LoadBillContractResult>
        <Data>
          <ClsBillContract>
            <id_contract>int</id_contract>
            <id_contract_type>int</id_contract_type>
            <id_agent>int</id_agent>
            <description>string</description>
            <base_value>double</base_value>
            <top_value>double</top_value>
            <volumetric_value>double</volumetric_value>
            <read_security_level>int</read_security_level>
            <write_security_level>int</write_security_level>
            <agent_name>string</agent_name>
            <contract_type>string</contract_type>
            <id_reference_point>int</id_reference_point>
            <reference_point_name>string</reference_point_name>
            <id_injection_point>int</id_injection_point>
            <injection_point_name>string</injection_point_name>
            <id_extraction_point>int</id_extraction_point>
            <extraction_point_name>string</extraction_point_name>
            <id_zone>int</id_zone>
            <zone_name>string</zone_name>
            <id_node>int</id_node>
            <node_name>string</node_name>
            <subscriber>string</subscriber>
            <unique_amount>boolean</unique_amount>
            <id_contract_detail>int</id_contract_detail>
            <contract_identification>long</contract_identification>
            <client_address>string</client_address>
            <vigency_start_date>dateTime</vigency_start_date>
            <vigency_end_date>dateTime</vigency_end_date>
            <supply_capacity>double</supply_capacity>
            <transport_capacity>double</transport_capacity>
            <standar_connection_length>double</standar_connection_length>
            <not_standar_connection_length>double</not_standar_connection_length>
            <id_billing_cycle>int</id_billing_cycle>
            <billing_cycle>string</billing_cycle>
            <id_trm_type>int</id_trm_type>
            <trm_name>string</trm_name>
            <id_origin_agent>int</id_origin_agent>
            <id_end_agent>int</id_end_agent>
            <end_agent_name>string</end_agent_name>
            <id_payment_method>int</id_payment_method>
            <payment_method>string</payment_method>
            <detail_record_status>boolean</detail_record_status>
            <supply_unit_name>string</supply_unit_name>
            <id_supply_unit>int</id_supply_unit>
            <transport_unit_name>string</transport_unit_name>
            <id_transport_unit>int</id_transport_unit>
            <id_currency>int</id_currency>
            <currency_name>string</currency_name>
            <fixed_base_for_transport>double</fixed_base_for_transport>
            <swing_base_for_transport>double</swing_base_for_transport>
            <volumetric_base_for_transport>double</volumetric_base_for_transport>
            <same_values_for_transport>boolean</same_values_for_transport>
            <is_volumetric_base_available>boolean</is_volumetric_base_available>
            <id_transporter>int</id_transporter>
            <transporter_name>string</transporter_name>
            <id_producer>int</id_producer>
            <producer_name>string</producer_name>
            <settlement_date_range xsi:nil="true" />
            <monthly_min_energy>double</monthly_min_energy>
            <date_apply_min_energy>dateTime</date_apply_min_energy>
            <create_user>string</create_user>
            <temp_base_value>double</temp_base_value>
            <temp_top_value>double</temp_top_value>
            <temp_volumetric_value>double</temp_volumetric_value>
            <temp_fixed_base_for_transport>double</temp_fixed_base_for_transport>
            <temp_swing_base_for_transport>double</temp_swing_base_for_transport>
            <temp_volumetric_base_for_transport>double</temp_volumetric_base_for_transport>
            <temp_vigency_start_date>dateTime</temp_vigency_start_date>
            <temp_vigency_end_date>dateTime</temp_vigency_end_date>
            <applied_temp_contract>boolean</applied_temp_contract>
            <same_temp_values_for_transport>boolean</same_temp_values_for_transport>
            <is_temp_volumetric_base_available>boolean</is_temp_volumetric_base_available>
          </ClsBillContract>
          <ClsBillContract>
            <id_contract>int</id_contract>
            <id_contract_type>int</id_contract_type>
            <id_agent>int</id_agent>
            <description>string</description>
            <base_value>double</base_value>
            <top_value>double</top_value>
            <volumetric_value>double</volumetric_value>
            <read_security_level>int</read_security_level>
            <write_security_level>int</write_security_level>
            <agent_name>string</agent_name>
            <contract_type>string</contract_type>
            <id_reference_point>int</id_reference_point>
            <reference_point_name>string</reference_point_name>
            <id_injection_point>int</id_injection_point>
            <injection_point_name>string</injection_point_name>
            <id_extraction_point>int</id_extraction_point>
            <extraction_point_name>string</extraction_point_name>
            <id_zone>int</id_zone>
            <zone_name>string</zone_name>
            <id_node>int</id_node>
            <node_name>string</node_name>
            <subscriber>string</subscriber>
            <unique_amount>boolean</unique_amount>
            <id_contract_detail>int</id_contract_detail>
            <contract_identification>long</contract_identification>
            <client_address>string</client_address>
            <vigency_start_date>dateTime</vigency_start_date>
            <vigency_end_date>dateTime</vigency_end_date>
            <supply_capacity>double</supply_capacity>
            <transport_capacity>double</transport_capacity>
            <standar_connection_length>double</standar_connection_length>
            <not_standar_connection_length>double</not_standar_connection_length>
            <id_billing_cycle>int</id_billing_cycle>
            <billing_cycle>string</billing_cycle>
            <id_trm_type>int</id_trm_type>
            <trm_name>string</trm_name>
            <id_origin_agent>int</id_origin_agent>
            <id_end_agent>int</id_end_agent>
            <end_agent_name>string</end_agent_name>
            <id_payment_method>int</id_payment_method>
            <payment_method>string</payment_method>
            <detail_record_status>boolean</detail_record_status>
            <supply_unit_name>string</supply_unit_name>
            <id_supply_unit>int</id_supply_unit>
            <transport_unit_name>string</transport_unit_name>
            <id_transport_unit>int</id_transport_unit>
            <id_currency>int</id_currency>
            <currency_name>string</currency_name>
            <fixed_base_for_transport>double</fixed_base_for_transport>
            <swing_base_for_transport>double</swing_base_for_transport>
            <volumetric_base_for_transport>double</volumetric_base_for_transport>
            <same_values_for_transport>boolean</same_values_for_transport>
            <is_volumetric_base_available>boolean</is_volumetric_base_available>
            <id_transporter>int</id_transporter>
            <transporter_name>string</transporter_name>
            <id_producer>int</id_producer>
            <producer_name>string</producer_name>
            <settlement_date_range xsi:nil="true" />
            <monthly_min_energy>double</monthly_min_energy>
            <date_apply_min_energy>dateTime</date_apply_min_energy>
            <create_user>string</create_user>
            <temp_base_value>double</temp_base_value>
            <temp_top_value>double</temp_top_value>
            <temp_volumetric_value>double</temp_volumetric_value>
            <temp_fixed_base_for_transport>double</temp_fixed_base_for_transport>
            <temp_swing_base_for_transport>double</temp_swing_base_for_transport>
            <temp_volumetric_base_for_transport>double</temp_volumetric_base_for_transport>
            <temp_vigency_start_date>dateTime</temp_vigency_start_date>
            <temp_vigency_end_date>dateTime</temp_vigency_end_date>
            <applied_temp_contract>boolean</applied_temp_contract>
            <same_temp_values_for_transport>boolean</same_temp_values_for_transport>
            <is_temp_volumetric_base_available>boolean</is_temp_volumetric_base_available>
          </ClsBillContract>
        </Data>
      </LoadBillContractResult>
    </LoadBillContractResponse>
  </soap12:Body>
</soap12:Envelope>