Requires the role: | manager |
GET | /customers/{Id} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrganisationId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Embed | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Customer | form | Customer | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
DateOfBirth | form | DateTime | No | |
DriversLicenceNo | form | string | No | |
form | string | No | ||
Phone | form | string | No | |
PreferredContactMethod | form | string | No | |
AddressLine1 | form | string | No | |
AddressLine2 | form | string | No | |
Suburb | form | string | No | |
StateTerritory | form | string | No | |
Postcode | form | string | No | |
BankAccount | form | BankAccount | No | |
UserAccountId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BsbNumber | form | string | No | |
AccountNumber | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Customer | form | Customer | No |
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/{Id} 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 } }, 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 } }