/user/purchases

From EveryTrail API Developer Documentation

Jump to: navigation, search

Contents

URL

/api/user/purchases

Semantics

All users purchases (currently only guides are available)

Parameters

Parameter nameParameter formatRequiredDescription
usernamestringyesusername of user performing the request
passwordstringyespassword of user performing the request
statusbitmasknoA bitwise OR of the data to return (see below), default is all
purchased_afterstring in Standard Date Formatnodate, results will only contains guides downloaded after that date
modified_afterstring in Standard Date Formatnodate, results will only contains guides downloaded or modified after that date
latfloatnolocation coordinate, used for ordering results by proximity
lonfloatnolocation coordinate, used for ordering results by proximity
limitintnoThe maximum number of results to return (default is 20)
startintnoThe index of the first guide to return from the result set. (default is 0)
sortstringnoHow to sort the results (rating, title, download_time, proximity)
orderstringnohow to order the results (asc, desc)
minimalbooleannoif true, only returns the root element for each result (and the id). used for quick syncing

Status

  • 0x1: pending
  • 0x2: paid
  • 0x4: deleted (but paid)
  • 0x8: paid through a bundle purchase
  • 0x16: deleted, (but paid through a bundle purchase)

Success Response

<etUserPurchasesResponse status="success">
  <userID>${userID}</userID>
   <guides>
      ${guideXML}
   </guides>
</etUserPurchasesResponse>

${userID}: ID of user making the search

For each guide, a status is returned. ${status} 0: pending 1: paid 2: deleted 3: bundled 4: deleted from bundle

Error Reponse

<etUserPurchasesResponse status="error">
   <userID>${userID}</userID>
  ${error reponse}
</etUserPurchasesResponse>
Personal tools