MyHome.ie Data Delivery Service

<back to all web services

GetPropertyIdListRequest

The following routes are available for this service:
GET/property/properties-list
GetPropertyIdListRequest Parameters:
NameParameterData TypeRequiredDescription
AddedSincequeryDateTime?No
ActivatedOnqueryDateTime?No
ModifiedOnqueryDateTime?No
IsActivequerybool?No
GroupIdqueryint?No
GroupIdsqueryList<int>No
PropertyClassIdqueryint?No
PropertyStatusIdqueryint?No
BaseDeliveryRequest Parameters:
NameParameterData TypeRequiredDescription
SessionIdformstringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
CorrelationIdformstringNo
ActiveUserIdformint?No
VersionformdoubleNo
RequestTypeIdformintNo
GetPropertyIdListResponse Parameters:
NameParameterData TypeRequiredDescription
PropertyListformList<int>No

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.

GET /property/properties-list HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'GetPropertyIdListResponse' using the custom 'csv' filter}No parameterless constructor defined for this object.