Playt Restaurant Query Message Category

SecurityService_ConnectToStore

This will initiate a "connection" to a specific restaurant.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
            apiName="SecurityService_ConnectToStore" apiCategory="playt" locale="en-US" requestTimestamp="xxx" >

  <parameters>
    <storeIdentifier value="12345"/>
    <loginEmailId value="jane@example.com"/>
    <deviceIdentifier value="A23BC9080H"/>
  </parameters>
    
</request>

Element	Attribute	Data Type	Optional	Notes
storeIdentifier			no
	value	String	no	Identifier of the restaurant to connect to
loginEmailId			no
	value	String	no	Identifier of the user making the request

Response Message

<response apiVersion="1.00" clientId="its_me" apiName="SecurityService_ConnectToStore"
          apiCategory="playt" requestTimestamp="xxx" responseTimestamp="xxx">

    <error code="0"
           localizedDescription="some French words" 
           defaultDescription="something you understand"/>

    <data>
    <store>
        <generalInfo identifier="12345" name="Subway" address="123 street, unit 101" 
postalCode="M1A 4V2" phoneNumber="123-456-7890" 
logoUrl="http://www.google.ca/images/nav_logo83.png"
storeHours="All day and all night, baby" location_latitude="3.4444" location_longitude="123.4444443332" 
profile="This is the Awesome restaurant!!!  Please come!" />

        <extendedInfo>
            <storeCapabilities allowsDineInOrders="yes" allowsTakeOutOrders="yes" allowsDeliveryOrders="yes" />
            <storeDeals>
                <deal identifier="12345" name="deal1" description="deal one" isFirstTimeDeal="yes" />
                <deal identifier="22345" name="deal2" description="deal two" isFirstTimeDeal="no" />
                ...
            </storeDeals>
        </extendedInfo>

    </store>
    </data>

</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	Code 0 if meal code is valid Code 3002 if meal code is not valid
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.

SecuirtyService_ConnectToStoreUsingMealCode

This will initiate a "connection" to a specific restaurant.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
            apiName="SecurityService_ConnectToStoreUsingMealCode" apiCategory="playt" locale="en-US" requestTimestamp="xxx" >

  <parameters>
    <mealCode value="12345567890123"/>
    <loginEmailId value="jane@example.com"/>
    <deviceIdentifier value="A23BC9080H"/>
  </parameters>
    
</request>

Element	Attribute	Data Type	Optional	Notes
storeIdentifier			no
	value	String	no	Identifier of the restaurant to connect to
loginEmailId			no
	value	String	no	Identifier of the user making the request

Response Message

<response apiVersion="1.00" clientId="its_me" apiName="SecurityService_ConnectToStoreUsingMealCode"
          apiCategory="playt" requestTimestamp="xxx" responseTimestamp="xxx">

    <error code="0"
           localizedDescription="some French words" 
           defaultDescription="something you understand"/>

    <data>
    <store>
        <generalInfo identifier="12345" name="Subway" address="123 street, unit 101" 
postalCode="M1A 4V2" phoneNumber="123-456-7890" 
logoUrl="http://www.google.ca/images/nav_logo83.png"
storeHours="All day and all night, baby" location_latitude="3.4444" location_longitude="123.4444443332" 
profile="This is the Awesome restaurant!!!  Please come!" />
        
        <sessionInfo storeIdentifier="12345" transactionIdentifier="123456" />

        <extendedInfo>
            <storeCapabilities allowsDineInOrders="yes" allowsTakeOutOrders="yes" allowsDeliveryOrders="yes" />
            <storeDeals>
                <deal identifier="12345" name="deal1" description="deal one" isFirstTimeDeal="yes" />
                <deal identifier="22345" name="deal2" description="deal two" isFirstTimeDeal="no" />
                ...
            </storeDeals>
            <customer pointBalance="300.0" />
            <invalidDeals>
                <deal identifier="15000024" name="DEMO 25% OFF" description="max - $5.00, one time" pointRequired="500" useTime="1" isFirstTimeDeal="false" />
                <deal identifier="15000026" name="DEMO FREE" description="max $20.00, 10000 points" pointRequired="10000" useTime="-1" isFirstTimeDeal="false" />
            </invalidDeals>
            <emailVerificationDeals />
        </extendedInfo>

    </store>
    </data>

</response>

Element	Attribute	Data Type	Optional	Notes
customer			no	Customer info
	pointBalance	float	no	Ppoints available for customer
storeDeals			no	This element encapsulates a list of valid deals
deal				Deal info
	identifier	int	no	ID of price modifier
	name	String	no	Short description of deal
	description	String	no	Long description of deal
	pointRequired	float	no	Points required to redeem this deal
	isFirstTimeDeal	boolean	no	Indicates whether it is the "welcome deal" of the store.
invalideDeals			no	This element encapsulates a list of invalid deals for current user.
deal			no	Same as above deal element
emailVerificationDeals			no	This element encapsulates a list of deals that requires email verification. It is always empty if current user has verified their email.
deal			no	Same as above deal element

StoreQuery_GetStores

Should be receiving it from the mobile app. This call is used to retrieve a list of participating stores.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
            apiName="StoreQuery_GetStores" apiCategory="playt" locale="en-US" requestTimestamp="xxx" >

  <parameters>
    <loginEmailId value="jane@example.com"/>
  </parameters>
    
</request>

Element	Attribute	Data Type	Optional	Notes
loginEmailId			no
	value	String	no	Identifier of the user making the request

Response Message

