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
CustomersLookup Parameters:
NameParameterData TypeRequiredDescription
TenantsIdqueryintNo
UserAuthIdqueryint?No
SegmentsIdquerylongNo
CompaniesIdquerylong?No
CurrenciesIdqueryint?No
AddressquerystringNo
Agequeryint?No
CityquerystringNo
ContactNumberquerystringNo
EmailquerystringNo
EthnicGroupquerystringNo
FirstNamequerystringNo
GenderquerystringNo
HomeLanguagequerystringNo
IdNumberquerystringNo
LastNamequerystringNo
PostalCodequerystringNo
RegionquerystringNo
SuburbquerystringNo
UniqueIdentifierquerystringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
			}
		}
	}
]