• My Account
  • Docs
  • Catalog
  • Status
Show / Hide Table of Contents

Variable

Variables are accessed at URL https://api.whenfresh.com/variable/[VARIABLE PATH].

An example variable type URL is:

https://api.whenfresh.com/variable/WhenFresh/Property Market/Property Attribute/Property Last Listed as Rented

An example URL for a variable of that type (with a particular provenance) is:

https://api.whenfresh.com/variable/WhenFresh/Property Market/Property Attribute/Property Last Listed as Rented/provenance/Zoopla/Property Attribute

Variables are embedded within Catalog resources.

Properties

Property Expected Type Description
variable Uri The variable that can be purchased.
price MonetaryAmount The price of the variable to be purchased.
value Text The value of the variable when purchased

Example JSON

{
    "@type" : "https://api.whenfresh.com/variable/WhenFresh/Property Market/Property Attribute/Property Last Listed as Rented",
    "variableId" : "https://api.whenfresh.com/variable/WhenFresh/Property Market/Property Attribute/Property Last Listed as Rented/provenance/Zoopla/Property Attribute",
    "price" : {
       "currency" : "GBP",
       "value" : 0.03
    }
 }
  • Improve this Doc