Billiecart API

<back to all web services

SearchAllCustomersRequest

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Customers;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;
using Application.Interfaces;

namespace Application.Interfaces
{
    public partial class Filtering
    {
        public Filtering()
        {
            Fields = new List<string>{};
        }

        public virtual List<string> Fields { get; set; }
        public virtual string Search { get; set; }
    }

    public partial class SearchMetadata
    {
        public virtual int Total { get; set; }
        public virtual int Limit { get; set; }
        public virtual int Offset { get; set; }
        public virtual Sorting Sort { get; set; }
        public virtual Filtering Filter { get; set; }
    }

    public enum SortDirection
    {
        Ascending,
        Descending,
    }

    public partial class Sorting
    {
        public virtual string By { get; set; }
        public virtual SortDirection Direction { get; set; }
    }

}

namespace Application.Interfaces.Resources
{
    public partial class BankAccount
    {
        public virtual string BsbNumber { get; set; }
        public virtual string AccountNumber { get; set; }
    }

    public partial class Customer
        : IIdentifiableResource
    {
        public virtual string Id { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual DateTime DateOfBirth { get; set; }
        public virtual string DriversLicenceNo { get; set; }
        public virtual string Email { get; set; }
        public virtual string Phone { get; set; }
        public virtual string PreferredContactMethod { get; set; }
        public virtual string AddressLine1 { get; set; }
        public virtual string AddressLine2 { get; set; }
        public virtual string Suburb { get; set; }
        public virtual string StateTerritory { get; set; }
        public virtual string Postcode { get; set; }
        public virtual BankAccount BankAccount { get; set; }
        public virtual string UserAccountId { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class GetOperationUnTenanted<TResponse>
        : IHasGetOptions, IGet
    {
        public virtual string Embed { get; set; }
    }

    public partial class SearchOperationTenanted<TResponse>
        : SearchOperationUnTenanted<TResponse>, ITenantedRequest
    {
        public virtual string OrganisationId { get; set; }
    }

    public partial class SearchOperationUnTenanted<TResponse>
        : GetOperationUnTenanted<TResponse>, IHasSearchOptions
    {
        public virtual string Distinct { get; set; }
        public virtual int? Limit { get; set; }
        public virtual int? Offset { get; set; }
        public virtual string Sort { get; set; }
        public virtual string Filter { get; set; }
        public virtual string Search { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Customers
{
    public partial class SearchAllCustomersRequest
        : SearchOperationTenanted<SearchAllCustomersResponse>
    {
    }

    public partial class SearchAllCustomersResponse
    {
        public SearchAllCustomersResponse()
        {
            Customers = new List<Customer>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<Customer> Customers { get; set; }
        public virtual SearchMetadata Metadata { get; set; }
    }

}

C# SearchAllCustomersRequest DTOs

GET /customers HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml

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

<SearchAllCustomersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Customers">
  <Customers xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Customer>
      <d2p1:AddressLine1>String</d2p1:AddressLine1>
      <d2p1:AddressLine2>String</d2p1:AddressLine2>
      <d2p1:BankAccount>
        <d2p1:AccountNumber>String</d2p1:AccountNumber>
        <d2p1:BsbNumber>String</d2p1:BsbNumber>
      </d2p1:BankAccount>
      <d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth>
      <d2p1:DriversLicenceNo>String</d2p1:DriversLicenceNo>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:Phone>String</d2p1:Phone>
      <d2p1:Postcode>String</d2p1:Postcode>
      <d2p1:PreferredContactMethod>String</d2p1:PreferredContactMethod>
      <d2p1:StateTerritory>String</d2p1:StateTerritory>
      <d2p1:Suburb>String</d2p1:Suburb>
      <d2p1:UserAccountId>String</d2p1:UserAccountId>
    </d2p1:Customer>
  </Customers>
  <Metadata xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces">
    <d2p1:Filter>
      <d2p1:Fields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Fields>
      <d2p1:Search>String</d2p1:Search>
    </d2p1:Filter>
    <d2p1:Limit>0</d2p1:Limit>
    <d2p1:Offset>0</d2p1:Offset>
    <d2p1:Sort>
      <d2p1:By>String</d2p1:By>
      <d2p1:Direction>Ascending</d2p1:Direction>
    </d2p1:Sort>
    <d2p1:Total>0</d2p1:Total>
  </Metadata>
  <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:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</SearchAllCustomersResponse>