YM REST Services

ContentAreas

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

The following routes are available for this service:
GET	/Ams/{ClientID}/ContentAreas	Return a content area.
PUT	/Ams/{ClientID}/ContentAreas	Update a content area.

**ContentAreas** Parameters:
Name	Parameter	Data Type	Required
AreaType	body	string	No
VersionID	body	int?	No
Revert	body	bool	No
VersionLabel	body	string	No
VersionNotes	body	string	No
Publish	body	bool	No
ContentArea	body	ContentArea	No

**MemberBaseSharedDto** Parameters:
Name	Parameter	Data Type	Required	Description
MemberID	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

**ContentArea** Parameters:
Name	Parameter	Data Type	Required
TitleDefault	form	string	No
Title	form	string	No
Body	form	string	No
AutoFormatted	form	int	No
AllowSponsorRotatorWidget	form	bool	No
ContentType	form	int	No
RotatorId	form	int?	No
AreaStatus	form	int	No
VersionID	form	int?	No
ModifiedAt	form	DateTime?	No
ModifiedByLastName	form	string	No
ModifiedByFirstName	form	string	No
MessageType	form	string	No
MessageLocation	form	string	No
MessageTypeID	form	string	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.

PUT /Ams/{ClientID}/ContentAreas HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AreaType: String,
	VersionID: 0,
	Revert: False,
	VersionLabel: String,
	VersionNotes: String,
	Publish: False,
	ContentArea: 
	{
		TitleDefault: String,
		Title: String,
		Body: String,
		AutoFormatted: 0,
		AllowSponsorRotatorWidget: False,
		ContentType: 0,
		RotatorId: 0,
		AreaStatus: 0,
		VersionID: 0,
		ModifiedAt: 0001-01-01,
		ModifiedByLastName: String,
		ModifiedByFirstName: String,
		MessageType: String,
		MessageLocation: String,
		MessageTypeID: String
	},
	MemberID: 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-03T07:52:02.1829608-04:00,
	Device: Desktop
}

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

{
	AreaType: String,
	VersionID: 0,
	Revert: False,
	VersionLabel: String,
	VersionNotes: String,
	Publish: False,
	ContentArea: 
	{
		TitleDefault: String,
		Title: String,
		Body: String,
		AutoFormatted: 0,
		AllowSponsorRotatorWidget: False,
		ContentType: 0,
		RotatorId: 0,
		AreaStatus: 0,
		VersionID: 0,
		ModifiedAt: 0001-01-01,
		ModifiedByLastName: String,
		ModifiedByFirstName: String,
		MessageType: String,
		MessageLocation: String,
		MessageTypeID: String
	},
	MemberID: 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-03T07:52:02.1907801-04:00,
	Device: Desktop
}