digitaluapi

<back to all web services

CustomersLookup

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

// @DataContract
class CustomersLookup implements IConvertible
{
    // @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;

    CustomersLookup({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});
    CustomersLookup.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        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() => {
        '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() => "CustomersLookup";
    TypeContext? context = _ctx;
}

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

Dart CustomersLookup 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.

GET /customers HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfCustomersLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CustomersLookupResponse>
    <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>
    <IdNumber>String</IdNumber>
    <LastName>String</LastName>
    <PostalCode>String</PostalCode>
    <Region>String</Region>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <SegmentsId>0</SegmentsId>
    <Suburb>String</Suburb>
    <TenantsId>0</TenantsId>
    <UniqueIdentifier>String</UniqueIdentifier>
    <UserAuthId>0</UserAuthId>
  </CustomersLookupResponse>
</ArrayOfCustomersLookupResponse>