<?xml version="1.0" encoding="UTF-8"?>
<response apiVersion="1.0" apiName="StoreQuery_GetStores" apiCategory="playt" requestTimestamp="2011-08-22 12:21:12 EDT" clientId="killvonchav@gmail.com_91E9E991-2BD9-48E3-92FD-D233E086565B-10691-00000221D2E89473">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." responseTimestamp="2011-08-22 12:22:25.39" />
  <data>
    <stores>
      <store identifier="2" name="Milestone - Grill and Bar" address="150 Consumers Road, Toronto" postalCode="M2J 1P9" 
             phoneNumber="1-416-988-6333" logourl="http://volanteportal.com:2859/img/milestone.jpg" storeHours="Mon-Fri: 10am to 11pm,Sat-Sun: closed" 
             location_latitude="43.6505" location_longitude="-79.381" profile="Restaurant Profile" backgroundImgUrl="http://www.ecosalon.com/data/fe/image/fruit%20salad(1).jpg"/>
      ...
      <store ... />
  </data>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	Code 0 if meal code is valid Code 3002 if meal code is not valid
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
stores			no	This element encapsulates all stores info
store			yes	This element encapsulates info of each store. may appear mutilple times in the response
	identifier	integer	no	Site id stored in portal server
	name	String	no	Restaurant name
	address	String	no	Address
	postalCode	String	no	Postal code
	storeHour	String	no	Store hour
	location_latitude	float	no	Latitude on map
	location_longitude	float	no	Longitude on map
	profile	String	no	Restaurant description
	backgroundImgUrl	String	no	The background image of restaurant page

StoreQuery_GetStoreMegaFeed

This will initiate a "connection" to a specific restaurant.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
            apiName="StoreQuery_GetStoreMegaFeed" apiCategory="playt" locale="en-US" requestTimestamp="xxx" >

  <parameters>
    <mealCode value="12345567890123"/>
    <storeIdentifier value="1"/>
    <loginEmailId value="jane@example.com"/>
    <deviceIdentifier value="A23BC9080H"/>
    <showStoreLogo value="true" />
    <showReceipt value="true" />
    <showPointsCoupon value="true" />
    <showSpecial value="true" />
    <showNewsEvents value="true" />
  </parameters>
    
</request>

Element	Attribute	Data Type	Optional	Notes
storeIdentifier			no
	value	String	no	Identifier of the restaurant to connect to
loginEmailId			no
	value	String	no	Identifier of the user making the request
showStoreLogo	value	string	no	Whether show store logo section
showReceipt	value	string	no	Whether show receipt section
showPointsCoupon	value	string	no	Whether show points and deals section
showSpecial	value	string	no	Whether show specials
showNewsEvents	value	string	no	Whether show news and events

Response Message

<?xml version="1.0" encoding="UTF-8"?>
<response apiVersion="1.0" apiName="StoreQuery_GetStoreMegaFeed" apiCategory="playt" requestTimestamp="2011-08-22 12:21:12 EDT" clientId="killvonchav@gmail.com_91E9E991-2BD9-48E3-92FD-D233E086565B-10691-00000221D2E89473">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." responseTimestamp="2011-08-22 12:22:25.39" />
  <data>
    <customer isNew="false" identifier="150002663" pointBalance="0.0" accountBalance1="" accountBalance2="" accountBalance3="" accountBalance4="" mealPlan="-1" />
    <storeDeals showContent="true">
      <deal identifier="150000008" name="volante deal 2" description="volante deal 2" isFirstTimeDeal="false" />
    </storeDeals>
    <storeSpecials showContent="true">
      <special name="Special1" image="http://www.google.com/logos/2011/fourth_of_july11-hp.jpg" description="Special #One" />
      <special name="special2" image="2.jpg" description="special #two" />
    </storeSpecials>
    <storeEvents showContent="true" />
    <storeInfo storeName="Flaming Lips" logo="http://www.google.com/logos/2011/maritimefestival11-hp.jpg" />
    <htmlContent><![CDATA[<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Volante</title>
<script type="text/javascript">
		function load() {
			var rawReceipt = document.getElementById("receipt").getAttribute("raw");
			rawReceipt = rawReceipt.replace(/\n/g, "<br>");
			document.getElementById("receipt").innerHTML = rawReceipt;
		}
		</script>
</head>
<body onload="load()">
<h2>Welcome to Flaming Lips</h2>
<img src="http://www.google.com/logos/2011/maritimefestival11-hp.jpg"><h2>Deals</h2>
<hr>
<div style="border-style: solid; border-width:5px" id="deals">
<div>
<h3>volante deal 2</h3>
<img src=""><p>volante deal 2</p>
</div>
</div>
<h2>Specials</h2>
<hr>
<div style="border-style: solid; border-width:5px" id="specials">
<div>
<h3>Special1</h3>
<img src="http://www.google.com/logos/2011/fourth_of_july11-hp.jpg"><p>Special #One</p>
</div>
<div>
<h3>special2</h3>
<img src="2.jpg"><p>special #two</p>
</div>
</div>
<h2>News</h2>
<hr>
<div style="border-style: solid; border-width:5px" id="events"></div>
</body>
</html>]]></htmlContent>
  </data>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	Code 0 if meal code is valid Code 3002 if meal code is not valid
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.

StoreQuery_GetMainMenuItems

Should be receiving from Playt. This message requests for menu information from a specified store.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
            apiName="StoreQuery_GetMainMenuItems" apiCategory="playt" locale="en-US" requestTimestamp="xxx" >

  <parameters>
    <storeIdentifier value="1"/>
    <loginEmailId value="jane@example.com"/>
  </parameters>
    
</request>

Element	Attribute	Data Type	Optional	Notes
storeIdentifier			no
	value	String	no	Identifier of the restaurant to connect to
loginEmailId			no
	value	String	no	Identifier of the user making the request

Response Message

<?xml version="1.0" encoding="UTF-8"?>
<response apiVersion="1.0" apiName="StoreQuery_GetMainMenuItems" apiCategory="playt" requestTimestamp="2011-08-22 12:21:12 EDT" clientId="killvonchav@gmail.com_91E9E991-2BD9-48E3-92FD-D233E086565B-10691-00000221D2E89473">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." responseTimestamp="2011-08-22 12:22:25.39" />
  <data>
     <groups>
        <group name="Tim Hortons" ID="15000008" MasterGID="15000008">
            <categories>
                <category ID="15000224" name="Beverage" MasterCID='15000224">
                     <menuitems>
                         <menuItem cost="0.0" count="0" interfaceLink=" " isDiscountable="1" isItem86ed="0" isOpenPrice="0" isTimerItem="0" isWeighScaleItem="0" maxOpenPriceAmt="0.0" 
                                   menuItemAltName="Chili" notes=" " numDiscountsAllowed="999" plu="1079" pointsAwarded="0.0" printName="Chili" priceOnReceipt="1" timerMinMinsCharged="0" 
                                   timerRoundingMethod="0" timerTimeIntervalMins="0" timerTimeRounding="0" trackByItemCount="0" unit="1.0" MasterMID="1079" ID="15002660" name="Chili" 
                                   price="3.99">
                              <sizes/>
                              <linkedOptions>
                                   <linkedOption categoryId="15000247" forceMaxSelection="0" maxSelection="1" ID="15001019" minSelection="0" priceGreaterThanQP="0.0" 
                                                 priceLessThanOrEqualToQP="0.0" quantityPoint="0" masterCID="15000247"/>
                                   </linkedOptions>
                              <extraOptions/>
                         </menuItem>
                         ...
                     </menuitems>
                </category>
                ...
            </categories>
         </group>
         ....
      </groups>
  </data>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	Code 0 if meal code is valid Code 3002 if meal code is not valid
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.

