| Requires the role: | manager |
| GET | /customers |
|---|
namespace Application.Interfaces
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type BankAccount() =
member val BsbNumber:String = null with get,set
member val AccountNumber:String = null with get,set
[<AllowNullLiteral>]
type Customer() =
member val Id:String = null with get,set
member val FirstName:String = null with get,set
member val LastName:String = null with get,set
member val DateOfBirth:DateTime = new DateTime() with get,set
member val DriversLicenceNo:String = null with get,set
member val Email:String = null with get,set
member val Phone:String = null with get,set
member val PreferredContactMethod:String = null with get,set
member val AddressLine1:String = null with get,set
member val AddressLine2:String = null with get,set
member val Suburb:String = null with get,set
member val StateTerritory:String = null with get,set
member val Postcode:String = null with get,set
member val BankAccount:BankAccount = null with get,set
member val UserAccountId:String = null with get,set
type SortDirection =
| Ascending = 0
| Descending = 1
[<AllowNullLiteral>]
type Sorting() =
member val By:String = null with get,set
member val Direction:SortDirection = new SortDirection() with get,set
[<AllowNullLiteral>]
type Filtering() =
member val Fields:ResizeArray<String> = new ResizeArray<String>() with get,set
member val Search:String = null with get,set
[<AllowNullLiteral>]
type SearchMetadata() =
member val Total:Int32 = new Int32() with get,set
member val Limit:Int32 = new Int32() with get,set
member val Offset:Int32 = new Int32() with get,set
member val Sort:Sorting = null with get,set
member val Filter:Filtering = null with get,set
[<AllowNullLiteral>]
type SearchAllCustomersResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val Customers:ResizeArray<Customer> = new ResizeArray<Customer>() with get,set
member val Metadata:SearchMetadata = null with get,set
[<AllowNullLiteral>]
type SearchAllCustomersRequest() =
inherit SearchOperationTenanted<SearchAllCustomersResponse>()
[<AllowNullLiteral>]
type SearchOperationTenanted<'TResponse>() =
inherit SearchOperationUnTenanted<TResponse>()
member val OrganisationId:String = null with get,set
[<AllowNullLiteral>]
type SearchOperationUnTenanted<'TResponse>() =
inherit GetOperationUnTenanted<TResponse>()
member val Distinct:String = null with get,set
member val Limit:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Offset:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Sort:String = null with get,set
member val Filter:String = null with get,set
member val Search:String = null with get,set
[<AllowNullLiteral>]
type GetOperationUnTenanted<'TResponse>() =
interface IGet
member val Embed:String = null with get,set
F# SearchAllCustomersRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}