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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateCustomerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Customers">
<OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
<AddressLine1>String</AddressLine1>
<AddressLine2>String</AddressLine2>
<DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
<DriversLicenceNo>String</DriversLicenceNo>
<FirstName>String</FirstName>
<Id>String</Id>
<LastName>String</LastName>
<Phone>String</Phone>
<Postcode>String</Postcode>
<PreferredContactMethod>String</PreferredContactMethod>
<StateTerritory>String</StateTerritory>
<Suburb>String</Suburb>
</UpdateCustomerRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <UpdateCustomerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Customers"> <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources"> <d2p1:AddressLine1>String</d2p1:AddressLine1> <d2p1:AddressLine2>String</d2p1:AddressLine2> <d2p1:BankAccount> <d2p1:AccountNumber>String</d2p1:AccountNumber> <d2p1:BsbNumber>String</d2p1:BsbNumber> </d2p1:BankAccount> <d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth> <d2p1:DriversLicenceNo>String</d2p1:DriversLicenceNo> <d2p1:Email>String</d2p1:Email> <d2p1:FirstName>String</d2p1:FirstName> <d2p1:Id>String</d2p1:Id> <d2p1:LastName>String</d2p1:LastName> <d2p1:Phone>String</d2p1:Phone> <d2p1:Postcode>String</d2p1:Postcode> <d2p1:PreferredContactMethod>String</d2p1:PreferredContactMethod> <d2p1:StateTerritory>String</d2p1:StateTerritory> <d2p1:Suburb>String</d2p1:Suburb> <d2p1:UserAccountId>String</d2p1:UserAccountId> </Customer> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> </UpdateCustomerResponse>