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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<AnalyticsPropertyPriceRegister xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Analytic">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">String</ApiKey>
  <CorrelationId xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">String</CorrelationId>
  <ActiveUserId xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">0</ActiveUserId>
  <Version xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">0</Version>
  <RequestTypeId xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">0</RequestTypeId>
  <FromDate>String</FromDate>
  <ToDate>String</ToDate>
</AnalyticsPropertyPriceRegister>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AnalyticsPropertyPriceRegisterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Analytic">
  <Version xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">0</Version>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <PropertyPriceRegister xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Analytic.Types">
    <d2p1:PropertyPriceRegister>
      <d2p1:Eircode>String</d2p1:Eircode>
      <d2p1:ImportedDate>String</d2p1:ImportedDate>
      <d2p1:Latitude>0</d2p1:Latitude>
      <d2p1:Locality>String</d2p1:Locality>
      <d2p1:Longitude>0</d2p1:Longitude>
      <d2p1:MyHomePPRID>0</d2p1:MyHomePPRID>
      <d2p1:NotFullMarketPrice>0</d2p1:NotFullMarketPrice>
      <d2p1:Price>0</d2p1:Price>
      <d2p1:PropertyAddress>String</d2p1:PropertyAddress>
      <d2p1:PropertyDescription>String</d2p1:PropertyDescription>
      <d2p1:Region>String</d2p1:Region>
      <d2p1:SoldDate>String</d2p1:SoldDate>
    </d2p1:PropertyPriceRegister>
  </PropertyPriceRegister>
</AnalyticsPropertyPriceRegisterResponse>