Event stream documentation

The event stream schema has a similar shape to other people first apis. The eventData object contains the actual event data for which the schema will vary depending on the eventType. The schema for each eventType is defined in the events section of this page.

Field lengths

The field lengths for string based fields are listed in the documentation for each event type. These field lengths are to assist integrators when consuming data from the event stream. Some fields have limitations for business purposes (such as driving licence id or ni number), others are purely technical limitations. The technical limitations are generally higher than would be expected for a given piece of data, however it is possible that these field lengths could be increased at some point. The field lengths will never decrease.

Casing

All fields are case insensitive.

Example schema for the event stream api

{
  "data": {
    "eventStream": [{
      "id": "80e3ef54-2905-42f7-87ac-eaaed55df144",
      "eventType": "personCreated",
      "timeOfCreation": "2019-11-07T09:15:11.28Z",
      "timeOfReceipt": "2019-11-07T09:15:11.29Z",
      "eventData": {
      }
    }]
  },
  "meta": {
    "links": {
      "self": {
        "href": "/rtpi/eventstream"
      },
      "first": {
        "href": "/rtpi/eventstream?page%5BLimit%5D=2&page%5BOffset%5D=0"
      },
      "last": {
        "href": "/rtpi/eventstream?page%5BLimit%5D=2&page%5BOffset%5D=6"
      },
      "next": {
        "href": "/rtpi/eventstream?page%5BLimit%5D=2&page%5BOffset%5D=4"
      },
      "previous": {
        "href": "/rtpi/eventstream?page%5BLimit%5D=2&page%5BOffset%5D=2"
      }
    },
    "paging": {
      "pageLimit": 2,
      "pageOffset": 2,
      "totalCount": 8
    }
  }
}

The timeOfCreation and timeOfReceipt are dateTimes stored in coordinated universal time (UTC).

Event stream events are eventually consistent and will not necessarily appear in the order the events occurred in the source microservice. However, the TimeOfCreation property does indicate when the event occurred in the source microservice.

All events in the event stream are related to either a person, job or occupancy. These owning resources are referenced in all events by means of a resource id and a resource reference. The id is the resource identifier within the people first apis, which is typically a guid. The reference is a customer defined identifier, which is typically a string. The resource reference allows consumers to associate resources in the two system by an identifier that may already exist in another system, rather than having to use the people first identifier.