Requires the role: | manager |
GET | /customers/{Id} |
---|
export class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
public embed?: string;
public constructor(init?: Partial<GetOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}
export class GetOperationTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements ITenantedRequest
{
public organisationId?: string;
public constructor(init?: Partial<GetOperationTenanted<TResponse>>) { super(init); (Object as any).assign(this, init); }
}
export class BankAccount
{
public bsbNumber?: string;
public accountNumber?: string;
public constructor(init?: Partial<BankAccount>) { (Object as any).assign(this, init); }
}
export class Customer implements IIdentifiableResource
{
public id?: string;
public firstName?: string;
public lastName?: string;
public dateOfBirth: string;
public driversLicenceNo?: string;
public email?: string;
public phone?: string;
public preferredContactMethod?: string;
public addressLine1?: string;
public addressLine2?: string;
public suburb?: string;
public stateTerritory?: string;
public postcode?: string;
public bankAccount?: BankAccount;
public userAccountId?: string;
public constructor(init?: Partial<Customer>) { (Object as any).assign(this, init); }
}
export class GetCustomerResponse
{
public responseStatus?: ResponseStatus;
public customer?: Customer;
public constructor(init?: Partial<GetCustomerResponse>) { (Object as any).assign(this, init); }
}
export class GetCustomerRequest extends GetOperationTenanted<GetCustomerResponse>
{
public id?: string;
public constructor(init?: Partial<GetCustomerRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript GetCustomerRequest DTOs
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
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"}}