MyHome.ie Data Delivery Service

GetPropertyIdListRequest

The following routes are available for this service:
GET	/property/properties-list

**GetPropertyIdListRequest** Parameters:
Name	Parameter	Data Type	Required
AddedSince	query	DateTime?	No
ActivatedOn	query	DateTime?	No
ModifiedOn	query	DateTime?	No
IsActive	query	bool?	No
GroupId	query	int?	No
GroupIds	query	List<int>	No
PropertyClassId	query	int?	No
PropertyStatusId	query	int?	No

**BaseDeliveryRequest** Parameters:
Name	Parameter	Data Type	Required	Description
SessionId	form	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

**GetPropertyIdListResponse** Parameters:
Name	Parameter	Data Type	Required	Description
PropertyList	form	List<int>	No

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.

GET /property/properties-list HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetPropertyIdListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.InternalDelivery">
  <PropertyList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </PropertyList>
</GetPropertyIdListResponse>