Activity stream information

In addition to a contact's basic information, Homepass also shows key interactions that have occurred with a contact.

The interactions are represented in a JSON notation based on Activity Stream 2.0

The aspects of an activity are:

Actor - The entity performing the action
Verb - The type of action being taken
Object - The direct object of the activity
Target - The indirect object, or target, of the activity
AttachedTo - The entity to which this object is attached
AttributedWith - The object to which this object is attributed to
Origin - The indirect object from which the activity is directed
Instrument - The item used to perform the activity
Provider - The publisher of the activity

When consuming the Homepass activity stream a third party system should not process any activities where the "Provider" is their own system.

Activities are idempotent (Activity @id is unique) and any activities which have been processed should not be processed again.

Example 1 - "Agent Jane checked in Customer John originating from Signboard to 123 Smith Street with Homepass published by Homepass" the aspects are:

Actor - Jane
Verb - checkin
Object - 123 Smith Street
Target - John
Origin - Signboard
AttributedWith - checkin object
Instrument - Homepass
Provider - Homepass

Example 2 - "Agent Jane added Note to Customer John with Homepass published by Homepass" the aspects are:

Actor - Jane
Verb - add
Object - note
Target - John
Instrument - Homepass
Provider - Homepass

Example 3 - "Agent Jane added Note to Customer John attached to 123 Smith Street with Homepass published by Homepass" the aspects are:

Actor - Jane
Verb - add
Object - note
Target - John
AttachedTo - 123 Smith Street
Instrument - Homepass
Provider - Homepass

Example 4 - "Agent Jane sent Document to Customer John attached to 123 Smith Street with Homepass published by Homepass" the aspects are:

Actor - Jane
Verb - send
Object - document
Target - John
AttachedTo - 123 Smith Street
Instrument - Homepass
Provider - Homepass

Example 5 - "Customer John requested Document from Agent Jane attached to 123 Smith Street with Homepass published by Homepass" the aspects are:

Actor - John
Verb - request
Object - document
Target - Jane
AttachedTo - 123 Smith Street
Instrument - Homepass
Provider - Homepass

Example 6 - "Customer John submitted Offer to Agent Jane attached to 123 Smith Street with Homepass published by Homepass" the aspects are:

Actor - John
Verb - submit
Object - offer
Target - Jane
AttachedTo - 123 Smith Street
Instrument - Homepass
Provider - Homepass

Example 7 - "Agent Jane shared Offer with Customer John attached to 123 Smith Street with Homepass published by Homepass" the aspects are:

Actor - Jane
Verb - share
Object - offer
Target - John
AttachedTo - 123 Smith Street
Instrument - Homepass
Provider - Homepass

Example 8 - "Agent Jane updated Customer John (details) with Homepass published by Homepass" the aspects are:

Actor - Jane
Verb - update
Object - John
Instrument - Homepass
Provider - Homepass

Example 9 - "Agent Jane deleted checkin with Homepass published by Homepass" the aspects are:

Actor - Jane
Verb - delete
Object - checkin
Instrument - Homepass
Provider - Homepass

Example 10 - "Agent Jane deleted note with Homepass published by Homepass" the aspects are:

Actor - Jane
Verb - delete
Object - note
Instrument - Homepass
Provider - Homepass

Example 11 - "Agent Jane created contact John with Homepass published by Homepass" the aspects are:

Actor - Jane
Verb - create
Object - John
Instrument - Homepass
Provider - Homepass

Example 12 - "Agent Jane updated note with Homepass published by Homepass" the aspects are:

Actor - Jane
Verb - update
Object - note
Instrument - Homepass
Provider - Homepass

Example 13 - "Agent Jane updated note with BlueWebsite published by BlueCRM" the aspects are:

Actor - Jane
Verb - update
Object - note
Instrument - BlueWebsite
Provider - BlueCRM

A number of activities can be grouped together in an "items" array.

Properties prefixed by "hp:" denote homepass specific properties which are not included in the standard Activity Stream 2.0 Vocabulary

