MyHome.ie Data Delivery Service

<back to all web services

AnalyticsNoPriceReport

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/analytics/nopricereport
AnalyticsNoPriceReport Parameters:
NameParameterData TypeRequiredDescription
FromDatebodystringNo
ToDatebodystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
CorrelationIdformstringNo
ActiveUserIdformint?No
VersionformdoubleNo
RequestTypeIdformintNo
AnalyticsNoPriceReportResponse Parameters:
NameParameterData TypeRequiredDescription
NoPriceReportformList<NoPriceReport>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
BaseType Parameters:
NameParameterData TypeRequiredDescription
VersionformdoubleNo
NoPriceReport Parameters:
NameParameterData TypeRequiredDescription
PropertyIDformintNo
GroupIDformintNo
DisplayAddressformstringNo
EircodeformstringNo
PropertyClassIDformintNo
PropertyStatusIDformintNo
Priceformdecimal?No
RentalPriceformdecimal?No
CreatedOnDateformstringNo
ActivatedOnformstringNo

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

HTTP + CSV

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

POST /analytics/nopricereport HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: text/csv
Content-Type: text/csv
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/csv
Content-Length: length

{"NoPriceReport":[{"PropertyID":0,"GroupID":0,"DisplayAddress":"String","Eircode":"String","PropertyClassID":0,"PropertyStatusID":0,"Price":0,"RentalPrice":0,"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}