Billiecart API

SearchAllCustomersRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
GET	/customers

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class SearchAllCustomersRequest : SearchOperationTenanted<SearchAllCustomersResponse>()
{
}

open class SearchOperationTenanted<TResponse> : SearchOperationUnTenanted<TResponse>(), ITenantedRequest
{
    var organisationId:String? = null
}

open class SearchOperationUnTenanted<TResponse> : GetOperationUnTenanted<TResponse>(), IHasSearchOptions
{
    var distinct:String? = null
    var limit:Int? = null
    var offset:Int? = null
    var sort:String? = null
    var filter:String? = null
    var search:String? = null
}

open class GetOperationUnTenanted<TResponse> : IHasGetOptions, IGet
{
    var embed:String? = null
}

open class SearchAllCustomersResponse
{
    var responseStatus:ResponseStatus? = null
    var customers:ArrayList<Customer> = ArrayList<Customer>()
    var metadata:SearchMetadata? = null
}

open class Customer : IIdentifiableResource
{
    var id:String? = null
    var firstName:String? = null
    var lastName:String? = null
    var dateOfBirth:Date? = null
    var driversLicenceNo:String? = null
    var email:String? = null
    var phone:String? = null
    var preferredContactMethod:String? = null
    var addressLine1:String? = null
    var addressLine2:String? = null
    var suburb:String? = null
    var stateTerritory:String? = null
    var postcode:String? = null
    var bankAccount:BankAccount? = null
    var userAccountId:String? = null
}

open class BankAccount
{
    var bsbNumber:String? = null
    var accountNumber:String? = null
}

open class SearchMetadata
{
    var total:Int? = null
    var limit:Int? = null
    var offset:Int? = null
    var sort:Sorting? = null
    var filter:Filtering? = null
}

open class Sorting
{
    @SerializedName("by") var By:String? = null
    var direction:SortDirection? = null
}

enum class SortDirection
{
    Ascending,
    Descending,
}

open class Filtering
{
    var fields:ArrayList<String> = ArrayList<String>()
    var search:String? = null
}

Kotlin SearchAllCustomersRequest DTOs

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

HTTP + CSV

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

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}