API root (p:root)

http://profiles.goabout.com/root

The root profile is used for the API root resource, which is the entry point to the API. It contains links to the different API components. What links are returned is dependent on the identity of the caller and the state of the system.

See also the Root resource section.

The root-resource is the only resource you’ll need to know the HTTP(s) endpoint of. It also is one of two resources you can access without any authentication. All other resources will be made available to you, via links with a relation-uri. (The http://rels.goabout… links). This also has the added means that if the resource is not made available, you don’t have access to it.

Examples

$ curl -H'Authorization: Bearer UArtDY9Bpo9Whga2mfd7nIK6vENxp2twtnH7RvPC6xj0jy6' 'https://api.goabout.com/'

{
  "version" : "3.4.0",
  "_links" : {
    "self" : {
      "href" : "https://api.goabout.com/"
    },
    "http://rels.goabout.com/oauth2-token" : {
      "href" : "https://auth.goabout.com/token"
    },
    "http://rels.goabout.com/geocoder" : {
      "href" : "https://api.goabout.com/geocoder/encode{?query,count}",
      "templated" : true
    },
    "http://rels.goabout.com/current-location" : {
      "href" : "https://api.goabout.com/location/current/{latitude}/{longitude}",
      "templated" : true
    },
    "http://rels.goabout.com/plan" : {
      "href" : "https://api.goabout.com/plan"
    },
    "http://rels.goabout.com/password-reset" : {
      "href" : "https://api.goabout.com/password-reset{/token}",
      "templated" : true
    },
    "http://rels.goabout.com/feedback" : {
      "href" : "https://api.goabout.com/feedback"
    },
    "http://rels.goabout.com/registration" : {
      "href" : "https://api.goabout.com/registration{/token}",
      "templated" : true
    },
    "http://rels.goabout.com/available-products" : {
      "href" : "https://api.goabout.com/products"
    }
  },
  "_embedded" : {
    "http://rels.goabout.com/client" : {
      "description" : "Test Client",
      "identifier" : "pcBzHCqUKztSU2Gj5S4xqtEXMsdisytK",
      "_links" : {
        "self" : {
          "href" : "https://api.goabout.com/client/1"
        }
      }
    },
    "http://rels.goabout.com/authenticated-user" : {
      "email" : "user@example.com",
      "name" : "Test User",
      "_links" : {
        "self" : {
          "href" : "https://api.goabout.com/user/1"
        },
        "http://rels.goabout.com/favorite-routes" : {
          "href" : "https://api.goabout.com/user/1/favorite-routes"
        },
        "http://rels.goabout.com/subcriptions" : {
          "href" : "https://api.goabout.com/user/1/subcriptions"
        },
        "http://rels.goabout.com/trips" : {
          "href" : "https://api.goabout.com/user/1/trips{?start,end}",
          "templated" : true
        }
      }
    }
  }
}

Reference

The only property on the root profile is the software version number.

version:String The internal version number of the Go About software that is serving the API. This number is purely for informational and debugging purposes. Clients should not use it to control their behavior.
build:String The internal build number.

Embedded

  • [UNDOC] /relations/client
  • [UNDOC] /relations/authenticated-user