EBRServices Web Service

EBRServices

Click here for a complete list of operations.

CNISearch

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 /EBRServices.asmx HTTP/1.1
Host: distributortest.ebr.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ebr.webservices.org/external/CNISearch"

<?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>
    <CNISearch xmlns="http://ebr.webservices.org/external/">
      <distributorAccountId>int</distributorAccountId>
      <distributorAccountPin>string</distributorAccountPin>
      <cniQuery>string</cniQuery>
      <countryCodes>string</countryCodes>
      <startCount>int</startCount>
      <pageSize>int</pageSize>
      <groupSorting>string</groupSorting>
      <returnAllEntities>boolean</returnAllEntities>
    </CNISearch>
  </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>
    <CNISearchResponse xmlns="http://ebr.webservices.org/external/">
      <CNISearchResult numGroupsFound="int" numGroupsReturned="int" numEntitiesReturned="int" numEntitiesFound="int" isError="boolean">
        <errorMessage xmlns="http://cni.ebr.org/webservice">string</errorMessage>
        <errorCode xmlns="http://cni.ebr.org/webservice">string</errorCode>
        <CNICountryBreakdown xmlns="http://cni.ebr.org/webservice">
          <CNIBreakdownResult available="boolean" countryCode="string" numEntitiesFound="int" />
          <CNIBreakdownResult available="boolean" countryCode="string" numEntitiesFound="int" />
        </CNICountryBreakdown>
        <CNITransactions xmlns="http://cni.ebr.org/webservice">
          <CNITransaction cost="float" countryCode="string" />
          <CNITransaction cost="float" countryCode="string" />
        </CNITransactions>
        <CNIEntities xmlns="http://cni.ebr.org/webservice">
          <CNIEntityGroup numFound="int" numReturned="int" isCurrentLegalNameReturned="boolean">
            <CountryCode>string</CountryCode>
            <TargetGatewayId>string</TargetGatewayId>
            <REID>string</REID>
            <ShortSearchCode>string</ShortSearchCode>
            <NumberInRegister>string</NumberInRegister>
            <RegistrationAuthority xsi:nil="true" />
            <CNIEntity xsi:nil="true" />
            <CNIEntity xsi:nil="true" />
          </CNIEntityGroup>
          <CNIEntityGroup numFound="int" numReturned="int" isCurrentLegalNameReturned="boolean">
            <CountryCode>string</CountryCode>
            <TargetGatewayId>string</TargetGatewayId>
            <REID>string</REID>
            <ShortSearchCode>string</ShortSearchCode>
            <NumberInRegister>string</NumberInRegister>
            <RegistrationAuthority xsi:nil="true" />
            <CNIEntity xsi:nil="true" />
            <CNIEntity xsi:nil="true" />
          </CNIEntityGroup>
        </CNIEntities>
        <CountryCode xmlns="http://cni.ebr.org/webservice">string</CountryCode>
      </CNISearchResult>
    </CNISearchResponse>
  </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 /EBRServices.asmx HTTP/1.1
Host: distributortest.ebr.org
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>
    <CNISearch xmlns="http://ebr.webservices.org/external/">
      <distributorAccountId>int</distributorAccountId>
      <distributorAccountPin>string</distributorAccountPin>
      <cniQuery>string</cniQuery>
      <countryCodes>string</countryCodes>
      <startCount>int</startCount>
      <pageSize>int</pageSize>
      <groupSorting>string</groupSorting>
      <returnAllEntities>boolean</returnAllEntities>
    </CNISearch>
  </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>
    <CNISearchResponse xmlns="http://ebr.webservices.org/external/">
      <CNISearchResult numGroupsFound="int" numGroupsReturned="int" numEntitiesReturned="int" numEntitiesFound="int" isError="boolean">
        <errorMessage xmlns="http://cni.ebr.org/webservice">string</errorMessage>
        <errorCode xmlns="http://cni.ebr.org/webservice">string</errorCode>
        <CNICountryBreakdown xmlns="http://cni.ebr.org/webservice">
          <CNIBreakdownResult available="boolean" countryCode="string" numEntitiesFound="int" />
          <CNIBreakdownResult available="boolean" countryCode="string" numEntitiesFound="int" />
        </CNICountryBreakdown>
        <CNITransactions xmlns="http://cni.ebr.org/webservice">
          <CNITransaction cost="float" countryCode="string" />
          <CNITransaction cost="float" countryCode="string" />
        </CNITransactions>
        <CNIEntities xmlns="http://cni.ebr.org/webservice">
          <CNIEntityGroup numFound="int" numReturned="int" isCurrentLegalNameReturned="boolean">
            <CountryCode>string</CountryCode>
            <TargetGatewayId>string</TargetGatewayId>
            <REID>string</REID>
            <ShortSearchCode>string</ShortSearchCode>
            <NumberInRegister>string</NumberInRegister>
            <RegistrationAuthority xsi:nil="true" />
            <CNIEntity xsi:nil="true" />
            <CNIEntity xsi:nil="true" />
          </CNIEntityGroup>
          <CNIEntityGroup numFound="int" numReturned="int" isCurrentLegalNameReturned="boolean">
            <CountryCode>string</CountryCode>
            <TargetGatewayId>string</TargetGatewayId>
            <REID>string</REID>
            <ShortSearchCode>string</ShortSearchCode>
            <NumberInRegister>string</NumberInRegister>
            <RegistrationAuthority xsi:nil="true" />
            <CNIEntity xsi:nil="true" />
            <CNIEntity xsi:nil="true" />
          </CNIEntityGroup>
        </CNIEntities>
        <CountryCode xmlns="http://cni.ebr.org/webservice">string</CountryCode>
      </CNISearchResult>
    </CNISearchResponse>
  </soap12:Body>
</soap12:Envelope>