StoreQuery_GetMenuOptions

Should be receiving from Playt. This message requests for menu options from a specified store. It will return the menu cache in portal.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
            apiName="StoreQuery_GetMenuOptions" apiCategory="playt" locale="en-US" requestTimestamp="xxx" >

  <parameters>
    <storeIdentifier value="1"/>
    <loginEmailId value="jane@example.com"/>
    <deviceIdentifier value="asdfzxcv" />
  </parameters>
    
</request>

Element	Attribute	Data Type	Optional	Notes
storeIdentifier			no
	value	String	no	Identifier of the restaurant to connect to
loginEmailId			no
	value	String	no	Identifier of the user making the request

Response Message

<?xml version="1.0" encoding="UTF-8"?>
<response apiVersion="1.0" apiName="StoreQuery_GetMenuOptions" apiCategory="playt" requestTimestamp="2011-08-22 12:21:12 EDT" clientId="killvonchav@gmail.com_91E9E991-2BD9-48E3-92FD-D233E086565B-10691-00000221D2E89473">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." responseTimestamp="2011-08-22 12:22:25.39" />
  <data>
     <groups>
        <group name="Tim Hortons" ID="15000008" MasterGID="15000008">
            <categories>
                <category ID="15000224" name="Beverage" MasterCID='15000224">
                     <menuitems>
                         <menuItem cost="0.0" count="0" interfaceLink=" " isDiscountable="1" isItem86ed="0" isOpenPrice="0" isTimerItem="0" isWeighScaleItem="0" maxOpenPriceAmt="0.0" 
                                   menuItemAltName="Chili" notes=" " numDiscountsAllowed="999" plu="1079" pointsAwarded="0.0" printName="Chili" priceOnReceipt="1" timerMinMinsCharged="0" 
                                   timerRoundingMethod="0" timerTimeIntervalMins="0" timerTimeRounding="0" trackByItemCount="0" unit="1.0" MasterMID="1079" ID="15002660" name="Chili" 
                                   price="3.99">
                              <sizes/>
                              <linkedOptions>
                                   <linkedOption categoryId="15000247" forceMaxSelection="0" maxSelection="1" ID="15001019" minSelection="0" priceGreaterThanQP="0.0" 
                                                 priceLessThanOrEqualToQP="0.0" quantityPoint="0" masterCID="15000247"/>
                                   </linkedOptions>
                              <extraOptions/>
                         </menuItem>
                         ...
                     </menuitems>
                </category>
                ...
            </categories>
         </group>
         ....
      </groups>
  </data>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Drror element contains error code and error descriptions
	code	integer	no	Code 0 if meal code is valid Code 3002 if meal code is not valid
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.

StoreQuery_GetStoresWithPastOrders

Should be received from Playt. This message requests for a list of stores which have the order history of their customers.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
            apiName="StoreQuery_GetStoresWithPastOrders" apiCategory="playt" locale="en-US" requestTimestamp="xxx" >

  <parameters>
    <loginEmailId value="jane@example.com"/>
  </parameters>
    
</request>

Element	Attribute	Data Type	Optional	Notes
loginEmailId			no
	value	String	no	Identifier of the user making the request

Response Message

<response apiVersion="1.00" apiName="StoreQuery_GetStoresWithPastOrders" apiCategory="playt" requestTimestamp="2012-01-11 10:47:53.902" clientId="its_me">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." responseTimestamp="2012-01-11 10:49:37.083"/>
  <data>
    <stores>
      <store identifier="2" name="Milestone - Grill and Bar" address="150 Consumers Road, Toronto" postalCode="M2J 1P9" phoneNumber="1-416-988-6333" 
             logourl="http://volanteportal.com:2859/img/milestone.jpg" storeHours="Mon-Fri: 10am to 11pm,Sat-Sun: closed" location_latitude="43.6505" location_longitude="-79.381" 
             profile="Some Description" backgroundImgUrl="http://www.ecosalon.com/data/fe/image/fruit%20salad(1).jpg"/>

     ...

    </stores>
  </data>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	Code 0 if meal code is valid Code 3002 if meal code is not valid
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
stores			no	This element encapsulates a list of stores that have order history from current customer
store			no	This element encapsulates store info
	identifier	integer	no	Site id stored in portal server
	name	String	no	Restaurant name
	address	String	no	Address
	postalCode	String	no	Postal code
	storeHour	String	no	Store hour
	location_latitude	float	no	Latitude on map
	location_longitude	float	no	Longitude on map
	profile	String	no	Restaurant description
	backgroundImgUrl	String	no	The background image of restaurant page

StoreQuery_GetDeals

Should be receiving from Playt. This message requests for a list of deals.

Request Message

<request apiVersion="1.00" apiName="StoreQuery_GetDeals" apiCategory="playt" clientId="its_me" 
         requestTimestamp="2012-03-30 11:44:14 EDT" locale="en_CA" devicePlatformId="1" apiKey="unless_you_know_this_key_you_cant_call_me">
  <parameters>
    <loginEmailId value="pwang@volantesystems.com" />
    <storeIdentifier value="2" />
    <deviceIdentifier value="970d09be106923475e2c05a39e800de4" />
  </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
storeIdentifier			no
	value	String	no	Identifier of the restaurant to connect to
loginEmailId			no
	value	String	no	Identifier of the user making the request
deviceIdentifier			no
	value	String	no	Device identifier

