| Requires any of the roles: | Client, Admin, Partner |
| GET | /customers |
|---|
// @DataContract
export class CustomersLookup
{
// @DataMember(Order=2)
public TenantsId: number;
// @DataMember(Order=3)
public UserAuthId?: number;
// @DataMember(Order=4)
public SegmentsId: number;
// @DataMember(Order=5)
public CompaniesId?: number;
// @DataMember(Order=6)
public CurrenciesId?: number;
// @DataMember(Order=7)
public Address: string;
// @DataMember(Order=8)
public Age?: number;
// @DataMember(Order=9)
public City: string;
// @DataMember(Order=10)
public ContactNumber: string;
// @DataMember(Order=11)
public Email: string;
// @DataMember(Order=12)
public EthnicGroup: string;
// @DataMember(Order=13)
public FirstName: string;
// @DataMember(Order=14)
public Gender: string;
// @DataMember(Order=15)
public HomeLanguage: string;
// @DataMember(Order=16)
public IdNumber: string;
// @DataMember(Order=17)
public LastName: string;
// @DataMember(Order=18)
public PostalCode: string;
// @DataMember(Order=19)
public Region: string;
// @DataMember(Order=20)
public Suburb: string;
// @DataMember(Order=21)
public UniqueIdentifier: string;
public constructor(init?: Partial<CustomersLookup>) { (Object as any).assign(this, init); }
}
TypeScript CustomersLookup DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
[{"TenantsId":0,"UserAuthId":0,"SegmentsId":0,"CompaniesId":0,"CurrenciesId":0,"Address":"String","Age":0,"City":"String","ContactNumber":"String","Email":"String","EthnicGroup":"String","FirstName":"String","Gender":"String","HomeLanguage":"String","IdNumber":"String","LastName":"String","PostalCode":"String","Region":"String","Suburb":"String","UniqueIdentifier":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}]