POST api/GetPromoCodeDetails

Returns the details of a promo code.

Request Information

URI Parameters

None.

Body Parameters

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

Request Formats

application/json, text/json

Sample:

{
  "SessionKey": "sample string 1",
  "PromoCode": 1,
  "PromoCodeString": "sample string 2"
}

application/xml, text/xml

Sample:

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

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 'GetPromoCodeDetailsRequest'.

Response Information

Resource Description

GetPromoCodeDetailsResult object

ApiSuccessOfGetPromoCodeDetailsResult

Name	Description	Type	Additional information
Success		boolean
Data		GetPromoCodeDetailsResult

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Data": {
    "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:58:42.515862+00:00",
    "SourceInactive": "sample string 15",
    "AppealInactive": "sample string 16"
  }
}

application/xml, text/xml

Sample:

<ApiSuccessOfGetPromoCodeDetailsResultopk7yXMH 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:58:42.515862+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>
  </Data>
</ApiSuccessOfGetPromoCodeDetailsResultopk7yXMH>