Response Message

<response apiVersion="1.0" apiName="StoreQuery_GetValidDeals" apiCategory="playt" requestTimestamp="2012-01-11 10:47:53.902" clientId="its_me">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." responseTimestamp="2012-01-11 11:39:57.515"/>
  <data>
    <customer pointBalance="200.0" />
    <storeDeals>
      <deal identifier="15000022" name="10% OFF" description="max -$2.00, 0 point" pointRequired="0" isFirstTimeDeal="false"/>
      ...
    </storeDeals>
    <invalidDeals>
      <deal identifier="15000024" name="DEMO 25% OFF" description="max - $5.00, one time" pointRequired="500" useTime="1" isFirstTimeDeal="false" />
    </invalidDeals>
    <emailVerificationDeals>
      <deal identifier="15000026" name="DEMO FREE" description="max $20.00, 10000 points" pointRequired="10000" useTime="-1" isFirstTimeDeal="false" />
    </emailVerificationDeals>
  </data>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	Code 0 if meal code is valid Code 3002 if meal code is not valid
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
customer			no	Customer info
	pointBalance	float	no	Points available for customer
storeDeals			no	This element encapsulates a list of valid deals
deal				Deal info
	identifier	int	no	ID of price modifier
	name	String	no	Short description of deal
	description	String	no	Long description of deal
	pointRequired	float	no	Points required to redeem this deal
	isFirstTimeDeal	boolean	no	Indicates whether it is the "welcome deal" of the store.
invalideDeals			no	This element encapsulates a list of invalid deals for current user.
deal			no	Same as above deal element
emailVerificationDeals			no	This element encapsulates a list of deals that requires email verification. It is always empty if current user has verified their email.
deal			no	Same as above deal element

RewardQuery_GetRestaurantPoints

Should be receiving from Playt app. This message requests for a list of restaurant points.

Request Message

<request apiVersion="1.00" apiName="RewardQuery_GetRestaurantPoints" apiCategory="playt" clientId="its_me" 
         requestTimestamp="2012-03-30 12:17:44 EDT" locale="en_CA" devicePlatformId="1" apiKey="unless_you_know_this_key_you_cant_call_me">
  <parameters>
    <loginEmailId value="pwang@volantesystems.com" />
  </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
loginEmailId			no
	value	String	no	Identifier of the user making the request

Response Message

<response apiVersion="1.00" apiName="RewardQuery_GetRestaurantPoints" apiCategory="playt" requestTimestamp="2012-03-30 12:17:44 EDT" clientId="pwang@volantesystems.com_733A8535-8672-46E4-9B7D-130D858854EC-484-0000003523810E16">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." />
  <data>
    <restaurantPoints>
      <restaurantPoint restaurantId="2" restaurantName="playt demo store" point="200.0" />
      ...
    </restaurantPoints>
  </data>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	Code 0 if meal code is valid Code 3002 if meal code is not valid
	localizedDescription	string	no	E description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		E description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
restaurantPoints			no	List of restaurant points
restaurantPoint
	restaurantId	integer	no	Restaurant id.
	restaurantName	String	no	Restaurant name
	point	float	no	User points in the restaurant

Playt Transaction Message Category

PlaytTrans_CreateTakeoutOrder

This call creates a pick up transaction. It will be translated and sent to the POS.

Request Message

<request apiVersion="1.00" apiName="PlaytTrans_CreateTakeOutOrder" apiCategory="playt" requestTimestamp="2012-07-31 15:22:35 EDT" locale="en_US" devicePlatformId="1" apiKey="apiKey" clientId="clientId">
  <parameters>
    <loginEmailId value="a@b.com" />
    <deviceIdentifier value="asdfzxcv" />
    <storeIdentifier value="1" />
    <submitTimestamp value="2012-07-31 15:22:35 EDT" />
    <tabName value="a@b.com" />
    <pickupTimestamp value="2012-07-31 15:22:13 EDT" />
    <phoneNumber value="1234" />
    <tableTrans>
      <seat seatNumber="1">
        <item menuItemId="1002421" quantity="1" seatName="Paul">
          <options />
        </item>
      </seat>
    </tableTrans>
    <priceMod identifier="1000002" isFirstTimeDeal="false" />
    <orderType value="TakeOut" />
  </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
loginEmailId			no	User Email Id
	value	String	no	User Email Id
deviceIdentifier			no	Device Id
	value	String	no	Device Id
storeIdentifier			no	Store Id
	value	integer	no	Store Id
submitTimestamp			no
	value	timestamp	no	Time they submit the order
pickupTimestamp			no
	value	timestamp	no	Time they want to pick it up order
tab name			no	Tab name displayed in POS
	value	String	no	Tab name
phoneNumber
	value	String	no	Phone number of user
tableTrans
	value			Please see POSTransaction_AddItemToTrans Message Web_Services_API_Transaction
priceMod			yes	Price modifier that will be applied.
	identifier	integer	no	Price modifier id
	isFirstTimeDeal	string	yes	Whether the price modifier is the first time deal

Response Message

<response apiVersion="1.00" clientId="its_me" apiName="PlaytTrans_CreateTakeoutOrder"
          apiCategory="playt" requestTimestamp="xxx" responseTimestamp="xxx">

    <error code="0"
           localizedDescription="some French words" 
           defaultDescription="something you understand"/>

    <data>
        <tableTransaction closeTime="2006-07-20 11:54:55.565" ID="3000002" isTableClosed="false" bills="" serverId="888" startServerId="888" startTime="2006-07-20 11:54:55.535" tableName="aa" tableTransactionOwner="10" tableType="1" transactionType="1">
            <seats>
                <tableSeat ID="3000002" seatNumber="1" seatState="0"/>
                <tableSeat ID="3000003" seatNumber="2" seatState="0"/>
            </seats>
        </tableTransaction>

    </data>

</response>



<?xml version="1.0" encoding="UTF-8"?>
<response apiVersion="1.0" apiName="PlaytTrans_CreateTakeoutOrder" apiCategory="playt" requestTimestamp="2011-08-16 12:45:25 EDT" clientId="killvonchav@gmail.com_FE5B7E59-2AC1-4B0F-AE91-94855B1BF7E7-99229-00011BAADAF3AB15">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." responseTimestamp="2011-08-16 12:46:11.843" />
  <table tableTransId="1000696" seatNumber="1" />
  <data>
    <tableTransaction ID="1000696" isTableClosed="false" bills="Date: Aug 16, 2011 12:46:11
