| Requires any of the roles: | Client, Admin, Partner |
| GET | /customers |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TenantsId | query | int | No | |
| UserAuthId | query | int? | No | |
| SegmentsId | query | long | No | |
| CompaniesId | query | long? | No | |
| CurrenciesId | query | int? | No | |
| Address | query | string | No | |
| Age | query | int? | No | |
| City | query | string | No | |
| ContactNumber | query | string | No | |
| query | string | No | ||
| EthnicGroup | query | string | No | |
| FirstName | query | string | No | |
| Gender | query | string | No | |
| HomeLanguage | query | string | No | |
| IdNumber | query | string | No | |
| LastName | query | string | No | |
| PostalCode | query | string | No | |
| Region | query | string | No | |
| Suburb | query | string | No | |
| UniqueIdentifier | query | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}
]