YM REST Services

Announcements

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

The following routes are available for this service:
GET	/Ams/{ClientID}/Announcements	Return a list of announcements for the admin.
POST	/Ams/{ClientID}/Announcements	Add a new admin announcement.
PUT	/Ams/{ClientID}/Announcements	Sort the existing announcements based on the order the IDs are passed.
GET	/Ams/{ClientID}/Member/{MemberID}/Announcements	Return a list of announcements for the member.
PUT	/Ams/{ClientID}/Announcements/{AnnouncementId}	Update an admin announcement details.
DELETE	/Ams/{ClientID}/Announcements/{AnnouncementId}	Delete an admin announcement.

**Announcements** Parameters:
Name	Parameter	Data Type	Required
AnnouncementId	path	int	No
AnnouncementIds	body	List<int>	No
Title	body	string	No
AnnouncementText	body	string	No
ActionText	body	string	No
ActionUrl	body	string	No
ActionInNewTab	body	bool	No
Active	body	bool	No
StartDate	body	DateTime	No
ExpireDate	body	DateTime	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

**AnnouncementsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
AnnouncementList	form	List<Announcement>	No

**Announcement** Parameters:
Name	Parameter	Data Type	Required
AnnouncementId	form	int	No
Title	form	string	No
AnnouncementText	form	string	No
ActionText	form	string	No
ActionUrl	form	string	No
ActionInNewTab	form	bool	No
Active	form	bool	No
StartDate	form	DateTime	No
ExpireDate	form	DateTime	No
ModifiedDate	form	DateTime	No
IsSystemGenerated	form	bool	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}/Announcements HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AnnouncementId: 0,
	AnnouncementIds: 
	[
		0
	],
	Title: String,
	AnnouncementText: String,
	ActionText: String,
	ActionUrl: String,
	ActionInNewTab: False,
	Active: False,
	StartDate: 0001-01-01,
	ExpireDate: 0001-01-01,
	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-03T06:11:53.7720355-04:00,
	Device: Desktop
}

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

{
	AnnouncementList: 
	[
		{
			AnnouncementId: 0,
			Title: String,
			AnnouncementText: String,
			ActionText: String,
			ActionUrl: String,
			ActionInNewTab: False,
			Active: False,
			StartDate: 0001-01-01,
			ExpireDate: 0001-01-01,
			ModifiedDate: 0001-01-01,
			IsSystemGenerated: False
		}
	],
	AnnouncementId: 0,
	AnnouncementIds: 
	[
		0
	],
	Title: String,
	AnnouncementText: String,
	ActionText: String,
	ActionUrl: String,
	ActionInNewTab: False,
	Active: False,
	StartDate: 0001-01-01,
	ExpireDate: 0001-01-01,
	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-03T06:11:53.7720355-04:00,
	Device: Desktop
}