All Verbs | /service/CreateProductList |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RetailerId | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
RetailerId | form | string | No | |
DisplayName | form | string | No | |
UserName | form | string | No | |
form | string | No | ||
FullName | form | string | No | |
PhoneNumber | form | string | No | |
ProfileImageUrl | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
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.
POST /service/CreateProductList HTTP/1.1
Host: www.bernhardt.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
retailerId: String,
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
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { 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 }