digitaluapi

<back to all web services

CustomersEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/customers/{Id}
import 'package:servicestack/servicestack.dart';

class CustomersEditResponse implements IConvertible
{
    // @DataMember(Order=1)
    int? Id;

    // @DataMember(Order=2)
    int? TenantsId;

    // @DataMember(Order=3)
    int? UserAuthId;

    // @DataMember(Order=4)
    int? SegmentsId;

    // @DataMember(Order=5)
    int? CompaniesId;

    // @DataMember(Order=6)
    int? CurrenciesId;

    // @DataMember(Order=7)
    String? Address;

    // @DataMember(Order=8)
    int? Age;

    // @DataMember(Order=9)
    String? City;

    // @DataMember(Order=10)
    String? ContactNumber;

    // @DataMember(Order=11)
    String? Email;

    // @DataMember(Order=12)
    String? EthnicGroup;

    // @DataMember(Order=13)
    String? FirstName;

    // @DataMember(Order=14)
    String? Gender;

    // @DataMember(Order=15)
    String? HomeLanguage;

    // @DataMember(Order=16)
    String? IdNumber;

    // @DataMember(Order=17)
    String? LastName;

    // @DataMember(Order=18)
    String? PostalCode;

    // @DataMember(Order=19)
    String? Region;

    // @DataMember(Order=20)
    String? Suburb;

    // @DataMember(Order=21)
    String? UniqueIdentifier;

    // @DataMember(Order=23)
    ResponseStatus? ResponseStatus;

    CustomersEditResponse({this.Id,this.TenantsId,this.UserAuthId,this.SegmentsId,this.CompaniesId,this.CurrenciesId,this.Address,this.Age,this.City,this.ContactNumber,this.Email,this.EthnicGroup,this.FirstName,this.Gender,this.HomeLanguage,this.IdNumber,this.LastName,this.PostalCode,this.Region,this.Suburb,this.UniqueIdentifier,this.ResponseStatus});
    CustomersEditResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        TenantsId = json['TenantsId'];
        UserAuthId = json['UserAuthId'];
        SegmentsId = json['SegmentsId'];
        CompaniesId = json['CompaniesId'];
        CurrenciesId = json['CurrenciesId'];
        Address = json['Address'];
        Age = json['Age'];
        City = json['City'];
        ContactNumber = json['ContactNumber'];
        Email = json['Email'];
        EthnicGroup = json['EthnicGroup'];
        FirstName = json['FirstName'];
        Gender = json['Gender'];
        HomeLanguage = json['HomeLanguage'];
        IdNumber = json['IdNumber'];
        LastName = json['LastName'];
        PostalCode = json['PostalCode'];
        Region = json['Region'];
        Suburb = json['Suburb'];
        UniqueIdentifier = json['UniqueIdentifier'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'TenantsId': TenantsId,
        'UserAuthId': UserAuthId,
        'SegmentsId': SegmentsId,
        'CompaniesId': CompaniesId,
        'CurrenciesId': CurrenciesId,
        'Address': Address,
        'Age': Age,
        'City': City,
        'ContactNumber': ContactNumber,
        'Email': Email,
        'EthnicGroup': EthnicGroup,
        'FirstName': FirstName,
        'Gender': Gender,
        'HomeLanguage': HomeLanguage,
        'IdNumber': IdNumber,
        'LastName': LastName,
        'PostalCode': PostalCode,
        'Region': Region,
        'Suburb': Suburb,
        'UniqueIdentifier': UniqueIdentifier,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

// @DataContract
class CustomersEdit implements IConvertible
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    int? Id;

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    int? TenantsId;

    // @DataMember(Order=3)
    int? UserAuthId;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    int? SegmentsId;

    // @DataMember(Order=5)
    int? CompaniesId;

    // @DataMember(Order=6)
    int? CurrenciesId;

    // @DataMember(Order=7)
    String? Address;

    // @DataMember(Order=8)
    int? Age;

    // @DataMember(Order=9)
    String? City;

    // @DataMember(Order=10)
    String? ContactNumber;

    // @DataMember(Order=11)
    String? Email;

    // @DataMember(Order=12)
    String? EthnicGroup;

    // @DataMember(Order=13)
    String? FirstName;

    // @DataMember(Order=14)
    String? Gender;

    // @DataMember(Order=15)
    String? HomeLanguage;

    // @DataMember(Order=16)
    String? IdNumber;

    // @DataMember(Order=17)
    String? LastName;

    // @DataMember(Order=18)
    String? PostalCode;

    // @DataMember(Order=19)
    String? Region;

    // @DataMember(Order=20)
    String? Suburb;

    // @DataMember(Order=21)
    String? UniqueIdentifier;

    CustomersEdit({this.Id,this.TenantsId,this.UserAuthId,this.SegmentsId,this.CompaniesId,this.CurrenciesId,this.Address,this.Age,this.City,this.ContactNumber,this.Email,this.EthnicGroup,this.FirstName,this.Gender,this.HomeLanguage,this.IdNumber,this.LastName,this.PostalCode,this.Region,this.Suburb,this.UniqueIdentifier});
    CustomersEdit.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        TenantsId = json['TenantsId'];
        UserAuthId = json['UserAuthId'];
        SegmentsId = json['SegmentsId'];
        CompaniesId = json['CompaniesId'];
        CurrenciesId = json['CurrenciesId'];
        Address = json['Address'];
        Age = json['Age'];
        City = json['City'];
        ContactNumber = json['ContactNumber'];
        Email = json['Email'];
        EthnicGroup = json['EthnicGroup'];
        FirstName = json['FirstName'];
        Gender = json['Gender'];
        HomeLanguage = json['HomeLanguage'];
        IdNumber = json['IdNumber'];
        LastName = json['LastName'];
        PostalCode = json['PostalCode'];
        Region = json['Region'];
        Suburb = json['Suburb'];
        UniqueIdentifier = json['UniqueIdentifier'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'TenantsId': TenantsId,
        'UserAuthId': UserAuthId,
        'SegmentsId': SegmentsId,
        'CompaniesId': CompaniesId,
        'CurrenciesId': CurrenciesId,
        'Address': Address,
        'Age': Age,
        'City': City,
        'ContactNumber': ContactNumber,
        'Email': Email,
        'EthnicGroup': EthnicGroup,
        'FirstName': FirstName,
        'Gender': Gender,
        'HomeLanguage': HomeLanguage,
        'IdNumber': IdNumber,
        'LastName': LastName,
        'PostalCode': PostalCode,
        'Region': Region,
        'Suburb': Suburb,
        'UniqueIdentifier': UniqueIdentifier
    };

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

TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
    'CustomersEditResponse': TypeInfo(TypeOf.Class, create:() => CustomersEditResponse()),
    'CustomersEdit': TypeInfo(TypeOf.Class, create:() => CustomersEdit()),
});

