EBRServices

Click here for a complete list of operations.

PersonSearch

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/PersonSearch"

<?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>
    <PersonSearch xmlns="http://ebr.webservices.org/external/">
      <distributorAccountId>int</distributorAccountId>
      <distributorAccountPin>string</distributorAccountPin>
      <targetGatewayId>string</targetGatewayId>
      <familyName>string</familyName>
      <firstName>string</firstName>
      <registrationAuthority>string</registrationAuthority>
      <advancedParams>
        <QueryParameter>
          <Name>string</Name>
          <Value>string</Value>
        </QueryParameter>
        <QueryParameter>
          <Name>string</Name>
          <Value>string</Value>
        </QueryParameter>
      </advancedParams>
      <maxResults>int</maxResults>
      <custReference>string</custReference>
      <language>string</language>
      <deliverOffline>boolean</deliverOffline>
    </PersonSearch>
  </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>
    <PersonSearchResponse xmlns="http://ebr.webservices.org/external/">
      <PersonSearchResponse xmlns="http://ebr.webservices.org/external/responses">
        <PersonList>
          <MessageEntity crId="integer" idEntity="ID">
            <EntityType xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRole xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <IndividualDetails xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EnterpriseDetails xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityDateTime xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityDateTime xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityEvent xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityEvent xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRegistration xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRegistration xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <OtherName xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <OtherName xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Indicator xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Indicator xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Capital xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Capital xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityCharacteristic xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityCharacteristic xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Amount xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Amount xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <ObjectOfProperty xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <ObjectOfProperty xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityAddress xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityAddress xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRelationship xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRelationship xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityAdditionalText xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityAdditionalText xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityLegalReference xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityLegalReference xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
          </MessageEntity>
          <MessageEntity crId="integer" idEntity="ID">
            <EntityType xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRole xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <IndividualDetails xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EnterpriseDetails xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityDateTime xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityDateTime xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityEvent xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityEvent xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRegistration xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRegistration xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <OtherName xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <OtherName xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Indicator xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Indicator xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Capital xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Capital xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityCharacteristic xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityCharacteristic xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Amount xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Amount xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <ObjectOfProperty xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <ObjectOfProperty xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityAddress xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityAddress xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRelationship xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRelationship xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityAdditionalText xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityAdditionalText xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityLegalReference xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityLegalReference xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
          </MessageEntity>
        </PersonList>
        <CustReference>string</CustReference>
        <OrderId>int</OrderId>
        <ResultsReturned>int</ResultsReturned>
        <ResultsMatched>int</ResultsMatched>
        <TxnId>int</TxnId>
      </PersonSearchResponse>
    </PersonSearchResponse>
  </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>
    <PersonSearch xmlns="http://ebr.webservices.org/external/">
      <distributorAccountId>int</distributorAccountId>
      <distributorAccountPin>string</distributorAccountPin>
      <targetGatewayId>string</targetGatewayId>
      <familyName>string</familyName>
      <firstName>string</firstName>
      <registrationAuthority>string</registrationAuthority>
      <advancedParams>
        <QueryParameter>
          <Name>string</Name>
          <Value>string</Value>
        </QueryParameter>
        <QueryParameter>
          <Name>string</Name>
          <Value>string</Value>
        </QueryParameter>
      </advancedParams>
      <maxResults>int</maxResults>
      <custReference>string</custReference>
      <language>string</language>
      <deliverOffline>boolean</deliverOffline>
    </PersonSearch>
  </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>
    <PersonSearchResponse xmlns="http://ebr.webservices.org/external/">
      <PersonSearchResponse xmlns="http://ebr.webservices.org/external/responses">
        <PersonList>
          <MessageEntity crId="integer" idEntity="ID">
            <EntityType xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRole xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <IndividualDetails xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EnterpriseDetails xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityDateTime xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityDateTime xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityEvent xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityEvent xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRegistration xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRegistration xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <OtherName xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <OtherName xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Indicator xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Indicator xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Capital xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Capital xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityCharacteristic xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityCharacteristic xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Amount xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Amount xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <ObjectOfProperty xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <ObjectOfProperty xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityAddress xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityAddress xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRelationship xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRelationship xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityAdditionalText xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityAdditionalText xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityLegalReference xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityLegalReference xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
          </MessageEntity>
          <MessageEntity crId="integer" idEntity="ID">
            <EntityType xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRole xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <IndividualDetails xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EnterpriseDetails xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityDateTime xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityDateTime xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityEvent xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityEvent xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRegistration xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRegistration xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <OtherName xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <OtherName xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Indicator xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Indicator xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Capital xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Capital xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityCharacteristic xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityCharacteristic xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Amount xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <Amount xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <ObjectOfProperty xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <ObjectOfProperty xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityAddress xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityAddress xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRelationship xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityRelationship xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityAdditionalText xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityAdditionalText xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityLegalReference xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
            <EntityLegalReference xsi:nil="true" xmlns="http://www.ebr.org/ebrXML/1.01/domains" />
          </MessageEntity>
        </PersonList>
        <CustReference>string</CustReference>
        <OrderId>int</OrderId>
        <ResultsReturned>int</ResultsReturned>
        <ResultsMatched>int</ResultsMatched>
        <TxnId>int</TxnId>
      </PersonSearchResponse>
    </PersonSearchResponse>
  </soap12:Body>
</soap12:Envelope>