User (p:user)

http://profiles.goabout.com/user

A user is a person who uses the Go About trip planner. In OAuth terms, users are resource owners of resources that represent their personal information. Such resources are accessible to third parties (clients) only with explicit permission from the user.

Example

{
  "email" : "johndoe@example.com",
  "name" : "John Doe",
  "phonenumber" : "0123456789",
  "identifier" : "c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2",
  "homeLocationHref" : "https://api.goabout.com/location/address/e8b970ce",
  "validated" : false,
  "bicycleSpeed" : 15,
  "_links" : {
    "http://rels.goabout.com/favorite-routes" : {
      "href" : "https://api.goabout.com/user/398/favorite-routes"
    },
    "http://rels.goabout.com/subscriptions" : {
      "href" : "https://api.goabout.com/user/398/subscriptions"
    },
    "http://rels.goabout.com/suggested-locations" : {
      "href" : "https://api.goabout.com/user/398/suggested-locations"
    },
    "http://rels.goabout.com/trips" : {
      "href" : "https://api.goabout.com/user/398/trips{?start,end}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.goabout.com/user/398"
    }
  }
}

Reference

Properties

email

The verified email address. The email address is used as username for authentication.

name

The display name.

phonenumber

The user’s phone number.

identifier

A unique identifier for this user.

homeLocationHref

URI The href to the location of the Users home location.

validated

Whether the user has been validated.

bicycleSpeed

The personal bicycle speed for this user, in km/h.

Links

• Favorite routes (r:favorite-routes): A list of favorite departure / arrival location combinations.

• Trips (r:trips): A collection of the users selected trips.

• Subscriptions (r:subscriptions): A list of Product (p:product) this User is subscribed to.

• Suggested locations (r:suggested-locations): A list of Location (p:location) that should be relevant to this user.

Methods

GET

Retrieve the user information.

PUT

Replace the user information.

DELETE

Delete the user and all related information.

A user information can be retrieved and replaced both by the user themselves and by administrators.