EMUN1 ASP.NET

<back to all web services

CreateDesign

Requires Authentication
The following routes are available for this service:
All Verbs/service/CreateDesign
CreateDesignBase Parameters:
NameParameterData TypeRequiredDescription
UnderlaysformList<DesignAreaUnderlay>No
OverlaysformList<DesignAreaOverlay>No
ProductIdformstringNo
AreaIndexformint?No
ContainformboolNo
SaveJsonformboolNo
RenderingsformList<RenderParams>No
ExchangeColorsformDictionary<string, string>No
CopyProductImagesformstringNo
TagsformDictionary<string, HashSet<String>>No
Design Parameters:
NameParameterData TypeRequiredDescription
JsonformstringNo
SvgformstringNo
BitmapformstringNo
BackgroundformstringNo
BackgroundColorformstringNo
OverlayColorformstringNo
OverlayImageformJsonObjectNo
BackgroundImageformJsonObjectNo
ObjectsformJsonArrayObjectsNo
PredecessorformMediaNo
OverlayImagesformDictionary<string, Dictionary<String,String>>No
UnderlayImagesformDictionary<string, Dictionary<String,String>>No
Media Parameters:
NameParameterData TypeRequiredDescription
PredecessorIdformint?No
ReplacePredecessorformboolNo
ContentTypeformstringNo
PredecessorformMediaNo
RealmformstringNo
HeightformdoubleNo
WidthformdoubleNo
AreaformdoubleNo
ContentLengthformdoubleNo
ClientIdformstringNo
UrlformstringNo
OriginalUrlformstringNo
ImagesformDictionary<string, string>No
KeyformstringNo
TaggedEntity Parameters:
NameParameterData TypeRequiredDescription
TagsformDictionary<string, HashSet<String>>No
EntityXL Parameters:
NameParameterData TypeRequiredDescription
RefIdformstringNo
RatingformdoubleNo
RestrictedformboolNo
EntityLG Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
EntityMD Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
NameformstringNo
TitleformstringNo
ActiveformboolNo
EntitySM Parameters:
NameParameterData TypeRequiredDescription
EuidformGuidNo
EntityXS Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
EntityXS<T> Parameters:
NameParameterData TypeRequiredDescription
IdformTNo
CreatedByformstringNo
CreatedOnformDateTimeNo
LastModifiedOnformDateTimeNo
LastModifiedByformstringNo
PositionformintNo
DesignAreaOverlay Parameters:
NameParameterData TypeRequiredDescription
MediaformMediaReferenceNo
HeightformdoubleNo
WidthformdoubleNo
XformdoubleNo
YformdoubleNo
IsProductImageformboolNo
IsPrintImageformboolNo
CanDesignformboolNo
ValueObject Parameters:
NameParameterData TypeRequiredDescription
EuidformGuidNo
LabelformstringNo
DescriptionformstringNo
MediaReference Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
EuidformGuid?No
LabelformstringNo
DescriptionformstringNo
RealmformstringNo
UrlformstringNo
ContentTypeformstringNo
Heightformdouble?No
Widthformdouble?No
RefIdformstringNo
RenderParams Parameters:
NameParameterData TypeRequiredDescription
TranslateformTranslatedDimensionsNo
ContainToformScaledDimensionsNo
CopyToformDictionary<string, HashSet<String>>No
LabelformstringNo
ClearBackgroundformboolNo
IsPrimaryformboolNo
ImageTypeformstringNo
QualityformbyteNo
OverlayIdformstringNo
OverlayUrlformstringNo
UnderlayIdformstringNo
UnderlayUrlformstringNo
BackgroundColorformstringNo
JsonformstringNo
SvgformstringNo
BitmapformstringNo
FileNameformstringNo
SlugformstringNo
MetaKeyformstringNo
Viewport Parameters:
NameParameterData TypeRequiredDescription
XformdoubleNo
YformdoubleNo
Dimensions Parameters:
NameParameterData TypeRequiredDescription
HeightformdoubleNo
WidthformdoubleNo
TranslatedDimensions Parameters:
NameParameterData TypeRequiredDescription
CoverformboolNo
ContainformboolNo
ToformDimensionsNo
LeftOffsetformdoubleNo
TopOffsetformdoubleNo
WidthRatioformdoubleNo
HeightRatioformdoubleNo
MultiplierformdoubleNo
ScaledDimensions Parameters:
NameParameterData TypeRequiredDescription
CoverformboolNo
ToformDimensionsNo
HeightRatioformdoubleNo
WidthRatioformdoubleNo
MultiplierformdoubleNo

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/CreateDesign HTTP/1.1 
Host: www.bernhardthospitality.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"underlays":[{"media":{"id":0,"euid":"00000000-0000-0000-0000-000000000000","label":"String","description":"String","realm":"String","url":"String","contentType":"String","height":0,"width":0,"refId":"String"},"height":0,"width":0,"x":0,"y":0,"isProductImage":false,"isPrintImage":false,"canDesign":false,"label":"String","description":"String"}],"overlays":[{"media":{"id":0,"euid":"00000000-0000-0000-0000-000000000000","label":"String","description":"String","realm":"String","url":"String","contentType":"String","height":0,"width":0,"refId":"String"},"height":0,"width":0,"x":0,"y":0,"isProductImage":false,"isPrintImage":false,"canDesign":false,"label":"String","description":"String"}],"productId":"String","areaIndex":0,"contain":false,"saveJson":false,"renderings":[{"copyTo":{"String":["String"]},"label":"String","clearBackground":false,"isPrimary":false,"imageType":"String","quality":0,"overlayId":"String","overlayUrl":"String","underlayId":"String","underlayUrl":"String","backgroundColor":"String","json":"String","svg":"String","bitmap":"String","fileName":"string.string","slug":"String/string.string","metaKey":"StringString","x":0,"y":0,"height":0,"width":0}],"exchangeColors":{"String":"String"},"copyProductImages":"String","tags":{"String":["String"]},"overlayImage":{"String":"String"},"backgroundImage":{"String":"String"},"objects":[{"String":"String"}],"predecessor":{"predecessorId":0,"replacePredecessor":false,"contentType":"String","predecessor":{"predecessorId":0,"replacePredecessor":false,"contentType":"String","predecessor":{"predecessorId":0,"replacePredecessor":false,"contentType":"String","realm":"String","height":0,"width":0,"area":0,"contentLength":0,"clientId":"String","url":"String","originalUrl":"String","key":"String","tags":{"String":["String"]},"refId":"String","rating":0,"restricted":false,"description":"String","label":"String","active":false,"id":0,"createdBy":"String","createdOn":"0001-01-01T00:00:00.0000000Z","lastModifiedOn":"0001-01-01T00:00:00.0000000Z","lastModifiedBy":"String","position":0},"realm":"String","height":0,"width":0,"area":0,"contentLength":0,"clientId":"String","url":"String","originalUrl":"String","key":"String","tags":{"String":["String"]},"refId":"String","rating":0,"restricted":false,"description":"String","label":"String","active":false,"id":0,"createdBy":"String","createdOn":"0001-01-01T00:00:00.0000000Z","lastModifiedOn":"0001-01-01T00:00:00.0000000Z","lastModifiedBy":"String","position":0},"realm":"String","height":0,"width":0,"area":0,"contentLength":0,"clientId":"String","url":"String","originalUrl":"String","key":"String","tags":{"String":["String"]},"refId":"String","rating":0,"restricted":false,"description":"String","label":"String","active":false,"id":0,"createdBy":"String","createdOn":"0001-01-01T00:00:00.0000000Z","lastModifiedOn":"0001-01-01T00:00:00.0000000Z","lastModifiedBy":"String","position":0},"predecessorId":0,"replacePredecessor":false,"contentType":"String","realm":"String","height":0,"width":0,"area":0,"contentLength":0,"clientId":"String","url":"String","originalUrl":"String","key":"String","refId":"String","rating":0,"restricted":false,"description":"String","label":"String","active":false,"id":0,"createdBy":"String","createdOn":"0001-01-01T00:00:00.0000000Z","lastModifiedOn":"0001-01-01T00:00:00.0000000Z","lastModifiedBy":"String","position":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"overlayImage":{"String":"String"},"backgroundImage":{"String":"String"},"objects":[{"String":"String"}],"predecessor":{"predecessorId":0,"replacePredecessor":false,"contentType":"String","predecessor":{"predecessorId":0,"replacePredecessor":false,"contentType":"String","predecessor":{"predecessorId":0,"replacePredecessor":false,"contentType":"String","realm":"String","height":0,"width":0,"area":0,"contentLength":0,"clientId":"String","url":"String","originalUrl":"String","key":"String","tags":{"String":["String"]},"refId":"String","rating":0,"restricted":false,"description":"String","label":"String","active":false,"id":0,"createdBy":"String","createdOn":"0001-01-01T00:00:00.0000000Z","lastModifiedOn":"0001-01-01T00:00:00.0000000Z","lastModifiedBy":"String","position":0},"realm":"String","height":0,"width":0,"area":0,"contentLength":0,"clientId":"String","url":"String","originalUrl":"String","key":"String","tags":{"String":["String"]},"refId":"String","rating":0,"restricted":false,"description":"String","label":"String","active":false,"id":0,"createdBy":"String","createdOn":"0001-01-01T00:00:00.0000000Z","lastModifiedOn":"0001-01-01T00:00:00.0000000Z","lastModifiedBy":"String","position":0},"realm":"String","height":0,"width":0,"area":0,"contentLength":0,"clientId":"String","url":"String","originalUrl":"String","key":"String","tags":{"String":["String"]},"refId":"String","rating":0,"restricted":false,"description":"String","label":"String","active":false,"id":0,"createdBy":"String","createdOn":"0001-01-01T00:00:00.0000000Z","lastModifiedOn":"0001-01-01T00:00:00.0000000Z","lastModifiedBy":"String","position":0},"predecessorId":0,"replacePredecessor":false,"contentType":"String","realm":"String","height":0,"width":0,"area":0,"contentLength":0,"clientId":"String","url":"String","originalUrl":"String","key":"String","tags":{"String":["String"]},"refId":"String","rating":0,"restricted":false,"description":"String","label":"String","active":false,"id":0,"createdBy":"String","createdOn":"0001-01-01T00:00:00.0000000Z","lastModifiedOn":"0001-01-01T00:00:00.0000000Z","lastModifiedBy":"String","position":0}