PUT api/passes/getpassdetails

Request Information

URI Parameters

None.

Body Parameters

PassDetailAPIRequest
NameDescriptionTypeAdditional information
PassId

integer

None.

CustomerId

integer

None.

UniqueId

globally unique identifier

None.

ContactId

integer

None.

LanguageId

integer

None.

PaymentCheckOutMappingId

integer

None.

PageNumber

integer

None.

PageSize

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "PassId": 1,
  "CustomerId": 2,
  "UniqueId": "88a63737-51a2-4470-8c7a-93bf6cf8b706",
  "ContactId": 4,
  "LanguageId": 5,
  "PaymentCheckOutMappingId": 6,
  "PageNumber": 7,
  "PageSize": 8
}

application/xml, text/xml

Sample:
<PassDetailAPIRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <ContactId>4</ContactId>
  <CustomerId>2</CustomerId>
  <LanguageId>5</LanguageId>
  <PageNumber>7</PageNumber>
  <PageSize>8</PageSize>
  <PassId>1</PassId>
  <PaymentCheckOutMappingId>6</PaymentCheckOutMappingId>
  <UniqueId>88a63737-51a2-4470-8c7a-93bf6cf8b706</UniqueId>
</PassDetailAPIRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APICommonWrapperOfPassDetailAPIResponse
NameDescriptionTypeAdditional information
Status

HttpStatusCode

None.

Message

string

None.

Data

PassDetailAPIResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": 100,
  "Message": "sample string 1",
  "Data": {
    "PassDetails": {
      "PassId": 1,
      "PassTypeId": 1,
      "PassTitle": "sample string 2",
      "PassDescription": "sample string 3",
      "PassRules": "sample string 4",
      "PassImage": "sample string 5",
      "PassType": "sample string 6",
      "PassEndDate": "2026-01-15T10:48:02.9838365+00:00",
      "PassExpiration": "sample string 7",
      "PassUseTimeLimit": "sample string 8",
      "PassPrice": 9.0,
      "PassOffers": [
        {
          "OfferId": 1,
          "OfferName": "sample string 2",
          "OfferDescription": "sample string 3",
          "PassId": 4,
          "OfferDisclaimer": "sample string 5",
          "OfferImage": "sample string 6",
          "LocationId": 7,
          "LocationTitle": "sample string 8",
          "Latitude": 9.0,
          "Longitude": 10.0,
          "IsRedeemed": true,
          "OfferRedeemedDate": "2026-01-15T10:48:02.9838365+00:00"
        },
        {
          "OfferId": 1,
          "OfferName": "sample string 2",
          "OfferDescription": "sample string 3",
          "PassId": 4,
          "OfferDisclaimer": "sample string 5",
          "OfferImage": "sample string 6",
          "LocationId": 7,
          "LocationTitle": "sample string 8",
          "Latitude": 9.0,
          "Longitude": 10.0,
          "IsRedeemed": true,
          "OfferRedeemedDate": "2026-01-15T10:48:02.9838365+00:00"
        }
      ],
      "ChallengePassRewardDetails": [
        {
          "Id": 1,
          "PassId": 2,
          "RewardName": "sample string 3",
          "Description": "sample string 4",
          "Type": "sample string 6",
          "PointRequire": 1,
          "SelectedSize": "sample string 8",
          "SuccessMessage": "sample string 9",
          "MainImage": "sample string 10",
          "RemainingPoints": 1,
          "IsRedeemed": true,
          "Images": [
            "sample string 1",
            "sample string 2"
          ],
          "SizeList": [
            {
              "Text": "sample string 1",
              "Value": 2
            },
            {
              "Text": "sample string 1",
              "Value": 2
            }
          ],
          "ColorList": [
            {
              "Text": "sample string 1",
              "Value": 2
            },
            {
              "Text": "sample string 1",
              "Value": 2
            }
          ],
          "RedeemedDate": "2026-01-15T10:48:02.9838365+00:00",
          "BadgeEarnedDate": "2026-01-15T10:48:02.9838365+00:00"
        },
        {
          "Id": 1,
          "PassId": 2,
          "RewardName": "sample string 3",
          "Description": "sample string 4",
          "Type": "sample string 6",
          "PointRequire": 1,
          "SelectedSize": "sample string 8",
          "SuccessMessage": "sample string 9",
          "MainImage": "sample string 10",
          "RemainingPoints": 1,
          "IsRedeemed": true,
          "Images": [
            "sample string 1",
            "sample string 2"
          ],
          "SizeList": [
            {
              "Text": "sample string 1",
              "Value": 2
            },
            {
              "Text": "sample string 1",
              "Value": 2
            }
          ],
          "ColorList": [
            {
              "Text": "sample string 1",
              "Value": 2
            },
            {
              "Text": "sample string 1",
              "Value": 2
            }
          ],
          "RedeemedDate": "2026-01-15T10:48:02.9838365+00:00",
          "BadgeEarnedDate": "2026-01-15T10:48:02.9838365+00:00"
        }
      ]
    }
  }
}

application/xml, text/xml

