MyHome.ie Data Delivery Service

AnalyticsPOAReport

**Requires Authentication**
Required role:	Admin

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

**AnalyticsPOAReport** 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

**AnalyticsPOAReportResponse** Parameters:
Name	Parameter	Data Type	Required	Description
POAReport	form	List<POAReport>	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

**POAReport** Parameters:
Name	Parameter	Data Type	Required
PropertyID	form	int	No
GroupID	form	int	No
DisplayAddress	form	string	No
Eircode	form	string	No
PropertyClassID	form	int	No
PropertyStatusID	form	int	No
Price	form	decimal?	No
ShowPrice	form	bool	No
CreatedOnDate	form	string	No
ActivatedOn	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/poareport 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

{
	POAReport: 
	[
		{
			PropertyID: 0,
			GroupID: 0,
			DisplayAddress: String,
			Eircode: String,
			PropertyClassID: 0,
			PropertyStatusID: 0,
			Price: 0,
			ShowPrice: False,
			CreatedOnDate: String,
			ActivatedOn: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Version: 0
}