People First API

These are well-known URLs which provide a fixed starting point in the API to determine the functionality available and obtain URLs for navigation to it.

The /profile entry point is like the 'Home Page' for the people first API, it provides information about your user, locale preferences and links into the functionality available to you.

A profile entry point is also exposed in the Admin, Custom Cards and Talent modules e.g. /admin/profile, providing access into the functionality specific to that area.

These endpoints answer the question 'Who am I and what can I do?' in the people first application.

Data types

• string: Variable length UTF-8 encoded string
• number: Number compliant with the JSON specification
• boolean: Boolean compliant with the JSON specification
• dateTime: These attributes have names appended with 'DateTime' and are ISO 8601 compliant strings which must always be UTC
• date: These attributes have names appended with 'Date' and are ISO 8601 compliant strings in the format 'YYYY-MM-DD'
• time: These attributes have name appended with 'Time' and are ISO 8601 compliant strings with no date component

Example fictional resource:

{
  "data": {
    "person": {
      "id": "031c0575-ed2e-4e04-bd01-cc7565045d8b",
      "firstName": "Susan",
      "lastName": "Smith",
      "children": 2,
      "bornDateTime": "1980-06-15T13:28:00Z",
      "employedDate": "2001-07-12",
      "startTime": "13:06:12",
      "isMarried": true,
      "_links": {
        "self": {
          "href": "people/031c0575-ed2e-4e04-bd01-cc7565045d8b"
        }
      }
    }
  }
}