EMUN1 ASP.NET

QueryProductLists

The following routes are available for this service:
All Verbs	/service/QueryProductLists
All Verbs	/service/QueryProductLists/{Id}

**QueryProductLists** Parameters:
Name	Parameter	Data Type	Required
Search	query	string	No
Id	path	string	No
RetailerId	query	string	No
IncludeViews	query	bool	No
VisibilityList	query	ProductListVisibility[]	No
Expired	query	bool	No
ListType	query	string	No
ListTags	query	string	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**ProductListEx** Parameters:
Name	Parameter	Data Type	Required
RetailerViews	form	int	No
RetailerViewed	form	bool	No
Editable	form	bool?	No
Visible	form	bool?	No

**ProductList** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Label	form	string	No
Description	form	string	No
ExpiresOn	form	DateTime	No
CreatedBy	form	string	No
CreatedOn	form	DateTime	No
LastModifiedOn	form	DateTime	No
LastModifiedBy	form	string	No
Position	form	int	No
User	form	User	No
RetailerAuthorization	form	Dictionary<string, bool>	No
Items	form	HashSet<string>	No
Tags	form	HashSet<string>	No
Visibility	form	HashSet<ProductListVisibility>	No
ItemCount	form	int	No
Expired	form	bool	No
ListType	form	string	No

**EntityBase<K>** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	K	No

**User** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
RetailerId	form	string	No
DisplayName	form	string	No
UserName	form	string	No
Email	form	string	No
FullName	form	string	No
PhoneNumber	form	string	No
ProfileImageUrl	form	string	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<T>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

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/QueryProductLists HTTP/1.1 
Host: www.bernhardt.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	search: String,
	id: String,
	retailerId: String,
	includeViews: False,
	visibilityList: 
	[
		OrderEntry
	],
	expired: False,
	listType: String,
	listTags: 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: 
	[
		{
			retailerViews: 0,
			retailerViewed: False,
			editable: False,
			visible: False,
			id: String,
			label: String,
			description: String,
			expiresOn: 0001-01-01,
			createdBy: String,
			createdOn: 0001-01-01,
			lastModifiedOn: 0001-01-01,
			lastModifiedBy: String,
			position: 0,
			user: 
			{
				id: String,
				retailerId: String,
				displayName: String,
				userName: String,
				email: String,
				fullName: String,
				phoneNumber: String,
				profileImageUrl: //emuncloud-staticassets.s3.amazonaws.com/blank-profile.png
			},
			retailerAuthorization: 
			{
				String: False
			},
			items: 
			[
				String
			],
			tags: 
			[
				String
			],
			visibility: 
			[
				OrderEntry
			],
			itemCount: 1,
			expired: True,
			listType: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}