Name	Description
totalItems	Total number of items
itemsPerPage	Maximum number of items that will be included in the "items" array
next	Link to the next page of activity items
self	Link to this page of activity items
prev	Link to the previous page of activity items
@id	The persistent, globally unique Homepass ID that represents the activity.
hp:ref	The activity reference key (typically unique) advised by an external business system.
hp:xRefs	An array of external reference keys. Contains the reference source (refSource) and the external key (ref)
verb	The type of action checkin (check a customer into property) send (send a document to a customer) * add (add note to customer/property)
published	ISO 8601 formatted timestamp for the activity when it was received and published to CRMs.
hp:activityDate	ISO 8601 formatted timestamp when the action was performed on device.
hp:activityCorrelationId	If the activity correlates with other activities, this value is populated with a unique ID to group them. Example: sending documents - where each activity denotes each document and the hp:activityCorrelationId is the ID assigned at the time it was sent.
hp:person	A Homepass structure containing the details of a person
hp:addr	A Homepass structure containing the details of an address
hp:note	A Homepass structure containing the details of a note
object	A structure containing the direct object of the activity (typically the property or document)
object.@type	The type of object accepts the following type values: urn:homepass:types:document urn:homepass:types:property * urn:homepass:types:note
object.@id	The persistent, globally unique Homepass ID that represents the object.
object.hp:ref	The object reference key (typically unique) advised by an external business system.
object.hp:xRefs	An array of external reference keys. Contains the reference source (refSource) and the external key (ref)
object.url - DEPRECATED	A link to the API which will return the full object details. DEPRECATED - this was not being published and so we no longer publish it.
object.hp:subtype	The subtype of object accepts the following type values: urn:homepass:doctypes:strata urn:homepass:doctypes:contract urn:homepass:doctypes:pest urn:homepass:doctypes:building
actor	A structure containing the ID and details of the person performing the activity
actor.@type	The type of actor accepts the following type values: urn:homepass:types:contact urn:homepass:types:agent
actor.@id	The persistent, globally unique Homepass ID that represents the actor.
actor.hp:ref - DEPRECATED	The actor reference key (typically unique) advised by an external business system. DEPRECATED - we can no longer support this field. We do not get 3rd party agent IDs.
actor.hp:xRefs - DEPRECATED	An array of external reference keys. Contains the reference source (refSource) and the external key (ref) DEPRECATED - we can no longer support this field. We do not get 3rd party agent IDs.
actor.url - DEPRECATED	A link to the API which will return the full actor details. DEPRECATED - this was not being published and so we no longer publish it.
target	A structure containing the ID and details of the target of the activity.
target.@type	The type of target Accepts the following type values: urn:homepass:types:contact urn:homepass:types:agent
target.@id	The persistent, globally unique Homepass ID that represents the target.
target.homepass:ref	The target reference key (typically unique) advised by an external business system.
target.url - DEPRECATED	A link to the API which will return the full target details. DEPRECATED - this was not being published and so we no longer publish it.
attachedTo	A structure containing the direct or indirect entity attached to the object of the activity (typically the property)
attachedTo.@type	The type of attachedTo accepts the following type values: * urn:homepass:types:property
attachedTo.@id	The persistent, globally unique Homepass ID that represents the attachedTo entity.
attachedTo.hp:ref	The attachedTo entity reference key (typically unique) advised by an external business system.
attachedTo.hp:xRefs	An array of external reference keys. Contains the reference source (refSource) and the external key (ref)
attachedTo.url - DEPRECATED	A link to the API which will return the full attachedTo entity details. DEPRECATED - this was not being published and so we no longer publish it.
instrument.@id	The optional instrument used to perform the action Accepts the following instrument values: urn:homepass:instruments:homepass urn:homepass:instruments:kiosk

