BNN Api

<back to all web services

GetClientsWithin

Get Clients Within

The following routes are available for this service:
POST/GetClientsWithinGet Clients Within

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

HTTP + XML

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

POST /xml/reply/GetClientsWithin HTTP/1.1 
Host: api.dev.bnn.us 
Content-Type: application/xml
Content-Length: length

<GetClientsWithin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bnn.Api.Entities.Requests">
  <Distance>0</Distance>
  <Lat>0</Lat>
  <Lon>0</Lon>
</GetClientsWithin>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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