Table: killvonchav@gmail.com
TableTransId: 1000696
TransId: 1000689
Server: Playt

1  Veggie Burger                      6.27
    Whole Wheat Bun
    Jack with Jalapenos
    Sauteed Mushrooms

Subtotal                              6.27
HST8%F (ON)                           0.50
GST                                   0.31
Total                                 7.08
volante deal 2                       -0.00
Acc.#: 
Total Due                             7.08
Balance                               7.08

PC__BARPRET1000689PC__BARPOST
" serverId="150000004" startServerId="150000004" tableName="killvonchav@gmail.com" tableTransactionOwner="-150" tableType="11" transactionType="1" startTime="2011-08-16 12:46:11.403" closeTime="2011-08-16 12:46:11.703" mealCode="301424409823910">
      <seats>
        <tableSeat ID="1000689" seatNumber="1" seatState="1" />
      </seats>
    </tableTransaction>
  </data>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.

StoreTransaction_GetPastOrders

Should be receiving from Playt. This message will request for a list of order history in a specified period with a specified zie.

When receiving this message, portal will firstly search the history in cache. If the size cannot meet the number specified in the message, it will be modified and forwarded to the POS to get more order records.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
            apiName="StoreTransaction_GetPastOrders" apiCategory="playt" locale="en-US" requestTimestamp="xxx" sessionId="xxx">
  <parameters>
    <storeIdentifier value="2"/>
    <loginEmailId value="abc@abc.com"/>
    <batchSize value="10"/>
    <olderThan value=""/>
    <newThan value="" />
  </parameters>     
</request>

Element	Attribute	Data Type	Optional	Notes
storeIdentifier			no
	value	integer	no	Store Identifier in portal
loginEmailId			no
	value	String	no	Customer email id
batchSize			no
	value	integer	no	The number of past orders returned. Should not be a positive integer
olderThan			no
	value	timestamp	no	The newest returned past order should be after this time. If empty, it means no limit
newerThan			no
	value	timestamp	no	The oldest returned order should be before this time. If empty, it means no limit

Response Message

<response apiVersion="1.00" clientId="its_me" apiName="StoreTransaction_GetPastOrders"
          apiCategory="playt" requestTimestamp="xxx" responseTimestamp="xxx">

    <error code="0"
           localizedDescription="some French words" 
           defaultDescription="something you understand"/>

    <data>
    <PastOrders>
      <PastOrder storeIdentifier="2" orderIdentifier="1000284" orderTimestamp="2011-12-08 19:10:16.0" paymentTotal="3.86" currencySign="$" orderDetail=" SOME DETALIS " />
      ...

    </data>

</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.
PastOrders			yes	This element encapsulates the list of past orders
PastOrder			yes	Order info
	storeIdentifier	integer	no	Store id in portal
	orderIdentifier	integer	no	Order id from pos
	orderTimestamp	timestamp	no	Order time
	pamentTotal	float	no	Bill amount
	currencySign	String	no	Indicate the currency
	orderDetail	String	no	HTML of order receipt

checkMealCode

This call checks if the meal code is valid or not.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
            apiName="checkMealCode" apiCategory="playt" locale="en-US" requestTimestamp="xxx" sessionId="xxx">

  <parameters>
    <mealCode value="1234533123123"/>
  </parameters>
    
</request>

Element	Attribute	Data Type	Optional	Notes
mealCode			no
	value	String	no	Value of the meal code

Response Message

<response apiVersion="1.00" clientId="its_me" apiName="SecurityService_IsValidCustomer"
          apiCategory="playt" requestTimestamp="xxx" responseTimestamp="xxx">

    <error code="0"
           localizedDescription="some French words" 
           defaultDescription="something you understand"/>

    <data/>

</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	Code 0 if meal code is valid Code 3002 if meal code is not valid
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call.

PlaytReward_CollectMissingStorePoints

This call requests to associate a closed transaction with using by provided meal code. This message will be translated and sent to the POS.

Request Message

<request apiVersion="1.00" apiName="PlaytReward_CollectMissingStorePoints" apiCategory="playt" clientId="its_me"
         requestTimestamp="2012-03-30 12:41:09 EDT" locale="en_CA" devicePlatformId="1" apiKey="secret_key">
  <parameters>
    <loginEmailId value="pwang@volantesystems.com" />
    <mealCode value="80349-07895-54102" />
  </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
loginEmailId			no
	value	String	no	Current user email id
mealCode			no
	value	String	no	Value of the meal code

Response Message

<response apiVersion="1.0" apiName="PlaytReward_CollectMissingStorePoints" apiCategory="playt" requestTimestamp="2012-03-30 12:41:09 EDT" clientId="pwang@volantesystems.com_733A8535-8672-46E4-9B7D-130D858854EC-484-0000003523810E16" sessionId="unassigned1333125683190">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." />
  <data />
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	Code 0 if meal code is valid Code 3002 if meal code is not valid
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.

StoreTransaction_ApplyBillPriceMod

This call attempts to apply a bill price mod. This message will be translated and sent to the POS.

Request Message

<request apiVersion="1.00" apiName="StoreTransaction_ApplyBillPriceMod" apiCategory="playt" clientId="its_me" 
         requestTimestamp="2012-03-30 16:48:03 EDT" locale="en_CA" devicePlatformId="1" apiKey="secret_key">
  <parameters>
    <loginEmailId value="pwang@volantesystems.com" />
    <mealCode value="12345-67890-12345" />
    <priceModId value="15000022" />
    <deviceIdentifier value="xx" />
  </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
loginEmailId			no
	value	String	no	Current user email id
mealCode			no
	value	String	no	Value of the meal code
priceModId			no
	value	String	no	Price modifier id
deviceIdentifier			no
	value	String	no	Device id

Response Message

