Billiecart API

<back to all web services

GetCustomerRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
GET/customers/{Id}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetCustomerRequest : GetOperationTenanted<GetCustomerResponse>()
{
    var id:String? = null
}

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

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

open class GetCustomerResponse
{
    var responseStatus:ResponseStatus? = null
    var customer:Customer? = 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
}

Kotlin GetCustomerRequest 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/{Id} 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"}},"customer":{"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"}}