PUT api/Content/v3/PassportRequest

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerId	integer	None.
UniqueId	globally unique identifier	None.
UserType	string	None.
UserUniqueId	integer	None.
QRCode	string	None.
UserName	string	None.
LoyaltyEventId	integer	None.
LoyaltyEventType	integer	None.
TransactionId	string	None.
Quantity	decimal number	None.
RefEmail	string	None.
Pin	string	None.
Latitude	decimal number	None.
Longitude	decimal number	None.
LocationId	integer	None.
IsManualRequest	boolean	None.
ImageType	integer	None.
Photo	string	None.
IgnoreStampFrequency	boolean	None.
LocationStatus	boolean	None.
IsMultiPassportApp	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "UniqueId": "eccbe3f5-3bd0-4491-9724-507e8db92932",
  "UserType": "sample string 3",
  "UserUniqueId": 4,
  "QRCode": "sample string 5",
  "UserName": "sample string 6",
  "LoyaltyEventId": 7,
  "LoyaltyEventType": 8,
  "TransactionId": "sample string 9",
  "Quantity": 10.0,
  "RefEmail": "sample string 11",
  "Pin": "sample string 12",
  "Latitude": 13.0,
  "Longitude": 14.0,
  "LocationId": 15,
  "IsManualRequest": true,
  "ImageType": 17,
  "Photo": "sample string 18",
  "IgnoreStampFrequency": true,
  "LocationStatus": true,
  "IsMultiPassportApp": true
}

application/xml, text/xml

Sample:

<APILoyaltyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <CustomerId>1</CustomerId>
  <IgnoreStampFrequency>true</IgnoreStampFrequency>
  <ImageType>17</ImageType>
  <IsManualRequest>true</IsManualRequest>
  <IsMultiPassportApp>true</IsMultiPassportApp>
  <Latitude>13</Latitude>
  <LocationId>15</LocationId>
  <LocationStatus>true</LocationStatus>
  <Longitude>14</Longitude>
  <LoyaltyEventId>7</LoyaltyEventId>
  <LoyaltyEventType>8</LoyaltyEventType>
  <Photo>sample string 18</Photo>
  <Pin>sample string 12</Pin>
  <QRCode>sample string 5</QRCode>
  <Quantity>10</Quantity>
  <RefEmail>sample string 11</RefEmail>
  <TransactionId>sample string 9</TransactionId>
  <UniqueId>eccbe3f5-3bd0-4491-9724-507e8db92932</UniqueId>
  <UserName>sample string 6</UserName>
  <UserType>sample string 3</UserType>
  <UserUniqueId>4</UserUniqueId>
</APILoyaltyRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APILoyaltyResponse

Name	Type	Additional information
Status	boolean	None.
Message	string	None.
List	Collection of APILoyaltyEvent	None.
BadgeRewarded	boolean	None.
BadgeMessage	string	None.
BadgeImage	string	None.
QRCode	string	None.
PassLoyaltyEventId	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": true,
  "Message": "sample string 2",
  "List": [
    {
      "Id": 1,
      "CustomerId": 2,
      "Title": "sample string 3",
      "Points": 4,
      "Description": "sample string 5",
      "Attended": true,
      "CreatedDate": 1,
      "RedeemedOn": 1,
      "Thumb": "sample string 7",
      "EventType": "sample string 8",
      "EntityType": 9,
      "Mode": "sample string 10",
      "EntityId": 1,
      "Location": {
        "Id": 1,
        "Title": "sample string 1",
        "Address": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "Country": "sample string 5",
        "Latitude": 6.0,
        "Longitude": 7.0,
        "ZipCode": "sample string 8",
        "Thumb": "sample string 9",
        "CreatedDate": 10,
        "IsAlreadyInWishList": true,
        "IsAlreadyInFav": true
      },
      "Event": {
        "Id": 1,
        "Title": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "EventDate": 5,
        "_EventDate": "2025-08-28T22:17:02.349698+00:00",
        "EventTime": "sample string 6",
        "Images": "sample string 7"
      },
      "IsPassportStampRequested": true,
      "TotalPoints": 1,
      "IsStamped": true,
      "Title_Computed": "sample string 13",
      "ProgramName": "sample string 14"
    },
    {
      "Id": 1,
      "CustomerId": 2,
      "Title": "sample string 3",
      "Points": 4,
      "Description": "sample string 5",
      "Attended": true,
      "CreatedDate": 1,
      "RedeemedOn": 1,
      "Thumb": "sample string 7",
      "EventType": "sample string 8",
      "EntityType": 9,
      "Mode": "sample string 10",
      "EntityId": 1,
      "Location": {
        "Id": 1,
        "Title": "sample string 1",
        "Address": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "Country": "sample string 5",
        "Latitude": 6.0,
        "Longitude": 7.0,
        "ZipCode": "sample string 8",
        "Thumb": "sample string 9",
        "CreatedDate": 10,
        "IsAlreadyInWishList": true,
        "IsAlreadyInFav": true
      },
      "Event": {
        "Id": 1,
        "Title": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "EventDate": 5,
        "_EventDate": "2025-08-28T22:17:02.349698+00:00",
        "EventTime": "sample string 6",
        "Images": "sample string 7"
      },
      "IsPassportStampRequested": true,
      "TotalPoints": 1,
      "IsStamped": true,
      "Title_Computed": "sample string 13",
      "ProgramName": "sample string 14"
    }
  ],
  "BadgeRewarded": true,
  "BadgeMessage": "sample string 4",
  "BadgeImage": "sample string 5",
  "QRCode": "sample string 6",
  "PassLoyaltyEventId": true
}

