YM REST Services

SponsorRotators

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

The following routes are available for this service:
GET	/Ams/{ClientID}/SponsorRotators	Return a list of sponsor rotators.

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

**SponsorRotatorsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
SponsorRotators	form	List<SponsorRotator>	No

**SponsorRotator** Parameters:
Name	Parameter	Data Type	Required
RotatorId	form	int	No
AutoScroll	form	bool	No
Random	form	bool	No
DateAdded	form	DateTime	No
Mode	form	int	No
Orientation	form	RotatorOrientation	No
SchoolId	form	int	No
Speed	form	int	No
Title	form	string	No
ClientId	form	int	No
Heading	form	string	No
Height	form	int	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SponsorRotatorsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID>
  <SponsorRotators xmlns:d2p1="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.Rotators">
    <d2p1:SponsorRotator>
      <d2p1:_clientId>0</d2p1:_clientId>
      <d2p1:_scriptTemplate_Carousel>
			&lt;script type="text/javascript"&gt;
				var intRotatorWidth_$id = 0;

				$(document).ready(function(){
					$('#bxslider_$id').bxSlider({
						mode: 'horizontal',
						useCSS: false,
						responsive: false,
						easing: 'swing',
						infiniteLoop: true,
						pager: false,
						slideMargin: 15,
						minSlides: 1,
						maxSlides: 100,
						controls: true,
						moveSlides: 1,
						onSliderLoad: function(){
							$("div.sponsorrotator_$id ul.bxslider li.slide img").each(function (intIndex) {
								intRotatorWidth_$id += $(this).width() + 30;
							}).promise().done(function () {
								$("div.sponsorrotator_$id ul.bxslider").css("width", (intRotatorWidth_$id * 3) + 15 + "px").css("margin", "0");
								$("div.sponsorrotator_$id div.bx-viewport").css("height", $height + "px");
								$("div.sponsorrotator_$id ul.bxslider li.slide").css("width", "auto");
								$("div.sponsorrotator_$id ul.bxslider").css("left", ($("div.sponsorrotator_$id ul.bxslider li.slide").not("li.bx-clone").first().position().left * -1) + "px");
								$("div.sponsorrotator_$id div.bx-wrapper").css("margin", "0");
							
								$('div.sponsorrotator_$id').css('visibility', 'visible')
							});
						}
					});
				});
			&lt;/script&gt;</d2p1:_scriptTemplate_Carousel>
      <d2p1:_scriptTemplate_Header_Horizontal>
			&lt;script type="text/javascript" src="/global_inc/widgets/SponsorRotator/js/jquery.bxslider.js"&gt;&lt;/script&gt;
			&lt;link rel="stylesheet" type="text/css" href="/global_inc/widgets/SponsorRotator/css/jquery.bxslider.css"&gt;
			&lt;style type="text/css"&gt;
				div.sponsorrotator_$id .bx-wrapper {
					margin: 0;
					overflow: hidden;
				}
				div.sponsorrotator_$id .bx-wrapper .bx-viewport {
					background: none;
					border: none;
					box-shadow: none;
					left: 0px;
					max-height: $heightpx;
					min-height: $heightpx;
				}
				div.sponsorrotator_$id ul.bxslider {
					padding-left: 0px;
				}
				div.sponsorrotator_$id ul.bxslider li.slide img {
					max-width: 100%; 
					max-height: $heightpx;
					min-height: $heightpx;
				}
			&lt;/style&gt;</d2p1:_scriptTemplate_Header_Horizontal>
      <d2p1:_scriptTemplate_Header_Single>
			&lt;script type="text/javascript" src="/global_inc/widgets/SponsorRotator/js/jquery.bxslider.js"&gt;&lt;/script&gt;
			&lt;link rel="stylesheet" type="text/css" href="/global_inc/widgets/SponsorRotator/css/jquery.bxslider.css"&gt;
			&lt;style type="text/css"&gt;
				div.sponsorrotator_$id .bx-wrapper {
					overflow: hidden;
				}
				div.sponsorrotator_$id .bx-wrapper img {
					margin: auto;
				}
				div.sponsorrotator_$id .bx-wrapper .bx-viewport {
					background: none;
					border: none;
					box-shadow: none;
					left: 0px;
					max-height: $heightpx;
					min-height: $heightpx;
				}
				div.sponsorrotator_$id ul.bxslider {
					padding-left: 0px;
					margin: 0;
				}
			&lt;/style&gt;</d2p1:_scriptTemplate_Header_Single>
      <d2p1:_scriptTemplate_Heading>&lt;h3&gt;@heading&lt;/h3&gt;</d2p1:_scriptTemplate_Heading>
      <d2p1:_scriptTemplate_Image>&lt;li class="slide"&gt;&lt;img src="{0}"&gt;&lt;/li&gt;</d2p1:_scriptTemplate_Image>
      <d2p1:_scriptTemplate_ImageWithLink>&lt;li class="slide"&gt;&lt;a href="{0}" {1}&gt;&lt;img src="{2}"&gt;&lt;/a&gt;&lt;/li&gt;</d2p1:_scriptTemplate_ImageWithLink>
      <d2p1:_scriptTemplate_Images>
			&lt;div class="sponsorrotator_$id" style="visibility: hidden;"&gt;
				&lt;ul id="bxslider_$id" class="bxslider"&gt;
					@@SliderImages
				&lt;/ul&gt;
			&lt;/div&gt;</d2p1:_scriptTemplate_Images>
      <d2p1:_scriptTemplate_Single>
			&lt;script type="text/javascript"&gt;
				$(document).ready(function(){
					$('#bxslider_$id').bxSlider({
						mode: 'fade',
						useCSS: false,
						responsive: true,
						easing: 'swing',
						infiniteLoop: true,
						pager: false,
						slideMargin: 0,
						minSlides: 1,
						maxSlides: 1,
						moveSlides: 1,
						controls: true,
						adaptiveHeight: true,
						onSliderLoad: function(){
							$('div.sponsorrotator_$id').css('visibility', 'visible')									
						}
					});
				});
			&lt;/script&gt;</d2p1:_scriptTemplate_Single>
      <d2p1:_scriptTemplate_SingleAuto>
			&lt;script type="text/javascript"&gt;
				$(document).ready(function(){
					$('#bxslider_$id').bxSlider({
						mode: 'fade',
						useCSS: false,
						responsive: true,
						easing: 'swing',
						infiniteLoop: true,
						pager: false,
						slideMargin: 0,
						minSlides: 1,
						maxSlides: 1,
						moveSlides: 1,
						auto: true,
						pause: $speed,
						autoHover: true,
						controls: false,
						adaptiveHeight: true,
						onSliderLoad: function(){
							$('div.sponsorrotator_$id').css('visibility', 'visible')
						}
					});
				});
			&lt;/script&gt;</d2p1:_scriptTemplate_SingleAuto>
      <d2p1:_scriptTemplate_Ticker>
			&lt;script type="text/javascript"&gt;
				var intRotatorWidth_$id = 0;

				$(document).ready(function(){
					$('#bxslider_$id').bxSlider({
						mode: 'horizontal',
						ticker: true,
						tickerHover: true,
						useCSS: false,
						responsive: false,
						slideMargin: 15,
						minSlides: 1,
						maxSlides: 100,
						speed: $speed,
						onSliderLoad: function(){
							$("div.sponsorrotator_$id ul.bxslider li.slide img").each(function (intIndex) {
								intRotatorWidth_$id += $(this).width() + 30;
							}).promise().done(function () {
								$("div.sponsorrotator_$id ul.bxslider").css("width", (intRotatorWidth_$id * 2) + 15 + "px").css("margin", "0");
								$("div.sponsorrotator_$id div.bx-viewport").css("height", $height + "px");
								$("div.sponsorrotator_$id ul.bxslider li.slide").css("width", "auto");
								$("div.sponsorrotator_$id div.bx-wrapper").css("margin", "0");
								
								$('div.sponsorrotator_$id').css('visibility', 'visible')
							});
						}
					});
				});
			&lt;/script&gt;</d2p1:_scriptTemplate_Ticker>
      <d2p1:_x003C_AutoScroll_x003E_k__BackingField>false</d2p1:_x003C_AutoScroll_x003E_k__BackingField>
      <d2p1:_x003C_DateAdded_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_DateAdded_x003E_k__BackingField>
      <d2p1:_x003C_Heading_x003E_k__BackingField>String</d2p1:_x003C_Heading_x003E_k__BackingField>
      <d2p1:_x003C_Height_x003E_k__BackingField>0</d2p1:_x003C_Height_x003E_k__BackingField>
      <d2p1:_x003C_Mode_x003E_k__BackingField>0</d2p1:_x003C_Mode_x003E_k__BackingField>
      <d2p1:_x003C_Random_x003E_k__BackingField>false</d2p1:_x003C_Random_x003E_k__BackingField>
      <d2p1:_x003C_RotatorId_x003E_k__BackingField>0</d2p1:_x003C_RotatorId_x003E_k__BackingField>
      <d2p1:_x003C_SchoolId_x003E_k__BackingField>0</d2p1:_x003C_SchoolId_x003E_k__BackingField>
      <d2p1:_x003C_Speed_x003E_k__BackingField>0</d2p1:_x003C_Speed_x003E_k__BackingField>
      <d2p1:_x003C_Title_x003E_k__BackingField>String</d2p1:_x003C_Title_x003E_k__BackingField>
    </d2p1:SponsorRotator>
  </SponsorRotators>
</SponsorRotatorsResponse>