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}
GetCustomerRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
GetOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
GetOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
EmbedformstringNo
GetCustomerResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CustomerformCustomerNo
Customer Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
FirstNameformstringNo
LastNameformstringNo
DateOfBirthformDateTimeNo
DriversLicenceNoformstringNo
EmailformstringNo
PhoneformstringNo
PreferredContactMethodformstringNo
AddressLine1formstringNo
AddressLine2formstringNo
SuburbformstringNo
StateTerritoryformstringNo
PostcodeformstringNo
BankAccountformBankAccountNo
UserAccountIdformstringNo
BankAccount Parameters:
NameParameterData TypeRequiredDescription
BsbNumberformstringNo
AccountNumberformstringNo
GetCustomerResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CustomerformCustomerNo

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

HTTP + JSON

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: 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"}},"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"}}