MyHome.ie Data Delivery Service

<back to all web services

AnalyticsPropertyPriceRegister

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/analytics/propertypriceregister
AnalyticsPropertyPriceRegister Parameters:
NameParameterData TypeRequiredDescription
FromDatebodystringNo
ToDatebodystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
CorrelationIdformstringNo
ActiveUserIdformint?No
VersionformdoubleNo
RequestTypeIdformintNo
AnalyticsPropertyPriceRegisterResponse Parameters:
NameParameterData TypeRequiredDescription
PropertyPriceRegisterformList<PropertyPriceRegister>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
BaseType Parameters:
NameParameterData TypeRequiredDescription
VersionformdoubleNo
PropertyPriceRegister Parameters:
NameParameterData TypeRequiredDescription
MyHomePPRIDformintNo
PropertyDescriptionformstringNo
SoldDateformstringNo
ImportedDateformstringNo
PropertyAddressformstringNo
LocalityformstringNo
RegionformstringNo
LatitudeformfloatNo
LongitudeformfloatNo
PriceformfloatNo
NotFullMarketPriceformintNo
EircodeformstringNo

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/propertypriceregister 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

{
	PropertyPriceRegister: 
	[
		{
			MyHomePPRID: 0,
			PropertyDescription: String,
			SoldDate: String,
			ImportedDate: String,
			PropertyAddress: String,
			Locality: String,
			Region: String,
			Latitude: 0,
			Longitude: 0,
			Price: 0,
			NotFullMarketPrice: 0,
			Eircode: String
		}
	],
	Version: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}