YM REST Services

<back to all web services

SponsorRotators

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/SponsorRotatorsReturn a list of sponsor rotators.
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
SponsorRotatorsResponse Parameters:
NameParameterData TypeRequiredDescription
SponsorRotatorsformList<SponsorRotator>No
SponsorRotator Parameters:
NameParameterData TypeRequiredDescription
RotatorIdformintNo
AutoScrollformboolNo
RandomformboolNo
DateAddedformDateTimeNo
ModeformintNo
OrientationformRotatorOrientationNo
SchoolIdformintNo
SpeedformintNo
TitleformstringNo
ClientIdformintNo
HeadingformstringNo
HeightformintNo

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.

GET /Ams/{ClientID}/SponsorRotators HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	SponsorRotators: 
	[
		{
			RotatorId: 0,
			AutoScroll: False,
			Random: False,
			DateAdded: 0001-01-01,
			Mode: 0,
			Orientation: 0,
			SchoolId: 0,
			Speed: 0,
			Title: String,
			ClientId: 0,
			Heading: String,
			Height: 0
		}
	],
	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-03T02:39:31.0070606-04:00,
	Device: Desktop
}