ESS:Prices

From ESS
Jump to: navigation, search
Format ESS
Ess-feed-icon.png
.ess, .xml
application/ess+xml
version 0.9

Contents

"Prices" definition

An event is comprised of several attributes, one of the most important is to define the cost to attend the event. Event prices can be fixed or varied. Event prices are represented in ESS through two element "type" attributes. This types represent every situations, price can take several aspects: "standalone" and "recurrent" :


STANDALONE PRICE

RECURRENT PRICE

Price is required only once.

Subscription every day, week, month or year.



Some price parameters should be specified to define if the prices are "fixed", "free", "invitation", "donation", "remunerated" or "prepaid" to attend the event.


FIXED PRICE EVENT

EVENT WITH INVITATION

FREE EVENT

BE REMUNERATE FOR THE EVENT

Specific fixed price is defined.

Invitation is required to participate.

No fees are required to participate.

Receive money to attend the event.




ESS structure

ESS documents are composed by various main XML elements. ESS processors must consider each and every element's description as valid and applicable to each and every other XML element within the same ESS document. If it is not the case, it depends on another feed to describe this event parameter.
Example: every items must be valid and applicable to every and items within the same feed.

XML element (ess:prices) must be defined within ESS Documents, it is a mandatory ESS XML element.
This section describes the interaction between ESS events and prices. (ess:prices) XML element must be composed by, at least, one (ess:item) XML element.
Several elements can be defined in XML structure to represent all event prices.




Prices


Name Description Type Required
type The "type" attribute can take two values: "standalone" or "recurrent" to represent if the event has a simple price or value. In the case of a type="recurrent", the "unit" attibute must be defined. ESS Processors should consider that "standalone" is the default attribute if it is not specified. String TRUE
mode The "mode" attribute can take six values: "fixed", "free", "invitation", "donation", "remunerated" or "prepaid" to represent the payment mode to attend the event. ESS Processors should consider that "fixed" is the default attribute if it is not specified. String TRUE
unit The "unit" attribute applies only if type="recurrent" is specified. The "unit" attribute can take five values: "hour", "day", "week", "month" or "year". ESS processors should consider unit="hour" as the default "unit" attribute if it is not specified. String TRUE
FALSE
limit The "limit" attribute applies only if type="recurrent" is specified. The "limit" attribute is optional and defines the number of times the recurrent event will happen. If the "limit" attribute is not specified or if limit="0" ESS Processors should consider the as infinite. Number FALSE
interval The "interval" attribute applies only if type="recurrent" is specified. The "interval" attribute is optional and defines the number of times the recurrent event have to be repeated according to the unit="xxx" attribute value. If the "interval" attribute is not specified ESS Processors should be considered the with a interval="1". Number FALSE
selected_day The "selected_day" attribute applies only if type="recurrent" is specified. The "selected_day" attribute can take eight values: "number", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" or "sunday". The "selected_day" attribute only applied if unit="week" or unit="month". The "selected_day" attribute is optional and defines the number of "unit" attribute that have to be repeated. Several values can be specified with a coma separation. String FALSE
selected_week The "selected_week" attribute applies only if type="recurrent" is specified. The "selected_week" attribute can take five values: "first", "second", "third", "fourth" or "last". The "selected_week" attribute only applies if unit="month". The "selected_week" attribute is optional and defines the section of the month that have to be repeated. Several values can be specified with a coma separation. String FALSE
priority The "priority" attribute refers to the order and the preference applied to each XML element. ESS processors should consider the natural XML position as the priority if this attribute is not defined. Number FALSE



Prices child elements


Name Description Type Required
Language-sensitive price name. Should not be longer then 64 chars String TRUE
Defines event price value. This number applies to the value. Number TRUE
Defines the 3 char currency (e.g. USD, EUR...). the XML element is mandatory only if is superior to zero. Number ISO4217 TRUE
FALSE
Defines an event's recurring price starting Date. Only applicable if type="recurrent". ESS processors should consider the Date as default value if the XML element is not specified. Date FALSE
Defines the duration in seconds when the price (entrance) will be available starting from the XML element. Default value should be 0 for an infinite availability. Number FALSE
This optional XML element contains the ticket specific description. Using HTML tags inside this XML element is possible but should be limited to the minimum necessary because ESS processors could use this information in an environment that can not read HTML. String FALSE
Defines the quantity of places, tickets, reservations or invitations available for this event. Default value should be 0 for an infinite availability. Number FALSE
Defines the minimum number of places, tickets, reservations or invitations that can be take per user to access to this event. Default value should be 1. Number FALSE
Defines the maximum number of places, tickets, reservations or invitations that can be take per user to access to this event. Default value should be 0 for an infinite availability. Number FALSE
Defines an URL where users can validate their access to the event: payment page or webservice, invitation form, free event subscription. URI RFC3986 FALSE




ESS price sample

DTD description http://essfeed.org/history/0.9

 version="1.0" encoding="UTF-8"?>

 xmlns="http://essfeed.org/history/0.9" version="0.9" lang="en">
   ...
   >
 
      
       type="standalone" mode="fixed">
         >Fixed price event>
         >25>
         >USD>
      >
 
      
       type="standalone" mode="remunerated">
         >Receive money to attend this event>
         >25>
         >USD>
      >
 
      
       type="standalone" mode="free">
         >Free event>
      >
 
      
       type="standalone" mode="invitation">
         >Event for invited person only>
         >http://sample.org/subscribe/invitation.html>
      >
 
      
       type="recurrent" unit="month" mode="fixed">
         >Monthly billing>
         >10>
         >USD>
         >http://sample.org/payment.asp?FID=123456789>
         >2012-05-25T10:45:00Z>
      >
 
      
       type="recurrent" mode="fixed" unit="month" limit="2" selected_day="monday" selected_week="last">
         >Bimestrial billing>
         >10>
         >USD>
         >http://sample.org/payment.asp?FID=123456789>
         >2012-05-28T10:45:00+0800>
      >
 
      
       type="prepaid" mode="fixed">
         >Prepaid Entrance ONLY>
         >10>
         >USD>
         >http://sample.org/payment.asp?FID=123456789>
         >2012-03-25T10:45:00+06:00>
         >604800>
      >
   >
   ...
>







External documentation

Ietf logo.png

ESS standard under RFC validation process: RFC ESS Draft

  • RFC 3076 : Canonical XML Version 1.0
  • RFC 3339 : Date and Time on the Internet: Timestamps
  • RFC 3987 : Internationalized Resource Identifiers (IRIs)
  • ISO 4217 : ISO 4217 Currency Codes


IF EVENTS MATTER TO YOU

Spread the news about ESS!
Personal tools
Actions
Standard

 


Developers

 


Communication