Product (p:product)¶
http://profiles.goabout.com/product
The Product (p:product) resource represent services (provided by Agency (p:agency)s) that a User can subscribe to. Things like:
- Voordeelurenkaart (discount for train-journeys not during rushour)
- Trajectkaart (free travel on certain routes)
- OV-fiets (possibility to use bikes available at some railway stations)
Note
not limited to those, query Available products (r:available-products) for a complete list of products
Example¶
{
"name" : "OV-Fiets",
"logoHref" : "https://goabout.com/pages/product/ov-fiets.png",
"moreInfoHref" : "https://goabout.com/pages/product/ov-fiets",
"description" : "Abonnement op de OV-Fietsen die beschikbaar zijn op een groot aantal stations",
"propertySchema" : {
"title": "OV-Fiets pasnummer",
"type": "object",
"properties": {
"cardnumber": {
"type": "string",
"title": "pasnummer",
"placeholder": "123456789",
"description": "Vul hier uw pasnummer voor de OV-Fiets in.",
"minLength": 1
}
},
"form" : [ "\*" ],
"required": [ "cardnumber" ]
},
"bookPropertySchema" : {
"title": "OV-Fiets pasnummer",
"type": "object",
"properties": {
"cardnumber": {
"type": "string",
"title": "pasnummer",
"placeholder": "123456789",
"description": "Vul hier uw pasnummer voor de OV-Fiets in.",
"minLength": 1
},
"phonenumber" : {
"type" : "string",
"title" : "telefoonnummer",
"placeholder" : "+31 6 1234 5678",
"minLength" : 1,
"description" : "Vul hier uw telefoonnummer in."
}
},
"form" : [
{
"type": "help",
"helpvalue": "Meer informatie over de OV-Fiets? Klik <a href=\"http://ovfiets.nl\">hier</a>",
},
"\*"
],
"required": [ "cardnumber", "phonenumber" ]
},
"_links" : {
"self" : {
"href" : "https://api.goabout.com/product/9"
}
},
"_embedded" : {
"http://rels.goabout.com/service-provider" : {
"name" : "NS",
"href" : "https://goabout.com/pages/agencies/ns",
"logoHref" : "https://goabout.com/pages/agencies/ns.png",
"_links" : {
"self" : {
"href" : "https://api.goabout.com/agency/12"
}
}
}
}
}
Properties¶
name: | String The name of the product |
---|---|
logoHref: | URI The href to the logo-resource |
moreInfoHref: | URI A href to a human-readable resource with more info about this product. |
description: | String A short description about this product, suitable as sub-title or tool-tip. |
propertySchema: | json-schema A json-form, (in the form of a json-schema) denoting the additional properties needed to subscribe to this product. |
bookPropertySchema: | |
json-schema A json-form in the form of a json-schema denoting the product properties needed to book to this product. | |
bookUserPropertySchema: | |
json-schema A json-form in the form of a json-schema denoting the user properties needed to book to this product. |