YM REST Services

Markup

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin

The following routes are available for this service:
GET	/Ams/{ClientID}/Markup	Return the list of markups.
POST	/Ams/{ClientID}/Markup	Create the Markup.
PUT	/Ams/{ClientID}/Markup	Update the Markup Json.
GET	/Ams/{ClientID}/Markup/{MarkupId}	Return the Markup data With Cache.
DELETE	/Ams/{ClientID}/Markup/{MarkupId}	Delete the Markup for given MarkupId.

**Markup** Parameters:
Name	Parameter	Data Type	Required
MarkupId	form	int	No
MarkupData	form	MarkupData	No
MarkupName	form	string	No
MarkupType	form	MarkupType	No
MarkupTypeName	form	string	No
TargetClientId	form	int	No
Template	form	bool	No
MarkupClass	form	MarkupClass	No
PageSize	form	int	No
PageNumber	form	int	No
CampaignId	form	int	No
DateCreated	form	DateTime	No
DateLastModified	form	DateTime	No
AdminLastModified	form	string	No
MaxComponents	form	int	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**MarkupData** Parameters:
Name	Parameter	Data Type	Required	Description
Settings	form	MarkupSettings	No
Column	form	List<MarkupComponentData>	No

**MarkupSettings** Parameters:
Name	Parameter	Data Type	Required
FontFamily	form	string	No
TextColor	form	string	No
PageBackgroundColor	form	string	No
CanvasBackgroundColor	form	string	No
Width	form	int	No
Margin	form	int	No
IncludeViewInBrowser	form	bool	No

**MarkupComponentData** Parameters:
Name	Parameter	Data Type	Required
ComponentType	form	ComponentType	No
ComponentName	form	string	No
IsAtRootColumn	form	bool	No
CanHaveChildren	form	bool	No
OrderId	form	int	No
ButtonData	form	ButtonData	No
ImageData	form	ImageData	No
DividerData	form	DividerData	No
TextData	form	TextData	No
ContainerData	form	ContainerData	No
PlainText	form	string	No

**ButtonData** Parameters:
Name	Parameter	Data Type	Required	Description
Properties	form	ButtonProperties	No
Settings	form	ButtonSettings	No

**ButtonProperties** Parameters:
Name	Parameter	Data Type	Required	Description
Text	form	string	No
Link	form	string	No

**ButtonSettings** Parameters:
Name	Parameter	Data Type	Required
ButtonColor	form	string	No
TextColor	form	string	No
Alignment	form	string	No
ButtonWidth	form	string	No
MarginTop	form	int	No
MarginBottom	form	int	No
MarginLeft	form	int	No
MarginRight	form	int	No

**ImageData** Parameters:
Name	Parameter	Data Type	Required	Description
Properties	form	ImageProperties	No
Settings	form	ImageSettings	No

**ImageProperties** Parameters:
Name	Parameter	Data Type	Required
URL	form	string	No
HyperLink	form	string	No
AltText	form	string	No

**ImageSettings** Parameters:
Name	Parameter	Data Type	Required
Alignment	form	string	No
MarginTop	form	int	No
MarginBottom	form	int	No
MarginLeft	form	int	No
MarginRight	form	int	No
Width	form	int	No
Height	form	int	No

**DividerData** Parameters:
Name	Parameter	Data Type	Required	Description
Settings	form	DividerSettings	No

**DividerSettings** Parameters:
Name	Parameter	Data Type	Required
MarginTop	form	int	No
MarginBottom	form	int	No
MarginLeft	form	int	No
MarginRight	form	int	No
BorderColor	form	string	No
Height	form	int	No

**TextData** Parameters:
Name	Parameter	Data Type	Required	Description
Properties	form	TextProperties	No
Settings	form	TextSettings	No

**TextProperties** Parameters:
Name	Parameter	Data Type	Required	Description
Text	form	string	No

**TextSettings** Parameters:
Name	Parameter	Data Type	Required
MarginTop	form	int	No
MarginBottom	form	int	No
MarginLeft	form	int	No
MarginRight	form	int	No

**ContainerData** Parameters:
Name	Parameter	Data Type	Required
Properties	form	ContainerProperties	No
Settings	form	ContainerSettings	No
Columns	form	List<MarkupComponentData>>	No

**ContainerSettings** Parameters:
Name	Parameter	Data Type	Required
BackgroundColor	form	string	No
MarginTop	form	int	No
MarginBottom	form	int	No
MarginLeft	form	int	No
MarginRight	form	int	No