Sample:
<APICommonWrapperOfPassDetailAPIResponseZdSfSp5S xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <Data>
    <PassDetails>
      <ChallengePassRewardDetails>
        <ChallengePassRewardDetails>
          <BadgeEarnedDate>2026-01-15T10:48:02.9838365+00:00</BadgeEarnedDate>
          <ColorList>
            <SizeOptionReward>
              <Text>sample string 1</Text>
              <Value>2</Value>
            </SizeOptionReward>
            <SizeOptionReward>
              <Text>sample string 1</Text>
              <Value>2</Value>
            </SizeOptionReward>
          </ColorList>
          <Description>sample string 4</Description>
          <Id>1</Id>
          <Image>sample string 5</Image>
          <Images xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </Images>
          <IsRedeemed>true</IsRedeemed>
          <MainImage>sample string 10</MainImage>
          <PassId>2</PassId>
          <PointRequire>1</PointRequire>
          <RedeemedDate>2026-01-15T10:48:02.9838365+00:00</RedeemedDate>
          <RemainingPoints>1</RemainingPoints>
          <RewardName>sample string 3</RewardName>
          <SelectedSize>sample string 8</SelectedSize>
          <Size>sample string 7</Size>
          <SizeList>
            <SizeOptionReward>
              <Text>sample string 1</Text>
              <Value>2</Value>
            </SizeOptionReward>
            <SizeOptionReward>
              <Text>sample string 1</Text>
              <Value>2</Value>
            </SizeOptionReward>
          </SizeList>
          <SuccessMessage>sample string 9</SuccessMessage>
          <Type>sample string 6</Type>
        </ChallengePassRewardDetails>
        <ChallengePassRewardDetails>
          <BadgeEarnedDate>2026-01-15T10:48:02.9838365+00:00</BadgeEarnedDate>
          <ColorList>
            <SizeOptionReward>
              <Text>sample string 1</Text>
              <Value>2</Value>
            </SizeOptionReward>
            <SizeOptionReward>
              <Text>sample string 1</Text>
              <Value>2</Value>
            </SizeOptionReward>
          </ColorList>
          <Description>sample string 4</Description>
          <Id>1</Id>
          <Image>sample string 5</Image>
          <Images xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </Images>
          <IsRedeemed>true</IsRedeemed>
          <MainImage>sample string 10</MainImage>
          <PassId>2</PassId>
          <PointRequire>1</PointRequire>
          <RedeemedDate>2026-01-15T10:48:02.9838365+00:00</RedeemedDate>
          <RemainingPoints>1</RemainingPoints>
          <RewardName>sample string 3</RewardName>
          <SelectedSize>sample string 8</SelectedSize>
          <Size>sample string 7</Size>
          <SizeList>
            <SizeOptionReward>
              <Text>sample string 1</Text>
              <Value>2</Value>
            </SizeOptionReward>
            <SizeOptionReward>
              <Text>sample string 1</Text>
              <Value>2</Value>
            </SizeOptionReward>
          </SizeList>
          <SuccessMessage>sample string 9</SuccessMessage>
          <Type>sample string 6</Type>
        </ChallengePassRewardDetails>
      </ChallengePassRewardDetails>
      <PassDescription>sample string 3</PassDescription>
      <PassEndDate>2026-01-15T10:48:02.9838365+00:00</PassEndDate>
      <PassExpiration>sample string 7</PassExpiration>
      <PassId>1</PassId>
      <PassImage>sample string 5</PassImage>
      <PassOffers>
        <PassOffers>
          <IsRedeemed>true</IsRedeemed>
          <Latitude>9</Latitude>
          <LocationId>7</LocationId>
          <LocationTitle>sample string 8</LocationTitle>
          <Longitude>10</Longitude>
          <OfferDescription>sample string 3</OfferDescription>
          <OfferDisclaimer>sample string 5</OfferDisclaimer>
          <OfferId>1</OfferId>
          <OfferImage>sample string 6</OfferImage>
          <OfferName>sample string 2</OfferName>
          <OfferRedeemedDate>2026-01-15T10:48:02.9838365+00:00</OfferRedeemedDate>
          <PassId>4</PassId>
        </PassOffers>
        <PassOffers>
          <IsRedeemed>true</IsRedeemed>
          <Latitude>9</Latitude>
          <LocationId>7</LocationId>
          <LocationTitle>sample string 8</LocationTitle>
          <Longitude>10</Longitude>
          <OfferDescription>sample string 3</OfferDescription>
          <OfferDisclaimer>sample string 5</OfferDisclaimer>
          <OfferId>1</OfferId>
          <OfferImage>sample string 6</OfferImage>
          <OfferName>sample string 2</OfferName>
          <OfferRedeemedDate>2026-01-15T10:48:02.9838365+00:00</OfferRedeemedDate>
          <PassId>4</PassId>
        </PassOffers>
      </PassOffers>
      <PassPrice>9</PassPrice>
      <PassRules>sample string 4</PassRules>
      <PassTitle>sample string 2</PassTitle>
      <PassType>sample string 6</PassType>
      <PassTypeId>1</PassTypeId>
      <PassUseTimeLimit>sample string 8</PassUseTimeLimit>
    </PassDetails>
  </Data>
  <Message>sample string 1</Message>
  <Status>Continue</Status>
</APICommonWrapperOfPassDetailAPIResponseZdSfSp5S>