GET v1/facilities/{fId}/promotions?utId={utId}

Gets the facility promos.

Request Information

URI Parameters

Name	Description	Type	Additional information
fId	The facility identifier.	globally unique identifier	Required
utId	The unit type identifier.	globally unique identifier	None.

Body Parameters

None.

Response Information

Resource Description

FacilityPromotions

Name	Type	Additional information
FacilityPromos	Collection of Promotions	None.
Errors	Collection of Exception	None.
IsSuccess	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "FacilityPromos": [
    {
      "PromotionName": "sample string 1",
      "PromotionId": "8ff6262c-e46b-4fbf-8fa2-68de3da1d2a9",
      "ControlledByQtyAvailAbove": 3,
      "ControlledByOccPctgBelow": 4,
      "BothPercentageandQtyMustBeMet": 5,
      "AvailabeWhenTotalSpacesExceed": 6,
      "CouponCode": "sample string 7",
      "UseAtCounter": true,
      "UseAtWeb": true,
      "UseAtKiosk": true,
      "UseAtCallCenter": true,
      "UseAsSocialPromo": true,
      "Code": "sample string 13",
      "QuantityAtFacility": 14,
      "QuantityAvailableToRent": 15,
      "UnitTypePromotionAvailable": true,
      "AvailableForUnitTypes": [
        {
          "Id": "931a8454-6e3b-4d28-b59a-ee5151077f16",
          "Description": "sample string 2",
          "TotalUnits": 3,
          "AvailableUnits": 4,
          "UseBasedOnSettings": true
        },
        {
          "Id": "931a8454-6e3b-4d28-b59a-ee5151077f16",
          "Description": "sample string 2",
          "TotalUnits": 3,
          "AvailableUnits": 4,
          "UseBasedOnSettings": true
        }
      ]
    },
    {
      "PromotionName": "sample string 1",
      "PromotionId": "8ff6262c-e46b-4fbf-8fa2-68de3da1d2a9",
      "ControlledByQtyAvailAbove": 3,
      "ControlledByOccPctgBelow": 4,
      "BothPercentageandQtyMustBeMet": 5,
      "AvailabeWhenTotalSpacesExceed": 6,
      "CouponCode": "sample string 7",
      "UseAtCounter": true,
      "UseAtWeb": true,
      "UseAtKiosk": true,
      "UseAtCallCenter": true,
      "UseAsSocialPromo": true,
      "Code": "sample string 13",
      "QuantityAtFacility": 14,
      "QuantityAvailableToRent": 15,
      "UnitTypePromotionAvailable": true,
      "AvailableForUnitTypes": [
        {
          "Id": "931a8454-6e3b-4d28-b59a-ee5151077f16",
          "Description": "sample string 2",
          "TotalUnits": 3,
          "AvailableUnits": 4,
          "UseBasedOnSettings": true
        },
        {
          "Id": "931a8454-6e3b-4d28-b59a-ee5151077f16",
          "Description": "sample string 2",
          "TotalUnits": 3,
          "AvailableUnits": 4,
          "UseBasedOnSettings": true
        }
      ]
    }
  ],
  "Errors": [
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    },
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    }
  ],
  "IsSuccess": true
}

application/xml, text/xml

Sample:

<FacilityPromotions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
  </Errors>
  <IsSuccess>true</IsSuccess>
  <FacilityPromos>
    <Promotions>
      <AvailabeWhenTotalSpacesExceed>6</AvailabeWhenTotalSpacesExceed>
      <AvailableForUnitTypes>
        <PromotionAvailableForUnitType>
          <AvailableUnits>4</AvailableUnits>
          <Description>sample string 2</Description>
          <Id>931a8454-6e3b-4d28-b59a-ee5151077f16</Id>
          <TotalUnits>3</TotalUnits>
          <UseBasedOnSettings>true</UseBasedOnSettings>
        </PromotionAvailableForUnitType>
        <PromotionAvailableForUnitType>
          <AvailableUnits>4</AvailableUnits>
          <Description>sample string 2</Description>
          <Id>931a8454-6e3b-4d28-b59a-ee5151077f16</Id>
          <TotalUnits>3</TotalUnits>
          <UseBasedOnSettings>true</UseBasedOnSettings>
        </PromotionAvailableForUnitType>
      </AvailableForUnitTypes>
      <BothPercentageandQtyMustBeMet>5</BothPercentageandQtyMustBeMet>
      <Code>sample string 13</Code>
      <ControlledByOccPctgBelow>4</ControlledByOccPctgBelow>
      <ControlledByQtyAvailAbove>3</ControlledByQtyAvailAbove>
      <CouponCode>sample string 7</CouponCode>
      <PromotionId>8ff6262c-e46b-4fbf-8fa2-68de3da1d2a9</PromotionId>
      <PromotionName>sample string 1</PromotionName>
      <QuantityAtFacility>14</QuantityAtFacility>
      <QuantityAvailableToRent>15</QuantityAvailableToRent>
      <UnitTypePromotionAvailable>true</UnitTypePromotionAvailable>
      <UseAsSocialPromo>true</UseAsSocialPromo>
      <UseAtCallCenter>true</UseAtCallCenter>
      <UseAtCounter>true</UseAtCounter>
      <UseAtKiosk>true</UseAtKiosk>
      <UseAtWeb>true</UseAtWeb>
    </Promotions>
    <Promotions>
      <AvailabeWhenTotalSpacesExceed>6</AvailabeWhenTotalSpacesExceed>
      <AvailableForUnitTypes>
        <PromotionAvailableForUnitType>
          <AvailableUnits>4</AvailableUnits>
          <Description>sample string 2</Description>
          <Id>931a8454-6e3b-4d28-b59a-ee5151077f16</Id>
          <TotalUnits>3</TotalUnits>
          <UseBasedOnSettings>true</UseBasedOnSettings>
        </PromotionAvailableForUnitType>
        <PromotionAvailableForUnitType>
          <AvailableUnits>4</AvailableUnits>
          <Description>sample string 2</Description>
          <Id>931a8454-6e3b-4d28-b59a-ee5151077f16</Id>
          <TotalUnits>3</TotalUnits>
          <UseBasedOnSettings>true</UseBasedOnSettings>
        </PromotionAvailableForUnitType>
      </AvailableForUnitTypes>
      <BothPercentageandQtyMustBeMet>5</BothPercentageandQtyMustBeMet>
      <Code>sample string 13</Code>
      <ControlledByOccPctgBelow>4</ControlledByOccPctgBelow>
      <ControlledByQtyAvailAbove>3</ControlledByQtyAvailAbove>
      <CouponCode>sample string 7</CouponCode>
      <PromotionId>8ff6262c-e46b-4fbf-8fa2-68de3da1d2a9</PromotionId>
      <PromotionName>sample string 1</PromotionName>
      <QuantityAtFacility>14</QuantityAtFacility>
      <QuantityAvailableToRent>15</QuantityAvailableToRent>
      <UnitTypePromotionAvailable>true</UnitTypePromotionAvailable>
      <UseAsSocialPromo>true</UseAsSocialPromo>
      <UseAtCallCenter>true</UseAtCallCenter>
      <UseAtCounter>true</UseAtCounter>
      <UseAtKiosk>true</UseAtKiosk>
      <UseAtWeb>true</UseAtWeb>
    </Promotions>
  </FacilityPromos>
</FacilityPromotions>