{
  "@context": "http://www.w3.org/ns/activitystreams",
  "@type": "Collection",
  "totalItems": 6,
  "itemsPerPage": 100,
  "next": "https://api.homepass.com/offices/8k3k967e2fd76efd72e6k3l9/activities?page=2",
  "self": "https://api.homepass.com/offices/8k3k967e2fd76efd72e6k3l9/activities?page=1",
  "items": [
    // Customer self checkin
    // John Wall checks in John Wall to property EXM-8378972348 with Homepass
    {
      "@type": "http://activitystrea.ms/2.0/Activity",
      "@id": "urn:homepass:activity:f6e37dd815e0435b482a4f30",
      "hp:ref": "ACT-897348973",
      "verb": "checkin",
      "published": "2015-01-05T15:04:55Z",
      "hp:activityDate": "2015-01-05T15:01:55Z"
      "actor": {
        "@type": "urn:homepass:types:contact",
        "@id": "urn:homepass:contact:7e2fd67e2fd76efd72e6df7d",
        "hp:person": {
          "given-name": "John",
          "family-name": "Wall",
          "mobile": "+61400000000",
          "landline": "+61300000000",
          "email": "[email protected]" 
        },
        "hp:addr": {
          "locality": "Kew"
        }
      },
      "object" : {
        "@type": "urn:homepass:types:property",
        "@id": "urn:homepass:property:546e8dd815e0475aca0efe82",
        "hp:ref": "EXM-8378972348",
        "hp:xRefs": [
          {
            "refSource": "bluecrm",
            "ref": "EXM-8378972348"
          },
          {
            "refSource": "acmecrm",
            "ref": "ACME-235"
          }
        ],
        "hp:addr": {
          "street-address": "26 Selbourne Rd",
          "locality": "Kew",
          "region": "VIC", 
          "postal-code": "3101",
          "country-name": "AUS"
        }
      },
      "target" : {
        "@type": "urn:homepass:types:contact",
        "@id": "urn:homepass:contact:7e2fd67e2fd76efd72e6df7d",
        "hp:ref": "CONTACT-3787399",
        "hp:person": {
          "given-name": "John",
          "family-name": "Wall",
          "mobile": "+61400000000",
          "landline": "+61300000000",
          "email": "[email protected]" 
        },
        "hp:addr": {
          "locality": "Kew"
        }
      },
      "attributedWith": {
        "@type": "urn:homepass:types:checkin",
        "@id": "urn:homepass:checkin:552db7258e85990b00a02bcc",
        "startTime": "2015-01-05T15:04:55Z"
      },
      "instrument" : {
        "@type": "urn:homepass:types:instrument",
        "@id": "urn:homepass:instruments:homepass"
      },
      "provider" : {
        "@type": "urn:homepass:types:provider",
        "@id": "urn:homepass:provider:homepass"
      }
    },

    // Agent Jane checks in John Wall originating from signboard 
    // to property EXM-8378972348 with Homepass
    {
      "@type": "http://activitystrea.ms/2.0/Activity",
      "@id": "urn:homepass:activity:f6e37dd815e0435b482a4f30",
      "hp:ref": "ACT-89734342525",
      "verb": "checkin",
      "published": "2015-01-05T16:04:55Z",
      "hp:activityDate": "2015-01-05T16:02:55Z",
      "actor": {
        "@type": "urn:homepass:types:agent",
        "@id": "urn:homepass:agent:8g3gd67e2fd76efd72e6dj8s",
        "hp:person": {
          "given-name": "Jane",
          "family-name": "West",
          "mobile": "+61411111111",
          "landline": "+61311111111",
          "email": "[email protected]" 
        }  
      },
      "object" : {
        "@type": "urn:homepass:types:property",
        "@id": "urn:homepass:property:546e8dd815e0475aca0efe82",
        "hp:ref": "EXM-8378972348",
        "hp:addr": {
          "street-address": "26 Selbourne Rd",
          "locality": "Kew",
          "region": "VIC", 
          "postal-code": "3101",
          "country-name": "AUS"
        }
      },
      "target" : {
        "@type": "urn:homepass:types:contact",
        "@id": "urn:homepass:contact:7e2fd67e2fd76efd72e6df7d",
        "hp:ref": "CONTACT-3787399",
        "hp:person": {
          "given-name": "John",
          "family-name": "Wall",
          "mobile": "+61400000000",
          "landline": "+61300000000",
          "email": "[email protected]" 
        },
        "hp:addr": {
          "locality": "Kew"
        }
      },
      "origin" : {
        "@type": "urn:homepass:types:source",
        "displayName": "signboard"
      },
      "attributedWith": {
        "@type": "urn:homepass:types:checkin",
        "@id": "urn:homepass:checkin:552db7258e85990b00a02bcc",
        "url": "http://api.homepass.com/checkin/552db7258e85990b00a02bcc",
        "startTime": "2015-01-05T15:04:55Z"
      },
      "instrument" : {
        "@type": "urn:homepass:types:instrument",
        "@id": "urn:homepass:instruments:homepass"
      },
      "provider" : {
        "@type": "urn:homepass:types:provider",
        "@id": "urn:homepass:provider:homepass"
      }
    },
    
    // Agent Jane West added note to customer
    // John Wall attached to property EXM-8378972348 with Homepass
    {
      "@type": "http://activitystrea.ms/2.0/Activity",
      "@id": "urn:homepass:activity:g7e37dd815e0435b482a4f99",
      "hp:ref": "ACT-726348834",
      "verb": "add",
      "published": "2015-01-05T14:04:11Z",
      "hp:activityDate": "2015-01-05T14:02:11Z",
      "actor": {
        "@type": "urn:homepass:types:agent",
        "@id": "urn:homepass:agent:8g3gd67e2fd76efd72e6dj8s",
        "hp:person": {
          "given-name": "Jane",
          "family-name": "West",
          "mobile": "+61411111111",
          "landline": "+61311111111",
          "email": "[email protected]" 
        }      
      },
      "object" : {
        "@type": "urn:homepass:types:note",
        "@id": "urn:homepass:note:122e8dd815e0475aca0efg33",
        "hp:ref": "NOTE-2374",
        "hp:note": {
          "text": "asked for section 32",
          "isVendorComment": true
        }
      },
      "target" : {
        "@type": "urn:homepass:types:contact",
        "@id": "urn:homepass:contact:7e2fd67e2fd76efd72e6df7d",
        "hp:ref": "CONTACT-3787399",
        "hp:person": {
          "given-name": "John",
          "family-name": "Wall",
          "mobile": "+61400000000",
          "landline": "+61300000000",
          "email": "[email protected]" 
        }
      },  
      "attachedTo" : {
        "@type": "urn:homepass:types:property",
        "@id": "urn:homepass:property:546e8dd815e0475aca0efe82",
        "hp:ref": "EXM-8378972348",
        "hp:addr": {
          "street-address": "26 Selbourne Rd",
          "locality": "Kew",
          "region": "VIC", 
          "postal-code": "3101",
          "country-name": "AUS"
        }
      },
      "instrument" : {
        "@type": "urn:homepass:types:instrument",
        "@id": "urn:homepass:instruments:homepass"
      },
      "provider" : {
        "@type": "urn:homepass:types:provider",
        "@id": "urn:homepass:provider:homepass"
      }
    },
    
    // Agent Jane West sent a document to customer
    // John Wall relating to property EXM-8378972348 with Homepass
    {
      "@type": "http://activitystrea.ms/2.0/Activity",
      "@id": "urn:homepass:activity:g7e37dd815e0435b482a4f12",
      "hp:ref": "ACT-3435464",
      "verb": "send",
      "published": "2015-01-05T14:04:11Z",
      "hp:activityDate": "2015-01-05T14:02:11Z",
      "hp:activityCorrelationId": "8d60ebed-36b1-4efb-abd0-1d130ff7b717",
      "actor": {
        "@type": "urn:homepass:types:agent",
        "@id": "urn:homepass:agent:8g3gd67e2fd76efd72e6dj8s",
        "hp:person": {
          "given-name": "Jane",
          "family-name": "West",
          "mobile": "+61411111111",
          "landline": "+61311111111",
          "email": "[email protected]" 
        }      
      },
      "object" : {
        "@type": "urn:homepass:types:document",
        "@id": "urn:homepass:document:122e8dd815e0475aca0efg36",
        "mediaType": "application/pdf",
        "displayName": "Section 32",
        "hp:ref": "DOC-128738"
      },
      "target" : {
        "@type": "urn:homepass:types:contact",
        "@id": "urn:homepass:contact:7e2fd67e2fd76efd72e6df7d",
        "hp:ref": "CONTACT-3787399",
        "hp:person": {
          "given-name": "John",
          "family-name": "Wall",
          "mobile": "+61400000000",
          "landline": "+61300000000",
          "email": "[email protected]" 
        }
      },  
      "attachedTo" : {
        "@type": "urn:homepass:types:property",
        "@id": "urn:homepass:property:546e8dd815e0475aca0efe82",
        "hp:ref": "EXM-8378972348",
        "hp:addr": {
          "street-address": "26 Selbourne Rd",
          "locality": "Kew",
          "region": "VIC", 
          "postal-code": "3101",
          "country-name": "AUS"
        }
      },
      "instrument" : {
        "@type": "urn:homepass:types:instrument",
        "@id": "urn:homepass:instruments:homepass"
      },
      "provider" : {
        "@type": "urn:homepass:types:provider",
        "@id": "urn:homepass:provider:homepass"
      }
    },
    
    // Agent Jane West updated Customer John Wall with 
    // Homepass
    {
      "@type": "http://activitystrea.ms/2.0/Activity",
      "@id": "urn:homepass:activity:g7e37dd815e0435b482a4f12",
      "hp:ref": "ACT-435422",
      "verb": "update",
      "published": "2015-01-06T14:04:11Z",
      "hp:activityDate": "2015-01-06T14:02:11Z",
      "actor": {
        "@type": "urn:homepass:types:agent",
        "@id": "urn:homepass:agent:8g3gd67e2fd76efd72e6dj8s",
        "hp:person": {
          "given-name": "Jane",
          "family-name": "West",
          "mobile": "+61411111111",
          "landline": "+61311111111",
          "email": "[email protected]" 
        }
      },
      "object" : {
        "@type": "urn:homepass:types:contact",
        "@id": "urn:homepass:contact:7e2fd67e2fd76efd72e6df7d",
        "hp:ref": "CONTACT-3787399",
        "hp:person": {
          "given-name": "John",
          "family-name": "Wall",
          "mobile": "+61400000000",
          "landline": "+61300000000",
          "email": "[email protected]" 
        }  
      },
      "instrument" : {
        "@type": "urn:homepass:types:instrument",
        "@id": "urn:homepass:instruments:homepass"
      },
      "provider" : {
        "@type": "urn:homepass:types:provider",
        "@id": "urn:homepass:provider:homepass"
      }
    },
    
    // Agent Jane West created Customer John Wall with 
    // Homepass
    {
      "@type": "http://activitystrea.ms/2.0/Activity",
      "@id": "urn:homepass:activity:g7e37dd815e0435b482a4f12",
      "hp:ref": "ACT-435444",
      "verb": "create",
      "published": "2015-01-05T14:04:11Z",
      "hp:activityDate": "2015-01-05T14:02:11Z",
      "actor": {
        "@type": "urn:homepass:types:agent",
        "@id": "urn:homepass:agent:8g3gd67e2fd76efd72e6dj8s",
        "hp:ref": "AGENT-1287311",
        "hp:person": {
          "given-name": "Jane",
          "family-name": "West",
          "mobile": "+61411111111",
          "landline": "+61311111111",
          "email": "[email protected]" 
        }
      },
      "object" : {
        "@type": "urn:homepass:types:contact",
        "@id": "urn:homepass:contact:7e2fd67e2fd76efd72e6df7d",
        "hp:ref": "CONTACT-3787399",
        "hp:person": {
          "given-name": "John",
          "family-name": "Wall",
          "mobile": "+61400000000",
          "landline": "+61300000000",
          "email": "[email protected]" 
        }  
      },
      "instrument" : {
        "@type": "urn:homepass:types:instrument",
        "@id": "urn:homepass:instruments:homepass"
      },
      "provider" : {
        "@type": "urn:homepass:types:provider",
        "@id": "urn:homepass:provider:homepass"
      }
    } 
  ]
}