digitaluapi

CustomersLookup

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
GET	/customers

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomersLookup:
    tenants_id: int = 0
    user_auth_id: Optional[int] = None
    segments_id: int = 0
    companies_id: Optional[int] = None
    currencies_id: Optional[int] = None
    address: Optional[str] = None
    age: Optional[int] = None
    city: Optional[str] = None
    contact_number: Optional[str] = None
    email: Optional[str] = None
    ethnic_group: Optional[str] = None
    first_name: Optional[str] = None
    gender: Optional[str] = None
    home_language: Optional[str] = None
    id_number: Optional[str] = None
    last_name: Optional[str] = None
    postal_code: Optional[str] = None
    region: Optional[str] = None
    suburb: Optional[str] = None
    unique_identifier: Optional[str] = None

Python 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>