BNN Api

<back to all web services

SearchCustomers

Search Customers

To override the Content-type in your clients HTTP Accept Header, append the .soap11 suffix or ?format=soap11

HTTP + SOAP11

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /soap11 HTTP/1.1 
Host: api.dev.bnn.us 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: SearchCustomers

<?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>

<SearchCustomers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bnn.Api.Entities.Requests">
  <FilterFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bnn.Api.Entities.Dto">
    <d2p1:SqlFilterDto>
      <d2p1:Field>String</d2p1:Field>
      <d2p1:FilterType>String</d2p1:FilterType>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:SqlFilterDto>
  </FilterFields>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </Roles>
  <SearchText>String</SearchText>
  <Skip>0</Skip>
  <SortFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bnn.Api.Entities.Dto">
    <d2p1:SqlSortDto>
      <d2p1:Direction>String</d2p1:Direction>
      <d2p1:Field>String</d2p1:Field>
    </d2p1:SqlSortDto>
  </SortFields>
  <Take>0</Take>
</SearchCustomers>

    </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: application/xml
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>

<CustomersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bnn.Api.Entities.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bnn.Api.Entities.Dto">
    <d2p1:CustomerDto>
      <d2p1:AccountNum>String</d2p1:AccountNum>
      <d2p1:Active>false</d2p1:Active>
      <d2p1:Anonymous>false</d2p1:Anonymous>
      <d2p1:ApiAllowedIpAddresses>String</d2p1:ApiAllowedIpAddresses>
      <d2p1:ApiSecretToken>String</d2p1:ApiSecretToken>
      <d2p1:Company>String</d2p1:Company>
      <d2p1:Complimentary>false</d2p1:Complimentary>
      <d2p1:DisableDataSubmit>false</d2p1:DisableDataSubmit>
      <d2p1:Distance>0</d2p1:Distance>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:MemberEmail>String</d2p1:MemberEmail>
      <d2p1:MobileNumber>String</d2p1:MobileNumber>
      <d2p1:Notes>String</d2p1:Notes>
      <d2p1:Primary>false</d2p1:Primary>
      <d2p1:Reporter>String</d2p1:Reporter>
      <d2p1:Transport>String</d2p1:Transport>
      <d2p1:TwoFactorAuthEnabled>false</d2p1:TwoFactorAuthEnabled>
      <d2p1:TwoFactorAuthType>String</d2p1:TwoFactorAuthType>
      <d2p1:Type>0</d2p1:Type>
      <d2p1:Zip>String</d2p1:Zip>
    </d2p1:CustomerDto>
  </Data>
  <Total>0</Total>
</CustomersResponse>

    </soap:Body>
</soap:Envelope>