Minimum activity fields

The activity stream contains fields which represent a minimal snapshot of the available data at the time of the activity. URL links are provided for each aspect (eg. actor, target) associated with the activity. However those further endpoints will return realtime data for those aspects, rather than the data which was current at the time the activity occurred.

Below is the minimum snapshot data which should be included in the activity stream.
Example activities with the required aspects are detailed in the section Activity stream information

person details (actor/object/target aspects. eg. agent, contact)
"id": "OWN_SYSTEM_ID"
"ref": "THIRD_PARTY_SYSTEM_ID"
"given-name": "John"
"family-name": "Wall"
"mobile": "+61400000000"
"landline": "+61300000000"
"email": "[email protected]"
"locality": "Kew"

location details (object/attachedTo aspects. eg. property)
"id": "OWN_SYSTEM_ID"
"ref": "THIRD_PARTY_SYSTEM_ID"
"street-address": "26 Selbourne Rd"
"locality": "Kew"
"region": "VIC"
"postal-code": "3101"
"country-name": "AUS"

document details (object aspect. eg. document)
"id": "OWN_SYSTEM_ID"
"ref": "THIRD_PARTY_SYSTEM_ID"
"url": "http://api.homepass.com/documents/324834837.pdf",
"mediaType": "application/pdf",
"displayName": "Section 32",

note details (object aspect. eg. vendor note)
"text": "asked for section 32"
"isVendorComment": true

source details (origin aspect. eg. Signboard)
"displayName": "signboard"

instrument details (instrument aspect. eg. Homepass360)
"@id": "urn:homepass:instruments:homepass360"

provider details (provider aspect. eg. Homepass)
"@id": "urn:homepass:provider:homepass"