Billiecart API

UpdateCustomerRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
PUT	/customers/{Id}

import 'package:servicestack/servicestack.dart';

abstract class PutOperationUnTenanted<TResponse> implements IPut
{
    PutOperationUnTenanted();
    PutOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "PutOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

abstract class PutOperationTenanted<TResponse> extends PutOperationUnTenanted<TResponse> implements ITenantedRequest
{
    String? organisationId;

    PutOperationTenanted({this.organisationId});
    PutOperationTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        organisationId = json['organisationId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'organisationId': organisationId
    });

    getTypeName() => "PutOperationTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class BankAccount implements IConvertible
{
    String? bsbNumber;
    String? accountNumber;

    BankAccount({this.bsbNumber,this.accountNumber});
    BankAccount.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        bsbNumber = json['bsbNumber'];
        accountNumber = json['accountNumber'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'bsbNumber': bsbNumber,
        'accountNumber': accountNumber
    };

    getTypeName() => "BankAccount";
    TypeContext? context = _ctx;
}

class Customer implements IIdentifiableResource, IConvertible
{
    String? id;
    String? firstName;
    String? lastName;
    DateTime? dateOfBirth;
    String? driversLicenceNo;
    String? email;
    String? phone;
    String? preferredContactMethod;
    String? addressLine1;
    String? addressLine2;
    String? suburb;
    String? stateTerritory;
    String? postcode;
    BankAccount? bankAccount;
    String? userAccountId;

    Customer({this.id,this.firstName,this.lastName,this.dateOfBirth,this.driversLicenceNo,this.email,this.phone,this.preferredContactMethod,this.addressLine1,this.addressLine2,this.suburb,this.stateTerritory,this.postcode,this.bankAccount,this.userAccountId});
    Customer.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        firstName = json['firstName'];
        lastName = json['lastName'];
        dateOfBirth = JsonConverters.fromJson(json['dateOfBirth'],'DateTime',context!);
        driversLicenceNo = json['driversLicenceNo'];
        email = json['email'];
        phone = json['phone'];
        preferredContactMethod = json['preferredContactMethod'];
        addressLine1 = json['addressLine1'];
        addressLine2 = json['addressLine2'];
        suburb = json['suburb'];
        stateTerritory = json['stateTerritory'];
        postcode = json['postcode'];
        bankAccount = JsonConverters.fromJson(json['bankAccount'],'BankAccount',context!);
        userAccountId = json['userAccountId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'firstName': firstName,
        'lastName': lastName,
        'dateOfBirth': JsonConverters.toJson(dateOfBirth,'DateTime',context!),
        'driversLicenceNo': driversLicenceNo,
        'email': email,
        'phone': phone,
        'preferredContactMethod': preferredContactMethod,
        'addressLine1': addressLine1,
        'addressLine2': addressLine2,
        'suburb': suburb,
        'stateTerritory': stateTerritory,
        'postcode': postcode,
        'bankAccount': JsonConverters.toJson(bankAccount,'BankAccount',context!),
        'userAccountId': userAccountId
    };

    getTypeName() => "Customer";
    TypeContext? context = _ctx;
}

class UpdateCustomerResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Customer? customer;

    UpdateCustomerResponse({this.responseStatus,this.customer});
    UpdateCustomerResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        customer = JsonConverters.fromJson(json['customer'],'Customer',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'customer': JsonConverters.toJson(customer,'Customer',context!)
    };

    getTypeName() => "UpdateCustomerResponse";
    TypeContext? context = _ctx;
}

class UpdateCustomerRequest extends PutOperationTenanted<UpdateCustomerResponse> implements IConvertible
{
    String? id;
    String? firstName;
    String? lastName;
    DateTime? dateOfBirth;
    String? driversLicenceNo;
    String? phone;
    String? preferredContactMethod;
    String? addressLine1;
    String? addressLine2;
    String? suburb;
    String? stateTerritory;
    String? postcode;

    UpdateCustomerRequest({this.id,this.firstName,this.lastName,this.dateOfBirth,this.driversLicenceNo,this.phone,this.preferredContactMethod,this.addressLine1,this.addressLine2,this.suburb,this.stateTerritory,this.postcode});
    UpdateCustomerRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        id = json['id'];
        firstName = json['firstName'];
        lastName = json['lastName'];
        dateOfBirth = JsonConverters.fromJson(json['dateOfBirth'],'DateTime',context!);
        driversLicenceNo = json['driversLicenceNo'];
        phone = json['phone'];
        preferredContactMethod = json['preferredContactMethod'];
        addressLine1 = json['addressLine1'];
        addressLine2 = json['addressLine2'];
        suburb = json['suburb'];
        stateTerritory = json['stateTerritory'];
        postcode = json['postcode'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'id': id,
        'firstName': firstName,
        'lastName': lastName,
        'dateOfBirth': JsonConverters.toJson(dateOfBirth,'DateTime',context!),
        'driversLicenceNo': driversLicenceNo,
        'phone': phone,
        'preferredContactMethod': preferredContactMethod,
        'addressLine1': addressLine1,
        'addressLine2': addressLine2,
        'suburb': suburb,
        'stateTerritory': stateTerritory,
        'postcode': postcode
    });

    getTypeName() => "UpdateCustomerRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
    'PutOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'PutOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'BankAccount': TypeInfo(TypeOf.Class, create:() => BankAccount()),
    'Customer': TypeInfo(TypeOf.Class, create:() => Customer()),
    'UpdateCustomerResponse': TypeInfo(TypeOf.Class, create:() => UpdateCustomerResponse()),
    'UpdateCustomerRequest': TypeInfo(TypeOf.Class, create:() => UpdateCustomerRequest()),
});

Dart UpdateCustomerRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>