POST api/GetPromoCodePerformanceAssociation

Returns the details of a promo code associated with a performance.

Request Information

URI Parameters

None.

Body Parameters

GetPromoCodePerformanceAssociationRequest

Name	Description	Type	Additional information
PerformanceId		integer	Required
SessionKey	Authenticated session key	string	Required
PromoCode	The promotion code to look up	string	Required

Request Formats

application/json, text/json

Sample:

{
  "PerformanceId": 1,
  "SessionKey": "sample string 2",
  "PromoCode": "sample string 3"
}

application/xml, text/xml

Sample:

<GetPromoCodePerformanceAssociationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Promotion">
  <PromoCode>sample string 3</PromoCode>
  <SessionKey>sample string 2</SessionKey>
  <PerformanceId>1</PerformanceId>
</GetPromoCodePerformanceAssociationRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GetPromoCodePerformanceAssociationRequest'.

Response Information

Resource Description

GetPromoCodeResult object

ApiSuccessOfGetPromoCodeResult

Name	Description	Type	Additional information
Success		boolean
Data		GetPromoCodeResult

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Data": {
    "ModeOfSaleOffers": [
      {
        "ID": 1,
        "MaxSeats": 2,
        "OverrideDefaultPriceTypeIndicator": true,
        "Rank": 4,
        "AppealId": 5,
        "ModeOfSaleId": 6,
        "PerformanceId": 7,
        "PackageId": 8,
        "PriceTypeId": 9,
        "StartDateTime": "2024-09-19T19:46:19.3458824+00:00",
        "EndDateTime": "2024-09-19T19:46:19.3458824+00:00"
      },
      {
        "ID": 1,
        "MaxSeats": 2,
        "OverrideDefaultPriceTypeIndicator": true,
        "Rank": 4,
        "AppealId": 5,
        "ModeOfSaleId": 6,
        "PerformanceId": 7,
        "PackageId": 8,
        "PriceTypeId": 9,
        "StartDateTime": "2024-09-19T19:46:19.3458824+00:00",
        "EndDateTime": "2024-09-19T19:46:19.3458824+00:00"
      }
    ],
    "SourceNumber": 1,
    "PromoCode": "sample string 2",
    "ModeOfSale": 3,
    "OverrideRankInd": "sample string 4",
    "SourceName": "sample string 5",
    "AppealNumber": 6,
    "AppealDescription": "sample string 7",
    "Text1": "sample string 8",
    "Text2": "sample string 9",
    "Text3": "sample string 10",
    "Text4": "sample string 11",
    "Text5": "sample string 12",
    "Text6": "sample string 13",
    "PromoteDate": "2024-09-19T19:46:19.3458824+00:00",
    "SourceInactive": "sample string 15",
    "AppealInactive": "sample string 16"
  }
}

application/xml, text/xml

Sample:

<ApiSuccessOfGetPromoCodeResultopk7yXMH xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Promotion">
    <d2p1:AppealDescription>sample string 7</d2p1:AppealDescription>
    <d2p1:AppealInactive>sample string 16</d2p1:AppealInactive>
    <d2p1:AppealNumber>6</d2p1:AppealNumber>
    <d2p1:ModeOfSale>3</d2p1:ModeOfSale>
    <d2p1:OverrideRankInd>sample string 4</d2p1:OverrideRankInd>
    <d2p1:PromoCode>sample string 2</d2p1:PromoCode>
    <d2p1:PromoteDate>2024-09-19T19:46:19.3458824+00:00</d2p1:PromoteDate>
    <d2p1:SourceInactive>sample string 15</d2p1:SourceInactive>
    <d2p1:SourceName>sample string 5</d2p1:SourceName>
    <d2p1:SourceNumber>1</d2p1:SourceNumber>
    <d2p1:Text1>sample string 8</d2p1:Text1>
    <d2p1:Text2>sample string 9</d2p1:Text2>
    <d2p1:Text3>sample string 10</d2p1:Text3>
    <d2p1:Text4>sample string 11</d2p1:Text4>
    <d2p1:Text5>sample string 12</d2p1:Text5>
    <d2p1:Text6>sample string 13</d2p1:Text6>
    <d2p1:ModeOfSaleOffers>
      <d2p1:ModeOfSaleOffer>
        <d2p1:AppealId>5</d2p1:AppealId>
        <d2p1:EndDateTime>2024-09-19T19:46:19.3458824+00:00</d2p1:EndDateTime>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:MaxSeats>2</d2p1:MaxSeats>
        <d2p1:ModeOfSaleId>6</d2p1:ModeOfSaleId>
        <d2p1:OverrideDefaultPriceTypeIndicator>true</d2p1:OverrideDefaultPriceTypeIndicator>
        <d2p1:PackageId>8</d2p1:PackageId>
        <d2p1:PerformanceId>7</d2p1:PerformanceId>
        <d2p1:PriceTypeId>9</d2p1:PriceTypeId>
        <d2p1:Rank>4</d2p1:Rank>
        <d2p1:StartDateTime>2024-09-19T19:46:19.3458824+00:00</d2p1:StartDateTime>
      </d2p1:ModeOfSaleOffer>
      <d2p1:ModeOfSaleOffer>
        <d2p1:AppealId>5</d2p1:AppealId>
        <d2p1:EndDateTime>2024-09-19T19:46:19.3458824+00:00</d2p1:EndDateTime>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:MaxSeats>2</d2p1:MaxSeats>
        <d2p1:ModeOfSaleId>6</d2p1:ModeOfSaleId>
        <d2p1:OverrideDefaultPriceTypeIndicator>true</d2p1:OverrideDefaultPriceTypeIndicator>
        <d2p1:PackageId>8</d2p1:PackageId>
        <d2p1:PerformanceId>7</d2p1:PerformanceId>
        <d2p1:PriceTypeId>9</d2p1:PriceTypeId>
        <d2p1:Rank>4</d2p1:Rank>
        <d2p1:StartDateTime>2024-09-19T19:46:19.3458824+00:00</d2p1:StartDateTime>
      </d2p1:ModeOfSaleOffer>
    </d2p1:ModeOfSaleOffers>
  </Data>
</ApiSuccessOfGetPromoCodeResultopk7yXMH>