Page History

...

GET /v1/events?since=<serialnumber>

200 OK
{
  "events":
  [
    {
      "serialNumber":103,
      "sor":"registry",
      "entity":"/v1/people/enterprise/49873",
      "timestamp":"2012-10-04T03:10:14.123Z",
      "comment":"Updated name",
      "messageType":"diff",
      "attributes":{
        "names":[
          {
            "type":"official",
            "given":"Pat",
            "family":"Lee"
          }
        ]
      }
    },
    {
      "serialNumber":104,
      "sor":"registry",
      "entity":"/v1/people/enterprise/49873",
      "timestamp":"2012-10-04T03:10:19.100Z",
      "comment":"Updated telephonenumber",
      "messageType":"diff",
      "attributes":{
        "telephoneNumbers":[
          {
            "type":"official",
            "number":"+1 646 555 1234",
            "verified":"no"
          }
        ]
      }
    }
  ]
}

• serialNumber allows a client to pull new changes by indicating the last change it saw. As such, the value must be comparable, with later events having later serial numbers.
• sor designates the system of record that triggered the change.
• entity is a reference to a resource obtainable via the Read API.
• timestamp is when the event was recorded, which is not necessarily when the change happened.
• comment is an optional human readable comment describing the change.
• Attributes may be passed in a message. When this is done
  • messageType indicates whether only the changed attributes are passed ("diff") or whether the full record is passed ("full").
  • attributes is of the same format as the Read API.
• TBD: Can a client send a filter to restrict the events it wishes to see?

...

• sor is an identifier to indicate the source (eg: Registry, GMS, etc) of the event.
• entity is a reference to a resource obtainable via the Read API.
• timestamp is when the event was recorded; if omitted now is assumed.
• comment is an optional human readable comment describing the change.
• Attributes may be passed in a message. When this is done
  • messageType indicates whether only the changed attributes are passed ("diff") or whether the full record is passed ("full").
  • attributes is of the same format as the Read API.

Register

The register operation can be used by other systems to trigger change notifications via the Registry.

...

• sor is an identifier to indicate the source (eg: Registry, GMS, etc) of the event.
• entity is a reference to a resource obtainable via the Read API.
• timestamp is when the event was recorded; if omitted now is assumed.
• comment is an optional human readable comment describing the change.
• Attributes may be passed in a message. When this is done
  • messageType indicates whether only the changed attributes are passed ("diff") or whether the full record is passed ("full").
  • attributes is of the same format as the Read API.

Read API

The Read API retrieves the set of attributes associated with a Registry Person. It is not quite the inverse of the write API, since the write API operates on an SOR Person Role.

...