Mode (p:mode)¶
http://profiles.goabout.com/mode
The Mode (p:mode) resource represents a mode of transport from one point to another. A mode is characterized by both the type of transport (bicycle, car, tram) and the agency behind or owner of the mode. This means that your bike, is another mode than my bike. Also: a train ran by NS is another mode than a train provided by Arriva.
Example¶
Transit mode, provided by an Agency
{
"type" : "train",
"label" : "Intercity van NS",
"name" : "Intercity",
"logoHref" : "https://goabout.com/pages/agency/ns/intercity.png",
"href" : "https://goabout.com/pages/agency/ns/intercity",
"description" : "Intercity-treinen stoppen niet op elk station en zijn daardoor vaak sneller op hun eindbestemming dan bijvoorbeeld een <a href=\"https://goabout.com/pages/agency/ns/sprinter\">Sprinter<a/>",
"_links" : {
"self" : {
"href" : "https://api.goabout.com/mode/102"
}
},
"_embedded" : {
"http://rels.goabout.com/operator" : {
"name" : "Arriva",
"href" : "https://goabout.com/pages/agencies/arriva",
"logoHref" : "https://goabout.com/pages/agencies/arriva.png",
"_links" : {
"self" : {
"href" : "https://api.goabout.com/agency/12"
}
}
}
}
}
Privately owned mode:
{
"type" : "bicycle",
"label" : "Jouw fiets",
"logoHref" : "https://goabout.com/pages/generic/home-bike.png",
"href" : "https://goabout.com/pages/generic/home-bike",
"description" : "De fiets die bij jouw voor de deur staat.",
"_links" : {
"self" : {
"href" : "https://api.goabout.com/mode/102"
},
"http://rels.goabout.com/owner" : {
"href" : "https://api.goabout.com/user/42"
}
}
}
Generic mode
{
"type" : "walk",
"label" : "Lopen",
"logoHref" : "https://goabout.com/pages/generic/walk.png",
"href" : "https://goabout.com/pages/generic/walk",
"_links" : {
"self" : {
"href" : "https://api.goabout.com/mode/102"
}
}
}
Reference¶
GET¶
Properties¶
type: | ModeType The type of this Mode. |
---|---|
label: | String Label suitable for display. Something like ‘Intercity’, ‘Arriva Bus’, ‘Fiets’, ‘OV-Fiets’, etc.. |
name: | String [OPTIONAL] The actual name of the mode, if applicable. (Intercity, Sprinter) |
standHref: | URI The train-station this mode is located by default. Setting a location is only possible for bikes and will result in getting trip-advices using your bike if you travel via the trainstation this bike is located at. |
logoHref: | URI [OPTIONAL] The href to the logo for this mode. |
href: | URI [OPTIONAL] The href where more (human readable) information about this mode can be found. |
description: | String [OPTIONAL] A (short) description about this mode. Intended to be displayed close to where |
Links¶
This link indicates the Mode is owned by the user behind the link.
Links to the agency operating this mode.
Note
Modes have an owner or an operator (or none, but never both).
DELETE¶
Deletion of modes is only possible for modes owned by a user, by the actual owner of that mode. In other words: only a user can delete its own modes and its own modes only.