Requires the role: | manager |
PUT | /customers/{Id} |
---|
export class PutOperationUnTenanted<TResponse> implements IPut
{
public constructor(init?: Partial<PutOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}
export class PutOperationTenanted<TResponse> extends PutOperationUnTenanted<TResponse> implements ITenantedRequest
{
public organisationId?: string;
public constructor(init?: Partial<PutOperationTenanted<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 UpdateCustomerResponse
{
public responseStatus?: ResponseStatus;
public customer?: Customer;
public constructor(init?: Partial<UpdateCustomerResponse>) { (Object as any).assign(this, init); }
}
export class UpdateCustomerRequest extends PutOperationTenanted<UpdateCustomerResponse>
{
public id?: string;
public firstName?: string;
public lastName?: string;
public dateOfBirth: string;
public driversLicenceNo?: string;
public phone?: string;
public preferredContactMethod?: string;
public addressLine1?: string;
public addressLine2?: string;
public suburb?: string;
public stateTerritory?: string;
public postcode?: string;
public constructor(init?: Partial<UpdateCustomerRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript UpdateCustomerRequest DTOs
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.
PUT /customers/{Id} HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
firstName: String,
lastName: String,
driversLicenceNo: String,
phone: String,
preferredContactMethod: String,
addressLine1: String,
addressLine2: String,
suburb: String,
stateTerritory: String,
postcode: String,
organisationId: String
}
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 } }