Root Discovery Profile

Irakli Nadareishvili edited this page Oct 16, 2013 · 6 revisions

Root of the API responds with a document of base media type. There is no special profile associated with "/".

The only significant thing about the home document is that it has no items and is all about communicating various affordances through query links.

Example:

{"version": "1.0", "attributes": {
  "valid": {
    "from": "2013-07-04T04:00:44+00:00",
    "to": "3013-07-04T04:00:44+00:00"
  },
  "created": "2013-10-01T15:57:55+00:00",
  "modified": "2013-10-16T23:12:57+00:00",
  "guid": "04224975-e93c-4b17-9df9-96db37d318f3",
  "title": "PMP Home Document",
  "published": "2013-07-04T04:00:44+00:00"
}, "links": {
  "creator": [
    {
      "href": "https://api-sandbox.pmp.io/docs/af676335-21df-4486-ab43-e88c1b48f026"
    }
  ],
  "navigation": [
    {
      "href": "https://api-sandbox.pmp.io/docs?guid=04224975-e93c-4b17-9df9-96db37d318f3",
      "rels": ["urn:pmp:navigation:self"]
    }
  ],
  "query": [
    {
      "href-template": "https://api-sandbox.pmp.io/users{?limit,offset,tag,collection,text,searchsort,has}",
      "title": "Query for users",
      "rels": ["urn:pmp:query:users"],
      "href-vars": {...}
    },
    {
      "href-template": "https://api-sandbox.pmp.io/groups{?limit,offset,tag,collection,text,searchsort,has}",
      "title": "Query for groups",
      "rels": ["urn:pmp:query:groups"]
    },
    {
      "href-template": "https://api-sandbox.pmp.io/profiles{/guid}",
      "title": "Access profiles",
      "rels": ["urn:pmp:hreftpl:profiles"]
    },
    {
      "href-template": "https://api-sandbox.pmp.io/schemas{/guid}",
      "title": "Access schemas",
      "rels": ["urn:pmp:hreftpl:schemas"]
    },
    {
      "href-template": "https://api-sandbox.pmp.io/docs{/guid}{?limit,offset}",
      "title": "Access documents",
      "rels": ["urn:pmp:hreftpl:docs"]
    }
}}
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.