<response apiVersion="1.0" apiName="StoreTransaction_ApplyBillPriceMod" apiCategory="playt" 
          requestTimestamp="2012-03-30 17:02:26 EDT" clientId="its_me" sessionId="sessionId">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." />
  <data>
    <tableTransaction ID="1000807" isTableClosed="false" bills="Date: 2012-03-30 at 17:02:40&#xA;&#xA;TableTransId: 1000807&#xA;TransId: 1000844&#xA;Table: T1000807&#xA;Server: admin&#xA;Current Term: Primary&#xA;&#xA;Meal Code:75598-94245-74491&#xA;&#xA;2  Stuffed Sandwich                   6.88&#xA;&#xA;Subtotal                              6.88&#xA;Food (ON)                             0.55&#xA;GST                                   0.41&#xA;Total                                 7.84&#xA;Balance                               7.84&#xA;" serverId="15000002" startServerId="15000002" tableName="T1000807" tableTransactionOwner="-110" tableType="2" transactionType="1" startTime="2012-03-30 16:39:02.706" closeTime="2012-03-30 17:02:40.618" paymentTotal="7.84" mealCode="755989424574491">
      <seats>
        <tableSeat ID="1000853" seatNumber="1" seatState="1" />
      </seats>
    </tableTransaction>
    <customer points="300" />
  </data>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	Code 0 if meal code is valid Code 3002 if meal code is not valid
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no
tableTransaction			no	This element contains all info about the table transaction
customer			no
	points	float	no	Updated customer points

StoreTransaction_AddItemsToTransaction

This call attempts to add items and/or apply price modifiers to table using meal codes. This message will be translated and sent to the POS.

Request Message

<request apiVersion="1.00" apiName="StoreTransaction_AddItemsToTransaction" apiCategory="playt" clientId="its_me"
         requestTimestamp="2012-03-30 17:22:48 EDT" locale="en_CA" devicePlatformId="1" apiKey="secret_key">
  <parameters>
    <loginEmailId value="pwang@volantesystems.com" />
    <storeIdentifier value="2" />
    <mealCode value="75598-94245-74491" />
    <deviceIdentifier value="deviceId" />
    <tableTrans>
      <seat seatNumber="1">
        <item menuItemId="15002669" quantity="1" seatName="John">
          <options />
        </item>
      </seat>
    </tableTrans>
    <priceMod identifier="15000022" isFirstTimeDeal="false" />
  </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
loginEmailId			no
	value	String	no	Current user email id
mealCode			no
	value	String	no	Value of the meal code
storeIdentifier			no
	value	Integer	no	Store Id
deviceIdentifier			no
	value	String	no	Device id
tableTrans				Contains added items
seat				Not used now
item
	menuItemId	integer	no	Item id
	quantity	integer	no	Maybe for future use
	seatName	String	no	The person item ordered for. used for split bill.
priceMod			yes	Price modifier info
	identifier	integer	no	Price modifier id
	isFirstTimeDeal	string	no	Whether it is first time deal

Response Message

<response apiVersion="1.0" apiName="StoreTransaction_ApplyBillPriceMod" apiCategory="playt" 
          requestTimestamp="2012-03-30 17:02:26 EDT" clientId="its_me" sessionId="sessionId">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." />
  <data>
    <tableTransaction ID="1000807" isTableClosed="false" bills="Date: 2012-03-30 at 17:02:40&#xA;&#xA;TableTransId: 1000807&#xA;TransId: 1000844&#xA;Table: T1000807&#xA;Server: admin&#xA;Current Term: Primary&#xA;&#xA;Meal Code:75598-94245-74491&#xA;&#xA;2  Stuffed Sandwich                   6.88&#xA;&#xA;Subtotal                              6.88&#xA;Food (ON)                             0.55&#xA;GST                                   0.41&#xA;Total                                 7.84&#xA;Balance                               7.84&#xA;" serverId="15000002" startServerId="15000002" tableName="T1000807" tableTransactionOwner="-110" tableType="2" transactionType="1" startTime="2012-03-30 16:39:02.706" closeTime="2012-03-30 17:02:40.618" paymentTotal="7.84" mealCode="755989424574491">
      <seats>
        <tableSeat ID="1000853" seatNumber="1" seatState="1" />
      </seats>
    </tableTransaction>
    <customer points="300" />
  </data>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	Code 0 if meal code is valid Code 3002 if meal code is not valid
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no
tableTransaction			no	This element contains all info about the table transaction
customer			no
	points	float	no	Updated customer points

PlaytTrans_CreateDeliveryOrder

This call creates a delivery transaction. The call will be translated and sent to the POS.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
            apiName="PlaytTrans_CreateDeliveryOrder" apiCategory="playt" locale="en-US" requestTimestamp="xxx" sessionId="xxx">

  <parameters>

  <loginEmailId value="abc@def.com"/>
  <storeIdentifier value="123"/>
  
  <takeoutName value="Name"/>
  <submitTimestamp value="YYYY-MM-DD HH:mm:ss zzz"/>
  <deliveryTime value="YYYY-MM-DD HH:mm:ss zzz" />
  <deliveryAddress value="Street, City, Province, Postal Code" />
  <phoneNumber value="1111111111" />

  <tableTrans>
    <seat seatNumber='1'>
      <item menuItemId='118' quantity='10' overrideOperatorWithTableOwner='false' openPrice='0.0'>
        <options>
          <option menuItemId='100' linkedOptionId='35'/>
          <option menuItemId='104' linkedOptionId='35'/>
          <option menuItemId='1002' linkedOptionId='10'/>
        </options>
      </item>
     </seat>
   </tableTrans>
  <priceMod identifier="3432" isFirstTimeDeal="true/false"/>

  <parameters/>

      
</request>

Element	Attribute	Data Type	Optional	Notes
takeoutName			no
	value	String	no	Display Name of takeout. For Playt, it may be their user name or email
submitTimestamp			no
	value	timestamp	no	Time they submit the order
deliveryAddress			no
	value	string	no	Dser address for delivery
deliveryTime			no
	value	timestamp	no	Time they want the order delivered
phoneNumber
	value	String	no	Phone number of current user
playtId			yes
	value	integer	yes	Option Playt ID
tableTrans
	value			Please see POSTransaction_AddItemToTrans Message POS Web Services API - Transaction
