EMUN1 ASP.NET

<back to all web services

QueryProductLists

The following routes are available for this service:
All Verbs/service/QueryProductLists
All Verbs/service/QueryProductLists/{Id}
QueryProductLists Parameters:
NameParameterData TypeRequiredDescription
SearchquerystringNo
IdpathstringNo
RetailerIdquerystringNo
IncludeViewsqueryboolNo
VisibilityListqueryProductListVisibility[]No
ExpiredqueryboolNo
ListTypequerystringNo
ListTagsquerystringNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
ProductListEx Parameters:
NameParameterData TypeRequiredDescription
RetailerViewsformintNo
RetailerViewedformboolNo
Editableformbool?No
Visibleformbool?No
ProductList Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
LabelformstringNo
DescriptionformstringNo
ExpiresOnformDateTimeNo
CreatedByformstringNo
CreatedOnformDateTimeNo
LastModifiedOnformDateTimeNo
LastModifiedByformstringNo
PositionformintNo
UserformUserNo
RetailerAuthorizationformDictionary<string, bool>No
ItemsformHashSet<string>No
TagsformHashSet<string>No
VisibilityformHashSet<ProductListVisibility>No
ItemCountformintNo
ExpiredformboolNo
ListTypeformstringNo
EntityBase<K> Parameters:
NameParameterData TypeRequiredDescription
IdformKNo
User Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
RetailerIdformstringNo
DisplayNameformstringNo
UserNameformstringNo
EmailformstringNo
FullNameformstringNo
PhoneNumberformstringNo
ProfileImageUrlformstringNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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.bernhardthospitality.com 
Accept: application/json
Content-Type: application/json
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: application/json
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-01T00:00:00.0000000Z","createdBy":"String","createdOn":"0001-01-01T00:00:00.0000000Z","lastModifiedOn":"0001-01-01T00:00:00.0000000Z","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"}}}