Basic contact information

Homepass's contact model uses the jCard format (aka the JSON version of vCard 4.0).

The jCard schema is published by the IETF.

A JSON jCard object is used to represent a vCard
Multiple jCard objects can be included in the same JSON document by use of a simple
JSON array, each element being a single jCard object representing a complete contact.
An additional x-ref property is included to represent an external contact reference key which is advised by an external business system.

The core vcard properties are:

Name	Description
adr	A structured representation of the physical address for the contact.
bday	Date of birth of the individual associated with the contact.
categories	A list of tags that can be used to describe the contact.
email	The address for electronic communication with the contact.
fn Required	The formatted name string associated with the contact.
gender	The individual's gender.
geo	Specifies a latitude and longitude.
kind	Defines the type of entity that this contact represents.
lang	Defines a language that the individual speaks.
n	A structured representation of the name of the contact.
nickname	One or more descriptive/familiar names for the contact.
note	Supplementary information or a comment associated with the contact.
org	The name and optionally the unit of the organisation associated with the contact. This field is based on the X.520 Organization Name attribute and the X.520 Organization Unit attribute.
photo	An image of the contact. It may point to an external URL or may be embedded as a Base64 encoded block of text.
events	A list of event structures associated with the contact. This is an xCard extended field that must be prefixed with the x-homepass namespace.
related	Another entity that the contact is related to.
rev	A timestamp for the last time the contact was updated.
role	The role, occupation, or business category of the contact with an organization.
tel	The canonical number string for a telephone number for telephony communication with the contact
tz	The time zone of the contact
url	A URL pointing to a website that represents the contact.
uid	The persistent, globally unique Homepass ID associated with the contact.
x-ref	The contact reference key (typically unique) advised by an external business system.

Additional properties to facilitate paging are:

Name	Description
totalItems	Total number of vcard objects
itemsPerPage	Maximum number of vcards that will be included in the "items" array
itemsSince	ISO 8601 formatted timestamp representing the time the first page request was made. Passing this value in the url parameters for subsequent page requests will aid in avoiding duplicate items being returned (eg. when new items have been added to the system since the first page request)
next	Link to the next page of vcard items
self	Link to this page of vcard items
items	An array of vcard objects

{ 
  "totalItems": 4,
  "itemsPerPage": 2,
  "next": "https://api.homepass.com/offices/8k3k967e2fd76efd72e6k3l9/contacts?page=2",
  "self": "https://api.homepass.com/offices/8k3k967e2fd76efd72e6k3l9/contacts?page=1",
  "items": 
    [
    	["vcard", 
      	[
      		["version", {}, "text", "4.0"],
      		["fn", {}, "text", "Bruce Wayne"],
      		["n", {}, "text", ["Wayne", "Bruce", "", "Mr", ""]],
      		["adr", {"type": "work"}, "text", 
          	[
        			"",
        			"",
        			"Level 9 412 Collins Street",
        			"Melbourne",
        			"Victoria",
        			"3000",
        			"Australia"
            ]
          ],
      		["tel", {"type": ["cell"]}, "uri", "tel:+61451659888"],
      		["tel", {"type": ["voice"]}, "uri", "tel:+61395518888"],
      		["email", {"type": "work"}, "text", "[email protected]"],
      		["geo", {"type": "home"}, "uri", "geo:46.766336,-71.28955"],
      		["note", {}, "text", "Looking for 3 bedroom house."],
      		["uid", {}, "text", "5460182a15e0475aca0ec1c8"],
      		["x-ref", {}, "text", "EXM-983748973"]
        ]
    	],
    	["vcard",
     		[
       		["version", {}, "text", "4.0"],
       		["fn", {}, "text", "Peter Parker"],
       		["n", {}, "text", ["Parker", "Peter", "", "Mr", ""]],
       		["adr", {"type": "work"}, "text",
        		[
          		"",
          		"",
          		"Level 10 412 Collins Street",
         		 	"Melbourne",
          		"Victoria",
          		"3000",
          		"Australia"
        		]
       		],
       		["tel", {"type": ["cell"]}, "uri", "tel:+61451659777"],
       		["tel", {"type": ["voice"]}, "uri", "tel:+6139551777"],
       		["email", {"type": "work"}, "text","[email protected]"],
       		["geo", { "type": "home" }, "uri", "geo:46.766344,-71.28944"],
       		["note", {}, "text", "Looking for 1 bedroom unit."],
       		["uid", {}, "text", "2873182a15e0475aca0ek3i8"],
       		["x-ref", {}, "text", "EXM-12374233"]
     		]
    	]
    ]
}