Billiecart API

UpdatePersonRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
PUT,PATCH	/persons/{Id}

import 'package:servicestack/servicestack.dart';

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

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

class UserAccountName implements IConvertible
{
    String? firstName;
    String? lastName;

    UserAccountName({this.firstName,this.lastName});
    UserAccountName.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'firstName': firstName,
        'lastName': lastName
    };

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

class Person implements IIdentifiableResource, IConvertible
{
    UserAccountName? name;
    String? displayName;
    String? email;
    String? phoneNumber;
    String? timezone;
    String? defaultOrganisationId;
    String? id;

    Person({this.name,this.displayName,this.email,this.phoneNumber,this.timezone,this.defaultOrganisationId,this.id});
    Person.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        name = JsonConverters.fromJson(json['name'],'UserAccountName',context!);
        displayName = json['displayName'];
        email = json['email'];
        phoneNumber = json['phoneNumber'];
        timezone = json['timezone'];
        defaultOrganisationId = json['defaultOrganisationId'];
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'name': JsonConverters.toJson(name,'UserAccountName',context!),
        'displayName': displayName,
        'email': email,
        'phoneNumber': phoneNumber,
        'timezone': timezone,
        'defaultOrganisationId': defaultOrganisationId,
        'id': id
    };

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

class UpdatePersonResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Person? person;

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

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

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

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

class UpdatePersonRequest extends PutPatchOperationUnTenanted<UpdatePersonResponse> implements IConvertible
{
    String? id;
    String? phoneNumber;
    String? timezone;

    UpdatePersonRequest({this.id,this.phoneNumber,this.timezone});
    UpdatePersonRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
    'PutPatchOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'UserAccountName': TypeInfo(TypeOf.Class, create:() => UserAccountName()),
    'Person': TypeInfo(TypeOf.Class, create:() => Person()),
    'UpdatePersonResponse': TypeInfo(TypeOf.Class, create:() => UpdatePersonResponse()),
    'UpdatePersonRequest': TypeInfo(TypeOf.Class, create:() => UpdatePersonRequest()),
});

Dart UpdatePersonRequest 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 /persons/{Id} HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdatePersonRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Persons">
  <Id>String</Id>
  <PhoneNumber>String</PhoneNumber>
  <Timezone>String</Timezone>
</UpdatePersonRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdatePersonResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Persons">
  <Person xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:DefaultOrganisationId>String</d2p1:DefaultOrganisationId>
    <d2p1:DisplayName>String</d2p1:DisplayName>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:Name>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:LastName>String</d2p1:LastName>
    </d2p1:Name>
    <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
    <d2p1:Timezone>String</d2p1:Timezone>
  </Person>
  <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>
</UpdatePersonResponse>