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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class CustomersLookup
{
    @DataMember(Order=2)
    open var TenantsId:Int? = null

    @DataMember(Order=3)
    open var UserAuthId:Int? = null

    @DataMember(Order=4)
    open var SegmentsId:Long? = null

    @DataMember(Order=5)
    open var CompaniesId:Long? = null

    @DataMember(Order=6)
    open var CurrenciesId:Int? = null

    @DataMember(Order=7)
    open var Address:String? = null

    @DataMember(Order=8)
    open var Age:Int? = null

    @DataMember(Order=9)
    open var City:String? = null

    @DataMember(Order=10)
    open var ContactNumber:String? = null

    @DataMember(Order=11)
    open var Email:String? = null

    @DataMember(Order=12)
    open var EthnicGroup:String? = null

    @DataMember(Order=13)
    open var FirstName:String? = null

    @DataMember(Order=14)
    open var Gender:String? = null

    @DataMember(Order=15)
    open var HomeLanguage:String? = null

    @DataMember(Order=16)
    open var IdNumber:String? = null

    @DataMember(Order=17)
    open var LastName:String? = null

    @DataMember(Order=18)
    open var PostalCode:String? = null

    @DataMember(Order=19)
    open var Region:String? = null

    @DataMember(Order=20)
    open var Suburb:String? = null

    @DataMember(Order=21)
    open var UniqueIdentifier:String? = null
}

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