Requires the role: | manager |
GET | /customers |
---|
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
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /customers HTTP/1.1 Host: staging-api.billiecart.com.au Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"customers":[{"id":"String","firstName":"String","lastName":"String","driversLicenceNo":"String","email":"String","phone":"String","preferredContactMethod":"String","addressLine1":"String","addressLine2":"String","suburb":"String","stateTerritory":"String","postcode":"String","bankAccount":{"bsbNumber":"String","accountNumber":"String"},"userAccountId":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"],"search":"String"}}}