**MarkupResponse** Parameters:
Name	Parameter	Data Type	Required	Description
MarkupList	form	List<Markup>	No
TotalCount	form	int	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 /Ams/{ClientID}/Markup HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	MarkupId: 0,
	MarkupData: 
	{
		Settings: 
		{
			FontFamily: String,
			TextColor: String,
			PageBackgroundColor: String,
			CanvasBackgroundColor: String,
			Width: 0,
			Margin: 0,
			IncludeViewInBrowser: False
		},
		Column: 
		[
			{
				ComponentType: Button,
				ComponentName: String,
				IsAtRootColumn: False,
				CanHaveChildren: False,
				OrderId: 0,
				ButtonData: 
				{
					Properties: 
					{
						Text: String,
						Link: String
					},
					Settings: 
					{
						ButtonColor: String,
						TextColor: String,
						Alignment: String,
						ButtonWidth: String,
						MarginTop: 0,
						MarginBottom: 0,
						MarginLeft: 0,
						MarginRight: 0
					}
				},
				ImageData: 
				{
					Properties: 
					{
						URL: String,
						HyperLink: String,
						AltText: String
					},
					Settings: 
					{
						Alignment: String,
						MarginTop: 0,
						MarginBottom: 0,
						MarginLeft: 0,
						MarginRight: 0,
						Width: 0,
						Height: 0
					}
				},
				DividerData: 
				{
					Settings: 
					{
						MarginTop: 0,
						MarginBottom: 0,
						MarginLeft: 0,
						MarginRight: 0,
						BorderColor: String,
						Height: 0
					}
				},
				TextData: 
				{
					Properties: 
					{
						Text: String
					},
					Settings: 
					{
						MarginTop: 0,
						MarginBottom: 0,
						MarginLeft: 0,
						MarginRight: 0
					}
				},
				ContainerData: 
				{
					Properties: {},
					Settings: 
					{
						BackgroundColor: String,
						MarginTop: 0,
						MarginBottom: 0,
						MarginLeft: 0,
						MarginRight: 0
					},
					Columns: 
					[
						[
							{
								ComponentType: Button,
								ComponentName: String,
								IsAtRootColumn: False,
								CanHaveChildren: False,
								OrderId: 0,
								ButtonData: 
								{
									Properties: 
									{
										Text: String,
										Link: String
									},
									Settings: 
									{
										ButtonColor: String,
										TextColor: String,
										Alignment: String,
										ButtonWidth: String,
										MarginTop: 0,
										MarginBottom: 0,
										MarginLeft: 0,
										MarginRight: 0
									}
								},
								ImageData: 
								{
									Properties: 
									{
										URL: String,
										HyperLink: String,
										AltText: String
									},
									Settings: 
									{
										Alignment: String,
										MarginTop: 0,
										MarginBottom: 0,
										MarginLeft: 0,
										MarginRight: 0,
										Width: 0,
										Height: 0
									}
								},
								DividerData: 
								{
									Settings: 
									{
										MarginTop: 0,
										MarginBottom: 0,
										MarginLeft: 0,
										MarginRight: 0,
										BorderColor: String,
										Height: 0
									}
								},
								TextData: 
								{
									Properties: 
									{
										Text: String
									},
									Settings: 
									{
										MarginTop: 0,
										MarginBottom: 0,
										MarginLeft: 0,
										MarginRight: 0
									}
								},
								ContainerData: 
								{
									Properties: {},
									Settings: 
									{
										BackgroundColor: String,
										MarginTop: 0,
										MarginBottom: 0,
										MarginLeft: 0,
										MarginRight: 0
									},
									Columns: 
									[
										[
											{
												ComponentType: Button,
												ComponentName: String,
												IsAtRootColumn: False,
												CanHaveChildren: False,
												OrderId: 0,
												ButtonData: 
												{
													Properties: 
													{
														Text: String,
														Link: String
													},
													Settings: 
													{
														ButtonColor: String,
														TextColor: String,
														Alignment: String,
														ButtonWidth: String,
														MarginTop: 0,
														MarginBottom: 0,
														MarginLeft: 0,
														MarginRight: 0
													}
												},
												ImageData: 
												{
													Properties: 
													{
														URL: String,
														HyperLink: String,
														AltText: String
													},
													Settings: 
													{
														Alignment: String,
														MarginTop: 0,
														MarginBottom: 0,
														MarginLeft: 0,
														MarginRight: 0,
														Width: 0,
														Height: 0
													}
												},
												DividerData: 
												{
													Settings: 
													{
														MarginTop: 0,
														MarginBottom: 0,
														MarginLeft: 0,
														MarginRight: 0,
														BorderColor: String,
														Height: 0
													}
												},
												TextData: 
												{
													Properties: 
													{
														Text: String
													},
													Settings: 
													{
														MarginTop: 0,
														MarginBottom: 0,
														MarginLeft: 0,
														MarginRight: 0
													}
												},
												ContainerData: 
												{
													Properties: {},
													Settings: 
													{
														BackgroundColor: String,
														MarginTop: 0,
														MarginBottom: 0,
														MarginLeft: 0,
														MarginRight: 0
													},
													Columns: []
												},
												PlainText: String
											}
										]
									]
								},
								PlainText: String
							}
						]
					]
				},
				PlainText: String
			}
		]
	},
	MarkupName: String,
	MarkupType: None,
	MarkupTypeName: String,
	TargetClientId: 0,
	Template: False,
	MarkupClass: All,
	PageSize: 0,
	PageNumber: 0,
	CampaignId: 0,
	DateCreated: 0001-01-01,
	DateLastModified: 0001-01-01,
	AdminLastModified: String,
	MaxComponents: 0,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T06:26:37.2058551-04:00,
	Device: Desktop
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	MarkupList: 
	[
		{
			MarkupId: 0,
			MarkupData: 
			{
				Settings: 
				{
					FontFamily: String,
					TextColor: String,
					PageBackgroundColor: String,
					CanvasBackgroundColor: String,
					Width: 0,
					Margin: 0,
					IncludeViewInBrowser: False
				},
				Column: 
				[
					{
						ComponentType: Button,
						ComponentName: String,
						IsAtRootColumn: False,
						CanHaveChildren: False,
						OrderId: 0,
						ButtonData: 
						{
							Properties: 
							{
								Text: String,
								Link: String
							},
							Settings: 
							{
								ButtonColor: String,
								TextColor: String,
								Alignment: String,
								ButtonWidth: String,
								MarginTop: 0,
								MarginBottom: 0,
								MarginLeft: 0,
								MarginRight: 0
							}
						},
						ImageData: 
						{
							Properties: 
							{
								URL: String,
								HyperLink: String,
								AltText: String
							},
							Settings: 
							{
								Alignment: String,
								MarginTop: 0,
								MarginBottom: 0,
								MarginLeft: 0,
								MarginRight: 0,
								Width: 0,
								Height: 0
							}
						},
						DividerData: 
						{
							Settings: 
							{
								MarginTop: 0,
								MarginBottom: 0,
								MarginLeft: 0,
								MarginRight: 0,
								BorderColor: String,
								Height: 0
							}
						},
						TextData: 
						{
							Properties: 
							{
								Text: String
							},
							Settings: 
							{
								MarginTop: 0,
								MarginBottom: 0,
								MarginLeft: 0,
								MarginRight: 0
							}
						},
						ContainerData: 
						{
							Properties: {},
							Settings: 
							{
								BackgroundColor: String,
								MarginTop: 0,
								MarginBottom: 0,
								MarginLeft: 0,
								MarginRight: 0
							},
							Columns: 
							[
								[
									{
										ComponentType: Button,
										ComponentName: String,
										IsAtRootColumn: False,
										CanHaveChildren: False,
										OrderId: 0,
										ButtonData: 
										{
											Properties: 
											{
												Text: String,
												Link: String
											},
											Settings: 
											{
												ButtonColor: String,
												TextColor: String,
												Alignment: String,
												ButtonWidth: String,
												MarginTop: 0,
												MarginBottom: 0,
												MarginLeft: 0,
												MarginRight: 0
											}
										},
										ImageData: 
										{
											Properties: 
											{
												URL: String,
												HyperLink: String,
												AltText: String
											},
											Settings: 
											{
												Alignment: String,
												MarginTop: 0,
												MarginBottom: 0,
												MarginLeft: 0,
												MarginRight: 0,
												Width: 0,
												Height: 0
											}
										},
										DividerData: 
										{
											Settings: 
											{
												MarginTop: 0,
												MarginBottom: 0,
												MarginLeft: 0,
												MarginRight: 0,
												BorderColor: String,
												Height: 0
											}
										},
										TextData: 
										{
											Properties: 
											{
												Text: String
											},
											Settings: 
											{
												MarginTop: 0,
												MarginBottom: 0,
												MarginLeft: 0,
												MarginRight: 0
											}
										},
										ContainerData: 
										{
											Properties: {},
											Settings: 
											{
												BackgroundColor: String,
												MarginTop: 0,
												MarginBottom: 0,
												MarginLeft: 0,
												MarginRight: 0
											},
											Columns: 
											[
												[
													{
														ComponentType: Button,
														ComponentName: String,
														IsAtRootColumn: False,
														CanHaveChildren: False,
														OrderId: 0,
														ButtonData: 
														{
															Properties: 
															{
																Text: String,
																Link: String
															},
															Settings: 
															{
																ButtonColor: String,
																TextColor: String,
																Alignment: String,
																ButtonWidth: String,
																MarginTop: 0,
																MarginBottom: 0,
																MarginLeft: 0,
																MarginRight: 0
															}
														},
														ImageData: 
														{
															Properties: 
															{
																URL: String,
																HyperLink: String,
																AltText: String
															},
															Settings: 
															{
																Alignment: String,
																MarginTop: 0,
																MarginBottom: 0,
																MarginLeft: 0,
																MarginRight: 0,
																Width: 0,
																Height: 0
															}
														},
														DividerData: 
														{
															Settings: 
															{
																MarginTop: 0,
																MarginBottom: 0,
																MarginLeft: 0,
																MarginRight: 0,
																BorderColor: String,
																Height: 0
															}
														},
														TextData: 
														{
															Properties: 
															{
																Text: String
															},
															Settings: 
															{
																MarginTop: 0,
																MarginBottom: 0,
																MarginLeft: 0,
																MarginRight: 0
															}
														},
														ContainerData: 
														{
															Properties: {},
															Settings: 
															{
																BackgroundColor: String,
																MarginTop: 0,
																MarginBottom: 0,
																MarginLeft: 0,
																MarginRight: 0
															},
															Columns: []
														},
														PlainText: String
													}
												]
											]
										},
										PlainText: String
									}
								]
							]
						},
						PlainText: String
					}
				]
			},
			MarkupName: String,
			MarkupType: None,
			MarkupTypeName: String,
			TargetClientId: 0,
			Template: False,
			MarkupClass: All,
			PageSize: 0,
			PageNumber: 0,
			CampaignId: 0,
			DateCreated: 0001-01-01,
			DateLastModified: 0001-01-01,
			AdminLastModified: String,
			MaxComponents: 0,
			ClientID: 0,
			ResponseStatus: 
			{
				ErrorCode: String,
				Message: String,
				StackTrace: String,
				Errors: 
				[
					{
						ErrorCode: String,
						FieldName: String,
						Message: String,
						Meta: 
						{
							String: String
						}
					}
				],
				Meta: 
				{
					String: String
				}
			},
			BypassCache: False,
			DateCached: 2024-05-03T06:26:37.2241025-04:00,
			Device: Desktop
		}
	],
	TotalCount: 0,
	MarkupId: 0,
	MarkupData: 
	{
		Settings: 
		{
			FontFamily: String,
			TextColor: String,
			PageBackgroundColor: String,
			CanvasBackgroundColor: String,
			Width: 0,
			Margin: 0,
			IncludeViewInBrowser: False
		},
		Column: 
		[
			{
				ComponentType: Button,
				ComponentName: String,
				IsAtRootColumn: False,
				CanHaveChildren: False,
				OrderId: 0,
				ButtonData: 
				{
					Properties: 
					{
						Text: String,
						Link: String
					},
					Settings: 
					{
						ButtonColor: String,
						TextColor: String,
						Alignment: String,
						ButtonWidth: String,
						MarginTop: 0,
						MarginBottom: 0,
						MarginLeft: 0,
						MarginRight: 0
					}
				},
				ImageData: 
				{
					Properties: 
					{
						URL: String,
						HyperLink: String,
						AltText: String
					},
					Settings: 
					{
						Alignment: String,
						MarginTop: 0,
						MarginBottom: 0,
						MarginLeft: 0,
						MarginRight: 0,
						Width: 0,
						Height: 0
					}
				},
				DividerData: 
				{
					Settings: 
					{
						MarginTop: 0,
						MarginBottom: 0,
						MarginLeft: 0,
						MarginRight: 0,
						BorderColor: String,
						Height: 0
					}
				},
				TextData: 
				{
					Properties: 
					{
						Text: String
					},
					Settings: 
					{
						MarginTop: 0,
						MarginBottom: 0,
						MarginLeft: 0,
						MarginRight: 0
					}
				},
				ContainerData: 
				{
					Properties: {},
					Settings: 
					{
						BackgroundColor: String,
						MarginTop: 0,
						MarginBottom: 0,
						MarginLeft: 0,
						MarginRight: 0
					},
					Columns: 
					[
						[
							{
								ComponentType: Button,
								ComponentName: String,
								IsAtRootColumn: False,
								CanHaveChildren: False,
								OrderId: 0,
								ButtonData: 
								{
									Properties: 
									{
										Text: String,
										Link: String
									},
									Settings: 
									{
										ButtonColor: String,
										TextColor: String,
										Alignment: String,
										ButtonWidth: String,
										MarginTop: 0,
										MarginBottom: 0,
										MarginLeft: 0,
										MarginRight: 0
									}
								},
								ImageData: 
								{
									Properties: 
									{
										URL: String,
										HyperLink: String,
										AltText: String
									},
									Settings: 
									{
										Alignment: String,
										MarginTop: 0,
										MarginBottom: 0,
										MarginLeft: 0,
										MarginRight: 0,
										Width: 0,
										Height: 0
									}
								},
								DividerData: 
								{
									Settings: 
									{
										MarginTop: 0,
										MarginBottom: 0,
										MarginLeft: 0,
										MarginRight: 0,
										BorderColor: String,
										Height: 0
									}
								},
								TextData: 
								{
									Properties: 
									{
										Text: String
									},
									Settings: 
									{
										MarginTop: 0,
										MarginBottom: 0,
										MarginLeft: 0,
										MarginRight: 0
									}
								},
								ContainerData: 
								{
									Properties: {},
									Settings: 
									{
										BackgroundColor: String,
										MarginTop: 0,
										MarginBottom: 0,
										MarginLeft: 0,
										MarginRight: 0
									},
									Columns: 
									[
										[
											{
												ComponentType: Button,
												ComponentName: String,
												IsAtRootColumn: False,
												CanHaveChildren: False,
												OrderId: 0,
												ButtonData: 
												{
													Properties: 
													{
														Text: String,
														Link: String
													},
													Settings: 
													{
														ButtonColor: String,
														TextColor: String,
														Alignment: String,
														ButtonWidth: String,
														MarginTop: 0,
														MarginBottom: 0,
														MarginLeft: 0,
														MarginRight: 0
													}
												},
												ImageData: 
												{
													Properties: 
													{
														URL: String,
														HyperLink: String,
														AltText: String
													},
													Settings: 
													{
														Alignment: String,
														MarginTop: 0,
														MarginBottom: 0,
														MarginLeft: 0,
														MarginRight: 0,
														Width: 0,
														Height: 0
													}
												},
												DividerData: 
												{
													Settings: 
													{
														MarginTop: 0,
														MarginBottom: 0,
														MarginLeft: 0,
														MarginRight: 0,
														BorderColor: String,
														Height: 0
													}
												},
												TextData: 
												{
													Properties: 
													{
														Text: String
													},
													Settings: 
													{
														MarginTop: 0,
														MarginBottom: 0,
														MarginLeft: 0,
														MarginRight: 0
													}
												},
												ContainerData: 
												{
													Properties: {},
													Settings: 
													{
														BackgroundColor: String,
														MarginTop: 0,
														MarginBottom: 0,
														MarginLeft: 0,
														MarginRight: 0
													},
													Columns: []
												},
												PlainText: String
											}
										]
									]
								},
								PlainText: String
							}
						]
					]
				},
				PlainText: String
			}
		]
	},
	MarkupName: String,
	MarkupType: None,
	MarkupTypeName: String,
	TargetClientId: 0,
	Template: False,
	MarkupClass: All,
	PageSize: 0,
	PageNumber: 0,
	CampaignId: 0,
	DateCreated: 0001-01-01,
	DateLastModified: 0001-01-01,
	AdminLastModified: String,
	MaxComponents: 0,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T06:26:37.2241025-04:00,
	Device: Desktop
}