Dart CustomersEdit 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: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CustomersEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <TenantsId>0</TenantsId>
  <UserAuthId>0</UserAuthId>
  <SegmentsId>0</SegmentsId>
  <CompaniesId>0</CompaniesId>
  <CurrenciesId>0</CurrenciesId>
  <Address>String</Address>
  <Age>0</Age>
  <City>String</City>
  <ContactNumber>String</ContactNumber>
  <Email>String</Email>
  <EthnicGroup>String</EthnicGroup>
  <FirstName>String</FirstName>
  <Gender>String</Gender>
  <HomeLanguage>String</HomeLanguage>
  <IdNumber>String</IdNumber>
  <LastName>String</LastName>
  <PostalCode>String</PostalCode>
  <Region>String</Region>
  <Suburb>String</Suburb>
  <UniqueIdentifier>String</UniqueIdentifier>
</CustomersEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomersEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Address>String</Address>
  <Age>0</Age>
  <City>String</City>
  <CompaniesId>0</CompaniesId>
  <ContactNumber>String</ContactNumber>
  <CurrenciesId>0</CurrenciesId>
  <Email>String</Email>
  <EthnicGroup>String</EthnicGroup>
  <FirstName>String</FirstName>
  <Gender>String</Gender>
  <HomeLanguage>String</HomeLanguage>
  <Id>0</Id>
  <IdNumber>String</IdNumber>
  <LastName>String</LastName>
  <PostalCode>String</PostalCode>
  <Region>String</Region>
  <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>
  <SegmentsId>0</SegmentsId>
  <Suburb>String</Suburb>
  <TenantsId>0</TenantsId>
  <UniqueIdentifier>String</UniqueIdentifier>
  <UserAuthId>0</UserAuthId>
</CustomersEditResponse>