YM REST Services

MarkupMacroComponents

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

The following routes are available for this service:
GET	/Ams/{ClientID}/MarkupMacroComponents	Return the MarkupMacroComponents for that client - with cache.
POST	/Ams/{ClientID}/MarkupMacroComponents	Add a new Macro Component.
DELETE	/Ams/{ClientID}/MarkupMacroComponents/{ComponentId}	Delete a Macro Component.

**MarkupMacroComponents** Parameters:
Name	Parameter	Data Type	Required
MarkupType	body	MarkupType	No
ComponentId	path	int	No
ComponentData	body	MarkupComponentData	No
MacroComponentName	body	string	No
MacroComponentId	body	int	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	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

**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

**MarkupMacroComponentsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Components	form	List<MacroComponent>	No
ContainerId	form	int	No

**MacroComponent** Parameters:
Name	Parameter	Data Type	Required
MacroComponentId	form	int	No
IsShared	form	bool	No
Name	form	string	No
ComponentData	form	MarkupComponentData	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}/MarkupMacroComponents HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	MarkupType: None,
	ComponentId: 0,
	ComponentData: 
	{
		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
	},
	MacroComponentName: String,
	MacroComponentId: 0,
	UsingRedis: True,
	AppInitTime: 2025-01-15T07:15:52.7259632-05:00,
	ServerID: WS-4-190-907,
	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: 2025-01-15T08:48:15.5064427-05:00,
	Device: Desktop
}

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

{
	Components: 
	[
		{
			MacroComponentId: 0,
			IsShared: False,
			Name: String,
			ComponentData: 
			{
				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
			}
		}
	],
	ContainerId: 0,
	MarkupType: None,
	ComponentId: 0,
	ComponentData: 
	{
		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
	},
	MacroComponentName: String,
	MacroComponentId: 0,
	UsingRedis: True,
	AppInitTime: 2025-01-15T07:15:52.7259632-05:00,
	ServerID: WS-4-190-907,
	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: 2025-01-15T08:48:15.5064427-05:00,
	Device: Desktop
}