application/xml, text/xml

Sample:

<APILoyaltyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <BadgeImage>sample string 5</BadgeImage>
  <BadgeMessage>sample string 4</BadgeMessage>
  <BadgeRewarded>true</BadgeRewarded>
  <List>
    <APILoyaltyEvent>
      <Attended>true</Attended>
      <CreatedDate>1</CreatedDate>
      <CustomerId>2</CustomerId>
      <Description>sample string 5</Description>
      <EntityId>1</EntityId>
      <EntityType>9</EntityType>
      <Event>
        <City>sample string 3</City>
        <EventDate>5</EventDate>
        <EventTime>sample string 6</EventTime>
        <Id>1</Id>
        <Images>sample string 7</Images>
        <State>sample string 4</State>
        <Title>sample string 2</Title>
        <_EventDate>2025-08-28T22:17:02.349698+00:00</_EventDate>
      </Event>
      <EventType>sample string 8</EventType>
      <Id>1</Id>
      <IsPassportStampRequested>true</IsPassportStampRequested>
      <IsStamped>true</IsStamped>
      <Location>
        <Address>sample string 2</Address>
        <City>sample string 3</City>
        <Country>sample string 5</Country>
        <CreatedDate>10</CreatedDate>
        <Id>1</Id>
        <IsAlreadyInFav>true</IsAlreadyInFav>
        <IsAlreadyInWishList>true</IsAlreadyInWishList>
        <Latitude>6</Latitude>
        <Longitude>7</Longitude>
        <State>sample string 4</State>
        <Thumb>sample string 9</Thumb>
        <Title>sample string 1</Title>
        <ZipCode>sample string 8</ZipCode>
      </Location>
      <Mode>sample string 10</Mode>
      <Points>4</Points>
      <ProgramName>sample string 14</ProgramName>
      <RedeemedOn>1</RedeemedOn>
      <Thumb>sample string 7</Thumb>
      <Title>sample string 3</Title>
      <Title_Computed>sample string 13</Title_Computed>
      <TotalPoints>1</TotalPoints>
    </APILoyaltyEvent>
    <APILoyaltyEvent>
      <Attended>true</Attended>
      <CreatedDate>1</CreatedDate>
      <CustomerId>2</CustomerId>
      <Description>sample string 5</Description>
      <EntityId>1</EntityId>
      <EntityType>9</EntityType>
      <Event>
        <City>sample string 3</City>
        <EventDate>5</EventDate>
        <EventTime>sample string 6</EventTime>
        <Id>1</Id>
        <Images>sample string 7</Images>
        <State>sample string 4</State>
        <Title>sample string 2</Title>
        <_EventDate>2025-08-28T22:17:02.349698+00:00</_EventDate>
      </Event>
      <EventType>sample string 8</EventType>
      <Id>1</Id>
      <IsPassportStampRequested>true</IsPassportStampRequested>
      <IsStamped>true</IsStamped>
      <Location>
        <Address>sample string 2</Address>
        <City>sample string 3</City>
        <Country>sample string 5</Country>
        <CreatedDate>10</CreatedDate>
        <Id>1</Id>
        <IsAlreadyInFav>true</IsAlreadyInFav>
        <IsAlreadyInWishList>true</IsAlreadyInWishList>
        <Latitude>6</Latitude>
        <Longitude>7</Longitude>
        <State>sample string 4</State>
        <Thumb>sample string 9</Thumb>
        <Title>sample string 1</Title>
        <ZipCode>sample string 8</ZipCode>
      </Location>
      <Mode>sample string 10</Mode>
      <Points>4</Points>
      <ProgramName>sample string 14</ProgramName>
      <RedeemedOn>1</RedeemedOn>
      <Thumb>sample string 7</Thumb>
      <Title>sample string 3</Title>
      <Title_Computed>sample string 13</Title_Computed>
      <TotalPoints>1</TotalPoints>
    </APILoyaltyEvent>
  </List>
  <Message>sample string 2</Message>
  <PassLoyaltyEventId>true</PassLoyaltyEventId>
  <QRCode>sample string 6</QRCode>
  <Status>true</Status>
</APILoyaltyResponse>