priceMod			yes
	identifier	integer	no	Price modifier id
	isFirstTimeDeal	string	yes	Whether the price modifier is the first time deal

Response Message

<response apiVersion="1.00" clientId="its_me" apiName="PlaytTrans_CreateDeliveryOrder"
          apiCategory="playt" requestTimestamp="xxx" responseTimestamp="xxx">

    <error code="0"
           localizedDescription="some French words" 
           defaultDescription="something you understand"/>

    <data>
        <tableTransaction closeTime="2006-07-20 11:54:55.565" ID="3000002" isTableClosed="false" bills="" serverId="888" startServerId="888" startTime="2006-07-20 11:54:55.535" tableName="aa" tableTransactionOwner="10" tableType="1" transactionType="1">
            <seats>
                <tableSeat ID="3000002" seatNumber="1" seatState="0"/>
                <tableSeat ID="3000003" seatNumber="2" seatState="0"/>
            </seats>
        </tableTransaction>

    </data>

</response>



<?xml version="1.0" encoding="UTF-8"?>
<response apiVersion="1.0" apiName="PlaytTrans_CreateTakeoutOrder" apiCategory="playt" requestTimestamp="2011-08-16 12:45:25 EDT" clientId="killvonchav@gmail.com_FE5B7E59-2AC1-4B0F-AE91-94855B1BF7E7-99229-00011BAADAF3AB15">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." responseTimestamp="2011-08-16 12:46:11.843" />
  <table tableTransId="1000696" seatNumber="1" />
  <data>
    <tableTransaction ID="1000696" isTableClosed="false" bills="Date: Aug 16, 2011 12:46:11
Table: killvonchav@gmail.com
TableTransId: 1000696
TransId: 1000689
Server: Playt

1  Veggie Burger                      6.27
    Whole Wheat Bun
    Jack with Jalapenos
    Sauteed Mushrooms

Subtotal                              6.27
HST8%F (ON)                           0.50
GST                                   0.31
Total                                 7.08
volante deal 2                       -0.00
Acc.#: 
Total Due                             7.08
Balance                               7.08

PC__BARPRET1000689PC__BARPOST
" serverId="150000004" startServerId="150000004" tableName="killvonchav@gmail.com" tableTransactionOwner="-150" tableType="11" transactionType="1" startTime="2011-08-16 12:46:11.403" closeTime="2011-08-16 12:46:11.703" mealCode="301424409823910">
      <seats>
        <tableSeat ID="1000689" seatNumber="1" seatState="1" />
      </seats>
    </tableTransaction>
  </data>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	This element encapsulates a custom data structure as the result of the call

Security Messages

SecurityService_ValidateCustomerEmailId

Should be receiving from the mobile app. This call is used to verify if a user (by email) exists.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
            apiName="SecurityService_ValidateCustomerEmailId" apiCategory="playt" locale="en-US" requestTimestamp="xxx" sessionId="xxx">
    <parameters>
        <loginEmailId value="jane@example.com"/>
    </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Parameters element contains a list of parameter element
loginEmailId			no	The loginEmailId parameter
	value		no	Tthe login email identifier/address

Response Message

<response apiVersion="1.00" clientId="its_me" apiName="SecurityService_ValidateCustomerEmailId"
apiCategory="playt" 
requestTimestamp="xxx" responseTimestamp="xxx" />

<error code="0" 
localizedDescription="some French words" 
defaultDescription="something you understand"/>

</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	0 is Success; Non-Zero: Any error condition. For this particular call, currently the Playt mobile app doesn't care much about the actual error code other than 0 (which is success).
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English

SecurityService_VerifyCustomer

Should be receiving it from the mobile app. This call is used to sign into Playt.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
            apiName="SecurityService_VerifyCustomer" apiCategory="playt" locale="en-US" requestTimestamp="xxx" sessionId="xxx">
    <parameters>
        <loginEmailId value="jane@example.com"/>
        <password value="mypassword"/>
    </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Parameters element contains a list of parameter element
loginEmailId			no	The loginEmailId parameter
password			no	The password parameter
	value		no	Value of a parameter

Response Message

<response apiVersion="1.00" clientId="its_me" apiName="SecurityService_VerifyCustomer"
        apiCategory="playt" requestTimestamp="xxx" responseTimestamp="xxx">

<error code="0" 
    localizedDescription="some French words" 
    defaultDescription="something you understand"/>

</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	0 - Success; Non-Zero: Any error condition. For this particular call, currently the Playt mobile app doesn't care much about the actual error code other than 0 (which is success).
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English

SecurityService_GetCustomerDetails

Should be receiving it from the mobile app. This call is used to get the detail info of customers.

Request Message

<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
            apiName="SecurityService_GetCustomerDetails" apiCategory="playt" requestTimestamp="xxx" locale="en-US" devicePlatformId="1">
    <parameters>
        <loginEmailId value="jane@example.com"/>
    </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Parameters element contains a list of parameter element
loginEmailId			no	The loginEmailId parameter
	value		no	The login email identifier/address

Response Message

<response apiVersion="1.00" clientId="its_me" apiName="SecurityService_GetCustomerDetails"
apiCategory="playt" 
requestTimestamp="xxx" responseTimestamp="xxx" />

<error code="0" 
localizedDescription="some French words" 
defaultDescription="something you understand"/>

<data/>
<customer identifier="26" status="1" nickname="Jane" email="jane@example.com" currentLevelName="Level 5" 
availablePoints="1050" currentLevelPoint="1000" userAccumulatedTotal="1050" nextLevelPoint="2000" currentLevel="5"/>

</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	0 is Success; Non-Zero: Any error condition. For this particular call, currently the Playt mobile app doesn't care much about the actual error code other than 0 (which is success).
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
customer			no	Customer element contains info of the customer.
	identifier	integer	no	The customer id in portal
	status	integer	no	0 - verified 1 - not verified 2 - facebook login
	email	String	no	Customer email address
	currentLevelName	String	no	The name of current playt level
	availablePoints	integer	no	The customer's available playt points
	currentLevelPoint	integer	no	The points required for current level (to calculate and display the experience bar)
	userAccumulatedTotal	integer	no	The customer's total playt points accuired
	nextLevelPoint	integer	no	The points requried for next level (to calculate and display the experience bar)
	currentLevel	integer	no	Current level

