The Account domain object is used to transport eHive Account information in and out of the API. The Account domain object is a flat structure apart from Media Sets structure that contains Account images. Here is a list of the fields on the Account domain object:
| Name | Data Type | Value | Required | Description | |
|---|---|---|---|---|---|
| accountId | Integer | 32-bit signed two’s complement | YES | Unique identifier for the Account | |
| publicProfileName | String | Max. 200 characters | NO | The name of the Account to appear on the Account’s public profile page | |
| shortProfileName | String | Max. 200 characters | NO | A shorted name for the Account | |
| physicalAddress | String | Max. 1000 characters | NO | The physical address associated with the Account | |
| postalAddress | String | Max. 1000 characters | NO | The postal address associated with the Account | |
| phoneNumber | String | Max. 200 characters | NO | The phone number information associated with the Account | |
| emailAddress | String | Max. 200 characters | NO | An Email address associtated with the Account | |
| facsimile | String | Max. 50 characters | NO | A Fax number associated with the Account | |
| website | String | Max. 200 characters | NO | A website address associated with the Account | |
| hoursOfOperation | String | Max. 1000 characters | NO | The hours of operation of a Musuem for example | |
| admissionCharges | String | Max. 1000 characters | NO | Costs associated with visiting a Museum for example | |
| staffDetails | String | Max. 1000 characters | NO | Details about available staff where applicable | |
| aboutCollection | String | Max. 65535 characters | NO | A detailed description of the collection maintaned by the Account | |
| wheelChairAccessFacility | Boolean | true/false | NO | Information on whether wheelchair facilities are available onsite | |
| cafeFacility | Boolean | true/false | NO | Information on whether there are cafes available onsite | |
| referenceLibraryFacility | Boolean | true/false | NO | Information on whether there is a reference library available | |
| parkingFacility | Boolean | true/false | NO | Information on whether parking facilities are available onsite | |
| shopFacility | Boolean | true/false | NO | Information on whether there is a shop onsite | |
| functionSpaceFacility | Boolean | true/false | NO | Information on whether there is a function space available onsite | |
| guidedTourFacility | Boolean | true/false | NO | Information on whether guided tours are available | |
| publicProgrammesFacility | Boolean | true/false | NO | Information on whether programms facilities are available onsite | |
| membershipClubFacility | Boolean | true/false | NO | Information on whether there are membership facilities available | |
| toiletFacility | Boolean | true/false | NO | Information on whether toilet facilities are available onsite | |
| otherFacility | String | Max. 1000 characters | NO | Information about other facilities avalable | |
| latitude | Float | single-precision 32-bit IEEE 754 floating point | NO | Latitude map coordianate | |
| longitude | Float | single-precision 32-bit IEEE 754 floating point | NO | Longitude map coordianate | |
| zoomLevel | Integer | 32-bit signed two’s complement | NO | Zoom level for use with 3rd party maps APIs | |
| mediaSets | Array of MediaSet domain objects | 32-bit signed two’s complement | NO | Collection of images associated with the account |
