EMUN1 ASP.NET

<back to all web services

QueryConsumers

The following routes are available for this service:
All Verbs/service/QueryConsumers
QueryConsumers Parameters:
NameParameterData TypeRequiredDescription
SearchquerystringNo
UserNameContainsquerystringNo
FullNameContainsquerystringNo
EmailContainsquerystringNo
DisplayNameContainsquerystringNo
PrimaryEmailContainsquerystringNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
EmunUserAuth Parameters:
NameParameterData TypeRequiredDescription
ContactIdformstringNo
RetailerIdformstringNo
SalesRepIdformstringNo
AspMembershipIdformGuidNo
MetaformDictionary<string, string>No
TagsformDictionary<string, HashSet<String>>No
ShardedUserAuth Parameters:
NameParameterData TypeRequiredDescription
ShardformstringNo
EmailformstringNo
UserNameformstringNo
MetaformDictionary<string, string>No
UserAuth Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UserNameformstringNo
EmailformstringNo
PrimaryEmailformstringNo
PhoneNumberformstringNo
FirstNameformstringNo
LastNameformstringNo
DisplayNameformstringNo
CompanyformstringNo
BirthDateformDateTime?No
BirthDateRawformstringNo
AddressformstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
CultureformstringNo
FullNameformstringNo
GenderformstringNo
LanguageformstringNo
MailAddressformstringNo
NicknameformstringNo
PostalCodeformstringNo
TimeZoneformstringNo
SaltformstringNo
PasswordHashformstringNo
DigestHa1HashformstringNo
RolesformList<string>No
PermissionsformList<string>No
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
InvalidLoginAttemptsformintNo
LastLoginAttemptformDateTime?No
LockedDateformDateTime?No
RecoveryTokenformstringNo
RefIdformint?No
RefIdStrformstringNo
MetaformDictionary<string, string>No
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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.

POST /service/QueryConsumers HTTP/1.1 
Host: www.bernhardthospitality.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	search: String,
	userNameContains: String,
	fullNameContains: String,
	emailContains: String,
	displayNameContains: String,
	primaryEmailContains: String,
	skip: 0,
	take: 0,
	orderBy: String,
	orderByDesc: String,
	include: String,
	fields: String,
	meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			address: String,
			address2: String,
			birthDate: 0001-01-01,
			city: String,
			company: String,
			country: String,
			createdDate: 0001-01-01,
			modifiedDate: 0001-01-01,
			culture: String,
			displayName: String,
			email: String,
			firstName: String,
			fullName: String,
			gender: String,
			id: 0,
			language: String,
			lastName: String,
			mailAddress: String,
			meta: 
			{
				String: String
			},
			nickname: String,
			permissions: 
			[
				String
			],
			phoneNumber: String,
			postalCode: String,
			zip: String,
			shard: String,
			primaryEmail: String,
			refId: 0,
			refIdStr: String,
			roles: 
			[
				String
			],
			role: Administrator,
			state: String,
			timeZone: String,
			userName: String,
			contactId: String,
			retailerId: String,
			companyName: String,
			salesRepId: String,
			consumerId: String,
			lastLoginAttempt: 0001-01-01,
			lockedDate: 0001-01-01,
			salesRep: 
			{
				id: String,
				bio: String,
				regionId: String,
				repGroupId: String,
				commissionGroup: String,
				phone: String,
				manager: String,
				address: String,
				city: String,
				state: String,
				zip: String,
				country: String,
				isActive: False,
				active: False,
				customerServiceEmailAddress: String
			},
			parentRepId: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}