SecurityService_RegisterNewCustomer

Should be receiving it from the mobile app. This call is used to register new customers.

Request Message

<request apiVersion="1.0" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiCategory="playt" apiName="SecurityService_RegisterNewCustomer" locale="en-US">
    <parameters>
        <loginEmailId value="jane@example.com"/>
        <password value="12345"/>
        <nickname value="Jane"/>
        <deviceIdentifier value="*****" />
        <devicePlatformId value="1" />
        <authenticatorId value="0" />        
    </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Parameters element contains a list of parameter element
loginEmailId			no	The loginEmailId parameter
	value		no	The login email identifier/address
password			no	Ppassword element
	value	String	no	Ppassword
nickname			no
	value	String	no	Nickname, can be empty "".
deviceIdentifier			no
	value	String	no	Device Id, generated by playt app
devicePlatformId			no
	value	integer	no	Platform Id 1- IOS 2- Android
authenticatorId
	value	integer	no	0 - email 1 - facebook

Response Message

<response apiVersion="1.00" clientId="its_me" apiName="SecurityService_RegisterNewCustomer"
apiCategory="playt" 
requestTimestamp="xxx" responseTimestamp="xxx" />

<error code="0" 
localizedDescription="some French words" 
defaultDescription="something you understand"/>

<data/>

</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	0 is Success; Non-Zero: Any error condition. For this particular call, currently the Playt mobile app doesn't care much about the actual error code other than 0 (which is success).
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English

SecurityService_EditProfile

Should be receiving it from the mobile app. This call is used to edit customer's info, including email address, nickname, and password.

Request Message

<request apiVersion="1.0" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
apiCategory="playt" apiName="SecurityService_RegisterNewCustomer" locale="en-US">
    <parameters>
        <loginEmailId value="jane@example.com"/>
        <newEmail value="jane2@example.com"/>
        <nickName value="Jane2"/>
        <currentPassword value="12345 />
        <newPassword value="qwert" />
    </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Parameters element contains a list of parameter element
loginEmailId			no	The loginEmailId parameter
	value		no	The login email identifier/address
newEmail			no
	value	String	no	New login email identifier/address. Only can be changed when email id is not verified
nickName			no
	value	String	no	New nickname, can be empty ""
currentPassword			no
	value	String	no	Only required when "newPassword" is not empty ""
currentPassword			no
	value	String	no	New password to change. must verify current password. disabled when using facebook login

Response Message

<response apiVersion="1.00" clientId="its_me" apiName="SecurityService_RegisterNewCustomer"
apiCategory="playt" 
requestTimestamp="xxx" responseTimestamp="xxx" />

<error code="0" 
localizedDescription="some French words" 
defaultDescription="something you understand"/>

<data/>

</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	0 is Success; Non-Zero: Any error condition. For this particular call, currently the Playt mobile app doesn't care much about the actual error code other than 0 (which is success).
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English

SecuirtyService_Request PasswordRecovery

Should be receiving it from the mobile app. This call is used to request password recovery.

Request Message

<request apiVersion="1.0" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me" 
apiCategory="playt" apiName="SecurityService_RequestPasswordRecovery" locale="en-US">
    <parameters>
        <loginEmailId value="jane@example.com"/>      
    </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Parameters element contains a list of parameter element
loginEmailId			no	The loginEmailId parameter
	value		no	The login email identifier/address

Response Message

<response apiVersion="1.00" clientId="its_me" apiName="SecurityService_RequestPasswordRecovery"
apiCategory="playt" 
requestTimestamp="xxx" responseTimestamp="xxx" />

<error code="0" 
localizedDescription="some French words" 
defaultDescription="something you understand"/>

<data/>

</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	0 is Success; Non-Zero: Any error condition. For this particular call, currently the Playt mobile app doesn't care much about the actual error code other than 0 (which is success).
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.

SecurityService_SendVerificationEmailId

Should be receiving it from the mobile app. This call is used to request to send a verification email.

Request Message

<request apiVersion="1.00" apiName="SecurityService_SendVerificationEmailId" apiCategory="playt" clientId="its_me" 
         requestTimestamp="2012-03-30 11:09:55 EDT" locale="en_CA" devicePlatformId="1" apiKey="unless_you_know_this_key_you_cant_call_me">
  <parameters>
    <loginEmailId value="pwang@volantesystems.com" />
  </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Parameters element contains a list of parameter element
loginEmailId			no	The loginEmailId parameter
	value		no	The login email identifier/address

Response Message

<response apiVersion="1.00" apiName="SecurityService_SendVerificationEmailId" apiCategory="playt" requestTimestamp="2012-03-30 11:09:55 EDT" 
          clientId="its_me">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." />
  <data />
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	0 is Success; Non-Zero: Any error condition. For this particular call, currently the Playt mobile app doesn't care much about the actual error code other than 0 (which is success).
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English

confirm_email

Should be received from the website. Used to confirm email registration.

Request Message

<request apiVersion="1.0" apiName="confirm_email" apiCategory="playt" requestTimestamp="2012-3-30 11:15:06.167" clientId="0">
  <parameters>
    <emailcode value="emailCode" />
  </parameters>
</request>

Element	Attribute	Data Type	Optional	Notes
parameters			no	Parameters element contains a list of parameter element
emailcode			no	The email code parameter
	value		no	The generated email code

Response Message

<response apiVersion="1.00" apiName="confirm_email" apiCategory="playt" requestTimestamp="2012-3-30 11:15:06.167" clientId="0">
  <error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." />
  <data>
    <email value="pwang@volantesystems.com" />
  </data>
</response>

Element	Attribute	Data Type	Optional	Notes
error			no	Error element contains error code and error descriptions
	code	integer	no	0 is Success; Non-Zero: Any error condition. For this particular call, currently the Playt mobile app doesn't care much about the actual error code other than 0 (which is success).
	localizedDescription	string	no	A description in the language corresponding to the locale setting in the original request.
	defaultDescription	string		A description in English.
data			no	Data Element
email			no	Email Element
	value	string	no	Confirmed email

Related Articles

Filter by label

There are no items with the selected labels at this time.

See Also:

Troubleshooting Articles

Browser not supported