MyHome.ie Data Delivery Service

AnalyticsProperties

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
POST	/analytics/properties

**AnalyticsProperties** Parameters:
Name	Parameter	Data Type	Required	Description
FromDate	body	string	No
ToDate	body	string	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required
ApiKey	form	string	No
CorrelationId	form	string	No
ActiveUserId	form	int?	No
Version	form	double	No
RequestTypeId	form	int	No

**AnalyticsPropertiesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Properties	form	List<Property>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**BaseType** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	double	No

**Property** Parameters:
Name	Parameter	Data Type	Required
PropertyID	form	int	No
AgentID	form	int	No
PropertyTypeId	form	int	No
PropertyType	form	string	No
Address	form	string	No
Eircode	form	string	No
Price	form	decimal?	No
PropertyClass	form	string	No
Region	form	string	No
RegionId	form	int?	No
LocalityId	form	int?	No
Beds	form	int?	No
BER	form	string	No
Bathrooms	form	int?	No
SqMetres	form	float?	No
DateListed	form	string	No
Locality	form	string	No
Latitude	form	float?	No
Longitude	form	float?	No
PMLink	form	string	No
Description	form	string	No
PropertyTypeDetailed	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /analytics/properties HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FromDate: String,
	ToDate: String,
	ApiKey: String,
	CorrelationId: String,
	ActiveUserId: 0,
	Version: 0,
	RequestTypeId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Properties: 
	[
		{
			PropertyID: 0,
			AgentID: 0,
			PropertyTypeId: 0,
			PropertyType: String,
			Address: String,
			Eircode: String,
			Price: 0,
			PropertyClass: String,
			Region: String,
			RegionId: 0,
			LocalityId: 0,
			Beds: 0,
			BER: String,
			Bathrooms: 0,
			SqMetres: 0,
			DateListed: String,
			Locality: String,
			Latitude: 0,
			Longitude: 0,
			PMLink: String,
			Description: String,
			PropertyTypeDetailed: String
		}
	],
	Version: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}